API Documentation > Interface Classes > 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:
Direct Known Subclasses:
Method Summary
void
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.
Returns a flag indicating whether a given component is visible in a simplified representation.
The model associated with the component the path points to
void
The root assembly
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
Sets the position of the component described by the component path.
Method Detail
GetRoot
()
void
SetRoot
(pfcAssembly_ptr value)
The root assembly
Manual References:
GetComponentIds
()
void
SetComponentIds
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:
GetLeaf
()
The model associated with the component the path points to
Manual References:
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:
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:
Manual References:
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:
GetIsVisible
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:
Parameters:
InRep
The simplfied representation, or null, to use the active representation.
Returns:
true if the component is visible, false otherwise.
Was this helpful?