Simulation 3D Actor Transform Get

Get actor translation, rotation, scale

Since R2021b

Libraries:
Vehicle Dynamics Blockset / Vehicle Scenarios / Sim3D / Sim3D Core
Aerospace Blockset / Animation / Simulation 3D
Simulink 3D Animation / Simulation 3D / Utilities

Description

Note

Simulating models with the Simulation 3D Actor Transform Get block requires Simulink^® 3D Animation™. If you had an Aerospace Blockset™ license prior to R2024a, you might be eligible to continue using Simulation 3D Actor Transform Get to simulate models in the 3D environment. For more information, see Opt-In Offer for Aerospace Blockset Unreal Engine Visualization Users.

The Simulation 3D Actor Transform Get block provides the actor translation, rotation, and scale for the Simulink simulation environment.

The block uses a vehicle-fixed coordinate system that is initially aligned with the inertial world coordinate system.

Coordinate system image showing roll, pitch, and yaw about x, y, and z axes, respectively

Axis	Description
X	Forward direction of the vehicle Roll — Right-handed rotation about X-axis
Y	Extends to the right of the vehicle, initially parallel to the ground plane Pitch — Right-handed rotation about Y-axis
Z	Extends upwards Yaw — Left-handed rotation about Z-axis

Axis

Description

Forward direction of the vehicle

Roll — Right-handed rotation about X-axis

Extends to the right of the vehicle, initially parallel to the ground plane

Pitch — Right-handed rotation about Y-axis

Extends upwards

Yaw — Left-handed rotation about Z-axis

Actors are scene objects that support 3D translation, rotation, and scale. Parts are actor components. Components do not exist by themselves; they are associated with an actor.

Tip

Verify that the Simulation 3D Scene Configuration block executes before the Simulation 3D Actor Transform Get block. That way, the Unreal Engine^® 3D visualization environment prepares the data before the Simulation 3D Actor Transform Get block receives it. To check the block execution order, right-click the blocks and select Properties. On the General tab, confirm these Priority settings:

Simulation 3D Scene Configuration — 0
Simulation 3D Actor Transform Get — 1

For more information about execution order, see Control and Display Execution Order.

Ports

Output

expand all

Translation — Actor translation
`array`

Actor translation, in m. Array dimensions are number of parts per actor-by-3.

Translation(1,1), Translation(1,2), and Translation(1,3) — Vehicle displacement along world X-, Y, and Z- axes, respectively.
Translation(...,1), Translation(...,2), and Translation(...,3) — Actor displacement relative to vehicle, in vehicle-fixed coordinate system initially aligned with world X-, Y, and Z- axes, respectively.

For example, consider a vehicle actor with a vehicle body and four wheels. The Translation signal:

Dimensions are [5x3].

Contains translation information according to the axle and wheel locations, relative to vehicle.

$T r a n s l a t i o n = [\begin{matrix} X_{v} & Y_{v} & Z_{v} \\ X_{F L} & Y_{F L} & Z_{F L} \\ X_{F R} & Y_{F R} & Z_{F R} \\ X_{R L} & Y_{R L} & Z_{R L} \\ X_{R R} & Y_{R R} & Z_{R R} \end{matrix}]$

Translation	Array Element
Vehicle, X_v	`Translation(1,1)`
Vehicle, Y_v	`Translation(1,2)`
Vehicle, Z_v	`Translation(1,3)`
Front left wheel, X_FL	`Translation(2,1)`
Front left wheel, Y_FL	`Translation(2,2)`
Front left wheel, Z_FL	`Translation(2,3)`
Front right wheel, X_FR	`Translation(3,1)`
Front right wheel, Y_FR	`Translation(3,2)`
Front right wheel, Z_FR	`Translation(3,3)`
Rear left wheel, X_RL	`Translation(4,1)`
Rear left wheel, Y_RL	`Translation(4,2)`
Rear left wheel, Z_RL	`Translation(4,3)`
Rear right wheel, X_RR	`Translation(5,1)`
Rear right wheel, Y_RR	`Translation(5,2)`
Rear right wheel, Z_RR	`Translation(5,3)`

Rotation — Actor rotation
`array`

Actor rotation across a [-pi/2, pi/2] range, in rad. Array dimensions are number of parts per actor-by-3.

Rotation(1,1), Rotation(1,2), and Rotation(1,3) — Vehicle rotation about vehicle-fixed pitch, roll, and yaw Y-, Z-, and X- axes, respectively.
Rotation(...,1), Rotation(...,2), and Rotation(...,3) — Actor rotation about vehicle-fixed pitch, roll, and yaw Y-, X-, and Z- axes, respectively.

For example, consider a vehicle actor with a vehicle body and four wheels. The Rotation signal:

Dimensions are [5x3].

Contains rotation information according to the axle and wheel locations.

$R o t a t i o n = [\begin{matrix} P i t c h_{v} & R o l l_{v} & Y a w_{v} \\ P i t c h_{F L} & R o l l_{F L} & Y a w_{F L} \\ P i t c h_{F R} & R o l l_{F R} & Y a w_{F R} \\ P i t c h_{R L} & R o l l_{R L} & Y a w_{R L} \\ P i t c h_{R R} & R o l l_{R R} & Y a w_{R R} \end{matrix}]$

Rotation	Array Element
Vehicle, Pitch_v	`Rotation(1,1)`
Vehicle, Roll_v	`Rotation(1,2)`
Vehicle, Yaw_v	`Rotation(1,3)`
Front left wheel, Pitch_FL	`Rotation(2,1)`
Front left wheel, Roll_FL	`Rotation(2,2)`
Front left wheel, Yaw_FL	`Rotation(2,3)`
Front right wheel, Pitch_FR	`Rotation(3,1)`
Front right wheel, Roll_FR	`Rotation(3,2)`
Front right wheel, Yaw_FR	`Rotation(3,3)`
Rear left wheel, Pitch_RL	`Rotation(4,1)`
Rear left wheel, Roll_RL	`Rotation(4,2)`
Rear left wheel, Yaw_RL	`Rotation(4,3)`
Rear right wheel, Pitch_RR	`Rotation(5,1)`
Rear right wheel, Roll_RR	`Rotation(5,2)`
Rear right wheel, Yaw_RR	`Rotation(5,3)`

Scale — Actor scale
`array`

Actor scale. Array dimensions are number of parts per actor-by-3.

Scale(1,1), Scale(1,2), and Scale(1,3) — Vehicle scale along world X-, Y-, and Z- axes, respectively.
Scale(...,1), Scale(...,2), and Scale(...,3) — Actor scale along world X-, Y-, and Z- axes, respectively.

For example, consider a vehicle actor with a vehicle body and four wheels. The Scale signal:

Dimensions are [5x3].

Contains scale information according to the axle and wheel locations.

$S c a l e = [\begin{matrix} X_{V_{s c a l e}} & Y_{V_{s c a l e}} & Z_{V_{s c a l e}} \\ X_{F L_{s c a l e}} & Y_{F L_{s c a l e}} & Z_{F L_{s c a l e}} \\ X_{F R_{s c a l e}} & Y_{F R_{s c a l e}} & Z_{F R_{s c a l e}} \\ X_{R L_{s c a l e}} & Y_{R L_{s c a l e}} & Z_{R L_{s c a l e}} \\ X_{R R_{s c a l e}} & Y_{R R_{s c a l e}} & Z_{R R_{s c a l e}} \end{matrix}]$

Scale	Array Element
Vehicle, X_{v_scale}	`Scale(1,1)`
Vehicle, Y_{v_scale}	`Scale(1,2)`
Vehicle, Z_{v_scale}	`Scale(1,3)`
Front left wheel, X_{FL_scale}	`Scale(2,1)`
Front left wheel, Y_{FL_scale}	`Scale(2,2)`
Front left wheel, Z_{FL_scale}	`Scale(2,3)`
Front right wheel, X_{FR_scale}	`Scale(3,1)`
Front right wheel, Y_{FR_scale}	`Scale(3,2)`
Front right wheel, Z_{FR_scale}	`Scale(3,3)`
Rear left wheel, X_{RL_scale}	`Scale(4,1)`
Rear left wheel, Y_{RL_scale}	`Scale(4,2)`
Rear left wheel, Z_{RL_scale}	`Scale(4,3)`
Rear right wheel, X_{RR_scale}	`Scale(5,1)`
Rear right wheel, Y_{RR_scale}	`Scale(5,2)`
Rear right wheel, Z_{RR_scale}	`Scale(5,3)`

Parameters

expand all

Tag for actor in 3D scene, ActorTag — Name
`SimulinkActor1` (default) | character vector

Actor name.

Actors are scene objects that support 3D translation, rotation, and scale. Parts are actor components. Components do not exist by themselves; they are associated with an actor.

The block does not support multiple instances of the same actor tag. To refer to the same scene actor when you use the 3D block pairs (e.g. Simulation 3D Actor Transform Get and Simulation 3D Actor Transform Set), specify the same Tag for actor in 3D scene, ActorTag parameter.

Number of parts per actor to get, NumberOfParts — Name
`1` (default) | `scalar`

Number of parts per actor. Actors are scene objects that support 3D translation, rotation, and scale. Parts are actor components. Components do not exist by themselves; they are associated with an actor. Typically, a vehicle actor with a body and four wheels has 5 parts.

Sample time — Sample time
`-1` (default) | `scalar`

Sample time, T_s. The graphics frame rate is the inverse of the sample time.

Version History

Introduced in R2021b

expand all

R2024a: Requires Simulink 3D Animation

Simulating models with the Simulation 3D Actor Transform Get block requires Simulink 3D Animation. If you had an Aerospace Blockset license prior to R2024a, you might be eligible to continue using Simulation 3D Actor Transform Get to simulate models in the 3D environment. For more information, see Opt-In Offer for Aerospace Blockset Unreal Engine Visualization Users.

Simulation 3D Actor Transform Get

Description

Ports

Output

Translation — Actor translation array

Rotation — Actor rotation array

Scale — Actor scale array

Parameters

Tag for actor in 3D scene, ActorTag — Name SimulinkActor1 (default) | character vector

Number of parts per actor to get, NumberOfParts — Name 1 (default) | scalar

Sample time — Sample time -1 (default) | scalar

Version History

R2024a: Requires Simulink 3D Animation

See Also

Translation — Actor translation
`array`

Rotation — Actor rotation
`array`

Scale — Actor scale
`array`

Tag for actor in 3D scene, ActorTag — Name
`SimulinkActor1` (default) | character vector

Number of parts per actor to get, NumberOfParts — Name
`1` (default) | `scalar`

Sample time — Sample time
`-1` (default) | `scalar`