create_object_coordinate_system#
- Modeler3D.create_object_coordinate_system(assignment, origin, x_axis, y_axis, move_to_end=True, reverse_x_axis=False, reverse_y_axis=False, name=None)[source]#
Create an object coordinate system.
- Parameters:
- assignment
str
,ansys.aedt.core.modeler.cad.object_3d.Object3d
Object to attach the object coordinate system to.
- origin
int
,VertexPrimitive
,EdgePrimitive
,FacePrimitive
,list
Refer to the origin where the object coordinate system is anchored. It can be:
int in which case it refers to the entity Id.
VertexPrimitive, EdgePrimitive, FacePrimitive in which case it refers to the entity type.
list in which case it refers to the origin coordinate system
[x, y, z]
.
- x_axis
int
,VertexPrimitive
,EdgePrimitive
,FacePrimitive
,list
Entity that the x axis of the object coordinate system points to. It can be:
int in which case it refers to the entity Id.
VertexPrimitive, EdgePrimitive, FacePrimitive in which case it refers to the entity type.
list in which case it refers to the point coordinate system
[x, y, z]
that the x axis points to.
- y_axis
int
,VertexPrimitive
,EdgePrimitive
,FacePrimitive
,list
Entity that the y axis of the object coordinate system points to. It can be:
int in which case it refers to the entity Id.
VertexPrimitive, EdgePrimitive, FacePrimitive in which case it refers to the entity type.
list in which case it refers to the point coordinate system
[x, y, z]
that the y axis points to.
- move_to_endbool,
optional
If
True
the Coordinate System creation operation will always be moved to the end of subsequent objects operation. This will guarantee that the coordinate system will remain solidal with the object face. IfFalse
the option “Always Move CS to End” is set to off. The default isTrue
.- reverse_x_axisbool,
optional
Whether the x-axis is in the reverse direction. The default is
False
.- reverse_y_axisbool,
optional
Whether the y-axis is in the reverse direction. The default is
False
.- name
str
,optional
Name of the coordinate system. The default is
None
.
- assignment
- Returns:
- bool
True
when successful,False
when failed.