create_object_coordinate_system#

Modeler2D.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:
assignmentstr, pyaedt.modeler.cad.object3d.Object3d

Object to attach the object coordinate system to.

originint, 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_axisint, 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_axisint, 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. If False the option “Always Move CS to End” is set to off. The default is True.

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.

namestr, optional

Name of the coordinate system. The default is None.

Returns:
bool

True when successful, False when failed.