simscape.multibody.StandardAxisTranslation Class

R2026b

Namespace: simscape.multibody
Superclasses: simscape.multibody.Translation

Construct standard-axis translation

Since R2022a

Description

Use an object of the simscape.multibody.StandardAxisTranslation class to construct a translation along an axis of the base frame.

The Offset property specifies the distance of the translation. The Axis property specifies the axis of the translation as a string. The axis can be any axis of the base frame.

Class Attributes

Sealed	true
ConstructOnLoad	true
RestrictsSubclassing	true

For information on class attributes, see Class Attributes.

Creation

Description

T = simscape.multibody.StandardAxisTranslation creates a standard-axis translation with default values.

T = simscape.multibody.StandardAxisTranslation(offset,axis) creates a standard-axis translation with the specified offset and axis.

Properties

Offset — Offset of translation

simscape.Value(0,"m") (default) | simscape.Value(d,"Length unit")

Offset of the translation, specified as a simscape.Value object that represents a scalar with a unit of length.

Example: simscape.Value(3,"cm")

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Axis — Axis of translation

"+Z" (default) | "+X" | "-X" | "+Y" | "-Y" | "-Z"

Axis of the translation, specified as a string. To specify the axis, use the following values:

• "+X": x-axis of the base frame

• "-X": -x-axis of the base frame

• "+Y": y-axis of the base frame

• "-Y": -y-axis of the base frame

• "+Z": z-axis of the base frame

• "-Z": -z-axis of the base frame

Example: "-Y"

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Version History

Introduced in R2022a