Class pfcAssembly
Description
This class describes an assembly.
Direct Parent Classes:
User Guide References:
Guidelines to Migrate the Applications:pfcAssembly, Additional API Features Introduced in Creo.JS:pfcAssembly, Solid:pfcAssembly, Mass Properties:pfcAssembly, Transforming Coordinates of an Assembly Member:pfcAssembly, Interference:pfcAssembly, Structure of Assemblies and Assembly Objects:pfcAssembly, Regenerating an Assembly Component:pfcAssembly, Component Path Information:pfcAssembly, Assembling Components:pfcAssembly, Exploded Assemblies:pfcAssembly, Skeleton Models:pfcAssembly, Export Instructions:pfcAssembly, Retrieving Simplified Representations:pfcAssembly
Property Summary
boolean | |
If the assembly uses dynamic positioning, this attribute is true; otherwise, it is false | |
/* readonly */ boolean | |
If the assembly is exploded, this attribute is true; otherwise, it isfalse |
Method Summary
Assembles a copy of a model into the assembly. | |
Assembles the model into the assembly. | |
void | |
Adds a skeleton model in the assembly. | |
void | |
Copies the specified template model into the assembly as a skeleton model. | |
void | |
Deletes the skeleton model from the assembly. | |
void | Explode () |
Explodes the specified assembly. The function invalidates the display list, but the application needs to repaint the window. | |
/* optional */ pfcExplodedState | |
Returns the current active exploded state in the assembly. | |
Returns the default exploded state in the assembly. | |
GetMassPropertyByCompPath ( /* optional */ pfcComponentPath CompPath, /* optional */ pfcModelItem CsysItem, /* optional */ pfcComponentPath CsysPath) | |
Calculates the mass properties of solid referenced by the specified coordinate system, using respective component paths. | |
GetSkeleton () | |
Returns the skeleton model in the assembly. | |
void | UnExplode () |
Unexplodes the assembly. The function invalidates the display list, but the application needs to repaint the window. |
Property Detail
boolean | DynamicPositioning |
If the assembly uses dynamic positioning, this attribute is true; otherwise, it is false
/* readonly */ boolean | IsExploded |
If the assembly is exploded, this attribute is true; otherwise, it isfalse
The exploded status of an assembly depends on the mode, in particular, while the drawing view is active, it does not represent the real explode state of the assembly, but the state of the assembly in the current drawing view.
Method Detail
AssembleByCopy |
Assembles a copy of a model into the assembly.
Exceptions thrown (but not limited to):
pfcXToolkitInvalidType - Template type does not correspond to component type.
pfcXToolkitAbort - The model can not be used as a template or has external dependencies. Copy is aborted.
pfcXToolkitNotValid - Required license not found.
pfcXToolkitLineTooLong - comp_name length of the new component is more than 31 chars. This restriction will be removed in future releases.
pfcXToolkitUnsupported - Unsupported model. For instance, models which come from Multi-CAD model approach, are not supported in this release.
Parameters:
NewModelName
The name of the new copy of the model.
ModelToCopy
The template model to copy.
LeaveUnplaced
true to leave the component unplaced, false to place the component in the default location.
Returns:
The new assembly component feature object.
User Guide References:
AssembleComponent |
Assembles the model into the assembly.
The new component will be packaged at the designated location.
Exceptions thrown (but not limited to):
pfcXToolkitUnsupported - Unsupported model. For instance, models which come from Multi-CAD model approach, are not supported in this release.
Parameters:
Model
The model to assemble.
Position
The initial position of the component.
Returns:
The new component feature object.
User Guide References:
void | AssembleSkeleton |
Adds a skeleton model in the assembly.
Exceptions thrown (but not limited to):
pfcXToolkitInvalidType - Skeleton is a handle not to a skeleton model.
pfcXToolkitFound - Skeleton model already exists in the assembly.
pfcXToolkitNotValid - Required license not found.
Parameters:
SkeletonModel
The skeleton model.
User Guide References:
void | AssembleSkeletonByCopy |
Copies the specified template model into the assembly as a skeleton model.
Exceptions thrown (but not limited to):
pfcXToolkitFound - Skeleton model already exists in the assembly.
pfcXToolkitAbort - Template type is invalid (for example, is a manufacturing part), or has external external dependencies. Copying is aborted.
pfcXToolkitNotValid - Required license is absent.
pfcXToolkitUnsupported - Models which come from Multi-CAD approach are not supported as template model.
pfcXToolkitLineTooLong - Name length of skeleton model is more than 31 chars.
Parameters:
NewSkeletonName
The name of the new skeleton model.
SkeletonToCopy
The template model to copy.
User Guide References:
void | DeleteSkeleton | () |
Deletes the skeleton model from the assembly.
Exceptions thrown (but not limited to):
pfcXToolkitNotFound - The specified assembly has no skeleton model.
pfcXToolkitNotValid - Required license not found.
User Guide References:
void | Explode | () |
Explodes the specified assembly. The function invalidates the display list, but the application needs to repaint the window.
Exceptions thrown (but not limited to):
pfcXToolkitNoChange - The specified assembly is already exploded.
User Guide References:
/* optional */ pfcExplodedState | GetActiveExplodedState | () |
Returns the current active exploded state in the assembly.
Returns:
The active exploded state, or null, if the assembly is not exploded.
User Guide References:
GetDefaultExplodedState | () |
Returns the default exploded state in the assembly.
Returns:
The default exploded state.
User Guide References:
GetMassPropertyByCompPath | ( /* optional */ pfcComponentPath CompPath, /* optional */ pfcModelItem CsysItem, /* optional */ pfcComponentPath CsysPath) |
Calculates the mass properties of solid referenced by the specified coordinate system, using respective component paths.
Exceptions thrown (but not limited to):
pfcXToolkitNotFound - The specified coordinate system was not found.
Parameters:
CompPath
The component path of solid. If this is null, the top assembly is referred.
CsysItem
The csys model item. If this is null, default csys is referred.
CsysPath
The component path of csys. If this is null, default csys is referred.
Returns:
User Guide References:
GetSkeleton | () |
Returns the skeleton model in the assembly.
Exceptions thrown (but not limited to):
pfcXToolkitNotFound - The specified assembly has no skeleton model.
pfcXToolkitCantAccess - The skeleton exists, but can not be used.
pfcXToolkitNotValid - Required license not found.
Returns:
The skeleton model.
User Guide References:
void | UnExplode | () |
Unexplodes the assembly. The function invalidates the display list, but the application needs to repaint the window.
Exceptions thrown (but not limited to):
pfcXToolkitNoChange - The specified assembly is already unexploded.
User Guide References: