Simulation 3D Actor Transform Set
Libraries:
Vehicle Dynamics Blockset /
Vehicle Scenarios /
Sim3D /
Sim3D Core
Aerospace Blockset /
Animation /
Simulation 3D
Description
Note
Simulating models with the Simulation 3D Actor Transform Set 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 Set 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 Set block sets the actor translation, rotation, and scale in the 3D visualization environment.
The block uses a vehicle-fixed coordinate system that is initially aligned with the inertial world coordinate system.
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 |
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 Actor Transform Set block executes before the Simulation 3D Scene Configuration block. That way, Simulation 3D Actor Transform Set prepares the signal data before the Unreal Engine® 3D visualization environment 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 Set —
-1
For more information about execution order, see Control and Display Execution Order.
Ports
Input
Translation — Actor translation
array
Actor translation, in m. Array dimensions are number of parts per
actor-by-3
.
Translation(1,1)
,Translation(1,2)
, andTranslation(1,3)
— Vehicle displacement along world X-, Y, and Z- axes, respectively.Translation(...,1)
,Translation(...,2)
, andTranslation(...,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.
Translation Array Element Vehicle, Xv
Translation(1,1)
Vehicle, Yv
Translation(1,2)
Vehicle, Zv
Translation(1,3)
Front left wheel, XFL
Translation(2,1)
Front left wheel, YFL
Translation(2,2)
Front left wheel, ZFL
Translation(2,3)
Front right wheel, XFR
Translation(3,1)
Front right wheel, YFR
Translation(3,2)
Front right wheel, ZFR
Translation(3,3)
Rear left wheel, XRL
Translation(4,1)
Rear left wheel, YRL
Translation(4,2)
Rear left wheel, ZRL
Translation(4,3)
Rear right wheel, XRR
Translation(5,1)
Rear right wheel, YRR
Translation(5,2)
Rear right wheel, ZRR
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)
, andRotation(1,3)
— Vehicle rotation about vehicle-fixed pitch, roll, and yaw Y-, Z-, and X- axes, respectively.Rotation(...,1)
,Rotation(...,2)
, andRotation(...,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.
Rotation Array Element Vehicle, Pitchv
Rotation(1,1)
Vehicle, Rollv
Rotation(1,2)
Vehicle, Yawv
Rotation(1,3)
Front left wheel, PitchFL
Rotation(2,1)
Front left wheel, RollFL
Rotation(2,2)
Front left wheel, YawFL
Rotation(2,3)
Front right wheel, PitchFR
Rotation(3,1)
Front right wheel, RollFR
Rotation(3,2)
Front right wheel, YawFR
Rotation(3,3)
Rear left wheel, PitchRL
Rotation(4,1)
Rear left wheel, RollRL
Rotation(4,2)
Rear left wheel, YawRL
Rotation(4,3)
Rear right wheel, PitchRR
Rotation(5,1)
Rear right wheel, RollRR
Rotation(5,2)
Rear right wheel, YawRR
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)
, andScale(1,3)
— Vehicle scale along world X-, Y-, and Z- axes, respectively.Scale(...,1)
,Scale(...,2)
, andScale(...,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.
Scale Array Element Vehicle, Xvscale
Scale(1,1)
Vehicle, Yvscale
Scale(1,2)
Vehicle, Zvscale
Scale(1,3)
Front left wheel, XFLscale
Scale(2,1)
Front left wheel, YFLscale
Scale(2,2)
Front left wheel, ZFLscale
Scale(2,3)
Front right wheel, XFRscale
Scale(3,1)
Front right wheel, YFRscale
Scale(3,2)
Front right wheel, ZFRscale
Scale(3,3)
Rear left wheel, XRLscale
Scale(4,1)
Rear left wheel, YRLscale
Scale(4,2)
Rear left wheel, ZRLscale
Scale(4,3)
Rear right wheel, XRRscale
Scale(5,1)
Rear right wheel, YRRscale
Scale(5,2)
Rear right wheel, ZRRscale
Scale(5,3)
Parameters
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 set, 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.
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.
Initial array values to translate actor per part, Translation — Actor initial position
[0 0 0]
(default) | array
Actor initial position, along world X-, Y-, and Z- axes, in m.
Array dimensions are number of parts per actor-by-3
.
Translation(1,1)
,Translation(1,2)
, andTranslation(1,3)
— Vehicle displacement along world X-, Y, and Z- axes, respectively.Translation(...,1)
,Translation(...,2)
, andTranslation(...,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 parameter:
Dimensions are
[5x3]
.Contains translation information according to the axle and wheel locations, relative to vehicle.
Translation Array Element Vehicle, Xv
Translation(1,1)
Vehicle, Yv
Translation(1,2)
Vehicle, Zv
Translation(1,3)
Front left wheel, XFL
Translation(2,1)
Front left wheel, YFL
Translation(2,2)
Front left wheel, ZFL
Translation(2,3)
Front right wheel, XFR
Translation(3,1)
Front right wheel, YFR
Translation(3,2)
Front right wheel, ZFR
Translation(3,3)
Rear left wheel, XRL
Translation(4,1)
Rear left wheel, YRL
Translation(4,2)
Rear left wheel, ZRL
Translation(4,3)
Rear right wheel, XRR
Translation(5,1)
Rear right wheel, YRR
Translation(5,2)
Rear right wheel, ZRR
Translation(5,3)
Initial array values to rotate actor per part, Rotation — Actor initial rotation
[0 0 0]
(default) | array
Actor initial rotation about world X-, Y-, and Z- axes 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)
, andRotation(1,3)
— Vehicle rotation about vehicle-fixed pitch, roll, and yaw Y-, Z-, and X- axes, respectively.Rotation(...,1)
,Rotation(...,2)
, andRotation(...,3)
— Actor rotation about vehicle-fixed pitch, roll, and yaw Y-, Z-, and X- axes, respectively.
For example, consider a vehicle actor with a vehicle body and four wheels. The parameter:
Dimensions are
[5x3]
.Contains rotation information according to the axle and wheel locations.
Rotation Array Element Vehicle, Pitchv
Rotation(1,1)
Vehicle, Rollv
Rotation(1,2)
Vehicle, Yawv
Rotation(1,3)
Front left wheel, PitchFL
Rotation(2,1)
Front left wheel, RollFL
Rotation(2,2)
Front left wheel, YawFL
Rotation(2,3)
Front right wheel, PitchFR
Rotation(3,1)
Front right wheel, RollFR
Rotation(3,2)
Front right wheel, YawFR
Rotation(3,3)
Rear left wheel, PitchRL
Rotation(4,1)
Rear left wheel, RollRL
Rotation(4,2)
Rear left wheel, YawRL
Rotation(4,3)
Rear right wheel, PitchRR
Rotation(5,1)
Rear right wheel, RollRR
Rotation(5,2)
Rear right wheel, YawRR
Rotation(5,3)
Initial array values to scale actor per part, Scale — Actor initial scale
[1 1 1]
(default) | array
Actor initial scale.
Array dimensions are number of number of parts per actor-by-3
.
Scale(1,1)
,Scale(1,2)
, andScale(1,3)
— Vehicle scale along world X-, Y, and Z- axes, respectively.Scale(...,1)
,Scale(...,2)
, andScale(...,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 parameter:
Dimensions are
[5x3]
.Contains scale information according to the axle and wheel locations.
Scale Array Element Scale Axis Vehicle, Xvscale
Scale(1,1)
World X-axis Vehicle, Yvscale
Scale(1,2)
World Y-axis Vehicle, Zvscale
Scale(1,3)
World Z-axis Front left wheel, XFLscale
Scale(2,1)
World X-axis Front left wheel, YFLscale
Scale(2,2)
World Y-axis Front left wheel, ZFLscale
Scale(2,3)
World Z-axis Front right wheel, XFRscale
Scale(3,1)
World X-axis Front right wheel, YFRscale
Scale(3,2)
World Y-axis Front right wheel, ZFRscale
Scale(3,3)
World Z-axis Rear left wheel, XRLscale
Scale(4,1)
World X-axis Rear left wheel, YRLscale
Scale(4,2)
World Y-axis Rear left wheel, ZRLscale
Scale(4,3)
World Z-axis Rear right wheel, XRRscale
Scale(5,1)
World X-axis Rear right wheel, YRRscale
Scale(5,2)
World Y-axis Rear right wheel, ZRRscale
Scale(5,3)
World Z-axis
Sample time — Sample time
-1
(default) | scalar
Sample time, Ts. The graphics frame rate is the inverse of the sample time.
Version History
Introduced in R2021bR2024a: Requires Simulink 3D Animation
Simulating models with the Simulation 3D Actor Transform Set 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 Set to simulate models in the 3D environment. For more information, see Opt-In Offer for Aerospace Blockset Unreal Engine Visualization Users.
MATLAB Command
You clicked a link that corresponds to this MATLAB command:
Run the command by entering it in the MATLAB Command Window. Web browsers do not support MATLAB commands.
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)