play

(To be removed) Animate virtual reality world for given position and angle in time series data

Simulink 3D Animation Viewer used by play has been removed. Aero.VirtualRealityAnimation does not open or play animations. Use sim3d classes in Unreal Engine 3d Environment to create and view a 3D environment instead. For more information on transitioning to the new 3D environment, see Transition Aero.VirtualRealityAnimation to Unreal Engine 3D Environment.

Syntax

play(h)

Description

play(h) animates the virtual reality world in h for the current TimeseriesDataSource at the specified rate given by the 'TimeScaling' property (in seconds of animation data per second of wall-clock time) and animated at a certain number of frames per second using the 'FramesPerSecond' property.

Input Arguments

h — Virtual reality animation object

Aero.VirtualRealityAnimation object

Virtual reality animation object, specified as an Aero.VirtualRealityAnimation object.

More About

Algorithm

The time series data is interpreted according to the 'TimeSeriesSourceType' property, which can be one of:

'timeseries'	MATLAB® time series data with six values per time: x y z phi theta psi The values are resampled.
'Simulink.Timeseries'	Simulink.Timeseries (Simulink® signal logging): First data item x y z Second data item phi theta psi
'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 vs. time using interp1.
'Array6DoF'	A double-precision array in n rows and 7 columns for 6-DoF data: time x y z phi theta psi. If a double-precision array of 8 or more columns is in 'TimeSeriesSource', the first 7 columns are used as 6-DoF data.
'Array3DoF'	A double-precision array in n rows and 4 columns for 3-DoF data: time x z theta. If a double-precision array of 5 or more columns is in 'TimeSeriesSource', the first 4 columns are used as 3-DoF data.
'Custom'	Position and angle data is retrieved from 'TimeSeriesSource' by the currently registered 'TimeseriesReadFcn'.

The time advancement algorithm used by play is based on animation frames counted by ticks:

ticks = ticks + 1;
time  = tstart + ticks*FramesPerSecond*TimeScaling;

where

TimeScaling	Specify the seconds of animation data per second of wall-clock time.
FramesPerSecond	Specify the number of frames per second used to animate the 'TimeSeriesSource'.

For default 'TimeseriesReadFcn' methods, the last frame played is the last time value.

Time is in seconds, position values are in the same units as the geometry data loaded into the animation object, and all angles are in radians.

Version History

Introduced in R2007b

R2025a: Removed

Simulink 3D Animation Viewer used by play has been removed. Aero.VirtualRealityAnimation does not open or play animations.

R2024b: To be removed

Aero.VirtualRealityAnimation will be removed in a future release.