DtRotaryWingEntityParameters Class Reference

The moving-object-param parameter type is used to configure rotary-wing type of entities. More...

Inheritance diagram for DtRotaryWingEntityParameters:

List of all members.

Public Member Functions
	DtRotaryWingEntityParameters (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	constructor with parameters to set up read/writability correctly
const DtRotaryWingEntityParameters &	operator= (const DtRotaryWingEntityParameters &orig)
virtual	~DtRotaryWingEntityParameters ()
	destructor
virtual DtVrfObjectParameters *	clone (const DtSymbolString &rwName, DtReaderWriterRegistry *parentRegistry=0) const
virtual DtVrfObjectParameters *	clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const
virtual DtString	type () const
	Should return the type of entity this is a parameter block for.
virtual bool	inheritValues (const DtVrfObjectParameters *benefactor)
	Values left unspecified may be inherited from a parameter block of the same type, typically an ancestor in the DIS/RPR entity type hierarchy. (
virtual void	inheritValuesFromThisType (const DtRotaryWingEntityParameters *benefactor)
virtual void	setDefaults ()
	Sets all the default values for flight and rotary wing parameters.
virtual void	copyValues (const DtRotaryWingEntityParameters &orig)
	Used by copy constructor and = operator to copy all member values.
virtual DtReal	maxYawAcceleration () const
virtual void	setMaxYawAcceleration (const DtReal val)
virtual DtReal	maxPitchAcceleration () const
virtual void	setMaxPitchAcceleration (const DtReal val)
virtual DtReal	maxRollAcceleration () const
virtual void	setMaxRollAcceleration (const DtReal val)
virtual DtReal	zeroCollectiveLiftAcceleration () const
virtual void	setZeroCollectiveLiftAcceleration (const DtReal val)
virtual DtReal	fullCollectiveLiftAcceleration () const
virtual void	setFullCollectiveLiftAcceleration (const DtReal val)
virtual const DtVector &	noseSupport () const
	Offset in body coordinates to forward support point.
virtual void	setNoseSupport (const DtVector &noseSupport)
	Offset in body coordinates to forward support point.
virtual DtReal	maxAltitude () const
	Accessor/mutator for myMaxAltitude.
virtual void	setMaxAltitude (DtReal maxAltitude)
	Accessor/mutator for myMaxAltitude.
virtual bool	isCheckingTerrainDistance () const
	Accessor/mutator for myIsCheckingTerrainDistance.
virtual void	setIsCheckingTerrainDistance (const bool val)
	Accessor/mutator for myIsCheckingTerrainDistance.
virtual DtReal	altitude () const
	Accessor/mutator for altitude in meters.
virtual void	setAltitude (const DtReal val)
	Accessor/mutator for altitude in meters.
virtual void	setJoystickControl (const bool val)
	Accessor/mutator for myJoystickControl.
virtual bool	joystickControl () const
	Accessor/mutator for myJoystickControl.
virtual DtReal	maxClimbRate () const
	Accessor/mutator for myMaxClimbRate.
virtual void	setMaxClimbRate (DtReal maxClimbRate)
	Accessor/mutator for myMaxClimbRate.
virtual DtReal	maxYawRate () const
	Accessor/mutator for myMaxYawRate.
virtual void	setMaxYawRate (DtReal maxYawRate)
	Accessor/mutator for myMaxYawRate.
virtual DtReal	maxPitchRate () const
	Accessor/mutator for myMaxPitchRate.
virtual void	setMaxPitchRate (DtReal maxPitchRate)
	Accessor/mutator for myMaxPitchRate.
virtual DtReal	maxRollRate () const
	Accessor/mutator for myMaxRollRate.
virtual void	setMaxRollRate (DtReal maxRollRate)
	Accessor/mutator for myMaxRollRate.
Static Public Member Functions
static DtVrfObjectParameters *	creator ()
Protected Member Functions
	DtRotaryWingEntityParameters (const DtRotaryWingEntityParameters &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
Protected Attributes
DtReal	myAltitude
Parameters
These parameters are available for setting in the OPD files.
DtRwReal	myMaxAltitude
	Parameter Name: max-altitude Parameter Description: Above this altitude no lift is generated.
DtRwBoolean	myJoystickControl
	Parameter Name: joystick-control Parameter Description: Specifies whether or not you can use a joystick to control rotary-wing entities.
DtRwBoolean	myIsCheckingTerrainDistance
	Parameter Name: terrain-check Parameter Description: Parameter Default Value: .
DtRwReal	myMaxClimbRate
	Parameter Name: max-climb-rate Parameter Description: Parameter Default Value: 50.
DtRwReal	myMaxYawRate
	Parameter Name: max-yaw-rate Parameter Description: Maximum rate this plane can pitch down or up about its Y axis (due to stick).
DtRwReal	myMaxPitchRate
	Parameter Name: max-pitch-rate Parameter Description: Parameter Default Value: 0.7854 (45.
DtRwReal	myMaxRollRate
	Parameter Name: max-roll-rate Parameter Description: Maximum rate this plane can rotate about its X axis (due to stick).
DtRwReal	myMaxYawAcceleration
	Parameter Name: max-yaw-acceleration Parameter Description: The maximum rotational acceleration around the body Z axis (due to pedal).
DtRwReal	myMaxPitchAcceleration
	Parameter Name: max-pitch-acceleration Parameter Description: Maximum rotational acceleration about the Y axis in radians per second squared.
DtRwReal	myMaxRollAcceleration
	Parameter Name: max-roll-acceleration Parameter Description: Maximum rotational acceleration around the X axis in radians per second squared.
DtRwReal	myZeroCollectiveLiftAcceleration
	Parameter Name: zero-collective-lift-acceleration Parameter Description: The upward acceleration when the collective is at zero, assuming no gravity.
DtRwReal	myFullCollectiveLiftAcceleration
	Parameter Name: full-collective-lift-acceleration Parameter Description: This is the upward acceleration when the collective is at full, assuming no gravity.

---

Detailed Description

The moving-object-param parameter type is used to configure rotary-wing type of entities.

Developer Description: Used to hold parameters for the DtVrfMovingObjectStateRepository class.

---

Constructor & Destructor Documentation

DtRotaryWingEntityParameters::DtRotaryWingEntityParameters	(	const DtString &	rwName = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = 0
	)

constructor with parameters to set up read/writability correctly

DtRotaryWingEntityParameters::DtRotaryWingEntityParameters	(	const DtRotaryWingEntityParameters &	orig,
		const DtString &	rwName = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = 0
	)		[protected]

copy constructor

virtual DtRotaryWingEntityParameters::~DtRotaryWingEntityParameters

(

)

[virtual]

destructor

---

Member Function Documentation

const DtRotaryWingEntityParameters& DtRotaryWingEntityParameters::operator=

(

const DtRotaryWingEntityParameters &

orig

)

virtual DtVrfObjectParameters* DtRotaryWingEntityParameters::clone	(	const DtSymbolString &	rwName,
		DtReaderWriterRegistry *	parentRegistry = 0
	)		const [virtual]

Reimplemented from DtMovingObjectParameters.

Reimplemented in DtSubsurfaceEntityParameters.

virtual DtVrfObjectParameters* DtRotaryWingEntityParameters::clone	(	const DtString &	rwName = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = 0
	)		const [virtual]

Reimplemented from DtMovingObjectParameters.

Reimplemented in DtSubsurfaceEntityParameters.

virtual DtString DtRotaryWingEntityParameters::type

(

)

const [virtual]

Should return the type of entity this is a parameter block for.

Use the strings in vrfParamTypes.h.

Reimplemented from DtMovingObjectParameters.

Reimplemented in DtSubsurfaceEntityParameters.

virtual bool DtRotaryWingEntityParameters::inheritValues

(

const DtVrfObjectParameters *

benefactor

)

[virtual]

Values left unspecified may be inherited from a parameter block of the same type, typically an ancestor in the DIS/RPR entity type hierarchy. (

For example, US ground vehicle (1 1 225 0 0 0 0) and US Large wheeled utility vehicle (1 1 225 7 0 0 0) might both have DtGroundVehicleParameters parameter blocks. If some or even all parameters are left unspecified for (1 1 225 7 0 0 0), it can inherit them from (1 1 225 0 0 0 0), its DIS/RPR ancestor.
The direct ancestor of a parameter block might use a parameter type that is different (and most likely a class the parameter block is derived from). Every parameter block type also knows how to inherit from the type it is derived from. ( const DtVrfObjectParameters* benefactor)

Reimplemented from DtMovingObjectParameters.

virtual void DtRotaryWingEntityParameters::inheritValuesFromThisType

(

const DtRotaryWingEntityParameters *

benefactor

)

[virtual]

virtual const DtVector& DtRotaryWingEntityParameters::noseSupport

(

)

const [virtual]

Offset in body coordinates to forward support point.

virtual void DtRotaryWingEntityParameters::setNoseSupport

(

const DtVector &

noseSupport

)

[virtual]

Offset in body coordinates to forward support point.

virtual DtReal DtRotaryWingEntityParameters::maxAltitude

(

)

const [virtual]

Accessor/mutator for myMaxAltitude.

virtual void DtRotaryWingEntityParameters::setMaxAltitude

(

DtReal

maxAltitude

)

[virtual]

Accessor/mutator for myMaxAltitude.

virtual bool DtRotaryWingEntityParameters::isCheckingTerrainDistance

(

)

const [virtual]

Accessor/mutator for myIsCheckingTerrainDistance.

virtual void DtRotaryWingEntityParameters::setIsCheckingTerrainDistance

(

const bool

val

)

[virtual]

Accessor/mutator for myIsCheckingTerrainDistance.

virtual DtReal DtRotaryWingEntityParameters::altitude

(

)

const [virtual]

Accessor/mutator for altitude in meters.

virtual void DtRotaryWingEntityParameters::setAltitude

(

const DtReal

val

)

[virtual]

Accessor/mutator for altitude in meters.

virtual void DtRotaryWingEntityParameters::setJoystickControl

(

const bool

val

)

[virtual]

Accessor/mutator for myJoystickControl.

virtual bool DtRotaryWingEntityParameters::joystickControl

(

)

const [virtual]

Accessor/mutator for myJoystickControl.

virtual void DtRotaryWingEntityParameters::setDefaults

(

)

[virtual]

Sets all the default values for flight and rotary wing parameters.

virtual void DtRotaryWingEntityParameters::copyValues

(

const DtRotaryWingEntityParameters &

orig

)

[virtual]

Used by copy constructor and = operator to copy all member values.

static DtVrfObjectParameters* DtRotaryWingEntityParameters::creator

(

)

[static]

Returns:

Newly created instance of this class, with an empty DtReaderWriter name. Creation methods are registered with a DtComponentDescriptorFactory, so they can be created on demand as they are read in from a parameter database file.

Reimplemented from DtMovingObjectParameters.

Reimplemented in DtSubsurfaceEntityParameters.

virtual DtReal DtRotaryWingEntityParameters::maxClimbRate

(

)

const [virtual]

Accessor/mutator for myMaxClimbRate.

virtual void DtRotaryWingEntityParameters::setMaxClimbRate

(

DtReal

maxClimbRate

)

[virtual]

Accessor/mutator for myMaxClimbRate.

virtual DtReal DtRotaryWingEntityParameters::maxYawRate

(

)

const [virtual]

Accessor/mutator for myMaxYawRate.

virtual void DtRotaryWingEntityParameters::setMaxYawRate

(

DtReal

maxYawRate

)

[virtual]

Accessor/mutator for myMaxYawRate.

virtual DtReal DtRotaryWingEntityParameters::maxPitchRate

(

)

const [virtual]

Accessor/mutator for myMaxPitchRate.

virtual void DtRotaryWingEntityParameters::setMaxPitchRate

(

DtReal

maxPitchRate

)

[virtual]

Accessor/mutator for myMaxPitchRate.

virtual DtReal DtRotaryWingEntityParameters::maxRollRate

(

)

const [virtual]

Accessor/mutator for myMaxRollRate.

virtual void DtRotaryWingEntityParameters::setMaxRollRate

(

DtReal

maxRollRate

)

[virtual]

Accessor/mutator for myMaxRollRate.

virtual DtReal DtRotaryWingEntityParameters::maxYawAcceleration

(

)

const [virtual]

virtual void DtRotaryWingEntityParameters::setMaxYawAcceleration

(

const DtReal

val

)

[virtual]

virtual DtReal DtRotaryWingEntityParameters::maxPitchAcceleration

(

)

const [virtual]

virtual void DtRotaryWingEntityParameters::setMaxPitchAcceleration

(

const DtReal

val

)

[virtual]

virtual DtReal DtRotaryWingEntityParameters::maxRollAcceleration

(

)

const [virtual]

virtual void DtRotaryWingEntityParameters::setMaxRollAcceleration

(

const DtReal

val

)

[virtual]

virtual DtReal DtRotaryWingEntityParameters::zeroCollectiveLiftAcceleration

(

)

const [virtual]

virtual void DtRotaryWingEntityParameters::setZeroCollectiveLiftAcceleration

(

const DtReal

val

)

[virtual]

virtual DtReal DtRotaryWingEntityParameters::fullCollectiveLiftAcceleration

(

)

const [virtual]

virtual void DtRotaryWingEntityParameters::setFullCollectiveLiftAcceleration

(

const DtReal

val

)

[virtual]

---

Member Data Documentation

DtRwReal DtRotaryWingEntityParameters::myMaxAltitude [protected]

Parameter Name: max-altitude Parameter Description: Above this altitude no lift is generated.

Parameter Default Value: 12000.0 Parameter Units: meters

DtRwBoolean DtRotaryWingEntityParameters::myJoystickControl [protected]

Parameter Name: joystick-control Parameter Description: Specifies whether or not you can use a joystick to control rotary-wing entities.

Currently unused. Parameter Default Value: False

DtRwBoolean DtRotaryWingEntityParameters::myIsCheckingTerrainDistance [protected]

Parameter Name: terrain-check
Parameter Description:
Parameter Default Value:
.

DtRwReal DtRotaryWingEntityParameters::myMaxClimbRate [protected]

Parameter Name: max-climb-rate
Parameter Description:
Parameter Default Value: 50.

Parameter Units: meters/second

DtRwReal DtRotaryWingEntityParameters::myMaxYawRate [protected]

Parameter Name: max-yaw-rate
Parameter Description: Maximum rate this plane can pitch down or up about its Y axis (due to stick).

Parameter Default Value: 0.7854 (45. degrees/second)
Parameter Units: radians/second

DtRwReal DtRotaryWingEntityParameters::myMaxPitchRate [protected]

Parameter Name: max-pitch-rate
Parameter Description:
Parameter Default Value: 0.7854 (45.

degrees/second)
Parameter Units: radians/second

DtRwReal DtRotaryWingEntityParameters::myMaxRollRate [protected]

Parameter Name: max-roll-rate
Parameter Description: Maximum rate this plane can rotate about its X axis (due to stick).

Parameter Default Value: 1.047 (60. degrees/second)
Parameter Units: radians/second

DtRwReal DtRotaryWingEntityParameters::myMaxYawAcceleration [protected]

Parameter Name: max-yaw-acceleration
Parameter Description: The maximum rotational acceleration around the body Z axis (due to pedal).

Parameter Default Value: 0.1768 (10. degrees/second/second)
Parameter Units: radians/second/second

DtRwReal DtRotaryWingEntityParameters::myMaxPitchAcceleration [protected]

Parameter Name: max-pitch-acceleration
Parameter Description: Maximum rotational acceleration about the Y axis in radians per second squared.

(due to stick). Parameter Default Value: 0.1768 (10. degrees/second/second)
Parameter Units: radians/second/second

DtRwReal DtRotaryWingEntityParameters::myMaxRollAcceleration [protected]

Parameter Name: max-roll-acceleration
Parameter Description: Maximum rotational acceleration around the X axis in radians per second squared.

(due to stick). Parameter Default Value: 0.1768 (10. degrees/second/second)
Parameter Units: radians/second/second

DtRwReal DtRotaryWingEntityParameters::myZeroCollectiveLiftAcceleration [protected]

Parameter Name: zero-collective-lift-acceleration
Parameter Description: The upward acceleration when the collective is at zero, assuming no gravity.

Parameter Default Value: -10.
Parameter Units: meters/second/second

DtRwReal DtRotaryWingEntityParameters::myFullCollectiveLiftAcceleration [protected]

Parameter Name: full-collective-lift-acceleration Parameter Description: This is the upward acceleration when the collective is at full, assuming no gravity.

Default Value: 30. Parameter Units: meters/second/second

DtReal DtRotaryWingEntityParameters::myAltitude [protected]

---

The documentation for this class was generated from the following file:

• include/vrfobjparam/rotWingPar.h