CIP C++ documentation for class "wfcWSelection"

Class wfcWSelection

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

Description

Selection related methods

Manual References:: ModelItem: Getting ModelItem Objects, Geometry Evaluation: Measurement, Overview of Creo Object TOOLKIT C++: Casting of Creo Object TOOLKIT C++ pfc Classes to wfc Classes, External Data: Selecting the Node from the External Application Tree

Method Summary


`wfcAnnotationElement_ptr`	`AddAnnotationElement (xbool InvokeUI)`
	LICENSE: 222

`void`	`AddAnnotationReferenceInAnnotationElement (wfcAnnotationReference_ptr Reference, xbool InvokeUI)`
	LICENSE: 222

`wfcAnnotationElements_ptr`	`AddElementsInAnnotationFeature (wfcAnnotations_ptr Annotations, xbool InvokeUI)`
	LICENSE: 222

`void`	`CopyAnnotationElement (wfcAnnotationElement_ptr AnnotElem)`
	LICENSE: 222

`wfcAnnotationElement_ptr`	`CreateAnnotationFeatBaseline (pfcSelection_ptr Reference, wfcAnnotationPlane_ptr Plane, optional pfcSelection_ptr DirReference)`
	LICENSE: 222

`wfcAnnotationPlane_ptr`	`CreateAnnotationPlane (pfcVector3D_ptr NormalVector)`


`wfcWFeature_ptr`	`CreateFeature (wfcElementTree_ptr Tree, wfcFeatCreateOptions_ptr Options, optional wfcWRegenInstructions_ptr Instrs)`
	Creates a feature from the Feature Element Tree

`void`	`DeleteAnnotationElement (xbool InvokeUI)`
	LICENSE: 222

`void`	`DeleteElementsInAnnotationFeature (pfcSelections_ptr AnnotElements, xbool InvokeUI)`
	LICENSE: 222

`xreal`	`EvaluateAngle (wfcWSelection_ptr Selection)`
	Evaluates angle between this and specified selection. Selections must represents straight edges

`xreal`	`EvaluateDiameter ()`
	Finds the geometry item (surface) diameter. Only revolved surfaces (cylinder, cone, and so on) are valid.

`optional xbool`	`GetAutoPropagateFlagInAnnotationElement (wfcAnnotationReference_ptr Reference)`
	LICENSE: 222

`wfcCollection_ptr`	`GetCollection ()`
	Get collection object containing selection

`pfcTable_ptr`	`GetDrawingTable ()`
	Get drawing table object from its selection

`wfcWFeature_ptr`	`GetPipelineFeature ()`
	Get pipeline feature from its selection

`optional wfcAppearance_ptr`	`GetVisibleAppearance ()`
	This method is enabled for Creo Direct. Gets the appearance properties

`optional wfcTextures_ptr`	`GetVisibleTextures ()`
	Gets the texture properties

`wfcWWindow_ptr`	`GetWindow ()`
	Retrieves the window in which selection was made.

`void`	`RecordExternalSelection (wfcSelectionRecordAction RecordAction)`
	Places external selection into `pfcBaseSession::Select(pfcSelectionOptions_ptr, optional pfcSelections_ptr)` buffer. Together with `wfcWSession::RegisterExternalSelectionHighlight(wfcExternalSelectionHighlight_ptr)` provides interaction between external application media (like a tree) and `pfcBaseSession::Select(pfcSelectionOptions_ptr, optional pfcSelections_ptr)`. Upon an object selection in their media, applications should create `wfcWSelection` and use this method to pass it to `pfcBaseSession::Select(pfcSelectionOptions_ptr, optional pfcSelections_ptr)`.

`void`	`RemoveAnnotationReferenceInAnnotationElement (wfcAnnotationReference_ptr Reference, xbool InvokeUI)`
	LICENSE: 222

`void`	`SetAnnotationInAnnotationElement (optional wfcAnnotation_ptr Annotation)`
	LICENSE: 222

`void`	`SetAnnotationReferencesInAnnotationElement (wfcAnnotationReferences_ptr References, xbool InvokeUI)`
	LICENSE: 222

`void`	`SetAutoPropagateFlagInAnnotationElement (wfcAnnotationReference_ptr Reference, xbool AutoPropagateFlag)`
	LICENSE: 222

`void`	`SetCopyFlagInAnnotationElement (xbool CopyFlag, xbool InvokeUI)`
	LICENSE: 222

`void`	`SetDependencyFlag (xbool DependencyFlag, xbool InvokeUI)`
	LICENSE: 222

`void`	`SetVisibleAppearance (optional wfcAppearance_ptr AppearProps)`
	This method is enabled for Creo Direct. Set the appearance properties

`void`	`SetVisibleTextures (wfcTextures_ptr TextureProps)`
	Sets the texture properties

`void`	`ShowAnnotations (pfcDrawing_ptr DrawingModel, wfcAnnotationType AnnotType, optional pfcView2D_ptr DrawingView)`


`void`	`ShowAxes (pfcDrawing_ptr DrawingModel, optional pfcView2D_ptr DrawingView)`


`void`	`ShowDatumTargets (pfcDrawing_ptr DrawingModel, optional pfcView2D_ptr DrawingView)`


`void`	`StrengthenAnnotationElementReference (wfcAnnotationReference_ptr Reference, xbool InvokeUI)`
	LICENSE: 222

`xbool`	`Verify ()`
	Verifies the validity of the `wfcWSelection`.

`void`	`WeakenAnnotationElementReference (wfcAnnotationReference_ptr Reference, xbool InvokeUI)`
	LICENSE: 222

Methods Inherited from Class pfcSelection:: GetSelModel, GetSelItem, SetSelItem, GetSelTableCell, SetSelTableCell, GetSelView2D, SetSelView2D, GetSelTableSegment, GetPath, SetPath, GetParams, SetParams, GetTParam, SetTParam, GetPoint, SetPoint, GetDepth, GetSelectionString, Highlight, UnHighlight, Display

Method Detail

void RecordExternalSelection (wfcSelectionRecordAction RecordAction)

Places external selection into pfcBaseSession::Select(pfcSelectionOptions_ptr, optional pfcSelections_ptr) buffer. Together with wfcWSession::RegisterExternalSelectionHighlight(wfcExternalSelectionHighlight_ptr) provides interaction between external application media (like a tree) and pfcBaseSession::Select(pfcSelectionOptions_ptr, optional pfcSelections_ptr). Upon an object selection in their media, applications should create wfcWSelection and use this method to pass it to pfcBaseSession::Select(pfcSelectionOptions_ptr, optional pfcSelections_ptr).

Exceptions thrown (but not limited to):

pfcXToolkitInvalidItem - Rejected by ProSelect() filters.

Manual References:: Technical Summary of Changes for Creo 4.0 F000: External Objects, External Data: Selecting the Node from the External Application Tree, External Data: Selecting the Node from the External Application Tree

Parameters:

RecordAction: Selection record action

Returns:

wfcCollection_ptr GetCollection ()

Get collection object containing selection

Exceptions thrown (but not limited to):

pfcXToolkitInvalidType - The selection object does not contain a collection.

pfcXToolkitInvalidPtr - The selection object contains a chain, but this chain reference is no longer valid. Chain references contained in ProSelections are only valid for as long as the chain is selected in the selection buffer.

Manual References:: Technical Summary of Changes for Creo 4.0 F000: Selection, Selection: Adding Items to the Selection Buffer

Returns:: A collection object

pfcTable_ptr GetDrawingTable ()

Get drawing table object from its selection

Manual References:: Technical Summary of Changes for Creo 4.0 F000: Selection, Selection: Accessing Selection Data, Selection: Accessing Selection Data

Returns:: A drawing table object

wfcWFeature_ptr GetPipelineFeature ()

Get pipeline feature from its selection

Manual References:: Technical Summary of Changes for Creo 4.0 F000: Selection, Selection: Accessing Selection Data

Returns:: A feature object

xbool Verify ()

Verifies the validity of the wfcWSelection.

Exceptions thrown (but not limited to):

pfcXToolkitInvalidType - Selection is invalid.

Manual References:: Technical Summary of Changes for Creo 4.0 F000: Selection, Selection: Interactive Selection, Selection: Interactive Selection

Returns:: Returns true if selection is valid

wfcWWindow_ptr GetWindow ()

Retrieves the window in which selection was made.

Exceptions thrown (but not limited to):

pfcXToolkitInvalidPtr - The selection argument is an invalid pointer.

Manual References:: Selection: Interactive Selection

Returns:: A wfcWWindow object

xreal EvaluateAngle (wfcWSelection_ptr Selection)

Evaluates angle between this and specified selection. Selections must represents straight edges

Manual References:: ModelItem: Getting ModelItem Objects, Geometry Evaluation: Measurement, Geometry Evaluation: Measurement, Technical Summary of Changes for Creo 4.0 F000: Graphics, Technical Summary of Changes for Creo 4.0 F000: Selection

Parameters:

Selection: Edge selection with which angle to be evaluated

Returns:: Value of the angle

xreal EvaluateDiameter ()

Finds the geometry item (surface) diameter. Only revolved surfaces (cylinder, cone, and so on) are valid.

Manual References:: Geometry Evaluation: Measurement

Returns:: The diameter

void SetVisibleAppearance (optional wfcAppearance_ptr AppearProps)

This method is enabled for Creo Direct.

Set the appearance properties

Manual References:: Technical Summary of Changes for Creo 4.0 F000: Surface, Graphics: Surface Properties, Graphics: Surface Properties

Parameters:

AppearProps

Returns:

optional wfcAppearance_ptr GetVisibleAppearance ()

This method is enabled for Creo Direct.

Gets the appearance properties

Exceptions thrown (but not limited to):

pfcXToolkitNotExist - The property does not exists.

Manual References:: Technical Summary of Changes for Creo 4.0 F000: Surface, Graphics: Surface Properties, Graphics: Surface Properties

Returns:

void SetVisibleTextures (wfcTextures_ptr TextureProps)

Sets the texture properties

Manual References:: Technical Summary of Changes for Creo 4.0 F000: Surface, Graphics: Surface Properties, Graphics: Surface Properties

Parameters:

TextureProps

Returns:

optional wfcTextures_ptr GetVisibleTextures ()

Gets the texture properties

Exceptions thrown (but not limited to):

pfcXToolkitNotExist - Properties does not exist on item.

Manual References:: Technical Summary of Changes for Creo 4.0 F000: Surface, Graphics: Surface Properties, Graphics: Surface Properties

Returns:

void ShowAnnotations (pfcDrawing_ptr DrawingModel, wfcAnnotationType AnnotType, optional pfcView2D_ptr DrawingView)

Manual References:: Annotations: Annotation Features and Annotations: Accessing Annotations, Annotations: Annotation Features and Annotations: Accessing Annotations, Technical Summary of Changes for Creo 4.0 F000: Annotations

Parameters:

DrawingModel
AnnotType
DrawingView

Returns:

void ShowAxes (pfcDrawing_ptr DrawingModel, optional pfcView2D_ptr DrawingView)

Manual References:: Annotations: Annotation Features and Annotations: Accessing Annotations, Annotations: Annotation Features and Annotations: Accessing Annotations, Technical Summary of Changes for Creo 4.0 F000: Annotations

Parameters:

DrawingModel
DrawingView

Returns:

void ShowDatumTargets (pfcDrawing_ptr DrawingModel, optional pfcView2D_ptr DrawingView)

Manual References:: Annotations: Annotation Features and Annotations: Accessing Annotations, Annotations: Annotation Features and Annotations: Accessing Annotations, Technical Summary of Changes for Creo 4.0 F000: Annotations

Parameters:

DrawingModel
DrawingView

Returns:

wfcAnnotationPlane_ptr CreateAnnotationPlane (pfcVector3D_ptr NormalVector)

Manual References:: Annotations: Annotation Features and Annotations: Annotation Orientation, Annotations: Annotation Features and Annotations: Annotation Orientation, Technical Summary of Changes for Creo 4.0 F000: Annotations

Parameters:

NormalVector

Returns:

wfcAnnotationElement_ptr AddAnnotationElement (xbool InvokeUI)

LICENSE: 222

Manual References:: Annotations: Annotation Features and Annotations: Redefining Annotation Features, Annotations: Annotation Features and Annotations: Redefining Annotation Features, Technical Summary of Changes for Creo 4.0 F000: Annotations

Parameters:

InvokeUI

Returns:

void CopyAnnotationElement (wfcAnnotationElement_ptr AnnotElem)

LICENSE: 222

Manual References:: Annotations: Annotation Features and Annotations: Redefining Annotation Features, Annotations: Annotation Features and Annotations: Redefining Annotation Features, Technical Summary of Changes for Creo 4.0 F000: Annotations

Parameters:

AnnotElem

Returns:

void DeleteAnnotationElement (xbool InvokeUI)

LICENSE: 222

Manual References:: Annotations: Annotation Features and Annotations: Redefining Annotation Features, Annotations: Annotation Features and Annotations: Redefining Annotation Features, Dimensions and Parameters: Accessing Reference and Driven Dimensions, Technical Summary of Changes for Creo 4.0 F000: Annotations

Parameters:

InvokeUI

Returns:

wfcAnnotationElements_ptr AddElementsInAnnotationFeature (wfcAnnotations_ptr Annotations, xbool InvokeUI)

LICENSE: 222

Manual References:: Annotations: Annotation Features and Annotations: Redefining Annotation Features, Annotations: Annotation Features and Annotations: Redefining Annotation Features, Technical Summary of Changes for Creo 4.0 F000: Annotations

Parameters:

Annotations
InvokeUI

Returns:

void DeleteElementsInAnnotationFeature (pfcSelections_ptr AnnotElements, xbool InvokeUI)

LICENSE: 222

Manual References:: Annotations: Annotation Features and Annotations: Redefining Annotation Features, Technical Summary of Changes for Creo 4.0 F000: Annotations

Parameters:

AnnotElements
InvokeUI

Returns:

void SetCopyFlagInAnnotationElement (xbool CopyFlag, xbool InvokeUI)

LICENSE: 222

Manual References:: Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Technical Summary of Changes for Creo 4.0 F000: Annotations

Parameters:

CopyFlag
InvokeUI

Returns:

void SetDependencyFlag (xbool DependencyFlag, xbool InvokeUI)

LICENSE: 222

Manual References:: Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Technical Summary of Changes for Creo 4.0 F000: Annotations

Parameters:

DependencyFlag
InvokeUI

Returns:

void SetAnnotationInAnnotationElement (optional wfcAnnotation_ptr Annotation)

LICENSE: 222

Manual References:: Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Technical Summary of Changes for Creo 4.0 F000: Annotations

Parameters:

Annotation

Returns:

void WeakenAnnotationElementReference (wfcAnnotationReference_ptr Reference, xbool InvokeUI)

LICENSE: 222

Manual References:: Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Technical Summary of Changes for Creo 4.0 F000: Annotations

Parameters:

Reference
InvokeUI

Returns:

void StrengthenAnnotationElementReference (wfcAnnotationReference_ptr Reference, xbool InvokeUI)

LICENSE: 222

Manual References:: Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Technical Summary of Changes for Creo 4.0 F000: Annotations

Parameters:

Reference
InvokeUI

Returns:

void SetAnnotationReferencesInAnnotationElement (wfcAnnotationReferences_ptr References, xbool InvokeUI)

LICENSE: 222

Manual References:: Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Technical Summary of Changes for Creo 4.0 F000: Annotations

Parameters:

References
InvokeUI

Returns:

void RemoveAnnotationReferenceInAnnotationElement (wfcAnnotationReference_ptr Reference, xbool InvokeUI)

LICENSE: 222

Manual References:: Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Technical Summary of Changes for Creo 4.0 F000: Annotations

Parameters:

Reference
InvokeUI

Returns:

void AddAnnotationReferenceInAnnotationElement (wfcAnnotationReference_ptr Reference, xbool InvokeUI)

LICENSE: 222

Manual References:: Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Technical Summary of Changes for Creo 4.0 F000: Annotations

Parameters:

Reference
InvokeUI

Returns:

void SetAutoPropagateFlagInAnnotationElement (wfcAnnotationReference_ptr Reference, xbool AutoPropagateFlag)

LICENSE: 222

Manual References:: Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Technical Summary of Changes for Creo 4.0 F000: Annotations

Parameters:

Reference
AutoPropagateFlag

Returns:

optional xbool GetAutoPropagateFlagInAnnotationElement (wfcAnnotationReference_ptr Reference)

LICENSE: 222

Manual References:: Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Technical Summary of Changes for Creo 4.0 F000: Annotations

Parameters:

Reference

Returns:

wfcAnnotationElement_ptr CreateAnnotationFeatBaseline (pfcSelection_ptr Reference, wfcAnnotationPlane_ptr Plane, optional pfcSelection_ptr DirReference)

LICENSE: 222

Manual References:: Annotations: Annotation Features and Annotations: Baseline Dimensions, Technical Summary of Changes for Creo 4.0 F000: Dimensions

Parameters:

Reference
Plane
DirReference

Returns:

wfcWFeature_ptr CreateFeature (wfcElementTree_ptr Tree, wfcFeatCreateOptions_ptr Options, optional wfcWRegenInstructions_ptr Instrs)

Creates a feature from the Feature Element Tree

Refer to the Release Notes for more information on restrictions of using this function with Multi-CAD models. Use pfcCreateModelSelection(pfcModel_ptr) to get selection of part or top assembly. Use pfcCreateComponentSelection(pfcComponentPath_ptr) to get selection component in an assembly.

Manual References:: Technical Summary of Changes for Creo 4.0 M060: Feature Element Tree, Feature Element Tree: Creating FET Using WCreateFeature

Parameters:

Tree: The Feature Element Tree object.
Options: Options to create the feature.
Instrs: Regeneration instructions to be used.

Returns:: The object representing the feature.