VR-Forces 5.0.2 Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Private Member Functions
DtHazardAreaManager Class Reference

The DtHazardAreaManager will keep track of all hazard area objects and their state. Hazard areas are predefined as part of this class. Call the add/remove methods to add or remove areas to watch.

Public Member Functions

 DtHazardAreaManager (const DtSimulationServices *)
 
virtual ~DtHazardAreaManager ()
 
virtual bool loadHazardAreaInformationFile (const DtFilename &filename, bool clear)
 
virtual void addHazardAreaType (const DtEntityType &)
 
virtual void removeHazardAreaType (const DtEntityType &)
 
virtual std::vector
< DtSimObjectReference
hazardAreas (const DtEntityType &) const
 
virtual const std::vector
< DtEntityType > & 
hazardAreaTypes () const
 
virtual const std::map
< unsigned long long,
DtSimObjectReference > & 
hazardAreas () const
 
virtual const
DtRwHazardAreaInformation
hazardAreaInformation () const
 

Protected Member Functions

virtual void processHazardAreaInformation (DtSimMessage *msg)
 
virtual void processHazardAreaAdded (DtSimObjectReference)
 
virtual void processHazardAreaDeleted (const DtSimObject *)
 

Static Protected Member Functions

static void requestHazardAreaInformationCallback (DtSimMessage *msg, void *usr)
 

Protected Attributes

const DtSimulationServicesmySimulationServices
 
DtRwHazardAreaInformation myHazardAreaInformation
 
std::vector< DtEntityType > myHazardAreaTypes
 
std::map< unsigned long long,
DtSimObjectReference
myHazardAreas
 
boost::signals2::scoped_connection mySimObjectAddedConnection
 

Private Member Functions

 DtHazardAreaManager (const DtHazardAreaManager &orig)
 
DtHazardAreaManageroperator= (const DtHazardAreaManager &orig)
 

Constructor & Destructor Documentation

DtHazardAreaManager::DtHazardAreaManager ( const DtSimulationServices )

CTOR.

virtual DtHazardAreaManager::~DtHazardAreaManager ( )
virtual

DTOR.

DtHazardAreaManager::DtHazardAreaManager ( const DtHazardAreaManager orig)
private

copy constructor

Member Function Documentation

virtual bool DtHazardAreaManager::loadHazardAreaInformationFile ( const DtFilename &  filename,
bool  clear 
)
virtual

Loads hazard area information file from given directory.

DtHazardAreaManager& DtHazardAreaManager::operator= ( const DtHazardAreaManager orig)
private

assignment operator

virtual void DtHazardAreaManager::addHazardAreaType ( const DtEntityType &  )
virtual

Adds a new hazard area to watch. Will redo internal list to contain new area.

virtual void DtHazardAreaManager::removeHazardAreaType ( const DtEntityType &  )
virtual

Removes a hazard area to watch. Will redo internal list to contain correct areas. Note that if a wildcarded type is supplied, all types that match that type will be removed.

virtual std::vector<DtSimObjectReference> DtHazardAreaManager::hazardAreas ( const DtEntityType &  ) const
virtual

Returns a list of hazard areas that match the given type.

virtual const std::vector<DtEntityType>& DtHazardAreaManager::hazardAreaTypes ( ) const
virtual
virtual const std::map<unsigned long long, DtSimObjectReference>& DtHazardAreaManager::hazardAreas ( ) const
virtual

Returns all hazard areas.

virtual const DtRwHazardAreaInformation& DtHazardAreaManager::hazardAreaInformation ( ) const
virtual

Returns the full hazard area information.

static void DtHazardAreaManager::requestHazardAreaInformationCallback ( DtSimMessage msg,
void *  usr 
)
staticprotected
virtual void DtHazardAreaManager::processHazardAreaInformation ( DtSimMessage msg)
protectedvirtual
virtual void DtHazardAreaManager::processHazardAreaAdded ( DtSimObjectReference  )
protectedvirtual

Called when a hazard area is added via the sim object manager.

virtual void DtHazardAreaManager::processHazardAreaDeleted ( const DtSimObject )
protectedvirtual

Called when a hazard area is removed.

Member Data Documentation

const DtSimulationServices* DtHazardAreaManager::mySimulationServices
protected
DtRwHazardAreaInformation DtHazardAreaManager::myHazardAreaInformation
protected
std::vector<DtEntityType> DtHazardAreaManager::myHazardAreaTypes
protected
std::map<unsigned long long, DtSimObjectReference> DtHazardAreaManager::myHazardAreas
protected
boost::signals2::scoped_connection DtHazardAreaManager::mySimObjectAddedConnection
protected

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

Document ID: Generated on Sun Dec 4 20:22:03 EST 2022 from SVN revision 249613
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)