Inheritance diagram for makVrv::DtInfoWidgetUpdater:

Public Member Functions
	DtInfoWidgetUpdater ()=delete

	DtInfoWidgetUpdater (const DtInfoWidgetUpdater &)=delete

DtInfoWidgetUpdater &	operator= (const DtInfoWidgetUpdater &)=delete

	DtInfoWidgetUpdater (DtDe &de, DtUniqueID id)

virtual	~DtInfoWidgetUpdater ()

virtual bool	needsUpdate (DtTime tNow) override

virtual void	update (DtTime tNow) override

virtual void	setWidget (DtWidgetLabel *widget)

virtual void	setSceneObject (DtSceneObject *sceneObject)

virtual void	slot_sceneObjectToBeDeleted (const DtUniqueID &id)

virtual void	slot_coordinateSystemChanged ()

virtual void	setDisplayUnitCollection (const DtUnicode &displayUnitType)

virtual void	setForceType (int force)

virtual void	setDisplayStrings (std::string displayName, std::string objectType, std::string identifierString)

virtual void	setVisible (bool v)

Public Member Functions inherited from makVrv::DtTickable
virtual bool	updateIfNeeded (DtTime tNow)

virtual	~DtTickable ()

virtual void	setIsThreadSafe (bool safe)

virtual bool	isThreadSafe () const

virtual void	setTickableListState (TickableListState safeList)

virtual TickableListState	tickableListState () const

virtual void	setUpdatePeriod (unsigned int period)

virtual unsigned int	updatePeriod () const

virtual bool	lodSystemEnabled () const

Protected Member Functions
virtual void	updateDisplayUnitCollectionNameIfNeeded ()

virtual void	updateBasedOnLatestDisplayUnitSettings ()

virtual void	connectToDisplayUnitSettingSignals ()

virtual DtUnicode	generateInfoString (DtTime tNow) const

Protected Member Functions inherited from makVrv::DtTickable
	DtTickable (DtTickableManagerInterface *manager)

	DtTickable ()

virtual void	slot_managerAboutToBeDeleted ()

Protected Attributes
DtDe &	myDe

DtWidgetLabel *	myWidgetLabel

DtSceneObject *	mySceneObject

const DtDisplayUnitsConverter &	myDisplayUnitsConverter

boost::signalslib::connection	mySceneObjectConnection

DtUnicode	myDisplayUnitCollectionName

bool	myDisplayUnitInformationIsInitialized

DtForceType	myForceType

std::string	myForceName

std::string	myDisplayName

std::string	myObjectType

std::string	myIdentifierString

bool	myIsVisible

DtTime	myLastUpdateTime

DtSignalConnectionManager	myConnections

DtCoordinateSystem *	myCoordinateSystem = nullptr

Protected Attributes inherited from makVrv::DtTickable
DtTickableManagerInterface *	myManager

DtSignalConnectionManager	myConnections

unsigned int	myFrameCounter

unsigned int	myFrameToUpdate

unsigned int	myUpdatePeriod

DtTime	myLastUpdateTime

bool	myIsThreadSafe

TickableListState	myTickableListState

Additional Inherited Members
Public Types inherited from makVrv::DtTickable
enum	TickableListState { TickableNotOnList, TickableOnMainList, TickableOnThreadSafeList }

Constructor & Destructor Documentation

makVrv::DtInfoWidgetUpdater::DtInfoWidgetUpdater ( )

delete

default constructor - not allowed

makVrv::DtInfoWidgetUpdater::DtInfoWidgetUpdater ( const DtInfoWidgetUpdater & )

delete

copy constructor - not allowed

makVrv::DtInfoWidgetUpdater::DtInfoWidgetUpdater	(	DtDe &	de,
		DtUniqueID	id
	)

CTOR.

virtual makVrv::DtInfoWidgetUpdater::~DtInfoWidgetUpdater ( )

virtual

DTOR.

Member Function Documentation

DtInfoWidgetUpdater& makVrv::DtInfoWidgetUpdater::operator= ( const DtInfoWidgetUpdater & )

delete

equals operator - not allowed

virtual bool makVrv::DtInfoWidgetUpdater::needsUpdate ( DtTime tNow )

overridevirtual

Checks myIsVisible.

Reimplemented from makVrv::DtTickable.

virtual void makVrv::DtInfoWidgetUpdater::update ( DtTime tNow )

overridevirtual

The update function called by DtTickableManager during update-ticks.

Parameters

[in] tNow is the current time-stamp.

Implements makVrv::DtTickable.

virtual void makVrv::DtInfoWidgetUpdater::setWidget ( DtWidgetLabel * widget )

virtual

Set the widget that this updater will update the text on.

virtual void makVrv::DtInfoWidgetUpdater::setSceneObject ( DtSceneObject * sceneObject )

virtual

Set the scene object that this updater will get position orientation information from.

virtual void makVrv::DtInfoWidgetUpdater::slot_sceneObjectToBeDeleted ( const DtUniqueID & id )

virtual

Called when the scene object we are updating from is destroyed.

virtual void makVrv::DtInfoWidgetUpdater::slot_coordinateSystemChanged ( )

virtual

slot for when the coordinate system changes

virtual void makVrv::DtInfoWidgetUpdater::setDisplayUnitCollection ( const DtUnicode & displayUnitType )

virtual

Converts to DtUnicode.

virtual void makVrv::DtInfoWidgetUpdater::setForceType ( int force )

virtual

Set the force type, used to look up force type string from force manager.

virtual void makVrv::DtInfoWidgetUpdater::setDisplayStrings	(	std::string	displayName,
		std::string	objectType,
		std::string	identifierString
	)

virtual

Set the display name, the object type, and the identifier string.

virtual void makVrv::DtInfoWidgetUpdater::setVisible ( bool v )

virtual

Tell the updater if the widget is visible, this is to avoid update getting called when not required.

virtual void makVrv::DtInfoWidgetUpdater::updateDisplayUnitCollectionNameIfNeeded ( )

protectedvirtual

Update myDisplayUnitCollectionName, if it is still equal to Default.

virtual void makVrv::DtInfoWidgetUpdater::updateBasedOnLatestDisplayUnitSettings ( )

protectedvirtual

Updates all the cached display unit settings for the updater. This function does nothing - implementation should be provided by child classes as the display unit settings of interest may vary by updater type. Called on first update and whenever the display unit settings change.

Reimplemented in makVrv::DtAggregateInfoWidgetUpdater, makVrv::DtEnvironmentalInfoWidgetUpdater, and makVrv::DtEntityInfoWidgetUpdater.

virtual void makVrv::DtInfoWidgetUpdater::connectToDisplayUnitSettingSignals ( )

protectedvirtual

Connect to display unit settings signals of interest. This function does nothing - implementation should be provided by child classes as the display unit settings of interest may vary by updater type. Called once on first update.

Reimplemented in makVrv::DtAggregateInfoWidgetUpdater, makVrv::DtEnvironmentalInfoWidgetUpdater, and makVrv::DtEntityInfoWidgetUpdater.

virtual DtUnicode makVrv::DtInfoWidgetUpdater::generateInfoString ( DtTime tNow ) const

protectedvirtual

Generate the information string that can be seen on screen Time is required to fetch the velocity from the DR updater.

Reimplemented in makVrv::DtAggregateInfoWidgetUpdater, makVrv::DtEnvironmentalInfoWidgetUpdater, and makVrv::DtEntityInfoWidgetUpdater.

Member Data Documentation

DtDe& makVrv::DtInfoWidgetUpdater::myDe

protected

DtWidgetLabel* makVrv::DtInfoWidgetUpdater::myWidgetLabel

protected

DtSceneObject* makVrv::DtInfoWidgetUpdater::mySceneObject

protected

const DtDisplayUnitsConverter& makVrv::DtInfoWidgetUpdater::myDisplayUnitsConverter

protected

boost::signalslib::connection makVrv::DtInfoWidgetUpdater::mySceneObjectConnection

protected

When the class is destructed, the scene object may or may not exist. Using a separate connection variable makes it possible to 'disconnect' even if the scene object has been deleted.

DtUnicode makVrv::DtInfoWidgetUpdater::myDisplayUnitCollectionName

protected

bool makVrv::DtInfoWidgetUpdater::myDisplayUnitInformationIsInitialized

protected

DtForceType makVrv::DtInfoWidgetUpdater::myForceType

protected

std::string makVrv::DtInfoWidgetUpdater::myForceName

protected

std::string makVrv::DtInfoWidgetUpdater::myDisplayName

protected

std::string makVrv::DtInfoWidgetUpdater::myObjectType

protected

std::string makVrv::DtInfoWidgetUpdater::myIdentifierString

protected

bool makVrv::DtInfoWidgetUpdater::myIsVisible

protected

DtTime makVrv::DtInfoWidgetUpdater::myLastUpdateTime

protected

DtSignalConnectionManager makVrv::DtInfoWidgetUpdater::myConnections

protected

DtCoordinateSystem* makVrv::DtInfoWidgetUpdater::myCoordinateSystem = nullptr

protected

local clone of the system wide coordinate system. for thread safety.

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrvCore/DtInfoWidgetUpdater.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation