 |
VR-Link API Documentation for DIS
|
|
VR-Link API Documentation for DIS
|
Class Description: DtAppearance is extracted from VR-Link's entity state repository class, and encapsulates all methods and data from that class pertaining to DIS / RPR appearance attributes. More...
Collaboration diagram for DtAppearance:Public Member Functions | |
| DtAppearance (const DtEntityType &entityType) | |
| Constructor. | |
| DtAppearance (const DtAppearance &orig) | |
| Copy Constructor. | |
| const DtAppearance & | operator= (const DtAppearance &orig) |
| Assignment Operator. | |
| virtual | ~DtAppearance () |
| Destructor. | |
| virtual DtAppearance * | clone () const |
| Clone. | |
| virtual void | setComplianceState (DtComplianceState s) |
| Set/Get lifeform compliance state. | |
| virtual DtComplianceState | complianceState () const |
| virtual void | setFrozen (bool onOff) |
| Set/Get whether frozen or not. | |
| virtual bool | frozen () const |
| virtual void | setPowerPlantOn (bool onOff) |
| Set/Get whether entity's power plant is on or not. | |
| virtual bool | powerPlantOn () const |
| virtual void | setDamageState (DtDamageState s) |
| Set/Get the damage state. | |
| virtual DtDamageState | damageState () const |
| virtual void | setEngineSmokeOn (bool onOff) |
| Set/Get whether engine smoke is on or not. | |
| virtual bool | engineSmokeOn () const |
| virtual void | setFlamesPresent (bool onOff) |
| Set/Get whether flames are present or not. | |
| virtual bool | flamesPresent () const |
| virtual void | setHatchState (DtHatchState s) |
| Set/Get the entity's hatch state. | |
| virtual DtHatchState | hatchState () const |
| virtual void | setImmobilized (bool onOff) |
| Set/Get whether the entity is immobilized or not. | |
| virtual bool | immobilized () const |
| virtual void | setLifeformState (DtLifeformState s) |
| Set/Get entity life form state. | |
| virtual DtLifeformState | lifeformState () const |
| virtual void | setLightState (DtLightType s, bool onOff) |
| Set/Get light state of entity. | |
| virtual bool | lightState (DtLightType s) const |
| virtual void | setLightState (DtLightState s) |
| Set/Get light state of entity. | |
| virtual DtLightState | lightState () const |
| virtual void | setDensity (DtDensityType dens) |
| Set/Get density state of entity. (Environment entities). | |
| virtual DtDensityType | density () const |
| virtual void | setRampDeployed (bool onOff) |
| Set/Get whether entity has ramp deployed or not. | |
| virtual bool | rampDeployed () const |
| virtual void | setSmokePlumePresent (bool onOff) |
| Set/Get whether a smoke plume is present or not. | |
| virtual bool | smokePlumePresent () const |
| virtual void | setTentDeployed (bool onOff) |
| Set/Get whether a tent is deployed or not. | |
| virtual bool | tentDeployed () const |
| virtual void | setTrailState (DtTrailState s) |
| Set/Get trailing effect state. | |
| virtual DtTrailState | trailState () const |
| virtual void | setCamouflageType (DtCamouflageType type) |
| Set/Get camouflage type. | |
| virtual DtCamouflageType | camouflageType () const |
| virtual void | setFirePowerDisabled (bool onOff) |
| Set/Get whether entity is fire power disabled or not. | |
| virtual bool | firePowerDisabled () const |
| virtual void | setIsConcealed (bool onOff) |
| Set/Get whether entity is concealed or not. | |
| virtual bool | isConcealed () const |
| virtual void | setAfterburnerOn (bool onOff) |
| Set/Get whether entity has after burner on or not. | |
| virtual bool | afterburnerOn () const |
| virtual void | setLauncherRaised (bool onOff) |
| Set/Get whether entity has launcher raised or not. | |
| virtual bool | launcherRaised () const |
| virtual void | setLauncherFlashPresent (bool onOff) |
| Set/Get whether launcher flash is present or not. | |
| virtual bool | launcherFlashPresent () const |
| virtual void | setPrimaryWeaponState (DtWeaponState s) |
| Set/Get primary weapon deployment state. | |
| virtual DtWeaponState | primaryWeaponState () const |
| virtual void | setSecondaryWeaponState (DtWeaponState s) |
| Set/Get secondary weapon deployment state. | |
| virtual DtWeaponState | secondaryWeaponState () const |
| virtual void | setAntennaRaised (bool upDown) |
| Set/Get Antenna Raised status. | |
| virtual bool | antennaRaised () const |
| virtual void | setMissionKill (bool yesNo) |
| Set/Get Mission Kill status. | |
| virtual bool | missionKill () const |
| virtual void | setInternalHeatSource (bool onOff) |
| Set/Get internal Heat Source status. | |
| virtual bool | internalHeatSource () const |
| virtual void | setAppearance (DtU32 app) |
| Appearance field accessors. | |
| virtual DtU32 | appearance () const |
| virtual void | setAppearanceAttribute (const DtAppearAttribute attr, const DtAppearAttrVal val) |
| Set/Get an appearance attribute. | |
| virtual DtAppearAttrVal | appearanceAttribute (const DtAppearAttribute attr) const |
| virtual const DtEntityType & | entityType () const |
| virtual void | setEntityType (const DtEntityType &entityType) |
Static Public Member Functions | |
| static const DtAppearance & | nullAppearance () |
Protected Member Functions | |
| DtAppearance () | |
| Default Constructor. Do not use. | |
Protected Attributes | |
| DtU32 | myAppearance |
| DtEntityType | myEntityType |
Class Description: DtAppearance is extracted from VR-Link's entity state repository class, and encapsulates all methods and data from that class pertaining to DIS / RPR appearance attributes.
| DtAppearance::DtAppearance | ( | ) | [protected] |
Default Constructor. Do not use.
| DtAppearance::DtAppearance | ( | const DtEntityType & | entityType | ) |
Constructor.
If an appearance attribute is not valid for the entity type supplied, the corresponding accessor will return false.
| DtAppearance::DtAppearance | ( | const DtAppearance & | orig | ) |
Copy Constructor.
| virtual DtAppearance::~DtAppearance | ( | ) | [virtual] |
Destructor.
| virtual bool DtAppearance::afterburnerOn | ( | ) | const [virtual] |
| virtual bool DtAppearance::antennaRaised | ( | ) | const [virtual] |
| DtU32 DtAppearance::appearance | ( | ) | const [inline, virtual] |
References myAppearance.
| virtual DtAppearAttrVal DtAppearance::appearanceAttribute | ( | const DtAppearAttribute | attr | ) | const [virtual] |
| virtual DtCamouflageType DtAppearance::camouflageType | ( | ) | const [virtual] |
| virtual DtAppearance* DtAppearance::clone | ( | ) | const [virtual] |
Clone.
| virtual DtComplianceState DtAppearance::complianceState | ( | ) | const [virtual] |
| virtual DtDamageState DtAppearance::damageState | ( | ) | const [virtual] |
| virtual DtDensityType DtAppearance::density | ( | ) | const [virtual] |
| virtual bool DtAppearance::engineSmokeOn | ( | ) | const [virtual] |
| virtual const DtEntityType& DtAppearance::entityType | ( | ) | const [virtual] |
| virtual bool DtAppearance::firePowerDisabled | ( | ) | const [virtual] |
| virtual bool DtAppearance::flamesPresent | ( | ) | const [virtual] |
| virtual bool DtAppearance::frozen | ( | ) | const [virtual] |
| virtual DtHatchState DtAppearance::hatchState | ( | ) | const [virtual] |
| virtual bool DtAppearance::immobilized | ( | ) | const [virtual] |
| virtual bool DtAppearance::internalHeatSource | ( | ) | const [virtual] |
| virtual bool DtAppearance::isConcealed | ( | ) | const [virtual] |
| virtual bool DtAppearance::launcherFlashPresent | ( | ) | const [virtual] |
| virtual bool DtAppearance::launcherRaised | ( | ) | const [virtual] |
| virtual DtLifeformState DtAppearance::lifeformState | ( | ) | const [virtual] |
| virtual bool DtAppearance::lightState | ( | DtLightType | s | ) | const [virtual] |
| virtual DtLightState DtAppearance::lightState | ( | ) | const [virtual] |
| virtual bool DtAppearance::missionKill | ( | ) | const [virtual] |
| static const DtAppearance& DtAppearance::nullAppearance | ( | ) | [static] |
| const DtAppearance& DtAppearance::operator= | ( | const DtAppearance & | orig | ) |
Assignment Operator.
| virtual bool DtAppearance::powerPlantOn | ( | ) | const [virtual] |
| virtual DtWeaponState DtAppearance::primaryWeaponState | ( | ) | const [virtual] |
| virtual bool DtAppearance::rampDeployed | ( | ) | const [virtual] |
| virtual DtWeaponState DtAppearance::secondaryWeaponState | ( | ) | const [virtual] |
| virtual void DtAppearance::setAfterburnerOn | ( | bool | onOff | ) | [virtual] |
Set/Get whether entity has after burner on or not.
| virtual void DtAppearance::setAntennaRaised | ( | bool | upDown | ) | [virtual] |
Set/Get Antenna Raised status.
| void DtAppearance::setAppearance | ( | DtU32 | app | ) | [inline, virtual] |
Appearance field accessors.
In general, these should not be used in HLA since appearance information may not always be represented as a bitfield. Set/Get the appearance field.
References myAppearance.
| virtual void DtAppearance::setAppearanceAttribute | ( | const DtAppearAttribute | attr, |
| const DtAppearAttrVal | val | ||
| ) | [virtual] |
Set/Get an appearance attribute.
attr is the appearance bitfield mask val is the hex number to be or'ed in
| virtual void DtAppearance::setCamouflageType | ( | DtCamouflageType | type | ) | [virtual] |
Set/Get camouflage type.
| virtual void DtAppearance::setComplianceState | ( | DtComplianceState | s | ) | [virtual] |
Set/Get lifeform compliance state.
| virtual void DtAppearance::setDamageState | ( | DtDamageState | s | ) | [virtual] |
Set/Get the damage state.
| virtual void DtAppearance::setDensity | ( | DtDensityType | dens | ) | [virtual] |
Set/Get density state of entity. (Environment entities).
| virtual void DtAppearance::setEngineSmokeOn | ( | bool | onOff | ) | [virtual] |
Set/Get whether engine smoke is on or not.
| virtual void DtAppearance::setEntityType | ( | const DtEntityType & | entityType | ) | [virtual] |
| virtual void DtAppearance::setFirePowerDisabled | ( | bool | onOff | ) | [virtual] |
Set/Get whether entity is fire power disabled or not.
| virtual void DtAppearance::setFlamesPresent | ( | bool | onOff | ) | [virtual] |
Set/Get whether flames are present or not.
| virtual void DtAppearance::setFrozen | ( | bool | onOff | ) | [virtual] |
Set/Get whether frozen or not.
| virtual void DtAppearance::setHatchState | ( | DtHatchState | s | ) | [virtual] |
Set/Get the entity's hatch state.
| virtual void DtAppearance::setImmobilized | ( | bool | onOff | ) | [virtual] |
Set/Get whether the entity is immobilized or not.
| virtual void DtAppearance::setInternalHeatSource | ( | bool | onOff | ) | [virtual] |
Set/Get internal Heat Source status.
| virtual void DtAppearance::setIsConcealed | ( | bool | onOff | ) | [virtual] |
Set/Get whether entity is concealed or not.
| virtual void DtAppearance::setLauncherFlashPresent | ( | bool | onOff | ) | [virtual] |
Set/Get whether launcher flash is present or not.
| virtual void DtAppearance::setLauncherRaised | ( | bool | onOff | ) | [virtual] |
Set/Get whether entity has launcher raised or not.
| virtual void DtAppearance::setLifeformState | ( | DtLifeformState | s | ) | [virtual] |
Set/Get entity life form state.
| virtual void DtAppearance::setLightState | ( | DtLightType | s, |
| bool | onOff | ||
| ) | [virtual] |
Set/Get light state of entity.
| virtual void DtAppearance::setLightState | ( | DtLightState | s | ) | [virtual] |
Set/Get light state of entity.
This is for <= vrlink3.4 compatibility
| virtual void DtAppearance::setMissionKill | ( | bool | yesNo | ) | [virtual] |
Set/Get Mission Kill status.
| virtual void DtAppearance::setPowerPlantOn | ( | bool | onOff | ) | [virtual] |
Set/Get whether entity's power plant is on or not.
| virtual void DtAppearance::setPrimaryWeaponState | ( | DtWeaponState | s | ) | [virtual] |
Set/Get primary weapon deployment state.
| virtual void DtAppearance::setRampDeployed | ( | bool | onOff | ) | [virtual] |
Set/Get whether entity has ramp deployed or not.
| virtual void DtAppearance::setSecondaryWeaponState | ( | DtWeaponState | s | ) | [virtual] |
Set/Get secondary weapon deployment state.
| virtual void DtAppearance::setSmokePlumePresent | ( | bool | onOff | ) | [virtual] |
Set/Get whether a smoke plume is present or not.
| virtual void DtAppearance::setTentDeployed | ( | bool | onOff | ) | [virtual] |
Set/Get whether a tent is deployed or not.
| virtual void DtAppearance::setTrailState | ( | DtTrailState | s | ) | [virtual] |
Set/Get trailing effect state.
| virtual bool DtAppearance::smokePlumePresent | ( | ) | const [virtual] |
| virtual bool DtAppearance::tentDeployed | ( | ) | const [virtual] |
| virtual DtTrailState DtAppearance::trailState | ( | ) | const [virtual] |
DtU32 DtAppearance::myAppearance [protected] |
Referenced by appearance(), and setAppearance().
DtEntityType DtAppearance::myEntityType [protected] |
