Simple widget that, if a location is set, will see if there is an entity under that location, and, if there is will set the name of the entity into the widget as something that could be embarked upon. More...

Inheritance diagram for makVrf::DtEmbarkationWidget:

[legend]

Classes
struct	ScribeBoxInfo
	current highlight information of selected embarkable object More...

Public Member Functions
	DtEmbarkationWidget (makVrv::DtDe &de, QWidget *parent, const Qt::WindowFlags &flags=0)
	CTOR.
virtual	~DtEmbarkationWidget ()
virtual void	setLocation (const DtVector &)
	Check to see if there is anything to embark on here at any of the locations. Locations are in local database coordinates.
virtual void	enable ()
	Whether or not the widget will update in response to setLocation sets.
virtual void	disable ()
virtual void	setCheckCanEmbarkOn (bool)
	Sets whether or not to check if this object the point is over can be embarked on. Default is false (i.e always embark)
virtual bool	checkCanEmbarkOn () const
virtual void	setIdsToIgnore (const std::vector< makVrv::DtUniqueID > &)
	The ids to ignore when doing the embark test.
virtual const std::vector < makVrv::DtUniqueID > &	idsToIgnore () const
virtual void	setEmbarkInSlotIfAvailableVisible (bool b)
virtual void	setEmbarkedOn (makVrv::DtUniqueID)
	Sets to specifically embark on the given object id.
virtual void	setStayEmbarkedIfEmbarked (bool)
	Set to true if this object should always stay embarked on the original object, regardless of where it moves to.
bool	stayEmbarkedIfEmbarked () const

Public Attributes
boost::signal< void(makVrv::DtUniqueID, bool)>	signal_embarkInformationChanged
QCheckBox *	myEnableAutomaticEmbarkation
QLabel *	myEmbarkOn
QCheckBox *	myEmbarkInSlotIfAvailable

Protected Types
typedef std::map < makVrv::DtUniqueID, std::vector< ScribeBoxInfo > >	ScribeBoxHighlightInfo

Protected Slots
virtual void	onEmbarkOnChanged ()
virtual void	onEmbarkInSlotIfAvailableChanged ()

Protected Member Functions
virtual void	setHighlight (makVrv::DtUniqueID, bool)
	Sets whether or not to highlight.
virtual void	setCurrentObserver (makVrv::DtObserver *observer)
virtual void	onCurrentObserverChanged (makVrv::DtInputDriver driver, makVrv::DtObserver observer)
virtual void	onObserverModeChanged (makVrv::DtObserver *observer, int mode)
virtual void	restoreOriginalHighlightInformation ()
virtual makVrv::DtOsgScribeBoxModel *	scribeBoxModelFor (makVrv::DtUniqueID displayId)
	Returns the scribe box mode (if exists) for the current display id.

Protected Attributes
bool	myEnabled
makVrv::DtDe &	myDe
DtVector	myLastLocation
std::vector< makVrv::DtUniqueID >	myIdsToIgnore
makVrv::DtUniqueID	myEmbarkId
makVrv::DtObserver *	myCurrentObserver
ScribeBoxHighlightInfo	myScribeBoxHighlightInfo
bool	myCheckCanEmbarkOn
bool	myStayEmbarkedIfEmbarked
bool	myWasEmbarked

Detailed Description

Simple widget that, if a location is set, will see if there is an entity under that location, and, if there is will set the name of the entity into the widget as something that could be embarked upon.

Member Typedef Documentation

typedef std::map<makVrv::DtUniqueID,std::vector<ScribeBoxInfo> > makVrf::DtEmbarkationWidget::ScribeBoxHighlightInfo

protected

Constructor & Destructor Documentation

makVrf::DtEmbarkationWidget::DtEmbarkationWidget	(	makVrv::DtDe &	de,
		QWidget *	parent,
		const Qt::WindowFlags &	flags = `0`
	)

CTOR.

virtual makVrf::DtEmbarkationWidget::~DtEmbarkationWidget ( )

virtual

Member Function Documentation

virtual void makVrf::DtEmbarkationWidget::setLocation ( const DtVector & )

virtual

Check to see if there is anything to embark on here at any of the locations. Locations are in local database coordinates.

virtual void makVrf::DtEmbarkationWidget::enable ( )

virtual

Whether or not the widget will update in response to setLocation sets.

virtual void makVrf::DtEmbarkationWidget::disable ( )

virtual

virtual void makVrf::DtEmbarkationWidget::setCheckCanEmbarkOn ( bool )

virtual

Sets whether or not to check if this object the point is over can be embarked on. Default is false (i.e always embark)

virtual bool makVrf::DtEmbarkationWidget::checkCanEmbarkOn ( ) const

virtual

virtual void makVrf::DtEmbarkationWidget::setIdsToIgnore ( const std::vector< makVrv::DtUniqueID > & )

virtual

The ids to ignore when doing the embark test.

virtual const std::vector<makVrv::DtUniqueID>& makVrf::DtEmbarkationWidget::idsToIgnore ( ) const

virtual

virtual void makVrf::DtEmbarkationWidget::setEmbarkInSlotIfAvailableVisible ( bool b )

virtual

virtual void makVrf::DtEmbarkationWidget::setEmbarkedOn ( makVrv::DtUniqueID )

virtual

Sets to specifically embark on the given object id.

If the object id IS NOT the same as whatever this widget thinks it should be embarked on, the automatic embarkation will be turned off

virtual void makVrf::DtEmbarkationWidget::setStayEmbarkedIfEmbarked ( bool )

virtual

Set to true if this object should always stay embarked on the original object, regardless of where it moves to.

This can be used for environmentals that can trail behind embarked objects

bool makVrf::DtEmbarkationWidget::stayEmbarkedIfEmbarked ( ) const

inline

virtual void makVrf::DtEmbarkationWidget::onEmbarkOnChanged ( )

protectedvirtualslot

virtual void makVrf::DtEmbarkationWidget::onEmbarkInSlotIfAvailableChanged ( )

protectedvirtualslot

virtual void makVrf::DtEmbarkationWidget::setHighlight	(	makVrv::DtUniqueID	,
		bool
	)

protectedvirtual

Sets whether or not to highlight.

virtual void makVrf::DtEmbarkationWidget::setCurrentObserver ( makVrv::DtObserver * observer )

protectedvirtual

virtual void makVrf::DtEmbarkationWidget::onCurrentObserverChanged	(	makVrv::DtInputDriver *	driver,
		makVrv::DtObserver *	observer
	)

protectedvirtual

virtual void makVrf::DtEmbarkationWidget::onObserverModeChanged	(	makVrv::DtObserver *	observer,
		int	mode
	)

protectedvirtual

virtual void makVrf::DtEmbarkationWidget::restoreOriginalHighlightInformation ( )

protectedvirtual

virtual makVrv::DtOsgScribeBoxModel* makVrf::DtEmbarkationWidget::scribeBoxModelFor ( makVrv::DtUniqueID displayId )

protectedvirtual

Returns the scribe box mode (if exists) for the current display id.

Member Data Documentation

boost::signal<void (makVrv::DtUniqueID, bool)> makVrf::DtEmbarkationWidget::signal_embarkInformationChanged

QCheckBox* makVrf::DtEmbarkationWidget::myEnableAutomaticEmbarkation

QLabel* makVrf::DtEmbarkationWidget::myEmbarkOn

QCheckBox* makVrf::DtEmbarkationWidget::myEmbarkInSlotIfAvailable

bool makVrf::DtEmbarkationWidget::myEnabled

protected

makVrv::DtDe& makVrf::DtEmbarkationWidget::myDe

protected

DtVector makVrf::DtEmbarkationWidget::myLastLocation

protected

std::vector<makVrv::DtUniqueID> makVrf::DtEmbarkationWidget::myIdsToIgnore

protected

makVrv::DtUniqueID makVrf::DtEmbarkationWidget::myEmbarkId

protected

makVrv::DtObserver* makVrf::DtEmbarkationWidget::myCurrentObserver

protected

ScribeBoxHighlightInfo makVrf::DtEmbarkationWidget::myScribeBoxHighlightInfo

protected

bool makVrf::DtEmbarkationWidget::myCheckCanEmbarkOn

protected

bool makVrf::DtEmbarkationWidget::myStayEmbarkedIfEmbarked

protected

bool makVrf::DtEmbarkationWidget::myWasEmbarked

protected

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-6-branch/include/vrfGuiCoreQt/embarkationWidget.h

Classes

Public Member Functions

Public Attributes

Protected Types

Protected Slots

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation