A DtEnvironmentalIconCenteringUpdater updates the attached scene object to be centered in the center of mass of a closed area or along the center of the line of an unclosed area. More...

Inheritance diagram for makVrv::DtEnvironmentalIconCenteringUpdater:

[legend]

Public Member Functions
	DtEnvironmentalIconCenteringUpdater (DtDe &de, DtUniqueID id)
	CTOR. More...

virtual	~DtEnvironmentalIconCenteringUpdater ()
	DTOR. More...

virtual bool	needsUpdate (DtTime tNow)
	Does this updater need to update? More...

virtual void	update (DtTime tNow)
	Calls centerIcon() More...

virtual void	setSceneObject (DtSceneObject *sceneObject)
	Set the scene object to be updated. More...

virtual void	setEnvironmentalSceneObject (DtSceneObject *sceneObject)
	Set the scene object that contains the original environmental (line or area). More...

virtual void	setOrderGroup (int)
	Sets the z order on which to place the icons. More...

Public Member Functions inherited from makVrv::DtTickable
virtual bool	updateIfNeeded (DtTime tNow)
	Calls needsUpdate(), and then calls update() if needsUpdate() is true. More...

virtual	~DtTickable ()
	Virtual DTOR. More...

virtual void	setIsThreadSafe (bool safe)
	Get/set whether this tickable can be updated in parallel with other tickables. More...

virtual bool	isThreadSafe () const

virtual void	setTickableListState (TickableListState safeList)
	Track which tickable list (if any) this tickable is on Since the tickable constructor puts ALL tickables on the main (unThreadSafe) to start we need a way to check which list a tickable is on (and this way we can request removals from the correct list instead of having to call DtTickableManager::removeTickableObject(), which tries both lists). More...

virtual TickableListState	tickableListState () const

virtual void	setUpdatePeriod (unsigned int period)
	Specify how often (in # of frames) this tickable should call update. More...

virtual unsigned int	updatePeriod () const

virtual bool	lodSystemEnabled () const
	is the update LOD system enabled, overridden by subclasses More...

Protected Member Functions
virtual void	centerIcon ()
	Find the actual position and orientation based on the attach points and offsets. More...

virtual DtVector	calculateGeometricCenter () const
	Calculates the geometric center of the polygonal area. More...

virtual DtVector	calculateLineCenter () const
	Calculates the point on the center of the line given the line distance. More...

virtual DtVector	centerOnLine (int startIndex, int endIndex, double lengthOnLine) const
	Centers the point on the given line segment. More...

Slots
Called when an object is to be deleted
virtual void	slot_sceneObjectToBeDeleted (const DtUniqueID &id)

virtual void	slot_modelAdded (DtModel *)
	Called when a model is added to the scene object. More...

virtual void	slot_modelRemoved (DtModel *)
	Called when a model is removed from the scene object. More...

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

	DtTickable ()
	Unimplemented default CTOR. More...

virtual void	slot_managerAboutToBeDeleted ()

Protected Attributes
DtDe &	myDe
	The display engine. More...

DtUniqueID	myUniqueId
	This distributed object's unique identifier. More...

DtSceneObject *	mySceneObject
	A pointer to the current scene object being updated. More...

DtPolygonModel *	myEnvironmentalPolygonModel
	A pointer to the current environmental model object. More...

DtLineModel *	myEnvironmentalLineModel

DtSceneObject *	myEnvironmentalSceneObject
	A pointer tothe current environmental scene object agent. More...

std::vector< DtVector >	myPoints
	Points that were last used for calculation. More...

int	myOrderGroup

bool	myUpdate

boost::signalslib::connection	mySceneObjectConnection

boost::signalslib::connection	myEnvironmentalSceneObjectConnection

boost::signalslib::connection	myModelAddedConnection

boost::signalslib::connection	myModelRemovedConnection

Protected Attributes inherited from makVrv::DtTickable
DtTickableManagerInterface *	myManager
	Pointer to manager for removal during destruction. More...

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 }
	Enumeration used to indicate which DtTickableManager's tickable list the tickable is on, if any. More...

Detailed Description

A DtEnvironmentalIconCenteringUpdater updates the attached scene object to be centered in the center of mass of a closed area or along the center of the line of an unclosed area.

Setting the control points or whether or not an item is closed will cause a recalculation of the center

Constructor & Destructor Documentation

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

CTOR.

virtual makVrv::DtEnvironmentalIconCenteringUpdater::~DtEnvironmentalIconCenteringUpdater ( )

virtual

DTOR.

Member Function Documentation

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

virtual

Does this updater need to update?

Reimplemented from makVrv::DtTickable.

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

virtual

Calls centerIcon()

Implements makVrv::DtTickable.

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

virtual

Set the scene object to be updated.

Parameters

[in] sceneObject is the scene object to receive updates.

virtual void makVrv::DtEnvironmentalIconCenteringUpdater::setEnvironmentalSceneObject ( DtSceneObject * sceneObject )

virtual

Set the scene object that contains the original environmental (line or area).

Parameters

[in] sceneObject is the scene object to look at for positional changes.

virtual void makVrv::DtEnvironmentalIconCenteringUpdater::setOrderGroup ( int )

virtual

Sets the z order on which to place the icons.

virtual void makVrv::DtEnvironmentalIconCenteringUpdater::centerIcon ( )

protectedvirtual

Find the actual position and orientation based on the attach points and offsets.

virtual DtVector makVrv::DtEnvironmentalIconCenteringUpdater::calculateGeometricCenter ( ) const

protectedvirtual

Calculates the geometric center of the polygonal area.

virtual DtVector makVrv::DtEnvironmentalIconCenteringUpdater::calculateLineCenter ( ) const

protectedvirtual

Calculates the point on the center of the line given the line distance.

virtual DtVector makVrv::DtEnvironmentalIconCenteringUpdater::centerOnLine	(	int	startIndex,
		int	endIndex,
		double	lengthOnLine
	)		const

protectedvirtual

Centers the point on the given line segment.

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

protectedvirtual

virtual void makVrv::DtEnvironmentalIconCenteringUpdater::slot_modelAdded ( DtModel * )

protectedvirtual

Called when a model is added to the scene object.

virtual void makVrv::DtEnvironmentalIconCenteringUpdater::slot_modelRemoved ( DtModel * )

protectedvirtual

Called when a model is removed from the scene object.

Member Data Documentation

DtDe& makVrv::DtEnvironmentalIconCenteringUpdater::myDe

protected

The display engine.

DtUniqueID makVrv::DtEnvironmentalIconCenteringUpdater::myUniqueId

protected

This distributed object's unique identifier.

DtSceneObject* makVrv::DtEnvironmentalIconCenteringUpdater::mySceneObject

protected

A pointer to the current scene object being updated.

DtPolygonModel* makVrv::DtEnvironmentalIconCenteringUpdater::myEnvironmentalPolygonModel

protected

A pointer to the current environmental model object.

Only one may be valid, however, both pointers are around for convenience

DtLineModel* makVrv::DtEnvironmentalIconCenteringUpdater::myEnvironmentalLineModel

protected

DtSceneObject* makVrv::DtEnvironmentalIconCenteringUpdater::myEnvironmentalSceneObject

protected

A pointer tothe current environmental scene object agent.

std::vector<DtVector> makVrv::DtEnvironmentalIconCenteringUpdater::myPoints

protected

Points that were last used for calculation.

int makVrv::DtEnvironmentalIconCenteringUpdater::myOrderGroup

protected

bool makVrv::DtEnvironmentalIconCenteringUpdater::myUpdate

protected

boost::signalslib::connection makVrv::DtEnvironmentalIconCenteringUpdater::mySceneObjectConnection

protected

boost::signalslib::connection makVrv::DtEnvironmentalIconCenteringUpdater::myEnvironmentalSceneObjectConnection

protected

boost::signalslib::connection makVrv::DtEnvironmentalIconCenteringUpdater::myModelAddedConnection

protected

boost::signalslib::connection makVrv::DtEnvironmentalIconCenteringUpdater::myModelRemovedConnection

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrvCore/DtEnvironmentalIconCenteringUpdater.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation