-
Notifications
You must be signed in to change notification settings - Fork 0
Assembly
Stephen S. Mitchell edited this page Sep 23, 2025
·
2 revisions
← Back to Classes | Documentation Home | All Classes
- Namespace:
AlibreScript.API - Kind:
Class
Type: Object
Comment property
Type: Object
A list of configurations defined on the assembly
Type: Object
Cost center property
Type: Object
Created By property
Type: Object
Created Date property
Type: Object
Creating Application property
Type: Object
Density of the part
Type: Object
Description of the part
Type: Object
Document Number property
Type: Object
Engineering Approval Date property
Type: Object
Engineering Approved By property
Type: Object
Estimated Cost property
Type: Object
Material (extended information) property
Type: Object
Path and filename of the assembly
Type: Object
Keywords property
Type: Object
Last Author property
Type: Object
Last Update Date property
Type: Object
Manufacturing Approved By property
Type: Object
Product property
Type: Object
Material of the part
Type: Object
Modified Information property
Type: Object
Name of the assembly
Type: Object
User-defined number for the part
Type: Object
Gets the origin (language independent)
Type: Object
A list of parameters defined on the assembly
Type: Object
A list of parts defined on the assembly
Type: Object
Product property
Type: Object
Received From property
Type: Object
Revision property
Type: Object
Gets the currently selected items as [ItemA, ItemB, ...]
Supports subassemblies, parts, faces, edges, vertices, planes, axes and points
Type: Object
Stock Size property
Type: Object
A list of subassemblies defined on the assembly
Type: Object
Supplier property
Type: Object
Title property
Type: Object
Vendor property
Type: Object
Web Link property
Type: Object
Gets the X-axis (language independent)
Type: Object
Gets the XY-plane (language independent)
Type: Object
Gets the Y-axis (language independent)
Type: Object
Gets the YZ-plane (language independent)
Type: Object
Gets the Z-axis (language independent)
Type: Object
Gets the ZX-plane (language independent)
Opens an existing assembly
Overload 1:
def Assembly(folder, name):
"""
Opens an existing assembly
Args:
folder (str): Folder containing assembly
name (str): Name of assembly to open
"""Overload 2:
def Assembly(folder, name, hide_editor):
"""
Opens an existing assembly, optionally hiding the editor
Args:
folder (str): Folder containing assembly
name (str): Name of assembly to open
hide_editor (bool): True to hide the editor
"""Overload 3:
def Assembly(name):
"""
Creates a new assembly
Args:
name (str): Name of new assembly
"""Overload 4:
def Assembly(name, create_new):
"""
Creates a new assembly or accesses an already opened assembly
Args:
name (str): Name of assembly to create or access
create_new (bool): True to create a new assembly, false to access an opened assembly
"""Overload 5:
def Assembly(name, create_new, hide_editor):
"""
Creates a new assembly or accesses an already opened assembly, optionally hiding the editor
Args:
name (str): Name of assembly to create or access
create_new (bool): True to create a new assembly, false to access an opened assembly
hide_editor (bool): True to hide the editor (only valid if assembly is not already open)
"""Adds a simple alignment constraint between two planes/faces/axes/edges/points
Overload 1:
def AddAlignConstraint(distance, partor_assembly_a, item_a, partor_assembly_b, item_b):
"""
Adds a simple alignment constraint between two planes/faces/axes/edges/points
Args:
distance (float): Alignment distance
partor_assembly_a (IAssembled): First part/assembly to constrain
item_a (IConstrainable): Plane/face/axis/edge/point on first part/assembly to constrain
partor_assembly_b (IAssembled): Second part/assembly to constrain
item_b (IConstrainable): Plane/face/axis/edge/point on second part/assembly to constrain
"""Overload 2:
def AddAlignConstraint(distance, partor_assembly_a, item_a, partor_assembly_b, item_b, is_reversed, name):
"""
Adds a simple alignment constraint between two planes/faces/axes/edges/points
Args:
distance (float): Alignment distance
partor_assembly_a (IAssembled): First part/assembly to constrain
item_a (IConstrainable): Plane/face/axis/edge/point on first part/assembly to constrain
partor_assembly_b (IAssembled): Second part/assembly to constrain
item_b (IConstrainable): Plane/face/axis/edge/point on second part/assembly to constrain
is_reversed (bool): true to reverse constraint
name (str): Name of constraint
"""Adds an alignment constraint between two planes/faces/axes/edges/points Uses bounds type
def AddAlignConstraint2(distance1, distance2, partor_assembly_a, item_a, partor_assembly_b, item_b, is_reversed, name, bounds_type):
"""
Adds an alignment constraint between two planes/faces/axes/edges/points Uses bounds type
Args:
distance1 (float): Align distance
distance2 (float): Second distance for 'between' bounds type or zero if not used
partor_assembly_a (IAssembled): First part/assembly to constrain
item_a (IConstrainable): Plane/face/axis/edge/point on first part/assembly to constrain
partor_assembly_b (IAssembled): Second part/assembly to constrain
item_b (IConstrainable): Plane/face/axis/edge/point on second part/assembly to constrain
is_reversed (bool): true to reverse constraint
name (str): Name of constraint
bounds_type (Assembly.ConstraintBoundsType): The bounds type to use
"""Adds an angle constraint between two planes/faces/axes/edges/points
Overload 1:
def AddAngleConstraint(angle, partor_assembly_a, item_a, partor_assembly_b, item_b):
"""
Adds an angle constraint between two planes/faces/axes/edges/points
Args:
angle (float): Angle in degrees
partor_assembly_a (IAssembled): First part/assembly to constrain
item_a (IConstrainable): Plane/face/axis/edge/point on first part/assembly to constrain
partor_assembly_b (IAssembled): Second part/assembly to constrain
item_b (IConstrainable): Plane/face/axis/edge/point on second part/assembly to constrain
"""Overload 2:
def AddAngleConstraint(angle, partor_assembly_a, item_a, partor_assembly_b, item_b, is_reversed, name):
"""
Adds a simple angle constraint between two planes/faces/axes/edges/points
Args:
angle (float): Angle in degrees
partor_assembly_a (IAssembled): First part/assembly to constrain
item_a (IConstrainable): Plane/face/axis/edge/point on first part/assembly to constrain
partor_assembly_b (IAssembled): Second part/assembly to constrain
item_b (IConstrainable): Plane/face/axis/edge/point on second part/assembly to constrain
is_reversed (bool): true to reverse constraint
name (str): Name of constraint
"""Adds an angle constraint between two planes/faces/axes/edges/points Uses bounds type
def AddAngleConstraint2(angle1, angle2, partor_assembly_a, item_a, partor_assembly_b, item_b, is_reversed, name, bounds_type):
"""
Adds an angle constraint between two planes/faces/axes/edges/points Uses bounds type
Args:
angle1 (float): Angle for constraint
angle2 (float): Second angle for 'between' bounds type or zero if not used
partor_assembly_a (IAssembled): First part/assembly to constrain
item_a (IConstrainable): Plane/face/axis/edge/point on first part/assembly to constrain
partor_assembly_b (IAssembled): Second part/assembly to constrain
item_b (IConstrainable): Plane/face/axis/edge/point on second part/assembly to constrain
is_reversed (bool): true to reverse constraint
name (str): Name of constraint
bounds_type (Assembly.ConstraintBoundsType): The bounds type to use
"""Creates an axis based on the intersection of two planes/faces
Overload 1:
def AddAxis(name, plane1, plane2):
"""
Creates an axis based on the intersection of two planes/faces
Args:
name (str): Name of axis
plane1 (ISketchSurface): First plane/face
plane2 (ISketchSurface): Second plane/face
Returns:
New Axis
"""Overload 2:
def AddAxis(name, point1, point2):
"""
Creates an axis based on two points
Args:
name (str): Name of axis
point1 (list): First point
point2 (list): Second point
Returns:
New axis
"""Adds a configuration to the assembly
Overload 1:
def AddConfiguration(name):
"""
Adds a configuration to the assembly
Args:
name (str): Name of configuration
Returns:
New configuration
"""Overload 2:
def AddConfiguration(name, base_configuration_name):
"""
Adds a configuration to the assembly using another configuration as a base
Args:
name (str): Name of configuration
base_configuration_name (str): Name of base configuration to use
Returns:
New configuration
"""Adds a fastner constraint
def AddFastenerConstraint(distance, partor_assembly_a, item_a, partor_assembly_b, item_b, is_reversed, name):
"""
Adds a fastner constraint
Args:
distance (float): Fastener to surface mate distance
partor_assembly_a (IAssembled): First part/assembly to constrain
item_a (IConstrainable): Plane/face/axis/edge/point on first part/assembly to constrain
partor_assembly_b (IAssembled): Second part/assembly to constrain
item_b (IConstrainable): Plane/face/axis/edge/point on second part/assembly to constrain
is_reversed (bool): true to reverse constraint
name (str): Name of constraint
"""Adds a fastner constraint
def AddFastenerConstraint2(distance1, distance2, partor_assembly_a, item_a, partor_assembly_b, item_b, is_reversed, name, bounds_type):
"""
Adds a fastner constraint
Args:
distance1 (float): Fastener to surface mate distance
distance2 (float): Second distance for 'between' bounds type or zero if not used
partor_assembly_a (IAssembled): First part/assembly to constrain
item_a (IConstrainable): Plane/face/axis/edge/point on first part/assembly to constrain
partor_assembly_b (IAssembled): Second part/assembly to constrain
item_b (IConstrainable): Plane/face/axis/edge/point on second part/assembly to constrain
is_reversed (bool): true to reverse constraint
name (str): Name of constraint
bounds_type (Assembly.ConstraintBoundsType): The bounds type to use
"""Adds a gear constraint using ratio RatioA:RatioB
def AddGearConstraint(ratio_a, ratio_b, partor_assembly_a, item_a, partor_assembly_b, item_b, is_reversed, name):
"""
Adds a gear constraint using ratio RatioA:RatioB
Args:
ratio_a (float): First value in gear ratio
ratio_b (float): Second value in gear ratio
partor_assembly_a (IAssembled): First part/assembly to constrain
item_a (IConstrainable): Plane/face/axis/edge/point on first part/assembly to constrain
partor_assembly_b (IAssembled): Second part/assembly to constrain
item_b (IConstrainable): Plane/face/axis/edge/point on second part/assembly to constrain
is_reversed (bool): true to reverse constraint
name (str): Name of constraint
"""Adds a simple mate constraint between two planes/faces/axes/edges/points
Overload 1:
def AddMateConstraint(distance, partor_assembly_a, item_a, partor_assembly_b, item_b):
"""
Adds a simple mate constraint between two planes/faces/axes/edges/points
Args:
distance (float): Mate distance
partor_assembly_a (IAssembled): First part/assembly to constrain
item_a (IConstrainable): Plane/face/axis/edge/point on first part/assembly to constrain
partor_assembly_b (IAssembled): Second part/assembly to constrain
item_b (IConstrainable): Plane/face/axis/edge/point on second part/assembly to constrain
"""Overload 2:
def AddMateConstraint(distance, partor_assembly_a, item_a, partor_assembly_b, item_b, is_reversed, name):
"""
Adds a simple mate constraint between two planes/faces/axes/edges/points
Args:
distance (float): Mate distance
partor_assembly_a (IAssembled): First part/assembly to constrain
item_a (IConstrainable): Plane/face/axis/edge/point on first part/assembly to constrain
partor_assembly_b (IAssembled): Second part/assembly to constrain
item_b (IConstrainable): Plane/face/axis/edge/point on second part/assembly to constrain
is_reversed (bool): true to reverse constraint
name (str): Name of constraint
"""Adds a mate constraint between two planes/faces/axes/edges/points Uses bounds type
def AddMateConstraint2(distance1, distance2, partor_assembly_a, item_a, partor_assembly_b, item_b, is_reversed, name, bounds_type):
"""
Adds a mate constraint between two planes/faces/axes/edges/points Uses bounds type
Args:
distance1 (float): Mate distance
distance2 (float): Second distance for 'between' bounds type or zero if not used
partor_assembly_a (IAssembled): First part/assembly to constrain
item_a (IConstrainable): Plane/face/axis/edge/point on first part/assembly to constrain
partor_assembly_b (IAssembled): Second part/assembly to constrain
item_b (IConstrainable): Plane/face/axis/edge/point on second part/assembly to constrain
is_reversed (bool): true to reverse constraint
name (str): Name of constraint
bounds_type (Assembly.ConstraintBoundsType): The bounds type to use
"""Adds a new part to the assembly
def AddNewPart(name, x, y, z):
"""
Adds a new part to the assembly
Args:
name (str): Name of the new part
x (float): X location of part
y (float): Y location of part
z (float): Z location of part
Returns:
New part
"""Adds a new sub-assembly to the assembly
def AddNewSubAssembly(name, x, y, z):
"""
Adds a new sub-assembly to the assembly
Args:
name (str): Name of the new assembly
x (float): X location of assembly
y (float): Y location of assembly
z (float): Z location of assembly
Returns:
New part
"""Adds an orient constraint between two planes/faces/axes/edges/points
Overload 1:
def AddOrientConstraint(value, partor_assembly_a, item_a, partor_assembly_b, item_b):
"""
Adds an orient constraint between two planes/faces/axes/edges/points
Args:
value (float): Value
partor_assembly_a (IAssembled): First part/assembly to constrain
item_a (IConstrainable): Plane/face/axis/edge/point on first part/assembly to constrain
partor_assembly_b (IAssembled): Second part/assembly to constrain
item_b (IConstrainable): Plane/face/axis/edge/point on second part/assembly to constrain
"""Overload 2:
def AddOrientConstraint(value, partor_assembly_a, item_a, partor_assembly_b, item_b, is_reversed, name):
"""
Adds an orient constraint between two planes/faces/axes/edges/points
Args:
value (float): Value
partor_assembly_a (IAssembled): First part/assembly to constrain
item_a (IConstrainable): Plane/face/axis/edge/point on first part/assembly to constrain
partor_assembly_b (IAssembled): Second part/assembly to constrain
item_b (IConstrainable): Plane/face/axis/edge/point on second part/assembly to constrain
is_reversed (bool): true to reverse constraint
name (str): Name of constraint
"""Adds a parameter to the assembly
Overload 1:
def AddParameter(name, type, value):
"""
Adds a parameter to the assembly
Args:
name (str): Name of parameter
type (ParameterTypes): Type of parameter
value (float): Value for parameter
Returns:
New parameter
"""Overload 2:
def AddParameter(name, type, equation):
"""
Adds a parameter to the assembly NOTE: DOESN'T SEEM TO WORK IN GD V16 - THROWS EXCEPTION ABOUT TRANSACTION ALREADY BEING OPEN
Args:
name (str): Name of parameter
type (ParameterTypes): Type of parameter
equation (str): Equation for parameter
Returns:
New parameter
"""Adds a part to the assembly at the origin
Overload 1:
def AddPart(folder, name):
"""
Adds a part to the assembly at the origin
Args:
folder (str): Folder containing part
name (str): Name of part to open
Returns:
The added part
"""Overload 2:
def AddPart(folder, name, offset_x, offset_y, offset_z):
"""
Adds a part to the assembly
Args:
folder (str): Folder containing part
name (str): Name of part to open
offset_x (float): X offset
offset_y (float): Y offset
offset_z (float): Z offset
Returns:
The added part
"""Overload 3:
def AddPart(folder, name, offset_x, offset_y, offset_z, angle_x, angle_y, angle_z, translation_first):
"""
Adds a part to the assembly
Args:
folder (str): Folder containing part
name (str): Name of part to open
offset_x (float): X offset
offset_y (float): Y offset
offset_z (float): Z offset
angle_x (float): X rotation angle in degrees
angle_y (float): Y rotation angle in degrees
angle_z (float): Z rotation angle in degrees
translation_first (bool): if true translation occurs before rotation, if false rotation occurs before translation
Returns:
The added part
"""Overload 4:
def AddPart(part):
"""
Adds a part to the assembly at the origin
Args:
part (Part): Part to add
Returns:
The added part
"""Overload 5:
def AddPart(part, offset_x, offset_y, offset_z):
"""
Adds a part to the assembly
Args:
part (Part): Part to add
offset_x (float): X offset
offset_y (float): Y offset
offset_z (float): Z offset
Returns:
The added part
"""Overload 6:
def AddPart(file_name):
"""
Adds a part to the assembly at the origin
Args:
file_name (str): Path and name of part to open
Returns:
The added part
"""Overload 7:
def AddPart(file_name, offset_x, offset_y, offset_z):
"""
Adds a part to the assembly
Args:
file_name (str): Path and name of part to open
offset_x (float): X offset
offset_y (float): Y offset
offset_z (float): Z offset
Returns:
The added part
"""Overload 8:
def AddPart(file_name, offset_x, offset_y, offset_z, angle_x, angle_y, angle_z, translation_first):
"""
Adds a part to the assembly
Args:
file_name (str): Path and name of part to open
offset_x (float): X offset
offset_y (float): Y offset
offset_z (float): Z offset
angle_x (float): X rotation angle in degrees
angle_y (float): Y rotation angle in degrees
angle_z (float): Z rotation angle in degrees
translation_first (bool): if true translation occurs before rotation, if false rotation occurs before translation
Returns:
The added part
"""Overload 9:
def AddPart(part, offset_x, offset_y, offset_z, angle_x, angle_y, angle_z, translation_first):
"""
Adds a part to the assembly
Args:
part (Part): Part to add
offset_x (float): X offset
offset_y (float): Y offset
offset_z (float): Z offset
angle_x (float): X rotation angle in degrees
angle_y (float): Y rotation angle in degrees
angle_z (float): Z rotation angle in degrees
translation_first (bool): if true translation occurs before rotation, if false rotation occurs before translation
Returns:
The added part
"""Creates a plane based on the offset from an existing plane
Overload 1:
def AddPlane(name, source_plane, offset):
"""
Creates a plane based on the offset from an existing plane
Args:
name (str): Name of plane
source_plane (ISketchSurface): Plane/face to use as basis
offset (float): Offset from basis plane in currently chosen units
Returns:
Created plane
"""Overload 2:
def AddPlane(name, normal_vector, pointon_plane):
"""
Adds a plane using a normal vector and a point on the plane
Args:
name (str): Name of plane to add
normal_vector (list): Normal vector as a list [nx, ny, nz]. Does not need to be a unit vector
pointon_plane (list): A point on the plane as a list [px, py, pz]
Returns:
Created plane
"""Overload 3:
def AddPlane(name, source_plane, rotation_axis, angle):
"""
Creates a new plane at an angle to an existing plane
Args:
name (str): Name of new plane
source_plane (ISketchSurface): Plane/face to use as basis for new plane
rotation_axis (Axis): Axis of rotation for new plane
angle (float): Angle of new plane in degrees
Returns:
New plane
"""Overload 4:
def AddPlane(name, point1, point2, point3):
"""
Creates a plane using three points
Args:
name (str): Name of plane
point1 (list): Point on plane
point2 (list): Point on plane
point3 (list): Point on plane
Returns:
Created plane
"""Add a point at an offset to a point or a vertex
Overload 1:
def AddPoint(name, point_or_vertex, x_offset, y_offset, z_offset):
"""
Add a point at an offset to a point or a vertex
Args:
name (str): Name of point
point_or_vertex (IPoint): Point or vertex
x_offset (float): X offse
y_offset (float): Y offset
z_offset (float): Z offset
Returns:
The created point
"""Overload 2:
def AddPoint(name, point_or_vertex1, point_or_vertex2, ratio):
"""
Add a point between two points/vertices
Args:
name (str): Name of point
point_or_vertex1 (IPoint): First point or vertex
point_or_vertex2 (IPoint): Second point or vertex
ratio (float): Ratio of distance between points/vertices
Returns:
The created point
"""Overload 3:
def AddPoint(name, axis_or_edge1, axis_or_edge2):
"""
Add a point at the intersection or two axes or edges
Args:
name (str): Name of point
axis_or_edge1 (IAxis): First axis or edge
axis_or_edge2 (IAxis): Second axis or edge
Returns:
The created point
"""Overload 4:
def AddPoint(name, plane_or_face1, plane_or_face2, plane_or_face3):
"""
Add a point at the intersection of three planes or faces
Args:
name (str): Name of point
plane_or_face1 (IPlane): First plane or face
plane_or_face2 (IPlane): Second plane or face
plane_or_face3 (IPlane): Third plane or face
Returns:
The created point
"""Overload 5:
def AddPoint(name, axis_or_edge, plane_or_face):
"""
Add a point at the the intersection of a axis or edge and a plane or face
Args:
name (str): Name of point
axis_or_edge (IAxis): Axis or edge
plane_or_face (IPlane): Plane or face
Returns:
The created point
"""Overload 6:
def AddPoint(name, source_point_or_vertex, target_plane_or_face, x_offset, y_offset):
"""
Add a point by projecting a point or vertex onto a plane or face
Args:
name (str): Name of point
source_point_or_vertex (IPoint): Point or vertex to project
target_plane_or_face (IPlane): Plane or face to project onto
x_offset (float): X offset to apply to point once projected
y_offset (float): Y offset to apply to point once projected
Returns:
The created point
"""Overload 7:
def AddPoint(name, target_edge, ratio):
"""
Add a point on an edge
Args:
name (str): Name of point
target_edge (Edge): The edge to create the point on
ratio (float): Ratio along the edge from 0.0 -> 1.0
Returns:
The created point
"""Overload 8:
def AddPoint(name, x, y, z):
"""
Adds a point to the assembly
Args:
name (str): Name of new point
x (float): X coordinate
y (float): Y coordinate
z (float): Z coordinate
Returns:
The new point
"""Adds a point at the center of a circular edge
def AddPointFromCircularEdge(name, target_edge):
"""
Adds a point at the center of a circular edge
Args:
name (str): Name of point
target_edge (Edge): The edge to use for creating the point
Returns:
The created point
"""Adds a point at the center of a toroidal face
def AddPointFromToroidalFace(name, target_face):
"""
Adds a point at the center of a toroidal face
Args:
name (str): Name of point
target_face (Face): Toroidal face to use in creating the point
Returns:
The created point
"""Adds a set of points to the part
def AddPoints(prefix, points):
"""
Adds a set of points to the part
Args:
prefix (str): Prefix for the point names
points (list): List of points [x1,y1,z1, ..., xn,yn,zn]
"""Adds a rack and pinion constraint
def AddRackAndPinionConstraint(pitch_diameter, partor_assembly_a, item_a, partor_assembly_b, item_b, is_reversed, name):
"""
Adds a rack and pinion constraint
Args:
pitch_diameter (float): Pitch diameter
partor_assembly_a (IAssembled): First part/assembly to constrain
item_a (IConstrainable): Plane/face/axis/edge/point on first part/assembly to constrain
partor_assembly_b (IAssembled): Second part/assembly to constrain
item_b (IConstrainable): Plane/face/axis/edge/point on second part/assembly to constrain
is_reversed (bool): true to reverse constraint
name (str): Name of constraint
"""Adds a screw constraint
def AddScrewConstraint(thread_pitch, partor_assembly_a, item_a, partor_assembly_b, item_b, is_reversed, name):
"""
Adds a screw constraint
Args:
thread_pitch (float): Pitch of thread
partor_assembly_a (IAssembled): First part/assembly to constrain
item_a (IConstrainable): Plane/face/axis/edge/point on first part/assembly to constrain
partor_assembly_b (IAssembled): Second part/assembly to constrain
item_b (IConstrainable): Plane/face/axis/edge/point on second part/assembly to constrain
is_reversed (bool): true to reverse constraint
name (str): Name of constraint
"""Adds a sub-assembly to the assembly
Overload 1:
def AddSubAssembly(file_name, offset_x, offset_y, offset_z):
"""
Adds a sub-assembly to the assembly
Args:
file_name (str): Path and name of sub-assembly to open
offset_x (float): X offset
offset_y (float): Y offset
offset_z (float): Z offset
Returns:
The added sub-assembly
"""Overload 2:
def AddSubAssembly(file_name, offset_x, offset_y, offset_z, angle_x, angle_y, angle_z, translation_first):
"""
Adds a sub-assembly to the assembly
Args:
file_name (str): Path and name of sub-asembly to open
offset_x (float): X offset
offset_y (float): Y offset
offset_z (float): Z offset
angle_x (float): X rotation angle in degrees
angle_y (float): Y rotation angle in degrees
angle_z (float): Z rotation angle in degrees
translation_first (bool): if true translation occurs before rotation, if false rotation occurs before translation
Returns:
The added assembly
"""Overload 3:
def AddSubAssembly(assembly):
"""
Adds a sub-assembly to the assembly at the origin
Args:
assembly (Assembly): Assembly to add
Returns:
The added assembly
"""Overload 4:
def AddSubAssembly(assembly, offset_x, offset_y, offset_z):
"""
Adds a sub-assembly to the assembly
Args:
assembly (Assembly): Assembly to add
offset_x (float): X offset
offset_y (float): Y offset
offset_z (float): Z offset
Returns:
The added assembly
"""Overload 5:
def AddSubAssembly(assembly, offset_x, offset_y, offset_z, angle_x, angle_y, angle_z, translation_first):
"""
Adds a sub-assembly to the assembly
Args:
assembly (Assembly): Sub-assembly to add
offset_x (float): X offset
offset_y (float): Y offset
offset_z (float): Z offset
angle_x (float): X rotation angle in degrees
angle_y (float): Y rotation angle in degrees
angle_z (float): Z rotation angle in degrees
translation_first (bool): if true translation occurs before rotation, if false rotation occurs before translation
Returns:
The added sub-assembly
"""Overload 6:
def AddSubAssembly(folder, name):
"""
Adds a sub-assembly to the assembly at the origin
Args:
folder (str): Folder containing sub-assembly
name (str): Name of sub-assembly to open
Returns:
The added sub-assembly
"""Overload 7:
def AddSubAssembly(folder, name, offset_x, offset_y, offset_z):
"""
Adds a sub-assembly to the assembly
Args:
folder (str): Folder containing sub-assembly
name (str): Name of sub-assembly to open
offset_x (float): X offset
offset_y (float): Y offset
offset_z (float): Z offset
Returns:
The added sub-assembly
"""Overload 8:
def AddSubAssembly(folder, name, offset_x, offset_y, offset_z, angle_x, angle_y, angle_z, translation_first):
"""
Adds a sub-assembly to the assembly
Args:
folder (str): Folder containing sub-assembly
name (str): Name of sub-assembly to open
offset_x (float): X offset
offset_y (float): Y offset
offset_z (float): Z offset
angle_x (float): X rotation angle in degrees
angle_y (float): Y rotation angle in degrees
angle_z (float): Z rotation angle in degrees
translation_first (bool): if true translation occurs before rotation, if false rotation occurs before translation
Returns:
The added sub-assembly
"""Overload 9:
def AddSubAssembly(file_name):
"""
Adds a sub-assembly to the assembly at the origin
Args:
file_name (str): Path and name of sub-assembly to open
Returns:
The added sub-assembly
"""Adds a tangent constraint between two planes/faces/axes/edges/points
Overload 1:
def AddTangentConstraint(distance, partor_assembly_a, item_a, partor_assembly_b, item_b, outside):
"""
Adds a tangent constraint between two planes/faces/axes/edges/points
Args:
distance (float): Alignment distance
partor_assembly_a (IAssembled): First part/assembly to constrain
item_a (IConstrainable): Plane/face/axis/edge/point on first part/assembly to constrain
partor_assembly_b (IAssembled): Second part/assembly to constrain
item_b (IConstrainable): Plane/face/axis/edge/point on second part/assembly to constrain
outside (bool): true for an outside tangent constraint, false for an inside tangent constraint
"""Overload 2:
def AddTangentConstraint(distance, partor_assembly_a, item_a, partor_assembly_b, item_b, outside, is_reversed, name):
"""
Adds a tangent constraint between two planes/faces/axes/edges/points
Args:
distance (float): Alignment distance
partor_assembly_a (IAssembled): First part/assembly to constrain
item_a (IConstrainable): Plane/face/axis/edge/point on first part/assembly to constrain
partor_assembly_b (IAssembled): Second part/assembly to constrain
item_b (IConstrainable): Plane/face/axis/edge/point on second part/assembly to constrain
outside (bool): true for an outside tangent constraint, false for an inside tangent constraint
is_reversed (bool): true to reverse constraint
name (str): Name of constraint
"""Anchors a part
Overload 1:
def AnchorPart(name):
"""
Anchors a part
Args:
name (str): Name of part to anchor
"""Overload 2:
def AnchorPart(part):
"""
Anchors a part
Args:
part (AssembledPart): Part to anchor
"""Anchors a sub-assembly
def AnchorSubAssembly(name):
"""
Anchors a sub-assembly
Args:
name (str): Name of sub-assembly to anchor
"""Creates a unique name that can be used to safely add a part or subassembly to the assembly if the names used in the assembly are not known in advance
def CreateUniqueName(base_name):
"""
Creates a unique name that can be used to safely add a part or subassembly to the assembly if the names used in the assembly are not known in advance
Args:
base_name (str): Base name to use
Returns:
Unique name
"""Duplicates a part in the assembly
Overload 1:
def DuplicatePart(name, offset_x, offset_y, offset_z):
"""
Duplicates a part in the assembly
Args:
name (str): Name of part to duplicate
offset_x (float): X offset
offset_y (float): Y offset
offset_z (float): Z offset
Returns:
The duplicate part
"""Overload 2:
def DuplicatePart(part, offset_x, offset_y, offset_z):
"""
Duplicates a part in the assembly
Args:
part (AssembledPart): Part to duplicate
offset_x (float): X offset
offset_y (float): Y offset
offset_z (float): Z offset
Returns:
The duplicate part
"""Overload 3:
def DuplicatePart(name, offset_x, offset_y, offset_z, angle_x, angle_y, angle_z, translation_first):
"""
Duplicates a part in the assembly
Args:
name (str): Name of part to duplicate
offset_x (float): X offset
offset_y (float): Y offset
offset_z (float): Z offset
angle_x (float): X rotation angle in degrees
angle_y (float): Y rotation angle in degrees
angle_z (float): Z rotation angle in degrees
translation_first (bool): if true translation occurs before rotation, if false rotation occurs before translation
Returns:
The duplicate part
"""Overload 4:
def DuplicatePart(part, offset_x, offset_y, offset_z, angle_x, angle_y, angle_z, translation_first):
"""
Duplicates a part in the assembly
Args:
part (AssembledPart): Part to duplicate
offset_x (float): X offset
offset_y (float): Y offset
offset_z (float): Z offset
angle_x (float): X rotation angle in degrees
angle_y (float): Y rotation angle in degrees
angle_z (float): Z rotation angle in degrees
translation_first (bool): if true translation occurs before rotation, if false rotation occurs before translation
Returns:
The duplicate part
"""Duplicates a sub-assembly in the assembly
Overload 1:
def DuplicateSubAssembly(sub_assembly, offset_x, offset_y, offset_z):
"""
Duplicates a sub-assembly in the assembly
Args:
sub_assembly (AssembledSubAssembly): Sub-assembly to duplicate
offset_x (float): X offset
offset_y (float): Y offset
offset_z (float): Z offset
Returns:
The duplicate sub-assembly
"""Overload 2:
def DuplicateSubAssembly(name, offset_x, offset_y, offset_z):
"""
Duplicates a sub-assembly in the assembly
Args:
name (str): Name of sub-assembly to duplicate
offset_x (float): X offset
offset_y (float): Y offset
offset_z (float): Z offset
Returns:
The duplicate sub-assembly
"""Overload 3:
def DuplicateSubAssembly(sub_assembly, offset_x, offset_y, offset_z, angle_x, angle_y, angle_z, translation_first):
"""
Duplicates a sub-assembly in the assembly
Args:
sub_assembly (AssembledSubAssembly): Sub-assembly to duplicate
offset_x (float): X offset
offset_y (float): Y offset
offset_z (float): Z offset
angle_x (float): X rotation angle in degrees
angle_y (float): Y rotation angle in degrees
angle_z (float): Z rotation angle in degrees
translation_first (bool): if true translation occurs before rotation, if false rotation occurs before translation
Returns:
The duplicate sub-assembly
"""Overload 4:
def DuplicateSubAssembly(name, offset_x, offset_y, offset_z, angle_x, angle_y, angle_z, translation_first):
"""
Duplicates a sub-assembly in the assembly
Args:
name (str): Name of sub-assembly to duplicate
offset_x (float): X offset
offset_y (float): Y offset
offset_z (float): Z offset
angle_x (float): X rotation angle in degrees
angle_y (float): Y rotation angle in degrees
angle_z (float): Z rotation angle in degrees
translation_first (bool): if true translation occurs before rotation, if false rotation occurs before translation
Returns:
The duplicate sub-assembly
"""Exports a keyshot file
def ExportBIP(file_name):
"""
Exports a keyshot file
Args:
file_name (str): Path and name of keyshot file
"""Exports the assembly as a IGES file
def ExportIGES(file_name):
"""
Exports the assembly as a IGES file
Args:
file_name (str): Path and name of IGES file
"""Exports the assembly as a SAT file
def ExportSAT(file_name, version, save_colors):
"""
Exports the assembly as a SAT file
Args:
file_name (str): Path and name of SAT file
version (int): Exported SAT file version
save_colors (bool): true to preseve colors
"""Exports the assembly as a STEP 203 file
def ExportSTEP203(file_name):
"""
Exports the assembly as a STEP 203 file
Args:
file_name (str): Path and name of STEP 203 file
"""Exports the assembly as a STEP 214 file
def ExportSTEP214(file_name):
"""
Exports the assembly as a STEP 214 file
Args:
file_name (str): Path and name of STEP 214 file
"""Exports the assembly as an STL file
def ExportSTL(file_name):
"""
Exports the assembly as an STL file
Args:
file_name (str): Path and name of STL file
"""Gets an axis from an axis name
def GetAxis(name):
"""
Gets an axis from an axis name
Args:
name (str): Name of axis to find
Returns:
Found axis
"""Gets a configuration with a specific name
def GetConfiguration(name):
"""
Gets a configuration with a specific name
Args:
name (str): Name of confguration
Returns:
Configuration object
"""Gets the value of a custonm property
def GetCustomProperty(name):
"""
Gets the value of a custonm property
Args:
name (str): Name of the custom property
Returns:
The value of the property as a string
"""Gets a parameter with a specific name
def GetParameter(name):
"""
Gets a parameter with a specific name
Args:
name (str): Name of parameter
Returns:
Parameter object
"""Gets a part in the assembly
def GetPart(name):
"""
Gets a part in the assembly
Args:
name (str): Name of part instance to get
Returns:
The part
"""Gets the orientation of a part in an assembly
Overload 1:
def GetPartOrientation(part):
"""
Gets the orientation of a part in an assembly
Args:
part (AssembledPart): Part in an assembly
Returns:
Part orientation as [OffsetX, OffsetY, OffsetZ, AngleX, AngleY, AngleZ], translation before rotation
"""Overload 2:
def GetPartOrientation(part_name):
"""
Gets the orientation of a part in an assembly
Args:
part_name (str): Name of part to get orientation
Returns:
Part orientation as [OffsetX, OffsetY, OffsetZ, AngleX, AngleY, AngleZ], translation before rotation
"""Gets a plane using the name of the plane
def GetPlane(name):
"""
Gets a plane using the name of the plane
Args:
name (str): Name of plane to find
Returns:
The plane
"""Gets a point on the assembly using the point name. The point must have been created in a script
def GetPoint(name):
"""
Gets a point on the assembly using the point name. The point must have been created in a script
Args:
name (str): Name of point to get
Returns:
The point
"""Gets a sub-assembly in the assembly
def GetSubAssembly(name):
"""
Gets a sub-assembly in the assembly
Args:
name (str): Name of sub-assembly instance to get
Returns:
The sub-assembly
"""Gets user data
def GetUserData(name):
"""
Gets user data
Args:
name (str): Name of data to get
Returns:
Data as a python dictionary or None if not found
"""Hides a part
Overload 1:
def HidePart(name):
"""
Hides a part
Args:
name (str): Name of part to hide
"""Overload 2:
def HidePart(part):
"""
Hides a part
Args:
part (AssembledPart): Part to hide
"""Hides a sub-assembly
def HideSubAssembly(name):
"""
Hides a sub-assembly
Args:
name (str): Name of sub-assembly to hide
"""Moves a part
Overload 1:
def MovePart(name, offset_x, offset_y, offset_z, apply_constraints):
"""
Moves a part
Args:
name (str): Name of part to move
offset_x (float): X offset to apply
offset_y (float): Y offset to apply
offset_z (float): Z offset to apply
apply_constraints (bool): true to apply constraints
"""Overload 2:
def MovePart(part, offset_x, offset_y, offset_z, apply_constraints):
"""
Moves a part
Args:
part (AssembledPart): Part to move
offset_x (float): X offset to apply
offset_y (float): Y offset to apply
offset_z (float): Z offset to apply
apply_constraints (bool): true to apply constraints
"""Moves a set of parts
def MoveParts(names, offset_x, offset_y, offset_z, apply_constraints):
"""
Moves a set of parts
Args:
names (list): Names of parts to move
offset_x (float): X offset to apply
offset_y (float): Y offset to apply
offset_z (float): Z offset to apply
apply_constraints (bool): true to apply constraints
"""Moves a set of sub-assemblies
def MoveSubAssemblies(names, offset_x, offset_y, offset_z, apply_constraints):
"""
Moves a set of sub-assemblies
Args:
names (list): Names of sub-assemblies to move
offset_x (float): X offset to apply
offset_y (float): Y offset to apply
offset_z (float): Z offset to apply
apply_constraints (bool): true to apply constraints
"""Moves a sub-assembly
Overload 1:
def MoveSubAssembly(name, offset_x, offset_y, offset_z, apply_constraints):
"""
Moves a sub-assembly
Args:
name (str): Name of sub-assembly to move
offset_x (float): X offset to apply
offset_y (float): Y offset to apply
offset_z (float): Z offset to apply
apply_constraints (bool): true to apply constraints
"""Overload 2:
def MoveSubAssembly(sub_assembly, offset_x, offset_y, offset_z, apply_constraints):
"""
Moves a sub-assembly
Args:
sub_assembly (AssembledSubAssembly): Sub-assembly to move
offset_x (float): X offset to apply
offset_y (float): Y offset to apply
offset_z (float): Z offset to apply
apply_constraints (bool): true to apply constraints
"""Rotates a part
Overload 1:
def RotatePart(name, angle_x, angle_y, angle_z, apply_constraints):
"""
Rotates a part
Args:
name (str): Name of part to rotate
angle_x (float): X rotation angle in degrees
angle_y (float): Y rotation angle in degrees
angle_z (float): Z rotation angle in degrees
apply_constraints (bool): true to apply constraints
"""Overload 2:
def RotatePart(part, angle_x, angle_y, angle_z, apply_constraints):
"""
Rotates a part
Args:
part (AssembledPart): Part to rotate
angle_x (float): X rotation angle in degrees
angle_y (float): Y rotation angle in degrees
angle_z (float): Z rotation angle in degrees
apply_constraints (bool): true to apply constraints
"""Rotates a set of parts
def RotateParts(names, angle_x, angle_y, angle_z, apply_constraints):
"""
Rotates a set of parts
Args:
names (list): Names of parts to rotate
angle_x (float): X rotation angle in degrees
angle_y (float): Y rotation angle in degrees
angle_z (float): Z rotation angle in degrees
apply_constraints (bool): true to apply constraints
"""Rotates a set of sub-assemblies
def RotateSubAssemblies(names, angle_x, angle_y, angle_z, apply_constraints):
"""
Rotates a set of sub-assemblies
Args:
names (list): Names of sub-assemblies to rotate
angle_x (float): X rotation angle in degrees
angle_y (float): Y rotation angle in degrees
angle_z (float): Z rotation angle in degrees
apply_constraints (bool): true to apply constraints
"""Rotates a sub-assembly
Overload 1:
def RotateSubAssembly(name, angle_x, angle_y, angle_z, apply_constraints):
"""
Rotates a sub-assembly
Args:
name (str): Name of sub-assembly to rotate
angle_x (float): X rotation angle in degrees
angle_y (float): Y rotation angle in degrees
angle_z (float): Z rotation angle in degrees
apply_constraints (bool): true to apply constraints
"""Overload 2:
def RotateSubAssembly(sub_assembly, angle_x, angle_y, angle_z, apply_constraints):
"""
Rotates a sub-assembly
Args:
sub_assembly (AssembledSubAssembly): Sub-assembly to rotate
angle_x (float): X rotation angle in degrees
angle_y (float): Y rotation angle in degrees
angle_z (float): Z rotation angle in degrees
apply_constraints (bool): true to apply constraints
"""Overload 3:
def RotateSubAssembly(assem_occ, angle_x, angle_y, angle_z, apply_constraints):
"""
Rotates a sub-assembly
Args:
assem_occ (AlibreX.IADOccurrence): Occurence of sub-assembly to rotate
angle_x (float): X rotation angle in degrees
angle_y (float): Y rotation angle in degrees
angle_z (float): Z rotation angle in degrees
apply_constraints (bool): true to apply constraints
"""Saves the assembly to a specific folder
def Save(folder):
"""
Saves the assembly to a specific folder
Args:
folder (str): Folder to save to
"""Save the assembly and all parts/sub-assemblies to a folder
def SaveAll(folder):
"""
Save the assembly and all parts/sub-assemblies to a folder
Args:
folder (str): Folder to save to
"""Saves the assembly to a specific folder with a new name
def SaveAs(folder, new_name):
"""
Saves the assembly to a specific folder with a new name
Args:
folder (str): Folder to save to
new_name (str): New name for assembly
"""Saves the current view as a bitmap image
def SaveSnapshot(file_name, width, height, use_aspect_ratio, use_widthand_height):
"""
Saves the current view as a bitmap image
Args:
file_name (str): Path and mame of file to save to
width (int): Width in pixels
height (int): Height in pixels
use_aspect_ratio (bool): if true uses greater of width/height along with current aspect ratio
use_widthand_height (bool): if true uses current width/height of view
"""Saves a thumbnail image of the assembly
def SaveThumbnail(file_name, width, height):
"""
Saves a thumbnail image of the assembly
Args:
file_name (str): Path and name of file to save to
width (int): Width of thumbnail in pixels
height (int): Height of thumbnail in pixels
"""Sets the value of a custom property The custom property must already be defined on the assembly or defined on the user's PC
def SetCustomProperty(name, value):
"""
Sets the value of a custom property The custom property must already be defined on the assembly or defined on the user's PC
Args:
name (str): Name of the custom property
value (str): New value for the custom property
"""Sets user data
def SetUserData(name, dict):
"""
Sets user data
Args:
name (str): Data name of the format companyname.projectname.dataname
dict (IronPython.Runtime.PythonDictionary): Python dictionary of data to store
"""Shows a part
Overload 1:
def ShowPart(name):
"""
Shows a part
Args:
name (str): Name of part to show
"""Overload 2:
def ShowPart(part):
"""
Shows a part
Args:
part (AssembledPart): Part to show
"""Shows a sub-assembly
def ShowSubAssembly(name):
"""
Shows a sub-assembly
Args:
name (str): Name of sub-assembly to show
"""Suppresses a part
Overload 1:
def SuppressPart(name):
"""
Suppresses a part
Args:
name (str): Name of part to suppress
"""Overload 2:
def SuppressPart(part):
"""
Suppresses a part
Args:
part (AssembledPart): Part to suppress
"""Suppresses a sub-assembly
def SuppressSubAssembly(name):
"""
Suppresses a sub-assembly
Args:
name (str): Name of sub-assembly to suppress
"""Un-anchors a part
Overload 1:
def UnanchorPart(name):
"""
Un-anchors a part
Args:
name (str): Name of part to un-anchor
"""Overload 2:
def UnanchorPart(part):
"""
Un-anchors a part
Args:
part (AssembledPart): Part to un-anchor
"""Un-anchors a sub-assembly
def UnanchorSubAssembly(name):
"""
Un-anchors a sub-assembly
Args:
name (str): Name of sub-assembly to un-anchor
"""Un-suppresses a part
Overload 1:
def UnsuppressPart(name):
"""
Un-suppresses a part
Args:
name (str): Name of part to un-suppress
"""Overload 2:
def UnsuppressPart(part):
"""
Un-suppresses a part
Args:
part (AssembledPart): Part to un-suppress
"""Un-suppresses a sub-assembly
def UnsuppressSubAssembly(name):
"""
Un-suppresses a sub-assembly
Args:
name (str): Name of sub-assembly to un-suppress
"""Documentation Home | Classes | Methods Index | Properties Index | Members Index
Generated on 2025-09-23 02:06