Aero.Body Class

Namespace: Aero

Create body object for use with animation object

Description

Use the Aero.Body class to create a body object for use with an Aero.Animation object. To use the Aero.Body object, you typically:

1. Create the animation body.

2. Configure or customize the body object.

3. Load the body.

4. Generate patches for the body. This step requires an axes from a figure.

5. Set the timeseries data source.

6. Move or update the body.

By default, an Aero.Body object natively uses aircraft x-y-z coordinates for the body geometry and the timeseries data. It expects the rotation order z-y-x (psi, theta, phi).

Convert timeseries data from other coordinate systems by registering a different CoordTransformFcn function.

The Aero.Body class is a handle class.

Creation

h = Aero.Body constructs a body for an animation object. The animation object is returned in h.

Properties

Name — Name of body

'' (default) | character vector | string scalar

Name of body, specified as a character vector or string scalar.

Attributes:

GetAccess	public
SetAccess	public

Data Types: string | char

CoordTransformFcn — Function that controls coordinate transformation

@nullCoordTransform (default) | function handle | character vector | string scalar

Function that controls coordinate transformation, specified as a function handle, character vector, or string scalar.

Attributes:

GetAccess	public
SetAccess	public

Position — Position of body

[0 0 0] (default) | MATLAB^® array

Position of body, specified as a MATLAB array.

Attributes:

GetAccess	public
SetAccess	public

Data Types: double

Rotation — Rotation of body

[0 0 0] (default) | MATLAB array

Rotation of body, specified as a MATLAB array.

Attributes:

GetAccess	public
SetAccess	public

Data Types: double

Geometry — Geometry of body

[1×1 Aero.Geometry] (default) | handle

Geometry of body, specified as a handle.

Attributes:

GetAccess	public
SetAccess	public

Data Types: double

PatchGenerationFcn — Patch generation function

@generatePatchesFromFvcData (default) | function handle | character vector | string scalar

Patch generation function, specified as a function handle, character vector, or string scalar.

Attributes:

GetAccess	public
SetAccess	public

PatchHandles — Patch handles

[] (default) | MATLAB array

Patch handles, specified as a MATLAB array.

Attributes:

GetAccess	public
SetAccess	public

Data Types: double

ViewingTransform — Viewing transform

[] (default) | scalar

Viewing transform, specified as a scalar.

Attributes:

GetAccess	public
SetAccess	public

TimeSeriesSource — Time series data source

timeseries object | timetable object | StructureWithTime | double precision array

Time series source, specified as a time series source.

The time series data property stored in and interpreted according to the 'TimeSeriesSourceType' property.

Attributes:

GetAccess	public
SetAccess	public

TimeSeriesSourceType — Type of timeseries source

'Array6DoF' (default) | 'Timeseries' | 'Timetable' | 'StructureWithTime' | 'Array3DoF' | 'Custom'

Type of timeseries data stored in 'TimeSeriesSource' property, specified as one of these values:

timeseries Type	Description
'Array6DoF'	A double-precision array in n rows and seven columns for 6-DoF data: time x y z phi theta psi. If a double-precision array of eight or more columns is in 'TimeSeriesSource', the first seven columns are used as 6-DoF data.
'Timeseries'	MATLAB timeseries data with six values per time: x y z phi theta psi The values are resampled.
'Timetable'	MATLAB timetable data with six values per time: x y z phi theta psi The values are resampled.
'StructureWithTime'	Simulink struct with time, for example, Simulink root outport logging 'Structure with time': signals(1).values: x y z signals(2).values: phi theta psi Signals are linearly interpolated versus time using interp1.
'Array3DoF'	A double-precision array in n rows and four columns for 3-DoF data: time x z theta. If a double-precision array of five or more columns is in 'TimeSeriesSource', the first four columns are used as 3-DoF data.
'Custom'	Position and angle data are retrieved from 'TimeSeriesSource' by the currently registered 'TimeseriesReadFcn'.

Attributes:

GetAccess	public
SetAccess	public

Data Types: string | char

TimeSeriesReadFcn — timeseries read function

@interp6DoFArrayWithTime (default) | function handle | character vector | string

timeseries read function, specified as a function handle, character vector, or string.

Attributes:

GetAccess	public
SetAccess	public

Methods

Public Methods

findstartstoptimes	Return start and stop times of time series data
generatePatches	Generate patches for body with loaded face, vertex, and color data
load	Get geometry data from source
move	Change animation body position and orientation
update	Update body position and orientation as function of time

Examples

Create Aero.Body Object

h = Aero.Body

h = 
  Body with properties:

                    Name: ''
       CoordTransformFcn: @nullCoordTransform
                Position: [0 0 0]
                Rotation: [0 0 0]
                Geometry: [1×1 Aero.Geometry]
      PatchGenerationFcn: @generatePatchesFromFvcData
            PatchHandles: []
        ViewingTransform: []
        TimeSeriesSource: []
    TimeSeriesSourceType: 'Array6DoF'
       TimeSeriesReadFcn: @interp6DoFArrayWithTime

Update Body

This example shows how to update the body, b, with time in seconds of 5.

b = Aero.Body;
b.load('pa24-250_orange.ac','Ac3d'); 
tsdata = [ ...
    0,  1,1,1, 0,0,0; ...
    10  2,2,2, 1,1,1; ];
b.TimeSeriesSource = tsdata;
b.update(5);

Version History

Introduced in R2007a