CIP C++ documentation for class "pfcSelection"

Class pfcSelection

# include <pfcSelect.h> class pfcSelection : public virtual pfcObject { xaideclare(pfcSelection) ... };

Description

This class represents a selection.

Manual References:: Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing Reference and Driven Dimensions, Annotations: Annotation Features and Annotations: Baseline Dimensions, Annotations: Annotation Features and Annotations: Ordinate Dimensions, Features: Creating a Custom UDF, Graphics: Item Properties, Selection: Programmatic Selection, Overview of Creo Object TOOLKIT C++: Casting of Creo Object TOOLKIT C++ pfc Classes to wfc Classes, Feature Element Tree: Element Tree Types, Annotations: Geometric Tolerances: Attaching the Geometric Tolerances, Assemblies and Components: Structure of Assemblies and Assembly Objects, Drawings: Creating Drawing Dimensions, Drawings: Listing Drawing Views, Drawings: Modifying Views, Drawings: Auxiliary Views, Drawings: Revolved Views, Drawings: Sections of a View, Drawings: Visible Areas of Views, Drawings: Parametric Attachment, Drawings: Offset Attachment

Direct Known Subclasses:: wfcWSelection

Method Summary


`void`	`Display ()`
	Displays the selection. Note that this is a one-time action (the next repaint will erase this display).

`xreal`	`GetDepth ()`
	The depth of the selection

`pfcUVParams_ptr`	`GetParams ()`
`void`	`SetParams (pfcUVParams_ptr value)`
	The UV parameters

`optional pfcComponentPath_ptr`	`GetPath ()`
`void`	`SetPath (optional pfcComponentPath_ptr value)`
	The component path

`pfcPoint3D_ptr`	`GetPoint ()`
`void`	`SetPoint (pfcPoint3D_ptr value)`
	The point

`xstring`	`GetSelectionString ()`
	Web.Link style selection string representation for this selection.

`optional pfcModelItem_ptr`	`GetSelItem ()`
`void`	`SetSelItem (optional pfcModelItem_ptr value)`
	The selected model item

`optional pfcModel_ptr`	`GetSelModel ()`
	The selected model

`optional pfcTableCell_ptr`	`GetSelTableCell ()`
`void`	`SetSelTableCell (optional pfcTableCell_ptr value)`
	The table cell, or `null`, if the selection does not represent a drawing table cell selection.

`optional xint`	`GetSelTableSegment ()`
	The drawing table segment, or `null`, if the selection does not contain a drawing table.

`optional pfcView2D_ptr`	`GetSelView2D ()`
`void`	`SetSelView2D (optional pfcView2D_ptr value)`
	The drawing view, or `null`, if the selection does not contain a drawing view.

`optional xreal`	`GetTParam ()`
`void`	`SetTParam (optional xreal value)`
	The T parameter of an edge or curve

`void`	`Highlight (pfcStdColor Color)`
	Highlights the selection in the current window. The selection remains highlighted until you call the Unhighlight() function.

`void`	`SetIntf3DCsys (optional pfcSelection_ptr ReferenceCsys)`
	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.

Method Detail

optional pfcModel_ptr GetSelModel ()

The selected model

Exceptions thrown (but not limited to):

pfcXToolkitNotExist - The model item doesn't exist.

pfcXToolkitNotFound - no associated drawing found

Manual References:: Models: Getting a Model Object, Models: Getting a Model Object, Selection: Accessing Selection Data, Selection: Accessing Selection Data

`optional pfcModelItem_ptr`	`GetSelItem`	`()`
`void`	`SetSelItem`	`(optional pfcModelItem_ptr value)`

The selected model item

Exceptions thrown (but not limited to):

pfcXToolkitNotExist - The model item doesn't exist.

Manual References:: ModelItem: Getting ModelItem Objects, ModelItem: Getting ModelItem Objects, Selection: Accessing Selection Data, Selection: Accessing Selection Data, Drawings: Obtaining Drawing Dimensions, Drawings: Selecting Drawing Tables and Cells, Drawings: Selecting Drawing Tables and Cells, Selection: Programmatic Selection, Selection: Programmatic Selection

`optional pfcTableCell_ptr`	`GetSelTableCell`	`()`
`void`	`SetSelTableCell`	`(optional pfcTableCell_ptr value)`

The table cell, or null, if the selection does not represent a drawing table cell selection.

Manual References:: Selection: Accessing Selection Data, Selection: Accessing Selection Data, Drawings: Selecting Drawing Tables and Cells, Drawings: Selecting Drawing Tables and Cells, Selection: Programmatic Selection, Selection: Programmatic Selection

`optional pfcView2D_ptr`	`GetSelView2D`	`()`
`void`	`SetSelView2D`	`(optional pfcView2D_ptr value)`

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

Manual References:: Selection: Accessing Selection Data, Selection: Accessing Selection Data, Drawings: Obtaining Drawing Views, Drawings: Obtaining Drawing Views, Selection: Programmatic Selection

optional xint GetSelTableSegment ()

The drawing table segment, or null, if the selection does not contain a drawing table.

Manual References:: Selection: Accessing Selection Data, Selection: Accessing Selection Data, Drawings: Selecting Drawing Tables and Cells, Drawings: Drawing Table Segments, Drawings: Drawing Table Segments

`optional pfcComponentPath_ptr`	`GetPath`	`()`
`void`	`SetPath`	`(optional pfcComponentPath_ptr value)`

The component path

Manual References:: Selection: Accessing Selection Data, Selection: Accessing Selection Data, Selection: Programmatic Selection, Selection: Programmatic Selection

`pfcUVParams_ptr`	`GetParams`	`()`
`void`	`SetParams`	`(pfcUVParams_ptr value)`

The UV parameters

Manual References:: Selection: Accessing Selection Data, Selection: Accessing Selection Data, Selection: Programmatic Selection, Selection: Programmatic Selection

`optional xreal`	`GetTParam`	`()`
`void`	`SetTParam`	`(optional xreal value)`

The T parameter of an edge or curve

Manual References:: Selection: Accessing Selection Data, Selection: Accessing Selection Data, Selection: Programmatic Selection, Selection: Programmatic Selection

`pfcPoint3D_ptr`	`GetPoint`	`()`
`void`	`SetPoint`	`(pfcPoint3D_ptr value)`

The point

Exceptions thrown (but not limited to):

pfcXToolkitInvalidPtr - The selection argument is an invalid pointer.

Manual References:: Selection: Accessing Selection Data, Selection: Accessing Selection Data, Assembly: Kinematic Dragging and Creating Snapshots: Performing Kinematic Drag, Selection: Programmatic Selection, Selection: Programmatic Selection

xreal GetDepth ()

The depth of the selection

Exceptions thrown (but not limited to):

pfcXToolkitInvalidPtr - The selection argument is an invalid pointer.

Manual References:: Selection: Accessing Selection Data, Selection: Accessing Selection Data

xstring GetSelectionString ()

Web.Link style selection string representation for this selection.

void Highlight (pfcStdColor Color)

Highlights the selection in the current window. The selection remains highlighted until you call the Unhighlight() function.

Manual References:: Selection: Controlling Selection Display, Selection: Controlling Selection Display

Parameters:

Color: The highlight color

Returns:

void UnHighlight ()

Removes the highlighting from the selection highlighted by a previous call to the Highlight() function.

Manual References:: Selection: Controlling Selection Display, Selection: Controlling Selection Display

Returns:

void Display ()

Displays the selection. Note that this is a one-time action (the next repaint will erase this display).

Manual References:: Selection: Controlling Selection Display

Returns:

void SetIntf3DCsys (optional pfcSelection_ptr ReferenceCsys)

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

Manual References:: Interface: Exporting Using Coordinate System

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.

Returns: