CIP JAVA documentation for class "com.ptc.pfc.pfcAssembly.ComponentPath"

Interface ComponentPath

package com.ptc.pfc.pfcAssembly; public interface ComponentPath extends com.ptc.pfc.pfcObject.Object

Description

This class identifies and locates a component within an assembly.

Direct Known Subclasses:: WComponentPath

Method Summary
`intseq`	`GetComponentIds ()` Get method for attribute "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.
`boolean`	`GetIsVisible ( /optional/ SimpRep InRep)` Returns a flag indicating whether a given component is visible in a simplified representation.
`Solid`	`GetLeaf ()` Get method for attribute "Leaf" The model associated with the component the path points to
`Assembly`	`GetRoot ()` Get method for attribute "Root" The root assembly
`Transform3D`	`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`	`SetComponentIds (intseq value)` Set method for attribute "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.
`void`	`SetRoot (Assembly value)` Set method for attribute "Root" The root assembly
`void`	`SetTransform (boolean BottomUp, Transform3D position)` Sets the position of the component described by the component path.

Method Detail

GetRoot/SetRoot

`Assembly`	`GetRoot`	`()`
`void`	`SetRoot`	`(Assembly 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

GetComponentIds/SetComponentIds

`intseq`	`GetComponentIds`	`()`
`void`	`SetComponentIds`	`(intseq 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

GetLeaf

Solid 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

GetTransform

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

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

SetTransform

void SetTransform (boolean BottomUp, Transform3D 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:: Assembly

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:

GetIsVisible

boolean GetIsVisible ( /*optional*/ SimpRep InRep)

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

Exceptions thrown (but not limited to):

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