Main Content

simscape.multibody.StandardAxisTranslation Class

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. 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

expand all

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 of the translation, specified as a member of the simscape.multibody.Axis class. To specify the axis, use the following members:

  • simscape.multibody.Axis.PosX: x-axis of the base frame

  • simscape.multibody.Axis.NegX: -x-axis of the base frame

  • simscape.multibody.Axis.PosY: y-axis of the base frame

  • simscape.multibody.Axis.NegY: -y-axis of the base frame

  • simscape.multibody.Axis.PosZ: z-axis of the base frame

  • simscape.multibody.Axis.NegZ: -z-axis of the base frame

Example: simscape.multibody.Axis.NegY

Attributes:

GetAccess
public
SetAccess
public
NonCopyable
true

Version History

Introduced in R2022a