makVrv::DtSharedCockpitSettings Class Reference

The shared simulation settings. More...

Inheritance diagram for makVrv::DtSharedCockpitSettings:

Public Member Functions
virtual	~DtSharedCockpitSettings ()
	DTOR.
void	setCockpitMapper (const DtEntityTypeMapper &cockpitTypeMapper)
	Set a number of the state parameters.
void	setCockpitModelMapping (const DtEntityType &type, const std::string &definition)
	Set the entity model mapping.
const std::vector< DtUnicode > &	mapCockpitModelDefinition (const DtEntityType &type) const
	Get a model definition for an entity model based upon entity type.
virtual void	setDe (DtDe *)
	Sets the display engine used for the settings object.
const DtModelDefinition *	findCockpitDefinition (const std::string &str) const
	finds a HUD definition if it exists. Returns NULL on failure
virtual DtEntityTypeMapper *	findMapperByName (const std::string &name)
	Get an mapper by name.
virtual const DtEntityTypeMapper *	findMapperByName (const std::string &name) const
virtual DtEntityTypeMapper &	cockpitTypeMapper ()
	Entity type mapping.
virtual const DtEntityTypeMapper &	cockpitTypeMapper () const
virtual void	setFromRecord (const makArchives::DtCockpitSettingsRecord &rec)
	Set the entity settings as a record.
virtual void	getRecord (makArchives::DtCockpitSettingsRecord &rec) const
	Get the settings as a record.
virtual void	mapperChanged (const DtEntityType &type, const DtUnicode &value, DtEntityTypeMapper &mapper)
	Slot called when mapper changes. Uses shared message signaller to send out a mapperUpdated signal.
virtual void	realizeCockpit (DtObserver *obs, DtUniqueID &id, const std::string &modelDefinition="")
	send signals to the agent in the other thread to create a HUD
virtual void	unrealizeCockpit (DtObserver *obs)
	send signals to the agent in the other thread to remove a HUD
virtual const std::string &	dataPath () const
	get the data path to the HUD shared objects
virtual void	setDataPath (const std::string &path)
	set the data path to the HUD shared objects
virtual void	setCockpitsEnabled (bool enable)
	turns all cockpits on or off
virtual bool	cockpitsEnabled () const
	checks whether all cockpits are on or off
virtual void	hideEntity (const std::string &obsName)
	Hides entities on a given observer.
virtual void	unHideEntity (const std::string &obsName)
	unhides entities on a given observer
virtual void	setAttachmentHas3DCockpit (const std::string &obsName, bool cockpit)
	The GL Studio driver uses this to tell the observer that it's going to render a 3D cockpit so the observer can take that into account when determining znear.
virtual DtGlStudioAttributeUpdaterFactory &	updaterFactory ()
	returns the factory for object and visualizer updater objects
virtual bool	smoothingEnabled () const
	checks if HUD updater smoothing is enabled
virtual void	setSmoothingEnabled (bool smooth)
	sets whether HUD updater smoothing is enabled
virtual double	smoothingPeriod () const
	returns HUD updater smoothing period
virtual void	setSmoothingPeriod (const double &period)
	sets theHUD updater smoothing period
const DtSettingsBackup *	settingsBackup () const
	Accessor for the settings backup (const).
DtSettingsBackup *	settingsBackup ()
	Accessor for the settings backup.
virtual void	backup ()
	\brief Backs up current state using backup settings object
Public Member Functions inherited from makVrv::DtSharedSettings
	DtSharedSettings (const DtSharedSettingsManager &manager)
	CTOR.
virtual	~DtSharedSettings ()
	DTOR.
boost::shared_mutex &	mutex ()
	Get the mutex for the settings object.
SafetyKey	safeToEmitSignals ()
	Create a safety key for the function, see above example.
void	setCurrentWriteLock (boost::unique_lock< boost::shared_mutex > *currentWriteLock)
	No need to call, set by the DtWriteSettingLock object.
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
	Do nothing constructor.
virtual	~DtVirtualBaseClass ()
	Virtual do nothing destructor.

Static Public Member Functions
static std::string	className ()
	Get an instance of the settings object.

Protected Member Functions
	DtSharedCockpitSettings (DtSharedSettingsManager &manager)
	CTOR.

Protected Attributes
std::vector< DtUnicode >	myEmptyMappings
DtEntityTypeMapper *	myCockpitTypeMapper
std::string	myDataPath
bool	myCockpitsEnabled
bool	myCockpitSmoothingEnabled
double	myCockpitSmoothingPeriod
DtDe *	myDe
DtGlStudioAttributeUpdaterFactory	myUpdaterFactory
DtCockpitSettingsBackup *	mySettingsBackup

Friends
class	DtReadSettingsLock< DtSharedCockpitSettings >
	Also protected, use the DtReadSettingsLock and DtWriteSettingsLock to access the object.
class	DtWriteSettingsLock< DtSharedCockpitSettings >
class	DtSharedSettingsManager

Detailed Description

The shared simulation settings.

Constructor & Destructor Documentation

virtual makVrv::DtSharedCockpitSettings::~DtSharedCockpitSettings ( )

virtual

DTOR.

makVrv::DtSharedCockpitSettings::DtSharedCockpitSettings ( DtSharedSettingsManager &  manager )

protected

CTOR.

Member Function Documentation

static std::string makVrv::DtSharedCockpitSettings::className ( )

static

Get an instance of the settings object.

Also protected, use the DtReadSettingsLock and DtWriteSettingsLock to access the object.

void makVrv::DtSharedCockpitSettings::setCockpitMapper

(

const DtEntityTypeMapper &

cockpitTypeMapper

)

Set a number of the state parameters.

void makVrv::DtSharedCockpitSettings::setCockpitModelMapping	(	const DtEntityType &	type,
		const std::string &	definition
	)

Set the entity model mapping.

const std::vector<DtUnicode>& makVrv::DtSharedCockpitSettings::mapCockpitModelDefinition

(

const DtEntityType &

type

)

const

Get a model definition for an entity model based upon entity type.

virtual void makVrv::DtSharedCockpitSettings::setDe ( DtDe *  )

virtual

Sets the display engine used for the settings object.

const DtModelDefinition* makVrv::DtSharedCockpitSettings::findCockpitDefinition

(

const std::string &

str

)

const

finds a HUD definition if it exists. Returns NULL on failure

virtual DtEntityTypeMapper* makVrv::DtSharedCockpitSettings::findMapperByName ( const std::string &  name )

virtual

Get an mapper by name.

virtual const DtEntityTypeMapper* makVrv::DtSharedCockpitSettings::findMapperByName ( const std::string &  name ) const

virtual

virtual DtEntityTypeMapper& makVrv::DtSharedCockpitSettings::cockpitTypeMapper ( )

virtual

Entity type mapping.

virtual const DtEntityTypeMapper& makVrv::DtSharedCockpitSettings::cockpitTypeMapper ( ) const

virtual

virtual void makVrv::DtSharedCockpitSettings::setFromRecord ( const makArchives::DtCockpitSettingsRecord &  rec )

virtual

Set the entity settings as a record.

virtual void makVrv::DtSharedCockpitSettings::getRecord ( makArchives::DtCockpitSettingsRecord &  rec ) const

virtual

Get the settings as a record.

virtual void makVrv::DtSharedCockpitSettings::mapperChanged ( const DtEntityType &  type, const DtUnicode &  value, DtEntityTypeMapper &  mapper  )

virtual

Slot called when mapper changes. Uses shared message signaller to send out a mapperUpdated signal.

virtual void makVrv::DtSharedCockpitSettings::realizeCockpit ( DtObserver *  obs, DtUniqueID &  id, const std::string &  modelDefinition = ""  )

virtual

send signals to the agent in the other thread to create a HUD

virtual void makVrv::DtSharedCockpitSettings::unrealizeCockpit ( DtObserver *  obs )

virtual

send signals to the agent in the other thread to remove a HUD

virtual const std::string& makVrv::DtSharedCockpitSettings::dataPath ( ) const

virtual

get the data path to the HUD shared objects

virtual void makVrv::DtSharedCockpitSettings::setDataPath ( const std::string &  path )

virtual

set the data path to the HUD shared objects

virtual void makVrv::DtSharedCockpitSettings::setCockpitsEnabled ( bool  enable )

virtual

turns all cockpits on or off

virtual bool makVrv::DtSharedCockpitSettings::cockpitsEnabled ( ) const

virtual

checks whether all cockpits are on or off

virtual void makVrv::DtSharedCockpitSettings::hideEntity ( const std::string &  obsName )

virtual

Hides entities on a given observer.

virtual void makVrv::DtSharedCockpitSettings::unHideEntity ( const std::string &  obsName )

virtual

unhides entities on a given observer

virtual void makVrv::DtSharedCockpitSettings::setAttachmentHas3DCockpit ( const std::string &  obsName, bool  cockpit  )

virtual

The GL Studio driver uses this to tell the observer that it's going to render a 3D cockpit so the observer can take that into account when determining znear.

virtual DtGlStudioAttributeUpdaterFactory& makVrv::DtSharedCockpitSettings::updaterFactory ( )

virtual

returns the factory for object and visualizer updater objects

virtual bool makVrv::DtSharedCockpitSettings::smoothingEnabled ( ) const

virtual

checks if HUD updater smoothing is enabled

virtual void makVrv::DtSharedCockpitSettings::setSmoothingEnabled ( bool  smooth )

virtual

sets whether HUD updater smoothing is enabled

virtual double makVrv::DtSharedCockpitSettings::smoothingPeriod ( ) const

virtual

returns HUD updater smoothing period

virtual void makVrv::DtSharedCockpitSettings::setSmoothingPeriod ( const double &  period )

virtual

sets theHUD updater smoothing period

const DtSettingsBackup* makVrv::DtSharedCockpitSettings::settingsBackup ( ) const

inlinevirtual

Accessor for the settings backup (const).

Exceptions

DtCorruptedState

Re-implement to use.

Reimplemented from makVrv::DtSharedSettings.

DtSettingsBackup* makVrv::DtSharedCockpitSettings::settingsBackup ( )

inlinevirtual

Accessor for the settings backup.

Exceptions

DtCorruptedState

Re-implement to use.

Reimplemented from makVrv::DtSharedSettings.

virtual void makVrv::DtSharedCockpitSettings::backup ( )

virtual

\brief Backs up current state using backup settings object

Reimplemented from makVrv::DtSharedSettings.

Friends And Related Function Documentation

friend class DtReadSettingsLock< DtSharedCockpitSettings >

friend

Also protected, use the DtReadSettingsLock and DtWriteSettingsLock to access the object.

friend class DtWriteSettingsLock< DtSharedCockpitSettings >

friend

friend class DtSharedSettingsManager

friend

Member Data Documentation

std::vector<DtUnicode> makVrv::DtSharedCockpitSettings::myEmptyMappings

protected

DtEntityTypeMapper* makVrv::DtSharedCockpitSettings::myCockpitTypeMapper

protected

std::string makVrv::DtSharedCockpitSettings::myDataPath

protected

bool makVrv::DtSharedCockpitSettings::myCockpitsEnabled

protected

bool makVrv::DtSharedCockpitSettings::myCockpitSmoothingEnabled

protected

double makVrv::DtSharedCockpitSettings::myCockpitSmoothingPeriod

protected

DtDe* makVrv::DtSharedCockpitSettings::myDe

protected

DtGlStudioAttributeUpdaterFactory makVrv::DtSharedCockpitSettings::myUpdaterFactory

protected

DtCockpitSettingsBackup* makVrv::DtSharedCockpitSettings::mySettingsBackup

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvGlStudioShared/DtSharedCockpitSettings.h