CIP C++ documentation for class "pfcComponentPath"

Class pfcComponentPath

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

Description

This class identifies and locates a component within an assembly.

Manual References:: Annotations: Annotation Features and Annotations: Annotation Text Styles, Overview of Creo Object TOOLKIT C++: Casting of Creo Object TOOLKIT C++ pfc Classes to wfc Classes, Assemblies and Components: Structure of Assemblies and Assembly Objects, Assembly: Kinematic Dragging and Creating Snapshots: Connecting to a Kinematic Drag Session

Direct Known Subclasses:: wfcWComponentPath

Method Summary


`xintsequence_ptr`	`GetComponentIds ()`
`void`	`SetComponentIds (xintsequence_ptr value)`
	The path from the root assembly to the component through various subassembliescontaining this component. Each element of this sequence is an identifierof a component feature in its parent assembly.

`xbool`	`GetIsVisible (optional pfcSimpRep_ptr InRep)`
	Returns a flag indicating whether a given component is visible in a simplified representation.

`pfcSolid_ptr`	`GetLeaf ()`
	The model associated with the component the path points to

`pfcAssembly_ptr`	`GetRoot ()`
`void`	`SetRoot (pfcAssembly_ptr value)`
	The root assembly

`pfcTransform3D_ptr`	`GetTransform (xbool BottomUp)`
	Retrieves the transformation matrix from the coordinate system of the root assemby to the coordinate system of the model pointed to by the component path, or from the coordinate system of the model to the coordinate system of the root assembly.





`void`	`SetTransform (xbool BottomUp, pfcTransform3D_ptr position)`
	Sets the position of the component described by the component path.

Method Detail

`pfcAssembly_ptr`	`GetRoot`	`()`
`void`	`SetRoot`	`(pfcAssembly_ptr value)`

The root assembly

Manual References:: Solid: Getting a Solid Object, Solid: Getting a Solid Object, Assemblies and Components: Component Path Information, Assemblies and Components: Component Path Information, Assemblies and Components: Component Path Information, Assemblies and Components: Component Path Information

`xintsequence_ptr`	`GetComponentIds`	`()`
`void`	`SetComponentIds`	`(xintsequence_ptr value)`

The path from the root assembly to the component through various subassembliescontaining this component. Each element of this sequence is an identifierof a component feature in its parent assembly.

Manual References:: Assemblies and Components: Component Path Information, Assemblies and Components: Component Path Information, Assemblies and Components: Component Path Information, Assemblies and Components: Component Path Information

pfcSolid_ptr GetLeaf ()

The model associated with the component the path points to

Manual References:: Solid: Getting a Solid Object, Solid: Getting a Solid Object, Assemblies and Components: Component Path Information, Assemblies and Components: Component Path Information

pfcTransform3D_ptr GetTransform (xbool BottomUp)

Retrieves the transformation matrix from the coordinate system of the root assemby to the coordinate system of the model pointed to by the component path, or from the coordinate system of the model to the coordinate system of the root assembly.

Manual References:: Windows and Views: Transformations, Assemblies and Components: Component Path Information, Assemblies and Components: Component Path Information

Parameters:

BottomUp: If you request the transformation from the model to theassembly, this is true. Otherwise, this is false.

Returns:: The transformation matrix

void SetTransform (xbool BottomUp, pfcTransform3D_ptr position)

Sets the position of the component described by the component path.

The component will be temporarily moved to the new location without affecting its constraints or actual position. Takes effect only when the assembly is using DynamicPositioning.

See Also:: pfcAssembly

Manual References:: Assemblies and Components: Component Path Information, Assemblies and Components: Component Path Information

Parameters:

BottomUp: true if the transformation is from the member to the assembly, false if the transformation is from the assembly to the member.
position: The location of the member with respect to the root assembly.

Returns:

xbool GetIsVisible (optional pfcSimpRep_ptr InRep)

Returns a flag indicating whether a given component is visible in a simplified representation.

Exceptions thrown (but not limited to):

pfcXToolkitBadContext - The assembly is in the master representation.

Manual References:: Assemblies and Components: Component Path Information, Assemblies and Components: Component Path Information

Parameters:

InRep: The simplfied representation, or null, to use the active representation.

Returns:: true if the component is visible, false otherwise.