VR-Forces 4.0.4 Class Documentation
Public Member Functions | Static Public Member Functions | Protected Attributes
DtIndividualLifeFormStateRepository Class Reference

lifeform entity's state repository. More...

Inheritance diagram for DtIndividualLifeFormStateRepository:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 DtIndividualLifeFormStateRepository ()
 default constructor
 DtIndividualLifeFormStateRepository (DtVrfObject *vrfObject, const DtObjectType &objectType, DtVrfObjectParameters *parameters, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
 constructor with parameters to set up read/writability correctly
 DtIndividualLifeFormStateRepository (const DtIndividualLifeFormStateRepository &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
 copy constructor
const
DtIndividualLifeFormStateRepository
operator= (const DtIndividualLifeFormStateRepository &orig)
 assignment operator
virtual ~DtIndividualLifeFormStateRepository ()
 destructor
virtual
DtSimObjectStateRepository
clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const
 Clone.
virtual bool init ()
 Our 'virtual' constructor. Calls all the create<>() methods.
virtual DtString type () const
 Returns the string type of the repository, as defined in vrfSRTypes.h.
virtual bool createParameters ()
virtual void initializeFromParameters ()
virtual const
DtIndividualLifeFormParameters
individualLifeFormParameters () const
virtual void setAssignedPosture (DtLifeformState newPosture)
 Value sets by user/opd.
virtual DtLifeformState assignedPosture () const
virtual DtLifeformState currentPosture () const
 current value, according with the current task
virtual void setCurrentPosture (DtLifeformState newPosture)
virtual void setAssignedWeaponState (DtWeaponState newWeaponState)
 Value sets by user/opd.
virtual DtWeaponState assignedWeaponState () const
virtual DtWeaponState currentWeaponState () const
 current value, according with the current task
virtual void setCurrentWeaponState (DtWeaponState newWeaponState)
virtual void clampToGround (const DtVector &location, const DtReal heading, bool *dataAvailable=0)
 Place entity on ground at location and heading.
virtual void setDestroyed (bool isDestroyed)
 Redefine setDestroyed to avoid smoke and flames.
virtual void calculateBodyEyepointOffset (DtLifeformState posture, DtVector &bodyEyepointOffset) const
 Computes an offset in body coordinates to eye point, for a given posture.
virtual bool uprightPosture (DtLifeformState posture) const
 Returns true if given posture is an upright one (i.e.
virtual bool staticPosture (DtLifeformState posture) const
 Returns true if given posture is static (i.e.
virtual bool movingPosture (DtLifeformState posture) const
 Returns true if given posture is a movement posture (i.e.

Static Public Member Functions

static DtVrfObjectStateRepositorycreator (const DtString &name, DtVrfObject *vrfObject, const DtObjectType &objectType, DtVrfObjectParameters *parameters, DtReaderWriterRegistry *parentRegistry)
static
DtIndividualLifeFormStateRepository
isIndividualLifeFormStateRepository (DtSimObjectStateRepository *repository)
 Returns a the pointer the repository, if the repository passed in is of type DtIndividualLifeFormStateRepository, 0 if not.
static const
DtIndividualLifeFormStateRepository
isIndividualLifeFormStateRepository (const DtSimObjectStateRepository *repository)

Protected Attributes

DtRwIndividualLifeFormStateType myAssignedPosture
DtRwIndividualLifeFormStateType myCurrentPosture
DtRwIndividualLifeFormWeaponStateType myAssignedWeaponState
DtRwIndividualLifeFormWeaponStateType myCurrentWeaponState

Detailed Description

lifeform entity's state repository.

This repository holds all information that is common to all the forms of local lifeform entities within the simulation.


Constructor & Destructor Documentation

default constructor

DtIndividualLifeFormStateRepository::DtIndividualLifeFormStateRepository ( DtVrfObject vrfObject,
const DtObjectType objectType,
DtVrfObjectParameters parameters,
const DtString rwName = DtString::nullString(),
DtReaderWriterRegistry parentRegistry = 0 
)

constructor with parameters to set up read/writability correctly

DtIndividualLifeFormStateRepository::DtIndividualLifeFormStateRepository ( const DtIndividualLifeFormStateRepository orig,
const DtString rwName = DtString::nullString(),
DtReaderWriterRegistry parentRegistry = 0 
)

copy constructor

destructor


Member Function Documentation

const DtIndividualLifeFormStateRepository& DtIndividualLifeFormStateRepository::operator= ( const DtIndividualLifeFormStateRepository orig)

assignment operator

virtual DtSimObjectStateRepository* DtIndividualLifeFormStateRepository::clone ( const DtString rwName = DtString::nullString(),
DtReaderWriterRegistry parentRegistry = 0 
) const [virtual]

Clone.

Reimplemented from DtGroundVehicleStateRepository.

Our 'virtual' constructor. Calls all the create<>() methods.

Reimplemented from DtGroundVehicleStateRepository.

Returns the string type of the repository, as defined in vrfSRTypes.h.

Reimplemented from DtGroundVehicleStateRepository.

Reimplemented from DtGroundVehicleStateRepository.

Reimplemented from DtGroundVehicleStateRepository.

virtual void DtIndividualLifeFormStateRepository::setAssignedPosture ( DtLifeformState  newPosture) [virtual]

Value sets by user/opd.

virtual DtLifeformState DtIndividualLifeFormStateRepository::assignedPosture ( ) const [virtual]
virtual DtLifeformState DtIndividualLifeFormStateRepository::currentPosture ( ) const [virtual]

current value, according with the current task

virtual void DtIndividualLifeFormStateRepository::setCurrentPosture ( DtLifeformState  newPosture) [virtual]
virtual void DtIndividualLifeFormStateRepository::setAssignedWeaponState ( DtWeaponState  newWeaponState) [virtual]

Value sets by user/opd.

virtual DtWeaponState DtIndividualLifeFormStateRepository::assignedWeaponState ( ) const [virtual]
virtual DtWeaponState DtIndividualLifeFormStateRepository::currentWeaponState ( ) const [virtual]

current value, according with the current task

virtual void DtIndividualLifeFormStateRepository::setCurrentWeaponState ( DtWeaponState  newWeaponState) [virtual]
static DtVrfObjectStateRepository* DtIndividualLifeFormStateRepository::creator ( const DtString name,
DtVrfObject vrfObject,
const DtObjectType objectType,
DtVrfObjectParameters parameters,
DtReaderWriterRegistry parentRegistry 
) [static]

Reimplemented from DtGroundVehicleStateRepository.

Returns a the pointer the repository, if the repository passed in is of type DtIndividualLifeFormStateRepository, 0 if not.

virtual void DtIndividualLifeFormStateRepository::clampToGround ( const DtVector location,
const DtReal  heading,
bool dataAvailable = 0 
) [virtual]

Place entity on ground at location and heading.

Redefined to set orientation with gravity direction.

Parameters:
Output
dataAvailableprevents the call from blocking due to terrain paging and will get a true value if the terrain intersections are successful. See DtVrfMovingObjectStateRepository::clampToGround for more information.
virtual void DtIndividualLifeFormStateRepository::setDestroyed ( bool  isDestroyed) [virtual]

Redefine setDestroyed to avoid smoke and flames.

Reimplemented from DtVrfObjectStateRepository.

virtual void DtIndividualLifeFormStateRepository::calculateBodyEyepointOffset ( DtLifeformState  posture,
DtVector bodyEyepointOffset 
) const [virtual]

Computes an offset in body coordinates to eye point, for a given posture.

virtual bool DtIndividualLifeFormStateRepository::uprightPosture ( DtLifeformState  posture) const [virtual]

Returns true if given posture is an upright one (i.e.

DtLifeformWalking, DtLifeformRunning, DtLifeformStanding), false otherwise.

virtual bool DtIndividualLifeFormStateRepository::staticPosture ( DtLifeformState  posture) const [virtual]

Returns true if given posture is static (i.e.

DtLifeformStanding, DtLifeformProne, etc.), false if not (posture is associated with movement).

virtual bool DtIndividualLifeFormStateRepository::movingPosture ( DtLifeformState  posture) const [virtual]

Returns true if given posture is a movement posture (i.e.

DtLifeformWalking, DtLifeformCrawling, etc.), false if not (posture is static).


Member Data Documentation


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

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)