Main Content

Simulation 3D Aircraft

Implement aircraft in 3D environment

  • Library:
  • Aerospace Blockset / Animation / Simulation 3D

  • Simulation 3D Aircraft block icon

Description

The Simulation 3D Aircraft block implements an aircraft in a 3D visualization environment using translation and rotation to place the aircraft.

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 aircraft north-east-down (NED) right-handed (RH) Cartesian coordinate system, with its origin fixed at the approximate aircraft center of gravity.

  • X-axis — Along aircraft longitudinal axis, points forward

  • Y-axis — Along aircraft lateral axis, points to the right

  • Z-axis — Points downward

For more information, see About Aerospace Coordinate Systems.

Tip

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

  • Simulation 3D Aircraft-1

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

Skeletons, Bones, and Meshes

Unreal® uses a skeleton, bones, and mesh to define a 3D model. A skeleton is comprised of a set of bones. A mesh is the outer covering of the skeleton. Aircraft parts are sections of the mesh, such as ailerons or wheels, which are linked to the bones. For more information, see https://docs.unrealengine.com/4.27/AnimatingObjects/SkeletalMeshAnimation/Skeleton/.

For more information on how the Simulation 3D Aircraft block translation input arrays connect to aircraft types, see Algorithms.

Ports

Input

expand all

Aircraft translation, specified as:

  • 11-by-3 array — Aircraft Type is Sky Hogg.

  • 12-by-3 array — Aircraft Type is Airliner.

  • 15-by-3 array — Aircraft Type is General Aviation.

  • 30-by-3 array — Aircraft Type is Air Transport.

  • 57-by-3 array — Aircraft Type is Custom.

The signal contains translation [X, Y, Z], in meters, with one row of the array for each bone of the aircraft.

The translation applies to these bones of the Airliner type:

BoneIndex

BODY

1

LEFT_ENGINE

2

RIGHT_ENGINE

3

RUDDER

4

ELEVATOR

5

LEFT_AILERON

6

RIGHT_AILERON

7

FLAPS

8

NOSE_WHEEL_STRUT

9

NOSE_WHEEL

10

LEFT_WHEEL

11

RIGHT_WHEEL

12

The translation applies to these bones of the Sky Hogg type:

BoneIndex

BODY

1

PROPELLER

2

RUDDER

3

ELEVATOR

4

LEFT_AILERON

5

RIGHT_AILERON

6

FLAPS

7

NOSE_WHEEL_STRUT

8

NOSE_WHEEL

9

LEFT_WHEEL

10

RIGHT_WHEEL

11

The translation applies to these bones of the General Aviation type:

BoneIndex

BODY

1

ENGINE1

2

RUDDER

3

ELEVATOR

4

LEFT_AILERON

5

RIGHT_AILERON

6

FLAPS

7

LEFT_SPOILER

8

RIGHT_SPOILER

9

NOSE_GEAR

10

NOSE_WHEEL

11

LEFT_GEAR

12

LEFT_WHEEL

13

RIGHT_GEAR

14

RIGHT_WHEEL

15

The translation applies to these bones of the Air Transport type:

BoneIndex

BODY

1

ENGINE1

2

ENGINE2

3

ENGINE3

4

ENGINE4

5

RUDDER

6

ELEVATOR

7

HORIZONTAL_STAB

8

LEFT_AILERON

9

RIGHT_AILERON

10

FLAPS1

11

FLAPS2

12

LEFT_SPOILER

13

RIGHT_SPOILER

14

NOSE_GEAR

15

NOSE_WHEEL

16

NOSE_GEAR_DOOR1

17

NOSE_GEAR_DOOR2

18

LEFT_GEAR

19

LEFT_WHEEL

20

LEFT_GEAR_LINK

21

LEFT_GEAR_DOOR1

22

LEFT_GEAR_DOOR2

23

LEFT_GEAR_DOOR2_2

24

RIGHT_GEAR

25

RIGHT_WHEEL

26

RIGHT_GEAR_LINK

27

RIGHT_GEAR_DOOR1

28

RIGHT_GEAR_DOOR2

29

RIGHT_GEAR_DOOR2_2

30

The translation applies to these bones of the Custom type:

BoneIndex

BODY

1

ENGINE1

2

ENGINE1_PROP

3

ENGINE2

4

ENGINE2_PROP

5

ENGINE3

6

ENGINE3_PROP

7

ENGINE4

8

ENGINE4_PROP

9

ENGINE5

10

ENGINE5_PROP

11

ENGINE6

12

ENGINE6_PROP

13

ENGINE7

14

ENGINE7_PROP

15

ENGINE8

16

ENGINE8_PROP

17

ENGINE9

18

ENGINE9_PROP

19

ENGINE10

20

ENGINE10_PROP

21

ENGINE11

22

ENGINE11_PROP

23

ENGINE12

24

ENGINE12_PROP

25

ENGINE13

26

ENGINE13_PROP

27

ENGINE14

28

ENGINE14_PROP

29

ENGINE15

30

ENGINE15_PROP

31

ENGINE16

32

ENGINE16_PROP

33

WING1

34

WING1_LEFT_FLAP

35

WING1_RIGHT_FLAP

36

WING1_LEFT_AILERON

337

WING1_RIGHT_AILERON

38

WING1_LEFT_SPOILER

39

WING1_RIGHT_SPOILER

40

WING2

41

WING2_LEFT_FLAP

42

WING2_RIGHT_FLAP

43

HORIZONTAL_STABILIZER

44

LEFT_ELEVATOR

45

RIGHT_ELEVATOR

46

LEFT_RUDDER

47

RIGHT_RUDDER

48

NOSE_GEAR

49

NOSE_WHEEL

50

NOSE_GEAR_DOOR

51

LEFT_GEAR

52

LEFT_WHEEL

53

LEFT_GEAR_DOOR

54

RIGHT_GEAR

55

RIGHT_WHEEL

56

RIGHT_GEAR_DOOR

57

Aircraft rotation, specified as:

  • 11-by-3 array — Aircraft Type is Sky Hogg.

  • 12-by-3 array — Aircraft Type is Airliner.

  • 15-by-3 array — Aircraft Type is General Aviation.

  • 30-by-3 array — Aircraft Type is Air Transport.

  • 57-by-3 array — Aircraft Type is Custom.

The rotation applies to the same bones as listed for the Translation port.

The signal contains the rotation [roll, pitch, yaw], in radians, with one row of the array for each bone of the aircraft.

Aircraft light control, specified as a 1-by-7 vector of Boolean values. Each element of the vector turns on or off a specific aircraft light group. The vector has this order:

  • LANDING_LIGHTS

  • TAXI_LIGHTS

  • ANTICOLLISION_BEACONS

  • WINGTIP_STROBE_LIGHTS

  • TAIL_STROBE_LIGHTS

  • NAVIGATION_LIGHTS

  • POSITION_LIGHTS

Dependencies

To enable this port, set the Light Configuration parameter to Configurable lights.

Output

expand all

Aircraft altitude, returned as a 1-by-4 vector. The four altitudes are, in order:

  • aircraft_body

  • aircraft_front_tire

  • aircraft_left_tire

  • aircraft_right_tire

Dependencies

To enable this port, select the Enable altitude sensor check box.

Data Types: double

Aircraft weight on wheels logical switch, returned as true if either of the main gear tires (left or right) are on the ground. Otherwise, false is returned.

Dependencies

To enable this port, select the Enable altitude sensor check box.

Data Types: Boolean

Parameters

expand all

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

Programmatic Use

Block Parameter: SampleTime
Type: character vector
Values: real scalar
Default: '-1'

Aircraft Parameters

Aircraft type, specified as Sky Hogg, Airliner, General Aviation, Air Transport, or Custom.

Dependencies

Setting this parameter requires that you set the Initial Translation and Initial rotation parameters to the matching array size. Failure to appropriately set these array sizes causes an error.

Programmatic Use

Block Parameter: Mesh
Type: character vector
Values: 'Sky Hogg' | 'Airliner' | 'General Aviation' | 'Air Transport' | 'Custom'
Default: 'Sky Hogg'

Path to general aviation mesh, specified as a character vector.

Dependencies

  • To enable this parameter, set Type to General Aviation.

Programmatic Use

Block Parameter: MeshPathGA
Type: character vector
Values: '/MathWorksAerospaceContent/Vehicles/Aircraft/GeneralAviation/Mesh/SK_GeneralAviation.SK_GeneralAviation'
Default: '/MathWorksAerospaceContent/Vehicles/Aircraft/GeneralAviation/Mesh/SK_GeneralAviation.SK_GeneralAviation'

Path to air transport mesh, specified as a character vector.

Dependencies

  • To enable this parameter, set Type to Air Transport.

Programmatic Use

Block Parameter: MeshPathAT
Type: character vector
Values: '/MathWorksAerospaceContent/Vehicles/Aircraft/AirTransport/Mesh/SK_AirTransport.SK_AirTransport'
Default: '/MathWorksAerospaceContent/Vehicles/Aircraft/AirTransport/Mesh/SK_AirTransport.SK_AirTransport'

Path to custom mesh, specified as a character vector.

Dependencies

  • To enable this parameter, set Type to Custom.

Programmatic Use

Block Parameter: MeshPath
Type: character vector
Values: '/MathWorksAerospaceContent/Vehicles/Aircraft/Custom/Mesh/SK_HL20.SK_HL20'
Default: '/MathWorksAerospaceContent/Vehicles/Aircraft/Custom/Mesh/SK_HL20.SK_HL20'

Aircraft color, specified as Red, Orange, Yellow, Green, Cyan, Blue, Black, White, Silver, or Metal.

Programmatic Use

Block Parameter: AircraftColor
Type: character vector
Values: 'Red' | 'Orange' | 'Yellow' | 'Green' | 'Cyan' | 'Blue' | 'Black' | 'White' | 'Silver' | 'Metal'
Default: 'Red'

Aircraft name, specified as a character vector. 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 Aircraft blocks that you have in your model.

Programmatic Use

Block Parameter: ActorName
Type: character vector
Values: scalar
Default: 'SimulinkVehicle1'

Initial Values

Initial translation of aircraft, specified as an 11-by-3, 12-by-3, 15-by-3, 30-by-3, or 57-by-3 array.

Dependencies

This parameter must match the aircraft type you set in Type. Failure to appropriately set these array sizes causes an error.

Programmatic Use

Block Parameter: Translation
Type: character vector
Values: 11-by-3 array | 12-by-3 array | 15-by-3 array | 30-by-3 array | 57-by-3 array
Default: 'zeros(11,3)'

Initial rotation of aircraft, specified as a 11-by-3, 12-by-3, 15-by-3, 30-by-3, or 57-by-3 array.

Programmatic Use

Block Parameter: Rotation
Type: character vector
Values: 11-by-3 array | 12-by-3 array | 15-by-3 array | 30-by-3 array | 57-by-3 array
Default: 'zeros(11,3)'

Altitude Sensor

To enable the altitude sensor, select this check box. Otherwise, clear this check box.

Programmatic Use

Block Parameter: IsGHSensorEnabled
Type: character vector
Values: 'on' | 'off'
Default: 'on'

To enable visible sensor rays, select this check box. Otherwise, clear this check box.

Dependencies

To enable this parameter, select the Enable altitude sensor check box.

Programmatic Use

Block Parameter: AreGHRaysVisible
Type: character vector
Values: 'on' | 'off'
Default: 'off'

Length of rays, specified as a real scalar in meters. The length of the rays limits the altitude detection. For example, if the vertical distance to the ground beneath the aircraft origin is greater than the length of the rays plus the aircraft body Z offset, the altitude sensor returns -1 for the first value.

Dependencies

To enable this parameter, select the Enable altitude sensor check box.

Programmatic Use

Block Parameter: GHRayLength
Type: character vector
Values: real scalar
Default: '1524'

Aircraft body Z offset, specified as a real scalar in meters.

Dependencies

To enable this parameter, select the Enable altitude sensor check box.

Programmatic Use

Block Parameter: GHBodyOffset
Type: character vector
Values: real scalar
Default: '0.90'

Front gear tire radius, specified as a real scalar in meters. The front gear altitude ray originates at the front gear axle center plus the front gear tire radius Z offset.

Dependencies

To enable this parameter, select the Enable altitude sensor check box.

Programmatic Use

Block Parameter: GHFrontTireRadius
Type: character vector
Values: real scalar
Default: '0.21'

Left gear tire radius, specified as a real scalar in meters.

Dependencies

To enable this parameter, select the Enable altitude sensor check box.

Programmatic Use

Block Parameter: GHLeftTireRadius
Type: character vector
Values: real scalar
Default: '0.21'

Right gear tire radius, specified as a real scalar in meters.

Dependencies

To enable this parameter, select the Enable altitude sensor check box.

Programmatic Use

Block Parameter: GHRightTireRadius
Type: character vector
Values: real scalar
Default: '0.21'

Light Configuration

Light configuration options

  • Automatic lights — Use default aircraft lighting configuration that provides realistic pattern cycling.

  • Configurable lights — Configure aircraft lighting parameters.

  • Lights off — Turn off all aircraft lights.

Dependencies

  • Setting this parameter to Automatic lights disables the configurability of all other Light Configuration parameters. The block uses the default parameter values for aircraft lighting values.

  • Setting this parameter to Configurable lights enables the configurability of the Light Configuration parameters according to the aircraft type.

  • Setting Type to these aircraft types and Light Configuration to Configurable lights enables the configurability of the lighting parameters in use for each aircraft.

    TypeLightsLight Parameters
    Airliner

    Landing lights

    • Landing lights intensity (cd)

    • Landing lights cone half angle (deg)

    Taxi lights

    • Taxi lights intensity (cd)

    • Taxi lights cone half angle (deg)

    Red/green navigation lights

    Navigation lights intensity

    White strobe lights

    • Strobe lights intensity

    • Wingtip strobe period (s)

    • Wingtip strobe pulse width (% of period)

    • Tail strobe period (s)

    • Tail strobe pulse width (% of period)

    Red beacon lights

    • Beacon lights intensity

    • Beacon period (s)

    • Beacon pulse width (% of period)

    Sky Hogg

    Landing lights

    • Landing lights intensity (cd)

    • Landing lights cone half angle (deg)

    Red/green navigation lights

    Navigation lights intensity

    White strobe lights

    • Strobe lights intensity

    • Tail strobe period (s)

    • Tail strobe pulse width (% of period)

    Red beacon lights

    • Beacon lights intensity

    • Beacon period (s)

    • Beacon pulse width (% of period)

    General Aviation, Air Transport, or Custom

    Landing lights

    • Landing lights intensity (cd)

    • Landing lights cone half angle (deg)

    • Left landing light location

    • Left landing light orientation

    • Right landing light location

    • Right landing light orientation

    Taxi lights

    • Taxi lights intensity (cd)

    • Taxi lights cone half angle (deg)

    • Taxi lights location

    • Taxi lights orientation (deg)

    Red/green navigation lights

    Navigation lights intensity

    White navigation lights

    Position light intensity

    White strobe lights

    • Strobe lights intensity

    • Wingtip strobe period (s)

    • Wingtip strobe pulse width (% of period)

    • Tail strobe period (s)

    • Tail strobe pulse width (% of period)

    Red beacon lights

    • Beacon lights intensity

    • Beacon period (s)

    • Beacon pulse width (% of period)

  • Setting this parameter to Lights off disables the configurability of all other Light Configuration parameters. The block turns off all aircraft lighting.

Programmatic Use

Block Parameter: 'LightsConfig'
Type: character vector
Values: 'Automatic lights' | 'Configurable lights' | 'Lights off'
Default: 'Automatic lights'

Landing lights intensity, specified as a positive scalar, in candela.

Dependencies

To enable this parameter, set Light configuration to Configurable lights.

Programmatic Use

Block Parameter: 'LandingLightIntensity'
Type: character vector
Values: positive scalar
Default: '30000'

Landing lights cone half angle, specified as a positive scalar, in degrees.

Dependencies

To enable this parameter, set Light configuration to Configurable lights.

Programmatic Use

Block Parameter: 'LandingLightConeAngle'
Type: character vector
Values: positive scalar
Default: '15'

Left landing light location with respect to the associated bone of the skeletal mesh, specified as a 3-element vector.

Dependencies

To enable this parameter, set Type to General Aviation, Air Transport, or Custom and Light configuration to Configurable lights.

Programmatic Use

Block Parameter: 'CustomLeftLandingLightLocation'
Type: character vector
Values: 3-element vector
Default: '[0 0 0]'

Left landing light orientation with respect to the associated bone of the skeletal mesh, specified as a 3-element vector.

Dependencies

To enable this parameter, set Type to General Aviation, Air Transport, or Custom and Light configuration to Configurable lights.

Programmatic Use

Block Parameter: 'CustomLeftLandingLightOrientation'
Type: character vector
Values: 3-element vector
Default: '[0 0 0]'

Right landing light location with respect to the associated bone of the skeletal mesh, specified as a 3-element vector.

Dependencies

To enable this parameter, set Type to General Aviation, Air Transport, or Custom and Light configuration to Configurable lights.

Programmatic Use

Block Parameter: 'CustomRightLandingLightLocation'
Type: character vector
Values: 3-element vector
Default: '[0 0 0]'

Right landing light orientation with respect to the associated bone of the skeletal mesh, specified as a 3-element vector.

Dependencies

To enable this parameter, set Type to General Aviation, Air Transport, or Custom and Light configuration to Configurable lights.

Programmatic Use

Block Parameter: 'CustomRightLandingLightOrientation'
Type: character vector
Values: 3-element vector
Default: '[0 0 0]'

Taxi lights intensity, specified as a positive scalar, in candela.

Dependencies

To enable this parameter, set Type to Airliner, General Aviation, Air Transport, or Custom and Light configuration to Configurable lights.

Programmatic Use

Block Parameter: 'TaxiLightIntensity'
Type: character vector
Values: positive scalar
Default: '150000'

Taxi lights cone half angle, specified as a positive scalar, in degrees.

Dependencies

To enable this parameter, set Type to Airliner, General Aviation, Air Transport, or Custom and Light configuration to Configurable lights.

Programmatic Use

Block Parameter: 'TaxiLightConeAngle'
Type: character vector
Values: positive scalar
Default: '36'

Taxi lights location with respect to the associated bone of the skeletal mesh, specified as a 3-element vector

Dependencies

To enable this parameter, set Type to General Aviation, Air Transport, or Custom and Light configuration to Configurable lights.

Programmatic Use

Block Parameter: 'CustomTaxiLightLocation'
Type: character vector
Values: positive scalar
Default: '[0 0 0]'

Taxi lights orientation with respect to the associated bone of the skeletal mesh, specified as a 3-element vector

Dependencies

To enable this parameter, set Type to General Aviation, Air Transport, or Custom and Light configuration to Configurable lights.

Programmatic Use

Block Parameter: 'CustomTaxiLightOrientation'
Type: character vector
Values: positive scalar
Default: '[0 0 0]'

Navigation lights intensity, specified as a positive scalar.

Dependencies

To enable this parameter, set Light configuration to Configurable lights.

Programmatic Use

Block Parameter: 'NavLightIntensity'
Type: character vector
Values: positive scalar
Default: '500'

Position light intensity, specified as a positive scalar.

Dependencies

To enable this parameter, set Light configuration to Configurable lights.

Programmatic Use

Block Parameter: 'PositionLightIntensity'
Type: character vector
Values: positive scalar
Default: '500'

Strobe lights intensity, specified as a positive scalar.

Dependencies

To enable this parameter, set Light configuration to Configurable lights.

Programmatic Use

Block Parameter: 'StrobeLightIntensity'
Type: character vector
Values: positive scalar
Default: '5000'

Wingtip strobe period, specified as a positive scalar.

Dependencies

To enable this parameter, set Type to Airliner, General Aviation, Air Transport, or Custom and Light configuration to Configurable lights.

Programmatic Use

Block Parameter: 'WingtipStrobePeriod'
Type: character vector
Values: positive scalar
Default: '1.5'

Wingtip strobe pulse width, specified as a positive scalar.

Dependencies

To enable this parameter, set Type to Airliner, General Aviation, Air Transport, or Custom and Light configuration to Configurable lights.

Programmatic Use

Block Parameter: 'WingtipStrobePulseWidth'
Type: character vector
Values: positive scalar
Default: '6'

Tail strobe period, specified as a positive scalar, in seconds.

Dependencies

To enable this parameter, set Light configuration to Configurable lights.

Programmatic Use

Block Parameter: 'TailStrobePeriod'
Type: character vector
Values: positive scalar
Default: '1.5'

Tail strobe pulse width, specified as a positive scalar.

Dependencies

To enable this parameter, set Light configuration to Configurable lights.

Programmatic Use

Block Parameter: 'TailStrobePulseWidth'
Type: character vector
Values: positive scalar
Default: '6'

Beacon lights intensity, specified as a positive scalar.

Dependencies

To enable this parameter, set Light configuration to Configurable lights.

Programmatic Use

Block Parameter: 'BeaconLightIntensity'
Type: character vector
Values: positive scalar
Default: '4000'

Beacon period, specified as a positive scalar, in seconds.

Dependencies

To enable this parameter, set Light configuration to Configurable lights.

Programmatic Use

Block Parameter: 'BeaconPeriod'
Type: character vector
Values: positive scalar
Default: '1.5'

Beacon pulse width, specified as a positive scalar.

Dependencies

To enable this parameter, set Light configuration to Configurable lights.

Programmatic Use

Block Parameter: 'BeaconPulseWidth'
Type: character vector
Values: positive scalar
Default: '10'

Algorithms

expand all

This topic lists how the block input arrays, 11-by-3, 12-by-3, 15-by-3, 30-by-3, and 57-by-3, connect to their associated aircraft types.

Version History

Introduced in R2021b

expand all