makVrf::DtVrfExtendedEntitySettingsData Class Reference

This class will be used to store the extended entity states and will be referenced by the DtVrfExtendedEntitySettings class. More...

Inheritance diagram for makVrf::DtVrfExtendedEntitySettingsData:

Public Member Functions
	DtVrfExtendedEntitySettingsData (makVrv::DtDe *=0)
	DtVrfExtendedEntitySettingsData (const DtVrfExtendedEntitySettingsData &)
virtual	~DtVrfExtendedEntitySettingsData ()
virtual void	setDisplayObjectConsoleWarningIcon (bool)
	Get/set whether or not to show the entity object console warning icon.
virtual bool	displayObjectConsoleWarningIcon () const
virtual void	setDisplayBoundingBoxesWhenSelected (bool)
	Get/set whether or not entity bounding boxes are shown when an entity is selected.
virtual bool	displayBoundingBoxesWhenSelected () const
virtual void	setPromptBeforeAbandoningPlan (bool)
	Get/set whether or user will be prompted to abandon plan before assigning task.
virtual bool	promptBeforeAbandoningPlan () const
virtual void	setPromptBeforeInterruptingTask (bool)
	Get/set whether or user will be prompted to interrupt current task before assigning task.
virtual bool	promptBeforeInterruptingTask () const
virtual DtVrfGuiApplicationSetting *	clone () const
	Clone of this object.
virtual std::string	classType () const
	Must implement to return unique name of class.
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)
Public Member Functions inherited from makVrf::DtVrfGuiApplicationSetting
	DtVrfGuiApplicationSetting (makVrv::DtDe *=0)
	DtVrfGuiApplicationSetting (const DtVrfGuiApplicationSetting &)
virtual	~DtVrfGuiApplicationSetting ()
virtual int	dataVersion ()
	Override in subclass to version data.

Protected Types
enum	Flags {   DisplayObjectConsoleWarningIcon = 0x00000001, DisplayBoundingBoxesWhenSelected = 0x00000002, PromptBeforeAbandoningPlan = 0x00000004, PromptBeforeInterruptingTask = 0x00000008,   Defaults }

Protected Member Functions
virtual void	setFlag (Flags, bool)
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
int	myFlags
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 entity states and will be referenced by the DtVrfExtendedEntitySettings class.

Member Enumeration Documentation

enum makVrf::DtVrfExtendedEntitySettingsData::Flags

protected

Enumerator:

DisplayObjectConsoleWarningIcon
DisplayBoundingBoxesWhenSelected
PromptBeforeAbandoningPlan
PromptBeforeInterruptingTask
Defaults

Constructor & Destructor Documentation

makVrf::DtVrfExtendedEntitySettingsData::DtVrfExtendedEntitySettingsData

(

makVrv::DtDe *

= 0

)

makVrf::DtVrfExtendedEntitySettingsData::DtVrfExtendedEntitySettingsData

(

const DtVrfExtendedEntitySettingsData &

)

virtual makVrf::DtVrfExtendedEntitySettingsData::~DtVrfExtendedEntitySettingsData ( )

virtual

Member Function Documentation

virtual void makVrf::DtVrfExtendedEntitySettingsData::setDisplayObjectConsoleWarningIcon ( bool  )

virtual

Get/set whether or not to show the entity object console warning icon.

virtual bool makVrf::DtVrfExtendedEntitySettingsData::displayObjectConsoleWarningIcon ( ) const

virtual

virtual void makVrf::DtVrfExtendedEntitySettingsData::setDisplayBoundingBoxesWhenSelected ( bool  )

virtual

Get/set whether or not entity bounding boxes are shown when an entity is selected.

Default is true

virtual bool makVrf::DtVrfExtendedEntitySettingsData::displayBoundingBoxesWhenSelected ( ) const

virtual

virtual void makVrf::DtVrfExtendedEntitySettingsData::setPromptBeforeAbandoningPlan ( bool  )

virtual

Get/set whether or user will be prompted to abandon plan before assigning task.

virtual bool makVrf::DtVrfExtendedEntitySettingsData::promptBeforeAbandoningPlan ( ) const

virtual

virtual void makVrf::DtVrfExtendedEntitySettingsData::setPromptBeforeInterruptingTask ( bool  )

virtual

Get/set whether or user will be prompted to interrupt current task before assigning task.

virtual bool makVrf::DtVrfExtendedEntitySettingsData::promptBeforeInterruptingTask ( ) const

virtual

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

virtual

Clone of this object.

Implements makVrf::DtVrfGuiApplicationSetting.

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

virtual

Must implement to return unique name of class.

Implements makVrf::DtVrfGuiApplicationSetting.

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

virtual

Override to read/write settings.

Implements makVrf::DtVrfGuiApplicationSetting.

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

virtual

Implements makVrf::DtVrfGuiApplicationSetting.

virtual void makVrf::DtVrfExtendedEntitySettingsData::setFlag ( Flags  , bool    )

protectedvirtual

Member Data Documentation

int makVrf::DtVrfExtendedEntitySettingsData::myFlags

protected

---

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

• include/vrfGuiCore/DtVrfExtendedEntitySettings.h