API Documentation > Classes > Interface IpfcComponentPath
Interface IpfcComponentPath
Description
This class identifies and locates a component within an assembly.
Direct Parent Classes:
User Guide References:
Property Summary
Property
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.
Property
The model associated with the component the path points to
Property
The root assembly
Method Summary
Function
GetIsVisible (InRep as IpfcSimpRep [optional]) as Boolean
Returns a flag indicating whether a given component is visible in a simplified representation.
Function
GetTransform (BottomUp as Boolean) as IpfcTransform3D
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.
Sub
SetTransform (BottomUp as Boolean, position as IpfcTransform3D)
Sets the position of the component described by the component path.
Property Detail
Property
ComponentIds
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.
Property
Leaf
The model associated with the component the path points to
Property
Root
The root assembly
Method Detail
Function
GetIsVisible
(InRep as IpfcSimpRep [optional]) as Boolean
Returns a flag indicating whether a given component is visible in a simplified representation.
Exceptions thrown (but not limited to):
IpfcXToolkitBadContext - The assembly is in the master representation.
Parameters:
InRep
The simplfied representation, or null, to use the active representation.
Returns:
true if the component is visible, false otherwise.
Function
GetTransform
(BottomUp as Boolean) as IpfcTransform3D
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.
Parameters:
BottomUp
If you request the transformation from the model to theassembly, this is true. Otherwise, this is false.
Returns:
The transformation matrix
User Guide References:
Sub
SetTransform
(BottomUp as Boolean, position as IpfcTransform3D)
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:
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.
User Guide References:
Was this helpful?