makVrf::DtSensorContactLinesUpdater Class Reference

Udpater that will update the sensor contact lines and positions for entities sensor contacts. More...

Inheritance diagram for makVrf::DtSensorContactLinesUpdater:

Classes
struct	Object

Public Member Functions
	DtSensorContactLinesUpdater (makVrv::DtDe &de, makVrv::DtUniqueID id)
	CTOR.
virtual	~DtSensorContactLinesUpdater ()
	DTOR.
virtual void	update (DtTime tNow)
	The update function called by DtTickableManager during update-ticks.
virtual void	setSceneObject (makVrv::DtSceneObject *sceneObject)
	Set the scene object that is representative of the entity that is doing the sensing.
virtual void	setSensorContactLinesModel (DtSensorContactLinesModel *)
	Set the model that will contain all the sensor contact lines.
virtual void	setEnabled (bool)
	Whether or not this class should be updating.
Public Member Functions inherited from makVrv::DtTickable
virtual	~DtTickable ()
	Virtual DTOR.
virtual void	setUpdatePeriod (unsigned int period)
	Specify how often (in # of frames) this tickable should call update.
virtual unsigned int	updatePeriod () const

Protected Types
typedef std::map < makVrv::DtUniqueID, Object >	SensorContacts

Protected Member Functions
virtual bool	needsUpdate (DtTime tNow)
	The check function called by DtTickableManager to verify if an update is required.
virtual void	slot_sceneObjectToBeDeleted (const makVrv::DtUniqueID &id)
virtual void	slot_contactInfoReceived (DtUUID, const DtVrfSensorInfoManager::DtSensorInformationMap &)
virtual void	slot_sensorContactLinesModelToBeDestroyed (makVrv::DtModel *)
virtual void	addSensorContact (makVrv::DtUniqueID)
virtual void	slot_sensorContactToBeDeleted (const makVrv::DtUniqueID &id)
virtual void	connectSceneObject ()
virtual void	clearSensorContacts (SensorContacts &)
virtual bool	findSpotReportFor (Object &)
Protected Member Functions inherited from makVrv::DtTickable
	DtTickable (DtTickableManagerInterface *manager)
	CTOR.
	DtTickable ()
	Unimplemented default CTOR.
virtual void	slot_managerAboutToBeDeleted ()

Protected Attributes
SensorContacts	mySensorContacts
makVrv::DtSceneObject *	mySceneObject
DtSensorContactLinesModel *	mySensorContactLinesModel
bool	myEnabled
makVrv::DtDe &	myDe
makVrv::DtUniqueID	myUniqueId
bool	myPendingConnection
DtVector	myLastPosition
boost::signalslib::connection	mySceneObjectConnection
	When the class is destructed, the scene object may or may not exist.
Protected Attributes inherited from makVrv::DtTickable
DtTickableManagerInterface *	myManager
	Pointer to manager for removal during destruction.
DtSignalConnectionManager	myConnections
unsigned int	myFrameCounter
unsigned int	myFrameToUpdate
unsigned int	myUpdatePeriod

Detailed Description

Udpater that will update the sensor contact lines and positions for entities sensor contacts.

The entity is defined by the ID of the supplied scene object

Member Typedef Documentation

typedef std::map<makVrv::DtUniqueID, Object> makVrf::DtSensorContactLinesUpdater::SensorContacts

protected

Constructor & Destructor Documentation

makVrf::DtSensorContactLinesUpdater::DtSensorContactLinesUpdater	(	makVrv::DtDe &	de,
		makVrv::DtUniqueID	id
	)

CTOR.

virtual makVrf::DtSensorContactLinesUpdater::~DtSensorContactLinesUpdater ( )

virtual

DTOR.

Member Function Documentation

virtual void makVrf::DtSensorContactLinesUpdater::update ( DtTime  tNow )

virtual

The update function called by DtTickableManager during update-ticks.

Parameters

[in]

tNow

is the current time-stamp.

Implements makVrv::DtTickable.

virtual void makVrf::DtSensorContactLinesUpdater::setSceneObject ( makVrv::DtSceneObject *  sceneObject )

virtual

Set the scene object that is representative of the entity that is doing the sensing.

virtual void makVrf::DtSensorContactLinesUpdater::setSensorContactLinesModel ( DtSensorContactLinesModel *  )

virtual

Set the model that will contain all the sensor contact lines.

virtual void makVrf::DtSensorContactLinesUpdater::setEnabled ( bool  )

virtual

Whether or not this class should be updating.

virtual bool makVrf::DtSensorContactLinesUpdater::needsUpdate ( DtTime  tNow )

protectedvirtual

The check function called by DtTickableManager to verify if an update is required.

If this function returns true, the DtTickableManager will then call update().

Parameters

[in]

tNow

is the current time-stamp.

Return values

true	if this object needs to be ticked.
false	otherwise. The base class checks handles period checks (for tickables that don't tick every frame. Deriving methods can incorporate that capability by calling down to the base class first.

Reimplemented from makVrv::DtTickable.

virtual void makVrf::DtSensorContactLinesUpdater::slot_sceneObjectToBeDeleted ( const makVrv::DtUniqueID &  id )

protectedvirtual

virtual void makVrf::DtSensorContactLinesUpdater::slot_contactInfoReceived ( DtUUID  , const DtVrfSensorInfoManager::DtSensorInformationMap &    )

protectedvirtual

virtual void makVrf::DtSensorContactLinesUpdater::slot_sensorContactLinesModelToBeDestroyed ( makVrv::DtModel *  )

protectedvirtual

virtual void makVrf::DtSensorContactLinesUpdater::addSensorContact ( makVrv::DtUniqueID  )

protectedvirtual

virtual void makVrf::DtSensorContactLinesUpdater::slot_sensorContactToBeDeleted ( const makVrv::DtUniqueID &  id )

protectedvirtual

virtual void makVrf::DtSensorContactLinesUpdater::connectSceneObject ( )

protectedvirtual

virtual void makVrf::DtSensorContactLinesUpdater::clearSensorContacts ( SensorContacts &  )

protectedvirtual

virtual bool makVrf::DtSensorContactLinesUpdater::findSpotReportFor ( Object &  )

protectedvirtual

Member Data Documentation

SensorContacts makVrf::DtSensorContactLinesUpdater::mySensorContacts

protected

makVrv::DtSceneObject* makVrf::DtSensorContactLinesUpdater::mySceneObject

protected

DtSensorContactLinesModel* makVrf::DtSensorContactLinesUpdater::mySensorContactLinesModel

protected

bool makVrf::DtSensorContactLinesUpdater::myEnabled

protected

makVrv::DtDe& makVrf::DtSensorContactLinesUpdater::myDe

protected

makVrv::DtUniqueID makVrf::DtSensorContactLinesUpdater::myUniqueId

protected

bool makVrf::DtSensorContactLinesUpdater::myPendingConnection

protected

DtVector makVrf::DtSensorContactLinesUpdater::myLastPosition

protected

boost::signalslib::connection makVrf::DtSensorContactLinesUpdater::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.

---

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

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