CIP C++ documentation for class "wfcWExplodedState"

Class wfcWExplodedState

# include <wfcAssembly.h> class wfcWExplodedState : public virtual wfcWModelItem, : public virtual pfcExplodedState { xaideclare(wfcWExplodedState) ... };

Description

Represent Exploded state in Assembly

Manual References:: Overview of Creo Object TOOLKIT C++: Casting of Creo Object TOOLKIT C++ pfc Classes to wfc Classes

Method Summary


`wfcWComponentPaths_ptr`	`GetExplodedcomponents ()`
	Gets the sequence of components of an explode state

`wfcExplodedAnimationMoveInstructions_ptr`	`GetExplodedStateMoves ()`
	Gets the moves of an explode state

`xstring`	`GetExplodedStateName ()`
	Returns the name of an explode state

`void`	`SetExplodedStateMoves (wfcExplodedAnimationMoveInstructions_ptr AnimMoveInstructions)`
	Sets the moves of an explode state

`void`	`SetExplodedStateName (xrstring ExplodedStateName)`
	Sets the name of an explode state

Methods Inherited from Class pfcActionSource:: AddActionListener, RemoveActionListener, AddActionListenerWithType

Methods Inherited from Class pfcParent:: GetChild

Methods Inherited from Class pfcParameterOwner:: GetParam, CreateParam, ListParams, SelectParam, CreateParamWithUnits, SelectParameters

Methods Inherited from Class wfcWParameterOwner:: ExportParameterTable, ApplyParameterTableset

Methods Inherited from Class pfcRelationOwner:: DeleteRelations, GetRelations, SetRelations, RegenerateRelations, EvaluateExpression

Methods Inherited from Class wfcWRelationOwner:: GetRelationConstraints, UnitsUsed, UseUnits, EvaluateExpressionWithUnits

Methods Inherited from Class pfcChild:: GetDBParent, GetOId

Methods Inherited from Class pfcModelItem:: GetName, SetName, GetId, GetType

Methods Inherited from Class wfcWModelItem:: DeleteUserDefinedName, Unhide, Hide, IsHidden, IsNameReadOnly, IsZoneFeature, GetDefaultName

Methods Inherited from Class pfcExplodedState:: Activate

Method Detail

xstring GetExplodedStateName ()

Returns the name of an explode state

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - explode state was not found.

Manual References:: Assemblies and Components: Accessing Exploded States, Assemblies and Components: Accessing Exploded States

Returns:: The name of the explode state.

void SetExplodedStateName (xrstring ExplodedStateName)

Sets the name of an explode state

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - explode state was not found.

Manual References:: Assemblies and Components: Accessing Exploded States, Assemblies and Components: Accessing Exploded States

Parameters:

ExplodedStateName: The name of the explode state. Cannot be NULL.

Returns:

wfcExplodedAnimationMoveInstructions_ptr GetExplodedStateMoves ()

Gets the moves of an explode state

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The explode state was not found.

Manual References:: Assemblies and Components: Accessing Exploded States, Assemblies and Components: Accessing Exploded States

Returns:: Returns sequence of wfcExplodedAnimationMoveInstruction

void SetExplodedStateMoves (wfcExplodedAnimationMoveInstructions_ptr AnimMoveInstructions)

Sets the moves of an explode state

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The explode state was not found, or some ProAsmcomppath in comp_set for some moves do not correspond to any component (this error may be also returned for other non-specified cases).

Manual References:: Assemblies and Components: Accessing Exploded States, Assemblies and Components: Accessing Exploded States

Parameters:

AnimMoveInstructions: Array of wfcExplodedAnimationMoveInstruction

Returns:

wfcWComponentPaths_ptr GetExplodedcomponents ()

Gets the sequence of components of an explode state

Manual References:: Assemblies and Components: Accessing Exploded States, Assemblies and Components: Accessing Exploded States

Returns:: Array of WComponentPath