makVrv::DtForceManager Class Reference

This class will maintain force information used in visualizers that need force dependent data (such as force color)

Inheritance diagram for makVrv::DtForceManager:

Classes
struct	ForceInfo
struct	RGBAColor

Public Member Functions
	DtForceManager (DtSharedSettingsManager &manager)
virtual	~DtForceManager ()
	DtForceManager ()=delete
	DtForceManager (const DtForceManager &)=delete
DtForceManager &	operator= (const DtForceManager &)=delete
virtual void	addForce (DtForceType force, const std::string &forceName, const RGBAColor &forceColor, const RGBAColor &forcePrimaryColor, bool includeInDialogs=true)
virtual void	removeForce (DtForceType)
virtual int	numForces () const
virtual DtForceType	forceAt (int iIndex) const
virtual RGBAColor	colorForForce (DtForceType force, bool usePrimaryColors=false) const
virtual std::string	nameForForce (DtForceType force) const
virtual DtForceType	forceFromName (const std::string &name) const
virtual bool	includeInDialogs (DtForceType force) const
virtual void	clearForces ()
virtual void	setHostility (DtU8 force, DtU8 targetForce, bool hostile)
virtual bool	hostile (DtU8 force, DtU8 targetForce)
Public Member Functions inherited from makVrv::DtSharedSettings
	DtSharedSettings (const DtSharedSettingsManager &manager)
virtual	~DtSharedSettings ()
boost::shared_mutex &	mutex ()
SafetyKey	safeToEmitSignals ()
void	setCurrentWriteLock (boost::unique_lock< boost::shared_mutex > *currentWriteLock)
virtual const DtSettingsBackup *	settingsBackup () const
virtual DtSettingsBackup *	settingsBackup ()
virtual void	backup ()
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
virtual	~DtVirtualBaseClass ()

Static Public Member Functions
static const std::string &	className ()

Protected Member Functions
virtual const ForceInfo &	forceInformation (DtForceType force) const
virtual ForceInfo &	forceInformation (DtForceType force)

Protected Attributes
ForceInfo	myNullForce
std::map< DtForceType, ForceInfo >	myForces

Constructor & Destructor Documentation

makVrv::DtForceManager::DtForceManager

(

DtSharedSettingsManager &

manager

)

CTOR.

virtual makVrv::DtForceManager::~DtForceManager ( )

virtual

DTOR.

makVrv::DtForceManager::DtForceManager ( )

delete

not allowed - default constructor

makVrv::DtForceManager::DtForceManager ( const DtForceManager &  )

delete

not allowed - copy constructor

Member Function Documentation

DtForceManager& makVrv::DtForceManager::operator= ( const DtForceManager &  )

delete

not allowed - equals operator

static const std::string& makVrv::DtForceManager::className ( )

static

virtual void makVrv::DtForceManager::addForce ( DtForceType  force, const std::string &  forceName, const RGBAColor &  forceColor, const RGBAColor &  forcePrimaryColor, bool  includeInDialogs = true  )

virtual

Adds a new force DtForceType to the manager. Replaces force if currently exists.

virtual void makVrv::DtForceManager::removeForce ( DtForceType  )

virtual

Removes force from system.

Reimplemented in makVrf::DtVrfGuiForceManager.

virtual int makVrv::DtForceManager::numForces ( ) const

virtual

Number of forces in the force list.

virtual DtForceType makVrv::DtForceManager::forceAt ( int  iIndex ) const

virtual

Force Type for a specific index.

virtual RGBAColor makVrv::DtForceManager::colorForForce ( DtForceType  force, bool  usePrimaryColors = false  ) const

virtual

Color for a specified force.

Reimplemented in makVrf::DtVrfGuiForceManager.

virtual std::string makVrv::DtForceManager::nameForForce ( DtForceType  force ) const

virtual

Name for a specified force.

virtual DtForceType makVrv::DtForceManager::forceFromName ( const std::string &  name ) const

virtual

Force Type for a specific force name.

virtual bool makVrv::DtForceManager::includeInDialogs ( DtForceType  force ) const

virtual

Whether the force is included in VRF dialogs.

virtual void makVrv::DtForceManager::setHostility ( DtU8  force, DtU8  targetForce, bool  hostile  )

virtual

virtual bool makVrv::DtForceManager::hostile ( DtU8  force, DtU8  targetForce  )

virtual

virtual void makVrv::DtForceManager::clearForces ( )

virtual

Clear hash list of forces.

virtual const ForceInfo& makVrv::DtForceManager::forceInformation ( DtForceType  force ) const

protectedvirtual

virtual ForceInfo& makVrv::DtForceManager::forceInformation ( DtForceType  force )

protectedvirtual

Member Data Documentation

ForceInfo makVrv::DtForceManager::myNullForce

protected

std::map<DtForceType, ForceInfo> makVrv::DtForceManager::myForces

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrvCore/DtForceManager.h