The DtTacticalGraphicDataInterface class is a wrapper around state views to give access to convenience methods which will allow developers to more easily access data about those objects. More...

Inheritance diagram for makVrf::DtTacticalGraphicDataInterface:

[legend]

Public Member Functions
	DtTacticalGraphicDataInterface (makVrv::DtDe &)
virtual	~DtTacticalGraphicDataInterface ()
virtual void	setStateView (const makVrv::DtStateView< makVrv::DtSimState > *)
	Called to set the state view this data will wrap.
virtual makVrv::DtElementEntry::ElementType	type () const
	Returns the type of this object. Used for dynamic casting to proper sub-class.
virtual DtVector	location (Representation rep=Local) const
	Returns the first point in the myPoints list of the state view.
virtual std::vector< DtVector >	locations (Representation rep=Local) const
	Returns all points.
virtual std::string	userData () const
	Returns the user data associated with this object.
virtual int	penStyle () const
	Returns the pen style of this environmental.
virtual int	fillStyle () const
	Returns the fill style.
virtual int	lineWidth () const
	Returns the line width.
virtual int	color () const
	Returns the color (RGBA value)
makVrv::DtStateView < DtVrlinkSimulatedEnvironmentProcess > *	environmentStateView () const
	Returns the state view of this class.
Public Member Functions inherited from makVrf::DtVrfVrlinkDataInterface
	DtVrfVrlinkDataInterface (makVrv::DtDe &)
virtual	~DtVrfVrlinkDataInterface ()
makVrv::DtStateView < makVrv::DtVrlinkSimulatedBaseState > *	vrlinkStateView () const
makVrv::DtStateView < DtVrfObjectDataState > *	objectDataState () const
const makVrv::DtStateView < DtExtendedStateData > *	extendedDataState () const
virtual const DtSimpleTypedDictionary &	extendedData () const
	Extended state data, if exists. Default if not.
DtVrfDataInterraceResourceRequestor &	resourceRequestor ()
	Use this class to control the update rate of resources.
virtual void	requestResources ()
	Requests resources for this item.
virtual std::string	name () const
	Returns the name (marking text) of the object.
virtual std::string	entityType () const
	Returns the type of the object.
virtual std::string	entityId () const
	Returns the objects entity id.
virtual std::string	globalId () const
	Returns the objects global id.
virtual bool	isCurrentlyTasked () const
	Returns if object is currently tasked.
virtual bool	isExecutingPlan () const
	Returns if executing a plan.
const DtVrfDataInterraceResourceRequestor::ResourceMap &	resources () const
Public Member Functions inherited from makVrf::DtObjectDataInterface
	DtObjectDataInterface (makVrv::DtDe &)
virtual	~DtObjectDataInterface ()
makVrv::DtElementID	elementID () const
	Returns the element id of this object.
virtual makVrv::DtSimEntryUpdater::UpdateRate	setUpdateRate (makVrv::DtSimEntryUpdater::UpdateRate)
	Sets the update rate for the data contained in this data interface.
makVrv::DtSimEntryUpdater::UpdateRate	updateRate () const
	Returns the current update rate.
virtual void	forceUpdate ()
	Forces an update of the data so on the next tick the network thread will update data in the gui thread.
virtual bool	isValid () const
	Returns true if this is a valid data interface.
virtual bool	hasBeenRemoved () const
	Returns true if this item has been removed from the simulation.
virtual bool	isVisible () const
	Returns true if the item is visible.
virtual void	setVisible (bool)
	Sets the item to visible or invisible.
virtual bool	isSelected () const
	Returns true if the item is selected.
virtual void	removeFromSelection ()
	Removes the item from the current selection.
virtual void	addToSelection (bool replace=false)
	Adds the item to the current selection. If replace is true will replace the current selection and leave only the item.

Protected Member Functions
virtual void	slot_simObjectEntryAboutToBeRemoved (makVrv::DtSimObjectEntry &)
	Slot that is called when the state view is destroyed. Will mark this item as removed by clearing out internal pointers.
Protected Member Functions inherited from makVrf::DtVrfVrlinkDataInterface
virtual void	slot_onResourcesChanged ()
	Slot called when resources have changed. Will send out resourcesChanged signal.
Protected Member Functions inherited from makVrf::DtObjectDataInterface
virtual DtVector	geocentricVectorToLocalVector (const DtVector &localLocation, const DtVector &geocVector) const
	Converts a geocentric vector to a local vector, given the local location.
virtual void	slot_onStateViewUpdated ()
	Called when any of the state views data has been updated. Sends out signal_dataUpdated.

Protected Attributes
makVrv::DtStateView < DtVrlinkSimulatedEnvironmentProcess > *	myTacticalGraphicStateView
Protected Attributes inherited from makVrf::DtVrfVrlinkDataInterface
makVrv::DtStateView < makVrv::DtVrlinkSimulatedBaseState > *	myVrlinkStateView
makVrv::DtStateView < DtVrfObjectDataState > *	myObjectDataState
makVrv::DtStateView < DtExtendedStateData > *	myExtendedStateData
DtVrfDataInterraceResourceRequestor	myResources
Protected Attributes inherited from makVrf::DtObjectDataInterface
makVrv::DtDe &	myDe
makVrv::DtStateView < makVrv::DtSimState > *	myStateView

Additional Inherited Members
Public Types inherited from makVrf::DtObjectDataInterface
enum	Representation { Local = 0, World = 1 }
	Use these enums in various information methods to return data in local or world coordinates. More...
Static Public Member Functions inherited from makVrf::DtObjectDataInterface
template<typename T_ObjectDataInterfaceType >
static DtBoost::shared_ptr < T_ObjectDataInterfaceType >	cast (DtBoost::shared_ptr< DtObjectDataInterface > dataInterface)
	This is a convenience method for casting a DtBoost::shared_ptr to a DtObjectDataInterface to a derived class.
Public Attributes inherited from makVrf::DtVrfVrlinkDataInterface
boost::signal< void()>	signal_resourcesChanged
	Signal sent when resources have changed.

Detailed Description

The DtTacticalGraphicDataInterface class is a wrapper around state views to give access to convenience methods which will allow developers to more easily access data about those objects.

It will also provide some basic manipulation for that object

Constructor & Destructor Documentation

makVrf::DtTacticalGraphicDataInterface::DtTacticalGraphicDataInterface ( makVrv::DtDe & )

virtual makVrf::DtTacticalGraphicDataInterface::~DtTacticalGraphicDataInterface ( )

virtual

Member Function Documentation

virtual void makVrf::DtTacticalGraphicDataInterface::setStateView ( const makVrv::DtStateView< makVrv::DtSimState > * )

virtual

Called to set the state view this data will wrap.

Subclasses are responsible for providing interface to access the specific data, however, you can access the data through the state() members of the contained state views. Overridden to cast to appropriate type

Reimplemented from makVrf::DtVrfVrlinkDataInterface.

virtual makVrv::DtElementEntry::ElementType makVrf::DtTacticalGraphicDataInterface::type ( ) const

virtual

Returns the type of this object. Used for dynamic casting to proper sub-class.

Reimplemented from makVrf::DtObjectDataInterface.

virtual DtVector makVrf::DtTacticalGraphicDataInterface::location ( Representation rep = Local ) const

virtual

Returns the first point in the myPoints list of the state view.

Reimplemented from makVrf::DtVrfVrlinkDataInterface.

virtual std::vector<DtVector> makVrf::DtTacticalGraphicDataInterface::locations ( Representation rep = Local ) const

virtual

Returns all points.

virtual std::string makVrf::DtTacticalGraphicDataInterface::userData ( ) const

virtual

Returns the user data associated with this object.

virtual int makVrf::DtTacticalGraphicDataInterface::penStyle ( ) const

virtual

Returns the pen style of this environmental.

virtual int makVrf::DtTacticalGraphicDataInterface::fillStyle ( ) const

virtual

Returns the fill style.

virtual int makVrf::DtTacticalGraphicDataInterface::lineWidth ( ) const

virtual

Returns the line width.

virtual int makVrf::DtTacticalGraphicDataInterface::color ( ) const

virtual

Returns the color (RGBA value)

makVrv::DtStateView<DtVrlinkSimulatedEnvironmentProcess>* makVrf::DtTacticalGraphicDataInterface::environmentStateView ( ) const

inline

Returns the state view of this class.

virtual void makVrf::DtTacticalGraphicDataInterface::slot_simObjectEntryAboutToBeRemoved ( makVrv::DtSimObjectEntry & )

protectedvirtual

Slot that is called when the state view is destroyed. Will mark this item as removed by clearing out internal pointers.

Reimplemented from makVrf::DtVrfVrlinkDataInterface.

Member Data Documentation

makVrv::DtStateView<DtVrlinkSimulatedEnvironmentProcess>* makVrf::DtTacticalGraphicDataInterface::myTacticalGraphicStateView

protected

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

include/vrfGuiCore/DtTacticalGraphicDataInterface.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation