CIP C++ documentation for class "wfcWSelection"

Class wfcWSelection

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

Description

Selection related methods

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

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 ()`
	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`	`SetAnnotationElementReferences (wfcAnnotationElements_ptr Elements, wfcAnnotationReferenceSetsArray_ptr References, xbool InvokeUI)`
	LICENSE: 222 Replaces all of the each of the annotation elements' user-defined references with the indicated sets.

`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)`
	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, SetIntf3DCsys

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:: 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:: Selection: Adding Items to the Selection Buffer

Returns:: A collection object

pfcTable_ptr GetDrawingTable ()

Get drawing table object from its selection

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

Returns:: A drawing table object

wfcWFeature_ptr GetPipelineFeature ()

Get pipeline feature from its selection

Manual References:: 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:: 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:: Geometry Evaluation: Measurement, Geometry Evaluation: Measurement, ModelItem: Getting ModelItem Objects

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)

Set the appearance properties

Manual References:: Graphics: Surface Properties, Graphics: Surface Properties, Solid Bodies: To set the appearance of bodies

Parameters:

AppearProps

Returns:

optional wfcAppearance_ptr GetVisibleAppearance ()

Gets the appearance properties

Exceptions thrown (but not limited to):

pfcXToolkitNotExist - The property does not exists.

Manual References:: Graphics: Surface Properties, Graphics: Surface Properties

Returns:

void SetVisibleTextures (wfcTextures_ptr TextureProps)

Sets the texture properties

Note Call SetVisibleAppearance method before this else the method will throw an exception.

Manual References:: 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:: Graphics: Surface Properties, Graphics: Surface Properties

Returns:

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

Exceptions thrown (but not limited to):

pfcXToolkitNotDisplayed - Drawing in which annotation will be shown is not displayed in the current session.

pfcXToolkitInvalidType - Input annotation type not supported.

Manual References:: Annotations: Annotation Features and Annotations: Accessing Annotations, Annotations: Annotation Features and Annotations: Accessing Annotations

Parameters:

DrawingModel
AnnotType
DrawingView

Returns:

void ShowAxes (pfcDrawing_ptr DrawingModel, optional pfcView2D_ptr DrawingView)

Exceptions thrown (but not limited to):

pfcXToolkitNotDisplayed - Drawing in which annotation will be shown is not displayed in the current session.

pfcXToolkitInvalidType - Input annotation type not supported.

Manual References:: Annotations: Annotation Features and Annotations: Accessing Annotations, Annotations: Annotation Features and Annotations: Accessing Annotations

Parameters:

DrawingModel
DrawingView

Returns:

void ShowDatumTargets (pfcDrawing_ptr DrawingModel, optional pfcView2D_ptr DrawingView)

Exceptions thrown (but not limited to):

pfcXToolkitNotDisplayed - Drawing in which annotation will be shown is not displayed in the current session.

pfcXToolkitInvalidType - Input annotation type not supported.

Manual References:: Annotations: Annotation Features and Annotations: Accessing Annotations, Annotations: Annotation Features and Annotations: Accessing Annotations

Parameters:

DrawingModel
DrawingView

Returns:

wfcAnnotationPlane_ptr CreateAnnotationPlane (pfcVector3D_ptr NormalVector)

Exceptions thrown (but not limited to):

pfcXToolkitInvalidMatrix - Invalid combination of the planar surface and the direction vector.

Manual References:: Annotations: Annotation Features and Annotations: Annotation Orientation, Annotations: Annotation Features and Annotations: Annotation Orientation

Parameters:

NormalVector

Returns:

wfcAnnotationElement_ptr AddAnnotationElement (xbool InvokeUI)

LICENSE: 222

Exceptions thrown (but not limited to):

pfcXToolkitCantModify - Datum Target annotation feature cannot be modified.

Manual References:: Annotations: Annotation Features and Annotations: Redefining Annotation Features, Annotations: Annotation Features and Annotations: Redefining Annotation Features

Parameters:

InvokeUI

Returns:

void SetAnnotationElementReferences (wfcAnnotationElements_ptr Elements, wfcAnnotationReferenceSetsArray_ptr References, xbool InvokeUI)

LICENSE: 222

Replaces all of the each of the annotation elements' user-defined references with the indicated sets.

Exceptions thrown (but not limited to):

pfcXToolkitBadContext - The reference array contains the same reference more than once.

pfcXToolkitUnattachedFeats - Reference modification was aborted due to regeneration failure.

pfcXToolkitCantModify - User defined references are not permitted for driving dimension annotation elements.

pfcXToolkitAmbiguous - The number of reference sets does not match the number of elements supplied.

pfcXToolkitInvalidItem - One or more annotation elements do not belong to the owner feature.

Manual References:: Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements

Parameters:

Elements: Annotation elements array. All of these elements must belong to the same feature
References: Annotation reference sets array. The number of sets should match the number of elements to be modified.
InvokeUI: True to bring up the Fix Model UI in the event of regeneration failure; False to abort the reference setting.

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

Parameters:

AnnotElem

Returns:

void DeleteAnnotationElement (xbool InvokeUI)

LICENSE: 222

Exceptions thrown (but not limited to):

pfcXToolkitBadContext - The annotation element is readonly and cannot be deleted.

pfcXToolkitUnattachedFeats - Deletion was aborted due to regeneration failure.

pfcXToolkitNotFound - The data sharing feature's parent model is not in memory;

pfcXToolkitNotValid - The element is owned by an independent feature.

pfcXToolkitNoPermission - Deletion of set datum tag from datum target annotation feature is not allowed.

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

Parameters:

InvokeUI

Returns:

wfcAnnotationElements_ptr AddElementsInAnnotationFeature (wfcAnnotations_ptr Annotations, xbool InvokeUI)

LICENSE: 222

Exceptions thrown (but not limited to):

pfcXToolkitCantModify - Only one set datum tag can exist in Datum Target annotation feature

Manual References:: Annotations: Annotation Features and Annotations: Redefining Annotation Features, Annotations: Annotation Features and Annotations: Redefining Annotation Features

Parameters:

Annotations
InvokeUI

Returns:

void DeleteElementsInAnnotationFeature (pfcSelections_ptr AnnotElements, xbool InvokeUI)

LICENSE: 222

Exceptions thrown (but not limited to):

pfcXToolkitInvalidItem - Feature is invalid for this operation.

pfcXToolkitBadContext - The annotation element is readonly and cannot be deleted.

pfcXToolkitUnattachedFeats - Deletion was aborted due to regeneration failure.

pfcXToolkitNotFound - The data sharing feature's parent model is not in memory;

pfcXToolkitNotValid - The element is owned by an independent feature.

pfcXToolkitNoPermission - Deletion of set datum tag from datum target annotation feature is not allowed.

Manual References:: Annotations: Annotation Features and Annotations: Redefining Annotation Features

Parameters:

AnnotElements
InvokeUI

Returns:

void SetCopyFlagInAnnotationElement (xbool CopyFlag, xbool InvokeUI)

LICENSE: 222

Exceptions thrown (but not limited to):

pfcXToolkitNoChange - The input flag is the same as the current value.

pfcXToolkitUnattachedFeats - Reference modification was aborted due to regeneration failure.

Manual References:: Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements

Parameters:

CopyFlag
InvokeUI

Returns:

void SetDependencyFlag (xbool DependencyFlag, xbool InvokeUI)

LICENSE: 222

Exceptions thrown (but not limited to):

pfcXToolkitNoChange - The input flag is the same as the current value.

pfcXToolkitCantAccess - The element is not owned by a data sharing feature.

pfcXToolkitNotFound - The data sharing feature's parent model is not in memory.

pfcXToolkitNotValid - The element is owned by an independent feature.

Manual References:: Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements

Parameters:

DependencyFlag
InvokeUI

Returns:

void SetAnnotationInAnnotationElement (optional wfcAnnotation_ptr Annotation)

LICENSE: 222

Exceptions thrown (but not limited to):

pfcXToolkitNoChange - The annotation is already contained in this element.

pfcXToolkitUnattachedFeats - Modification was aborted due to regeneration failure.

pfcXToolkitInvalidType - You cannot assign this type of annotation to the annotation element

pfcXToolkitCantModify - datum target annotation element or annotation are not permitted for this function

Manual References:: Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements

Parameters:

Annotation

Returns:

void WeakenAnnotationElementReference (wfcAnnotationReference_ptr Reference, xbool InvokeUI)

LICENSE: 222

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The annotation element doesn't contain this strong reference.

pfcXToolkitCantWrite - This strong reference may not be weakened due to the rules for the individual annotation.

Manual References:: Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements

Parameters:

Reference
InvokeUI

Returns:

void StrengthenAnnotationElementReference (wfcAnnotationReference_ptr Reference, xbool InvokeUI)

LICENSE: 222

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The annotation element doesn't contain this weak reference.

pfcXToolkitCantWrite - This weak reference may not be strengthened due to the rules for the individual annotation.

Manual References:: Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements

Parameters:

Reference
InvokeUI

Returns:

void SetAnnotationReferencesInAnnotationElement (wfcAnnotationReferences_ptr References, xbool InvokeUI)

LICENSE: 222

Exceptions thrown (but not limited to):

pfcXToolkitBadContext - The reference array contains the same reference more than once.

pfcXToolkitUnattachedFeats - Reference modification was aborted due to regeneration failure.

pfcXToolkitCantModify - User defined references are not permitted for driving dimension annotation elements.

Manual References:: Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements

Parameters:

References
InvokeUI

Returns:

void RemoveAnnotationReferenceInAnnotationElement (wfcAnnotationReference_ptr Reference, xbool InvokeUI)

LICENSE: 222

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The annotation element does not contain this reference.

pfcXToolkitBadContext - This reference is provided from the annotation and cannot be removed.

pfcXToolkitUnattachedFeats - Removal was aborted due to regeneration failure.

Manual References:: Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements

Parameters:

Reference
InvokeUI

Returns:

void AddAnnotationReferenceInAnnotationElement (wfcAnnotationReference_ptr Reference, xbool InvokeUI)

LICENSE: 222

Exceptions thrown (but not limited to):

pfcXToolkitFound - The annotation element already has a reference to this item.

pfcXToolkitCantModify - User defined references are not permitted for driving dimension annotation elements.

Manual References:: Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements

Parameters:

Reference
InvokeUI

Returns:

void SetAutoPropagateFlagInAnnotationElement (wfcAnnotationReference_ptr Reference, xbool AutoPropagateFlag)

LICENSE: 222

Exceptions thrown (but not limited to):

pfcXToolkitBadContext - The element is not owned by an annotation feature.

pfcXToolkitNotFound - The annotation element doesn't contain this reference

pfcXToolkitNoChange - Reference autopropagate flag is already set to the input value.

pfcXToolkitInvalidType - This type of reference does not have an autopropagate flag.

pfcXToolkitNoLicense - License check failure.

Manual References:: Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements

Parameters:

Reference
AutoPropagateFlag

Returns:

optional xbool GetAutoPropagateFlagInAnnotationElement (wfcAnnotationReference_ptr Reference)

LICENSE: 222

Exceptions thrown (but not limited to):

pfcXToolkitBadContext - The element is not owned by an annotation feature.

pfcXToolkitNotFound - The annotation element doesn't contain this reference

pfcXToolkitInvalidType - This type of reference does not have an autopropagate flag.

pfcXToolkitNoLicense - License check failure.

Manual References:: Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements

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

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:: 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.