CIP JavaScript documentation for class " pfcComponentPath"

Class pfcComponentPath

Description

This class identifies and locates a component within an assembly.

Direct Parent Classes:: pfcObject

Property Summary


`intseq`	`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.

`/* readonly */ pfcSolid`	`Leaf`
	The model associated with the component the path points to

`pfcAssembly`	`Root`
	The root assembly

Method Summary


`boolean`	`GetIsVisible ( /* optional */ pfcSimpRep InRep)`
	Returns a flag indicating whether a given component is visible in a simplified representation.

`pfcTransform3D`	`GetTransform (boolean 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 (boolean BottomUp, pfcTransform3D position)`
	Sets the position of the component described by the component path.

Property Detail

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

/* readonly */ pfcSolid Leaf

The model associated with the component the path points to

pfcAssembly Root

The root assembly

Method Detail

boolean GetIsVisible ( /* optional */ pfcSimpRep 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.

Parameters:

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

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

pfcTransform3D GetTransform (boolean 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.

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 (boolean BottomUp, pfcTransform3D 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

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.