makVrf::DtVrfExtendedIntervisibilitySettingsData Class Reference

This class will be used to store the extended intervisibility states and will be referenced by the DtVrfExtendedIntervisibilitySettings class. More...

Inheritance diagram for makVrf::DtVrfExtendedIntervisibilitySettingsData:

Classes
struct	Color
struct	IntervisibilitySettings

Public Types
enum	Flags {   UseBackendForIntersections = 0x00000001, IntersectTerrain = 0x00000002, IntersectFeatures = 0x00000004, IntersectEntities = 0x00000008,   WaitForServer = 0x00000010, Defaults = UseBackendForIntersections | IntersectTerrain }

Public Member Functions
	DtVrfExtendedIntervisibilitySettingsData (makVrv::DtDe *de=0)
	DtVrfExtendedIntervisibilitySettingsData (const DtVrfExtendedIntervisibilitySettingsData &)
virtual	~DtVrfExtendedIntervisibilitySettingsData ()
virtual void	setUseBackendForIntersections (const std::string &key, bool)
	Get/set whether or not to use a back-end for intersections.
virtual bool	useBackendForIntersections (const std::string &key) const
virtual void	setIntersectTerrain (const std::string &key, bool)
	Get/set whether or not to intersect the terrain on back-end intersections.
virtual bool	intersectTerrain (const std::string &key) const
virtual void	setIntersectFeatures (const std::string &key, bool)
	Get/set whether or not to intersect features on back-end intersections.
virtual bool	intersectFeatures (const std::string &key) const
virtual void	setIntersectEntities (const std::string &key, bool)
	Get/set whether or not to intersect entities on back-end intersections.
virtual bool	intersectEntities (const std::string &key) const
virtual void	setFanModeSamplingRate (const std::string &key, double)
	The sampling rate (in radians) around a circle to check for line of sight on a fan. Default is 10 degrees.
virtual double	fanModeSamplingRate (const std::string &key) const
virtual DtVrfGuiApplicationSetting *	clone () const
	Clone of this object.
virtual std::string	classType () const
	Must implement to return unique name of class.
virtual const IntervisibilitySettings &	settingsFor (const std::string &key) const
virtual IntervisibilitySettings &	settingsFor (const std::string &key)
virtual void	write (boost::archive::xml_oarchive &out, const unsigned int)
	Override to read/write settings.
virtual void	read (boost::archive::xml_iarchive &in, const unsigned int)
virtual void	setWaitTimeRequest (const std::string &key, double)
	The amount of time after movement has stopped to query the back-end rather than the front-end for terrain intersection information.
virtual double	waitTimeRequest (const std::string &key) const
virtual void	setWaitingForServerColor (const std::string &key, unsigned int)
	Accessor/mutator for the color for waiting for server.
virtual unsigned int	waitingForServerColor (const std::string &key) const
virtual void	setWaitForServer (const std::string &key, bool)
virtual bool	waitForServer (const std::string &key) const
virtual int	dataVersion ()
	Override in subclass to version data.
Public Member Functions inherited from makVrf::DtVrfGuiApplicationSetting
	DtVrfGuiApplicationSetting (makVrv::DtDe *=0)
	DtVrfGuiApplicationSetting (const DtVrfGuiApplicationSetting &)
virtual	~DtVrfGuiApplicationSetting ()

Protected Types
typedef std::map< std::string, IntervisibilitySettings >	ExtendedSettings

Protected Member Functions
virtual void	setFlag (const std::string &key, Flags, bool)
virtual bool	flagSet (const std::string &, Flags) const
Protected Member Functions inherited from makVrf::DtVrfGuiApplicationSetting
template<class Archive >
void	serialize (Archive &ar, const unsigned int version)
	When the class Archive corresponds to an output archive, the & operator is defined similar to <<.

Protected Attributes
ExtendedSettings	myExtendedSettings
Protected Attributes inherited from makVrf::DtVrfGuiApplicationSetting
makVrv::DtDe *	myDe

Additional Inherited Members
Static Public Member Functions inherited from makVrf::DtVrfGuiApplicationSetting
template<typename T >
static std::string	theClassType ()
template<typename T >
static DtVrfGuiApplicationSetting *	create (makVrv::DtDe &de)

Detailed Description

This class will be used to store the extended intervisibility states and will be referenced by the DtVrfExtendedIntervisibilitySettings class.

Member Typedef Documentation

typedef std::map<std::string, IntervisibilitySettings> makVrf::DtVrfExtendedIntervisibilitySettingsData::ExtendedSettings

protected

Member Enumeration Documentation

enum makVrf::DtVrfExtendedIntervisibilitySettingsData::Flags

Enumerator:

UseBackendForIntersections
IntersectTerrain
IntersectFeatures
IntersectEntities
WaitForServer
Defaults

Constructor & Destructor Documentation

makVrf::DtVrfExtendedIntervisibilitySettingsData::DtVrfExtendedIntervisibilitySettingsData

(

makVrv::DtDe *

de = 0

)

makVrf::DtVrfExtendedIntervisibilitySettingsData::DtVrfExtendedIntervisibilitySettingsData

(

const DtVrfExtendedIntervisibilitySettingsData &

)

virtual makVrf::DtVrfExtendedIntervisibilitySettingsData::~DtVrfExtendedIntervisibilitySettingsData ( )

virtual

Member Function Documentation

virtual void makVrf::DtVrfExtendedIntervisibilitySettingsData::setUseBackendForIntersections ( const std::string &  key, bool    )

virtual

Get/set whether or not to use a back-end for intersections.

virtual bool makVrf::DtVrfExtendedIntervisibilitySettingsData::useBackendForIntersections ( const std::string &  key ) const

virtual

virtual void makVrf::DtVrfExtendedIntervisibilitySettingsData::setIntersectTerrain ( const std::string &  key, bool    )

virtual

Get/set whether or not to intersect the terrain on back-end intersections.

virtual bool makVrf::DtVrfExtendedIntervisibilitySettingsData::intersectTerrain ( const std::string &  key ) const

virtual

virtual void makVrf::DtVrfExtendedIntervisibilitySettingsData::setIntersectFeatures ( const std::string &  key, bool    )

virtual

Get/set whether or not to intersect features on back-end intersections.

virtual bool makVrf::DtVrfExtendedIntervisibilitySettingsData::intersectFeatures ( const std::string &  key ) const

virtual

virtual void makVrf::DtVrfExtendedIntervisibilitySettingsData::setIntersectEntities ( const std::string &  key, bool    )

virtual

Get/set whether or not to intersect entities on back-end intersections.

virtual bool makVrf::DtVrfExtendedIntervisibilitySettingsData::intersectEntities ( const std::string &  key ) const

virtual

virtual void makVrf::DtVrfExtendedIntervisibilitySettingsData::setFanModeSamplingRate ( const std::string &  key, double    )

virtual

The sampling rate (in radians) around a circle to check for line of sight on a fan. Default is 10 degrees.

virtual double makVrf::DtVrfExtendedIntervisibilitySettingsData::fanModeSamplingRate ( const std::string &  key ) const

virtual

virtual DtVrfGuiApplicationSetting* makVrf::DtVrfExtendedIntervisibilitySettingsData::clone ( ) const

virtual

Clone of this object.

Implements makVrf::DtVrfGuiApplicationSetting.

virtual std::string makVrf::DtVrfExtendedIntervisibilitySettingsData::classType ( ) const

virtual

Must implement to return unique name of class.

Implements makVrf::DtVrfGuiApplicationSetting.

virtual const IntervisibilitySettings& makVrf::DtVrfExtendedIntervisibilitySettingsData::settingsFor ( const std::string &  key ) const

virtual

virtual IntervisibilitySettings& makVrf::DtVrfExtendedIntervisibilitySettingsData::settingsFor ( const std::string &  key )

virtual

virtual void makVrf::DtVrfExtendedIntervisibilitySettingsData::write ( boost::archive::xml_oarchive &  out, const unsigned  int  )

virtual

Override to read/write settings.

Implements makVrf::DtVrfGuiApplicationSetting.

virtual void makVrf::DtVrfExtendedIntervisibilitySettingsData::read ( boost::archive::xml_iarchive &  in, const unsigned  int  )

virtual

Implements makVrf::DtVrfGuiApplicationSetting.

virtual void makVrf::DtVrfExtendedIntervisibilitySettingsData::setWaitTimeRequest ( const std::string &  key, double    )

virtual

The amount of time after movement has stopped to query the back-end rather than the front-end for terrain intersection information.

Note that if the object starts moving again before the information is received from the back-end, the back-end result will be ignored. A time of 0 means to update every movement, which could flood the network with requests

virtual double makVrf::DtVrfExtendedIntervisibilitySettingsData::waitTimeRequest ( const std::string &  key ) const

virtual

virtual void makVrf::DtVrfExtendedIntervisibilitySettingsData::setWaitingForServerColor ( const std::string &  key, unsigned  int  )

virtual

Accessor/mutator for the color for waiting for server.

virtual unsigned int makVrf::DtVrfExtendedIntervisibilitySettingsData::waitingForServerColor ( const std::string &  key ) const

virtual

virtual void makVrf::DtVrfExtendedIntervisibilitySettingsData::setWaitForServer ( const std::string &  key, bool    )

virtual

virtual bool makVrf::DtVrfExtendedIntervisibilitySettingsData::waitForServer ( const std::string &  key ) const

virtual

virtual int makVrf::DtVrfExtendedIntervisibilitySettingsData::dataVersion ( )

inlinevirtual

Override in subclass to version data.

Reimplemented from makVrf::DtVrfGuiApplicationSetting.

virtual void makVrf::DtVrfExtendedIntervisibilitySettingsData::setFlag ( const std::string &  key, Flags  , bool    )

protectedvirtual

virtual bool makVrf::DtVrfExtendedIntervisibilitySettingsData::flagSet ( const std::string &  , Flags    ) const

protectedvirtual

Member Data Documentation

ExtendedSettings makVrf::DtVrfExtendedIntervisibilitySettingsData::myExtendedSettings

mutableprotected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfGuiCore/vrfExtendedIntervisibilitySettings.h