add_transformation#
- class ansys.systemcoupling.core.adaptor.api_25_2.add_transformation.add_transformation(name=None, parent=None)#
Bases:
CommandAdd a transformation to a reference frame defined in the datamodel
Given the reference frame to add to the transform to, the type of transform to be added, and any required information for the transformation, add the transformation to the referenceFrame. Not all parameters are required for every transformation.
The name of the transformation will be based on the type of transformation. The name will be of the form
<transformation_type>-#where#is the first positive integer which yields a unique frame name.The transformation will also be added to the end of the
transformation_orderlist for the reference frame.Returns the name of the transformation.
- Parameters:
- reference_frame
str Name of the reference frame to which the transformation will be added.
- transformation_type
str Type of transformation to be added. Available options are Rotation or Translation
- Required Parameters for Transformation Types:
Rotation:
angle,axis,vector(ifaxisis “UserDefined”) Translation:vector
- angle
real,optional Angle to rotate a reference frame. Used with Rotation
transformation_type. Default unit is Radians.- axis
str,optional Axis about which a rotation is applied. Used with Rotation
transformation_type. Available options are: “XAxis”, “YAxis”, “ZAxis”, and “UserDefined”.- vector
Tuple,optional A vector for use with Translation
transformation_typeor Rotationtransformation_typeif theaxisis “UserDefined”.
- reference_frame
Included in:
Parent |
Summary |
|---|---|
‘root’ object |