Class pfcSelection
Description
This class represents a selection.
Direct Parent Classes:
User Guide References:
Accessing Selection Data:pfcSelection, Adding Items to the Selection Buffer:pfcSelection, Analyzing Interference Information:pfcSelection, Controlling Selection Display:pfcSelection, Creating Drawing Dimensions:pfcSelection, Drawing Table Segments:pfcSelection, Example Code: Using Interactive Selection:pfcSelection, Exporting Using Coordinate System:pfcSelection, Getting a Model Object:pfcSelection, Getting ModelItem Objects:pfcSelection, Managing Application Arguments:pfcSelection, Obtaining Drawing Dimensions:pfcSelection, Obtaining Drawing Views:pfcSelection, Offset Attachment:pfcSelection, Parametric Attachment:pfcSelection, pfcSelectionExamples:pfcSelection, PFC Exceptions:pfcSelection, Programmatic Selection:pfcSelection, Reading the Contents of the Selection Buffer:pfcSelection, Removing the Items of the Selection Buffer:pfcSelection, Selecting Drawing Tables and Cells:pfcSelection, Selection:pfcSelection, Setting the User Defined References:pfcSelection, Structure of Assemblies and Assembly Objects:pfcSelection
Property Summary
/* readonly */ number | |
The depth of the selection | |
The UV parameters | |
/* optional */ pfcComponentPath | |
The component path | |
The point | |
/* readonly */ string | |
Web.Link style selection string representation for this selection. | |
/* optional */ pfcModelItem | |
The selected model item | |
/* readonly */ /* optional */ pfcModel | |
The selected model | |
/* optional */ pfcTableCell | |
The table cell, or null, if the selection does not represent a drawing table cell selection. | |
/* readonly */ /* optional */ number | |
The drawing table segment, or null, if the selection does not contain a drawing table. | |
/* optional */ pfcView2D | |
The drawing view, or null, if the selection does not contain a drawing view. | |
/* optional */ number | |
The T parameter of an edge or curve |
Method Summary
void | Display () |
Displays the selection. Note that this is a one-time action (the next repaint will erase this display). | |
void | |
Highlights the selection in the current window. The selection remains highlighted until you call the Unhighlight() function. | |
void | |
Set reference CSYS for export file. User should conver pfcModel to pfcSelection and then call this method on it. Use method pfcCreateModelSelection() to get pfcSelection from pfcModel | |
void | UnHighlight () |
Removes the highlighting from the selection highlighted by a previous call to the Highlight() function. |
Property Detail
/* readonly */ number | Depth |
The depth of the selection
Exceptions thrown (but not limited to):
pfcXToolkitInvalidPtr - The selection argument is an invalid pointer.
Params |
The UV parameters
/* optional */ pfcComponentPath | Path |
The component path
Point |
The point
Exceptions thrown (but not limited to):
pfcXToolkitInvalidPtr - The selection argument is an invalid pointer.
/* readonly */ string | SelectionString |
Web.Link style selection string representation for this selection.
/* optional */ pfcModelItem | SelItem |
The selected model item
Exceptions thrown (but not limited to):
pfcXToolkitNotExist - The model item doesn't exist.
/* readonly */ /* optional */ pfcModel | SelModel |
The selected model
Exceptions thrown (but not limited to):
pfcXToolkitNotExist - The model item doesn't exist.
pfcXToolkitNotFound - no associated drawing found
/* optional */ pfcTableCell | SelTableCell |
The table cell, or null, if the selection does not represent a drawing table cell selection.
/* readonly */ /* optional */ number | SelTableSegment |
The drawing table segment, or null, if the selection does not contain a drawing table.
/* optional */ pfcView2D | SelView2D |
The drawing view, or null, if the selection does not contain a drawing view.
Exceptions thrown (but not limited to):
pfcXToolkitNotFound - no associated drawing found
/* optional */ number | TParam |
The T parameter of an edge or curve
Method Detail
void | Display | () |
Displays the selection. Note that this is a one-time action (the next repaint will erase this display).
void | Highlight |
Highlights the selection in the current window. The selection remains highlighted until you call the Unhighlight() function.
Parameters:
Color
The highlight color
User Guide References:
void | SetIntf3DCsys |
Set reference CSYS for export file. User should conver pfcModel to pfcSelection and then call this method on it. Use method pfcCreateModelSelection() to get pfcSelection from pfcModel
Parameters:
ReferenceCsys
The reference coordinate system selection. This is Optional argument. Call this method without any argument to set default coordinate system. Reference CSYS is not supported for CADDS and NEUTRAL file types.
User Guide References:
void | UnHighlight | () |
Removes the highlighting from the selection highlighted by a previous call to the Highlight() function.