makVrf::DtSpotReportDataInterface Class Reference

The DtSpotReportDataInterface 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::DtSpotReportDataInterface:

Public Member Functions
	DtSpotReportDataInterface (makVrv::DtDe &)
virtual	~DtSpotReportDataInterface ()
virtual makVrv::DtElementEntry::ElementType	type () const
	Returns the type of this object. Used for dynamic casting to proper sub-class.
makVrv::DtStateView < DtSpotReportState > *	spotReportStateView () const
	Access to the complete set of data on the spot report object is done though this method.
virtual DtVector	location (Representation rep=Local) const
	Returns the location of the entity.
virtual std::string	name () const
	Returns the label of the object.
virtual DtTaitBryan	orientation (Representation rep=Local) const
	Returns the orientation of the object.
virtual std::string	entityType () const
	Returns the type of the object.
virtual DtVector	velocity (Representation rep=Local) const
	Returns the objects velocity.
virtual DtVector	acceleration (Representation rep=Local) const
	Returns the objects acceleration.
virtual double	heading () const
	Returns the objects topographic heading (in degrees)
virtual void	setStateView (const makVrv::DtStateView< makVrv::DtSimState > *)
	Called to set the state view this data will wrap.
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::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 < DtSpotReportState > *	mySpotReportStateView
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::DtObjectDataInterface
boost::signal< void()>	signal_dataUpdated
	Signal sent when any of this items data has been updated.
boost::signal< void()>	signal_dataRemoved
	Signal send when this items data has been removed.

Detailed Description

The DtSpotReportDataInterface 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.

See Also

DtObjectDataInterface

Examples

GUI Object Data Interface example.

Constructor & Destructor Documentation

makVrf::DtSpotReportDataInterface::DtSpotReportDataInterface

(

makVrv::DtDe &

)

virtual makVrf::DtSpotReportDataInterface::~DtSpotReportDataInterface ( )

virtual

Member Function Documentation

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

virtual

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

Reimplemented from makVrf::DtObjectDataInterface.

makVrv::DtStateView<DtSpotReportState>* makVrf::DtSpotReportDataInterface::spotReportStateView ( ) const

inline

Access to the complete set of data on the spot report object is done though this method.

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

virtual

Returns the location of the entity.

virtual std::string makVrf::DtSpotReportDataInterface::name ( ) const

virtual

Returns the label of the object.

virtual DtTaitBryan makVrf::DtSpotReportDataInterface::orientation ( Representation  rep = Local ) const

virtual

Returns the orientation of the object.

virtual std::string makVrf::DtSpotReportDataInterface::entityType ( ) const

virtual

Returns the type of the object.

virtual DtVector makVrf::DtSpotReportDataInterface::velocity ( Representation  rep = Local ) const

virtual

Returns the objects velocity.

virtual DtVector makVrf::DtSpotReportDataInterface::acceleration ( Representation  rep = Local ) const

virtual

Returns the objects acceleration.

virtual double makVrf::DtSpotReportDataInterface::heading ( ) const

virtual

Returns the objects topographic heading (in degrees)

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

virtual

Called to set the state view this data will wrap.

Reimplemented from makVrf::DtObjectDataInterface.

virtual void makVrf::DtSpotReportDataInterface::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::DtObjectDataInterface.

Member Data Documentation

makVrv::DtStateView<DtSpotReportState>* makVrf::DtSpotReportDataInterface::mySpotReportStateView

protected

---

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

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