Simulation 3D Vehicle

Implement vehicle in 3D environment

Libraries:
Vehicle Dynamics Blockset / Vehicle Scenarios / Sim3D / Sim3D Vehicle / Components

Description

Note

Simulating models with the Simulation 3D Vehicle block requires Simulink^® 3D Animation™.

The Simulation 3D Vehicle block implements a vehicle with four wheels in the 3D simulation environment.

To use this block, ensure that the Simulation 3D Scene Configuration block is in your model. If you set the Sample time parameter of this block to -1, the block uses the sample time specified in the Simulation 3D Scene Configuration block.

The block input uses the vehicle Z-down right-handed (RH) Cartesian coordinate system defined in SAE J670¹. The coordinate system is inertial and initially aligned with the vehicle geometric center:

X-axis — Along vehicle longitudinal axis, points forward
Y-axis — Along vehicle lateral axis, points to the right
Z-axis — Points downward

Tip

Verify that the Simulation 3D Vehicle block executes before the Simulation 3D Scene Configuration block. That way, Simulation 3D Vehicle 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 Vehicle — -1

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

You can configure the Simulation 3D Vehicle with Ground Following block to import custom meshes and control vehicle lights.

Examples

Scene Interrogation with Camera and Ray Tracing Reference Application

Interrogate a 3D Unreal Engine scene with a vehicle dynamics model by using a camera and ray tracing reference application project.

Open Script

Ports

Input

expand all

Translation — Vehicle translation
`5`-by-`3` array

Vehicle and wheel translation, in m. Array dimensions are 5-by-3.

Translation(1,1), Translation(1,2), and Translation(1,3) — Vehicle translation along the inertial vehicle Z-down X-, Y-, and Z- axes, respectively.
Translation(...,1), Translation(...,2), and Translation(...,3) — Wheel translation relative to vehicle, along the vehicle Z-down X-, Y-, and Z- axes, respectively.

The signal contains translation information according to the axle and wheel locations.

$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	Translation Axis
Vehicle, X_v	`Translation(1,1)`	Inertial vehicle Z-down X-axis
Vehicle, Y_v	`Translation(1,2)`	Inertial vehicle Z-down Y-axis
Vehicle, Z_v	`Translation(1,3)`	Inertial vehicle Z-down Z-axis
Front left wheel, X_FL	`Translation(2,1)`	Vehicle Z-down X-axis
Front left wheel, Y_FL	`Translation(2,2)`	Vehicle Z-down Y-axis
Front left wheel, Z_FL	`Translation(2,3)`	Vehicle Z-down Z-axis
Front right wheel, X_FR	`Translation(3,1)`	Vehicle Z-down X-axis
Front right wheel, Y_FR	`Translation(3,2)`	Vehicle Z-down Y-axis
Front right wheel, Z_FR	`Translation(3,3)`	Vehicle Z-down Z-axis
Rear left wheel, X_RL	`Translation(4,1)`	Vehicle Z-down X-axis
Rear left wheel, Y_RL	`Translation(4,2)`	Vehicle Z-down Y-axis
Rear left wheel, Z_RL	`Translation(4,3)`	Vehicle Z-down Z-axis
Rear right wheel, X_RR	`Translation(5,1)`	Vehicle Z-down X-axis
Rear right wheel, Y_RR	`Translation(5,2)`	Vehicle Z-down Y-axis
Rear right wheel, Z_RR	`Translation(5,3)`	Vehicle Z-down Z-axis

Rotation — Vehicle rotation
`5`-by-`3` array

Vehicle and wheel rotation, in rad. Array dimensions are 5-by-3.

Rotation(1,1), Rotation(1,2), and Rotation(1,3) — Vehicle rotation about the inertial vehicle Z-down X-, Y-, and Z- axes, respectively.
Rotation(...,1), Rotation(...,2), and Rotation(...,3) — Wheel rotation relative to vehicle, about the vehicle Z-down X-, Y-, and Z- axes, respectively.

The signal contains rotation information according to the axle and wheel locations.

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

Rotation	Array Element	Rotation Axis
Vehicle, Roll_v	`Rotation(1,1)`	Inertial vehicle Z-down X-axis
Vehicle, Pitch_v	`Rotation(1,2)`	Inertial vehicle Z-down Y-axis
Vehicle, Yaw_v	`Rotation(1,3)`	Inertial vehicle Z-down Z-axis
Front left wheel, Roll_FL	`Rotation(2,1)`	Vehicle Z-down X-axis
Front left wheel, Pitch_FL	`Rotation(2,2)`	Vehicle Z-down Y-axis
Front left wheel, Yaw_FL	`Rotation(2,3)`	Vehicle Z-down Z-axis
Front right wheel, Roll_FR	`Rotation(3,1)`	Vehicle Z-down X-axis
Front right wheel, Pitch_FR	`Rotation(3,2)`	Vehicle Z-down Y-axis
Front right wheel, Yaw_FR	`Rotation(3,3)`	Vehicle Z-down Z-axis
Rear left wheel, Roll_RL	`Rotation(4,1)`	Vehicle Z-down X-axis
Rear left wheel, Pitch_RL	`Rotation(4,2)`	Vehicle Z-down Y-axis
Rear left wheel, Yaw_RL	`Rotation(4,3)`	Vehicle Z-down Z-axis
Rear right wheel, Roll_RR	`Rotation(5,1)`	Vehicle Z-down X-axis
Rear right wheel, Pitch_RR	`Rotation(5,2)`	Vehicle Z-down Y-axis
Rear right wheel, Yaw_RR	`Rotation(5,3)`	Vehicle Z-down Z-axis

Scale — Vehicle scale
`5`-by-`3`

Vehicle and wheel scale, dimensionless. Array dimensions are 5-by-3.

Scale(1,1), Scale(1,2), and Scale(1,3) — Vehicle scale along the inertial vehicle Z-down X-, Y-, and Z- axes, respectively.
Scale(...,1), Scale(...,2), and Scale(...,3) — Wheel scale relative to vehicle, along vehicle Z-down X-, Y-, and Z- axes, respectively.

The signal 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	Scale Axis
Vehicle, X_{v_scale}	`Scale(1,1)`	Vehicle Z-down X-axis
Vehicle, Y_{v_scale}	`Scale(1,2)`	Vehicle Z-down Y-axis
Vehicle, Z_{v_scale}	`Scale(1,3)`	Vehicle Z-down Z-axis
Front left wheel, X_{FL_scale}	`Scale(2,1)`	Vehicle Z-down X-axis
Front left wheel, Y_{FL_scale}	`Scale(2,2)`	Vehicle Z-down Y-axis
Front left wheel, Z_{FL_scale}	`Scale(2,3)`	Vehicle Z-down Z-axis
Front right wheel, X_{FR_scale}	`Scale(3,1)`	Vehicle Z-down X-axis
Front right wheel, Y_{FR_scale}	`Scale(3,2)`	Vehicle Z-down Y-axis
Front right wheel, Z_{FR_scale}	`Scale(3,3)`	Vehicle Z-down Z-axis
Rear left wheel, X_{RL_scale}	`Scale(4,1)`	Vehicle Z-down X-axis
Rear left wheel, Y_{RL_scale}	`Scale(4,2)`	Vehicle Z-down Y-axis
Rear left wheel, Z_{RL_scale}	`Scale(4,3)`	Vehicle Z-down Z-axis
Rear right wheel, X_{RR_scale}	`Scale(5,1)`	Vehicle Z-down X-axis
Rear right wheel, Y_{RR_scale}	`Scale(5,2)`	Vehicle Z-down Y-axis
Rear right wheel, Z_{RR_scale}	`Scale(5,3)`	Vehicle Z-down Z-axis

Light controls — Vehicle light controls
1-by-6 vector

Light controls input signal, specified as a 1-by-6 Boolean vector. Each element of the vector turns a specific vehicle light on or off, as indicated in this table. A value of 1 turns the light on; a value of 0 turns the light off.

Vector Element	Vehicle Light
(1,1)	Headlight high beam
(1,2)	Headlight low beam
(1,3)	Brake
(1,4)	Reverse
(1,5)	Left signal
(1,6)	Right signal

Dependencies

To create this port, on the Light Controls tab, select Enable light controls.

Data Types: Boolean

Parameters

expand all

Vehicle Parameters

Type, PassVehMesh — Type
`Muscle car` (default) | `Sedan` | `Sport utility vehicle` | `Small pickup truck` | `Hatchback` | `Box truck` | `Formula student vehicle`

Specify the vehicle type. This table provides links to the vehicle dimensions.

Vehicle type Setting	Vehicle Dimensions
`Muscle car`	Muscle Car
`Sedan`	Sedan
`Sport utility vehicle`	Sport Utility Vehicle
`Small pickup truck`	Small Pickup Truck
`Hatchback`	Hatchback
`Box truck`	Box Truck

Dependencies

Selecting Custom enables parameters that allow you to import a custom mesh for your vehicle.

Path to custom mesh, MeshPath — Path to custom mesh
`/MathWorksSimulation/Vehicles/Muscle/Meshes/SK_MuscleCar.SK_MuscleCar` (default) | valid path

Path to custom mesh.

To create a custom vehicle mesh, see Prepare Custom Vehicle Mesh for the Unreal Editor.

Example: /MathWorksSimulation/Vehicles/Muscle/Meshes/SK_Sedan.SK_Sedan

Dependencies

To enable this parameter, set Type to Custom.

Color, VehColor — Color of vehicle
`Red` (default) | `Orange` | `Yellow` | `Green` | `Blue` | `Black` | `White` | `Silver` | `Dazzle camouflage`

Select the color of the vehicle.

Name, ActorName — Name of vehicle
`SimulinkVehicle1` (default) | character vector

Name of vehicle. By default, when you use the block in your model, the block sets the Name parameter to SimulinkVehicleX. The value of X depends on the number of Simulation 3D Vehicle with Ground Following and Simulation 3D Vehicle blocks that you have in your model.

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

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

Light Controls

Enable light controls — Option to control vehicle lights
`off` (default) | `on`

Select whether to control the vehicle headlights. Use the enabled parameters to set the light parameters, including headlight intensity.

Dependencies

Selecting this parameter:

Creates the input port Light controls.

Enables these light parameters.

Lights	Light Parameters
Headlights	Headlight color High beam intensity Low beam intensity High beam cone half angle Low beam cone half angle Left headlight beam orientation Right headlight beam orientation
Brake lights	Brake light intensity
Reverse lights	Reverse light intensity
Turn signal lights	Turn signal light intensity Period Pulse width

Headlights