Aero.FlightGearAnimation
Construct FlightGear animation object
Description
The Aero.flightGearAnimation
constructs a
FlightGear
animation object to visualize flight data using
FlightGear flight simulator.
Creation
Description
creates
a FlightGear animation object h
= Aero.FlightGearAnimationh
.
Properties
TimeSeriesSource
— Variable that contains the time series data
array
Variable that contains the time series data, specified as a MATLAB® array.
TimeSeriesSourceType
— Type of time series data stored in 'TimeSeriesSource'
'Timeseries'
(default) | 'Array6DoF'
| 'Array3DoF'
| 'StructureWithTime'
| 'Timetable'
| 'Custom'
Type of time series data stored in
'TimeSeriesSource'
, specified as one of
'Timeseries'
, 'Array6DoF'
,
'Array3DoF'
, 'StructureWithTime'
,
'Timetable'
, or 'Custom'
.
'Timeseries'
– MATLABtimeseries
data with six values per time:lat lon alt phi theta psi
The values are resampled.
'Timetable'
– MATLABtimetable
data with six values per time:lat lon alt phi theta psi
The values are resampled.
'StructureWithTime'
– Simulink®struct
with time:signals(1).values: lat lon alt
signals(2).values: phi theta psi
'Timetable'
– MATLABtimetable
data with six values per time:lat lon alt phi theta psi
The values are resampled.
'Array6DoF'
– A double-precision array inn
rows and 7 columns for 6-DoF data:time lat lon alt 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 inn
rows and 4 columns for 3-DoF data:time lat alt theta
. If a double-precision array of 5 or more columns is in'TimeSeriesSource'
, the first 4 columns are used as 3-DoF data.'Array3DoF'
– A double-precision array inn
rows and 4 columns for 3-DoF data:time lat alt 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'
.
Data Types: string
TimeseriesReadFcn
— Function to read time series data
function handle
Function to read time series data when
'TimeSeriesSourceType'
value is
'Custom'
.
Data Types: function_handle
TimeScaling
— Seconds of animation data per second of wall-clock time
1 (default) | positive real scalar
Seconds of animation data per second of wall-clock time, specified as a positive real scalar.
Data Types: double
FramesPerSecond
— Number of frames per second used to animate the 'TimeSeriesSource'
12 (default) | positive real scalar
Number of frames per second used to animate the
'TimeSeriesSource'
, specified as a positive real
scalar.
Data Types: double
OutputFileName
— Name of the output file
'runfg.bat'
(default) | string
Name of the output file, specified as a string. The file name is the name of the command you will use to start FlightGear with these initial parameters.
Note
The run script file name must be composed of ASCII characters.
Data Types: string
FlightGearBaseDirectory
— Name of FlightGear installation folder
'D:\Applications\FlightGear'
(default) | string
Name of FlightGear installation folder, specified as a string.
Note
FlightGear must be installed in a folder path name composed of ASCII characters.
Data Types: string
GeometryModelName
— Name of folder containing desired model geometry
'HL20'
(default) | string
Name of the folder containing the desired model geometry in the
FlightGear
\data\Aircraft
folder.
Data Types: string
DestinationIpAddress
— Destination IP address
'127.0.0.1'
(default) | string
Destination IP address, specified as a string.
Data Types: string
DestinationPort
— Network flight dynamics model (FDM) port
'5502'
(default) | string
Network flight dynamics model (FDM) port, specified as a string.
Data Types: string
AirportId
— Airport ID
'KSFO'
(default) | string
Airport ID, specified as a string. The list of supported airports is available in the FlightGear interface, under Location.
Data Types: string
RunwayId
— Runway ID
'10L'
(default) | string
Runway ID, specified as a string.
InitialAltitude
— Initial altitude of the aircraft
7224
(default) | real positive scalar
Initial altitude of the aircraft, in feet, specified as a real positive scalar.
Data Types: double
InitialHeading
— Initial heading of the aircraft
113
(default) | real positive scalar
Initial heading of the aircraft, in degrees, specified as a real positive scalar.
Data Types: double
OffsetDistance
— Offset distance of the aircraft from the airport
4.72
(default) | real positive scalar
Offset distance of the aircraft from the airport, in miles, specified as a real positive scalar.
Data Types: double
OffsetAzimuth
— Offset azimuth of the aircraft
0
(default) | real positive scalar
Offset azimuth of the aircraft, in degrees, specified as a real positive scalar.
Data Types: double
TStart
— Start time
real positive scalar
Start time of the aircraft, specified as a real positive scalar.
Data Types: double
TFinal
— End time
real positive scalar
End time of the aircraft, specified as a real positive scalar.
Dependencies
Comparison of values of TStart
and
TFinal
:
Must be numeric.
Cannot be
Inf
orNaN
.TFinal
must be greater than or equal toTStart
.TFinal
cannot be greater than the maximum of the timeseries time.TStart
cannot be less than the minimum of the timeseries time.
InstallScenery
— Install required scenery
off
(default) | on
Direct FlightGear to automatically install required scenery while the simulator is running. This property requires a steady internet connection. For Windows® systems, you may encounter an error message while launching FlightGear with this option enabled. For more information, see Installing Additional FlightGear Scenery.
Data Types: logical
DisableShaders
— Deactivate FlightGear shader options
off
(default) | on
Deactivate FlightGear shader options. Your computer built-in video card, such as NVIDIA® cards, can conflict with FlightGear shaders. Consider using this property if you have this conflict.
Data Types: logical
Architecture
— Architecture of FlightGear software
'Default'
(default) | 'Win64'
| 'Linux'
| 'Mac'
| 'MacARM'
Architecture the FlightGear software is running on, specified as one of
'Win64'
, 'Linux'
,
'Mac'
, 'MacARM'
, or
'Default'
. GenerateRunScript
generates
the bash run script to start FlightGear based on the architecture specified.
The platforms are:
'Default'
– Architecture the MATLAB software is currently running on. If the property has this value,GenerateRunScript
creates a bash file that can work in the architecture that MATLAB is currently running on.'Win64'
– Windows (64-bit) architecture.'Mac'
– Mac OS X (64-bit) architecture.'Linux'
– Linux® (64-bit) architecture.
.
Object Functions
ClearTimer | Clear and delete timer for animation of FlightGear flight simulator |
delete | Destroy FlightGear animation object |
GenerateRunScript | Generate run script for FlightGear flight simulator |
SetTimer | Set name of timer for animation of FlightGear flight simulator |
initialize | Set up FlightGear animation object |
update | Update position data to FlightGear animation object |
play | Animate FlightGear flight simulator using given position/angle time series |
wait | Wait until animation is done playing |
Examples
Initialize Animation Object
This example shows how to initialize the animation object, h
.
h = Aero.FlightGearAnimation; h.initialize();
Limitations
FlightGear is not supported in MATLAB Online™.
Version History
Introduced in R2007a
See Also
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)