`RigidBodyTransformationMatrix`#

class ansys.mechanical.stubs.v261.Ansys.Mechanical.DataModel.Utilities.RigidBodyTransformationMatrix#

Bases: object

A 4x4 transformation matrix, to be used explicitly for rigid body transformations. The transformation matrix is in column-major format. Elements 0-3 represent, respectively, the x-components of the X axis, Y axis, Z axis, and translation with respect to global. Identically, elements 4-7 represent the y components and elements 8-11 the z components. Elements 2-15, per rigid-body requirements, are expected to be [0.0, 0.0, 0.0, 1.0].

The ability to piecewise set rotation and translation components precludes the option of validating the matrix data at every operation. Thus, these values *must* be checked before the data is used.

The class Ansys.ACT.Common.SimpleTransform provides a simplified mechanism for working with rigid body transformations and getting a RigidBodyTransformationMatrix object.

Overview#

Methods

`Equals`	Equals method.
`GetHashCode`	GetHashCode method.
`GetType`	GetType method.
`IsMatrixWellFormed`	Verify that the data meets the following criteria for a rigid-body transformation:
`IsRotationValid`	IsRotationValid method.
`IsScaleValid`	IsScaleValid method.
`IsShearValid`	IsShearValid method.
`IsTranslationValid`	IsTranslationValid method.
`ToString`	ToString method.

Properties

`Data`	A 16-value list representing a linearized 4x4 transformation matrix.
`S`	Element 15: the transformation scale, which must be '1.0' for rigid body
`T_x`	Element 3: the x component of the translation.
`T_y`	Element 7: the y component of the translation.
`T_z`	Element 11: the z component of the translation.
`X_x`	Element 0: the x component of the X axis rotation.
`X_y`	Element 4: the y component of the X axis rotation.
`X_z`	Element 8: the z component of the X axis rotation.
`Y_x`	Element 1: the x component of the Y axis rotation.
`Y_y`	Element 5: the y component of the Y axis rotation.
`Y_z`	Element 9: the z component of the Y axis rotation.
`Z_x`	Element 2: the x component of the Z axis rotation.
`Z_y`	Element 6: the y component of the Z axis rotation.
`Z_z`	Element 10: the z component of the Z axis rotation.
`tau_x`	Element 12: the x component of the shear, which must be '0.0' for rigid body
`tau_y`	Element 13: the y component of the shear, which must be '0.0' for rigid body
`tau_z`	Element 14: the z component of the shear, which must be '0.0' for rigid body

Property detail#

property RigidBodyTransformationMatrix.Data: List[Any] | None#: A 16-value list representing a linearized 4x4 transformation matrix.

property RigidBodyTransformationMatrix.S: float | None#: Element 15: the transformation scale, which must be '1.0' for rigid body transformations.

property RigidBodyTransformationMatrix.T_x: float | None#: Element 3: the x component of the translation.

property RigidBodyTransformationMatrix.T_y: float | None#: Element 7: the y component of the translation.

property RigidBodyTransformationMatrix.T_z: float | None#: Element 11: the z component of the translation.

property RigidBodyTransformationMatrix.X_x: float | None#: Element 0: the x component of the X axis rotation.

property RigidBodyTransformationMatrix.X_y: float | None#: Element 4: the y component of the X axis rotation.

property RigidBodyTransformationMatrix.X_z: float | None#: Element 8: the z component of the X axis rotation.

property RigidBodyTransformationMatrix.Y_x: float | None#: Element 1: the x component of the Y axis rotation.

property RigidBodyTransformationMatrix.Y_y: float | None#: Element 5: the y component of the Y axis rotation.

property RigidBodyTransformationMatrix.Y_z: float | None#: Element 9: the z component of the Y axis rotation.

property RigidBodyTransformationMatrix.Z_x: float | None#: Element 2: the x component of the Z axis rotation.

property RigidBodyTransformationMatrix.Z_y: float | None#: Element 6: the y component of the Z axis rotation.

property RigidBodyTransformationMatrix.Z_z: float | None#: Element 10: the z component of the Z axis rotation.

property RigidBodyTransformationMatrix.tau_x: float | None#: Element 12: the x component of the shear, which must be '0.0' for rigid body transformations.

property RigidBodyTransformationMatrix.tau_y: float | None#: Element 13: the y component of the shear, which must be '0.0' for rigid body transformations.

property RigidBodyTransformationMatrix.tau_z: float | None#: Element 14: the z component of the shear, which must be '0.0' for rigid body transformations.

Method detail#

RigidBodyTransformationMatrix.Equals(obj: Any) → bool#: Equals method.

RigidBodyTransformationMatrix.GetHashCode() → int#: GetHashCode method.

RigidBodyTransformationMatrix.GetType() → type#: GetType method.

RigidBodyTransformationMatrix.IsMatrixWellFormed() → bool#

Verify that the data meets the following criteria for a rigid-body transformation:
  1) The rotation matrix contains three orthonormal orientations
  2) The transformation components are valid values
  3) The shear components are all zero
  4) The scale value is unity

RigidBodyTransformationMatrix.IsRotationValid() → bool#: IsRotationValid method.

RigidBodyTransformationMatrix.IsScaleValid() → bool#: IsScaleValid method.

RigidBodyTransformationMatrix.IsShearValid() → bool#: IsShearValid method.

RigidBodyTransformationMatrix.IsTranslationValid() → bool#: IsTranslationValid method.

RigidBodyTransformationMatrix.ToString() → str#: ToString method.