Aircraft

SWITCH TO MANUAL

Class in Zendir.Classes | Inherits from Vehicle

Declaration

class Aircraft;

---

Description

An aircraft is a vehicle that can travel through the full three-dimensional local coordinate frame. Its nose heading is independent of its track and flight-path angle, and its altitude, climb, and turn can be limited.

---

Properties

Declared	Description
FlightPathAngle	Commanded angle of the travel direction above the horizontal plane [deg].Positive values climb and negative values descend.
MaxClimbRate	Maximum absolute vertical speed [m/s]. A value of 0 disables the limit.
MaxTurnRate	Maximum heading and track change [deg/s]. A value of 0 disables the limit.
MinimumAltitude	Lowest permitted geodetic altitude [m]. Descent stops at this altitude.
Out_AircraftStateMsg	The latest flight-state report for this aircraft.
Track	Commanded horizontal travel direction, clockwise from true north [deg].This is independent of .

Inherited	Description
AlignHeadingToRoute	Whether waypoint travel sets the body heading from the horizontal leg.When disabled, the route still moves the vehicle and leaves heading unchanged.
Altitude	The altitude that the object is located above the surface of the planet.
Behaviours	A collection of behaviours attached to this object.
CenterOfMassB_B	The center of mass of the component in respect to the body frame (B) of the component. This is isolated from anychildren and exists in isolation.
CenterOfMassDot_LB_B	The center of mass time-derivative of the component within its own local coordinates. This does not include anyof the sub-components and exists in isolation.
CenterOfMassDotB_B	The center of mass time-derivative of the component relative to the body frame (B). This does not include any ofthe sub-components and exists in isolation.
CenterOfMassL_L	The center of mass of the component within its own local coordinates. This does not include any of thesub-components and exists in isolation.
CenterOfMassPrime_LB_B	The center of mass general-derivative of the component within its own local coordinates. This does not includeany of the sub-components and exists in isolation.
CenterOfMassPrimeB_B	[m/s] The center of mass general-derivative of the component relative to the body frame (B). This does notinclude any of the sub-components and exists in isolation.
Children	A collection of children attached to this object.
Coordinates	The coordinates of the vehicle in the origin coordinate system. Thisis relative to the 0, 0, 0 location and always along the surface ofthe planet, where the Y axis is the origin’s north direction, the X axisis 90 degrees clockwise from the north direction, and the Z axis is uptowards the zenith from the ground.
DCM_BN	The rotational DCM matrix between the body frame (B) at the top of this component chain and the inertial frame (N).
DCM_LB	The rotational DCM matrix between the component frame of this object (L) relative to the body frame (B).
DCM_LN	The DCM rotational matrix of the component relative to the inertial origin (N) of the world.
DCM_LP	Rotation matrix from planet-centered, planet-fixed frame P to site-local topographic (SEZ) frame L coordinates.
EulerAngles	The euler angles, as a roll, pitch, yaw set, of the vehicle indegrees.
Heading	The clockwise body heading from true north [deg]. Ground vehicles and vesselstravel in this direction while not following a waypoint route.
In_PlanetStateMsg	A reference to the message for the planet attached to.
IsEnabled	Is true if the object is currently enabled.
Latitude	The latitude that this object is located at on the surface of the planet.
LocalForward	The direction of the transform frame’s forward vector, which is along the Y axis.
LocalRight	The direction of the transform frame’s right vector, which is along the X axis.
LocalUp	The direction of the transform frame’s up vector, which is along the Z axis.
Longitude	The longitude that this object is located at on the surface of the planet.
LoopWaypoints	Whether a completed route starts again at its first waypoint.
Mass	The component mass defined in the object. This is independent of any parent or children objects and exists inisolation.
MassDot	The component mass time-derivative defined in the object. This is independent of any parent or children objectsand exists in isolation.
Models	A collection of models attached to this object.
MomentOfInertia_LB	The moment of inertia of the component, measured at the local center of mass, represented with its own localcoordinates. This does not include any of the sub-components and exists in isolation.
MomentOfInertiaB_B	The moment of inertia of this component, measured in the body frame relative to the parented body. This isindependent of any children and exists in isolation.
MomentOfInertiaPrime_LB	The derivative of the moment of inertia of the component, measured at the local center of mass, represented withits own local coordinates. This does not include any of the sub-components and exists in isolation.
MomentOfInertiaPrimeB_B	The derivative of the moment of inertia of the component, represented in the body frame (B). This is independentand exists in isolation.
Name	The display name or tag of this object.
OriginNorth	The northing of the origin of the coordinate system. This defines theangle, relative to true north along the surface, where 0, 0, 0 is located.This is a clockwise angle between 0 and 360 degrees.
Out_ComponentMassMsg	The component mass message defines the set of mass properties and states of the system within this componentlocally. This is independent of any parent or children properties or objects.
Out_GeodeticMsg	The message defining the geodetic location of the Geodetic Object relative to the Planet.
Out_GroundStateMsg	The Ground state message contains all the information about the current state of the Geodetic Object in inertialspace.
Out_TransformMsg	This defines the base transform message that stores the state of the transform of this object.
Out_VehicleStateMsg	The output message storing the state of the vehicle and thecurrent origin and position data.
Parent	The currently attached parent object (if any).
PCPF_P	Initial Ground Location to Planet origin vector in planet frame coordinates.
Planet	The name of the planet that the Geodetic Object is located on.
Position	[m] The position of the object relative to the parent or to world origin, if no parent exists.
Position_BN_N	The position of the body (the root parent B) in the inertial frame relative to the inertial point (N).
Position_LB_B	The position of the component relative to the root object of this hierarchy. This is in the inertial frame and ifthe component is the root object, then there will be no position.
Position_LN_N	The position of the inertial world space. This position is derived from the world’s transform (N).
Position_LP_P	The position of the object relative to the parented object (P). If there is no parent object, then this will bein the inertial frame.
Quaternion	The quaternion that defines the rotation of the vehicle in the originreference frame.
Root	The root object in the parent chain.
Rotation	[-] The rotation of the object relative to the parent or to the world origin, if no parent exists.
Speed	The commanded travel speed [m/s].
Thermal	[TEMPORARY] A reference to the thermal model that is attached to this object. This will allow the object to havethermal properties and be able to be used in thermal simulations.
VehicleForwardAxis	Defines the up axis relative to the vehicle and the ground. This willbe in the Z axis of the coordinate frame, in the origin coordinate frame.
VehicleRightAxis	Defines the right axis relative to the vehicle and the ground. This willbe in the X axis of the coordinate frame, in the origin coordinate frame.
VehicleUpAxis	Defines the forward axis relative to the vehicle and the ground. This willbe in the Y axis of the coordinate frame, in the origin coordinate frame.
WaypointArrivalTolerance	Distance from a waypoint at which it is considered reached [m].
Waypoints	Ordered geodetic route. While this array is non-empty, the vehicle followsits waypoints instead of heading-controlled travel. Each vector stores latitude[deg], longitude [deg], and altitude [m].

---

Methods

Inherited	Description
AddObject	Returns a new simulation object with the specified type.
Attach	Attempts to attach this object to a new parent. This will only work if the current object is no parented to anyother object.
ClearWaypointRoute	Removes all waypoints and stops waypoint-controlled motion.
ContainsModelWithID	Returns true if an attached model satisfies the specified ID.
ContainsModelWithType	Returns true if an attached model satisfies the specified type.
Detach	This is an action to detach the current object from its parent, if it exists and move it to another object or tojust exist within the simulation.
FindBehavioursWithType	Returns all attached behaviours that satisfies the specified type.
FindBehaviourWithID	Returns an attached behaviour that satisfies the specified ID.
FindBehaviourWithType	Returns an attached behaviour that satisfies the specified type.
FindChildrenWithType	Returns all attached children that satisfies the specified type.
FindChildWithID	Returns an attached child that satisfies the specified ID.
FindChildWithType	Returns an attached child that satisfies the specified type.
FindModelsWithType	Returns all attached models that satisfies the specified type.
FindModelWithID	Returns an attached model that satisfies the specified ID.
FindModelWithType	Returns an attached model that satisfies the specified type.
FindParentWithID	Returns an attached parent that satisfies the specified ID.
FindParentWithType	Returns an attached parent that satisfies the specified type.
FindRootWithID	Returns a root object that satisfies the specified ID.
FindRootWithType	Returns a root object that satisfies the specified type.
GetModel	Returns a valid assigned model with the specified type.
GetWorldForward	[DEPRECATED] THIS FUNCTION WILL BE REMOVED AND SHOULD NOT BE USED.
GetWorldRight	[DEPRECATED] THIS FUNCTION WILL BE REMOVED AND SHOULD NOT BE USED.
GetWorldTransform	Returns the world transform of the object which is relative to the parent. If no parent exists, this will be thetransform of the object in world space.
GetWorldUp	[DEPRECATED] THIS FUNCTION WILL BE REMOVED AND SHOULD NOT BE USED.
ReadBodyTransform	This method will reset the dirty flag on the mass so that it has been read successfully and is valid.
SetGroundPosition	Sets the position of the Geodetic Object relative to the planet. This will update the PCPF value and the inertialcoordinates. This will be relative to the planet and with the planet’s rotation.
SetLocation	Updates the location of the ground body relative to the planet. If the location needs to be changed during theruntime, this function should be called and not the updating of the fields.
SetWaypointRoute	Replaces the current route and begins moving towards its first geodetic waypoint.
SetWorldTransform	[DEPRECATED] THIS FUNCTION WILL BE REMOVED AND SHOULD NOT BE USED.
UpdateMassProperties	Updates the mass properties of the current physical object at a particular time.