makVrv::DtParticleCollisionObjectUpdater Class Reference

Abstract particle collision object updater interface.

DtParticleCollisionObjectUpdaters are distributed objects, managed by DtTickableManager. They update the collision object (sphere, ellipse) usually associated with a rotor wash during the manager 'tick' update.

Inheritance diagram for makVrv::DtParticleCollisionObjectUpdater:

Public Member Functions
	DtParticleCollisionObjectUpdater (DtDe &de, DtUniqueID id)
virtual	~DtParticleCollisionObjectUpdater ()
virtual void	update (DtTime tNow)=0
virtual void	setCollisionObjectModel (DtModel *collisionObjectModel)
DtUniqueID	uniqueId () const
Public Member Functions inherited from makVrv::DtTickable
virtual bool	needsUpdate (DtTime tNow)
virtual bool	updateIfNeeded (DtTime tNow)
virtual	~DtTickable ()
virtual void	setTickableEnabled (bool enabled)
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	adaptiveTickLodEnabled () const

Protected Attributes
DtDe &	myDe
DtUniqueID	myUniqueId
DtModel *	myCollisionObjectModel
Protected Attributes inherited from makVrv::DtTickable
DtTickableManagerInterface *	myManager
DtSignalConnectionManager	myConnections
unsigned int	myFrameCounter
unsigned int	myFrameToUpdate
unsigned int	myUpdatePeriod
unsigned int	myTickableIndex
DtTime	myLastUpdateTime
bool	myIsThreadSafe
TickableListState	myTickableListState

Private Member Functions
	DtParticleCollisionObjectUpdater (const DtParticleCollisionObjectUpdater &other)
DtParticleCollisionObjectUpdater &	operator= (const DtParticleCollisionObjectUpdater &other)

Additional Inherited Members
Public Types inherited from makVrv::DtTickable
enum	TickableListState { TickableNotOnList, TickableOnMainList, TickableOnThreadSafeList }
Protected Member Functions inherited from makVrv::DtTickable
	DtTickable (DtTickableManagerInterface *manager)
	DtTickable ()=delete
virtual void	slot_managerAboutToBeDeleted ()

Constructor & Destructor Documentation

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

CTOR.

Parameters

[in]	de	is the display engine.
[in]	id	is a unique identifier for this distributed object.

virtual makVrv::DtParticleCollisionObjectUpdater::~DtParticleCollisionObjectUpdater ( )

virtual

Virtual DTOR.

makVrv::DtParticleCollisionObjectUpdater::DtParticleCollisionObjectUpdater ( const DtParticleCollisionObjectUpdater &  other )

private

Copy Constructor not implemented – Copy Not Allowed.

Member Function Documentation

DtParticleCollisionObjectUpdater& makVrv::DtParticleCollisionObjectUpdater::operator= ( const DtParticleCollisionObjectUpdater &  other )

private

Assignment Operator Not implemented – Assignment Not Allowed.

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

pure virtual

The update function called by DtTickableManager during update-ticks.

Parameters

[in]

tNow

is the current time-stamp.

Note

Derived classes should update the particle collision object at the end of their implementation of this function.

Implements makVrv::DtTickable.

Implemented in makVrv::DtFxParticleCollisionObjectUpdater.

virtual void makVrv::DtParticleCollisionObjectUpdater::setCollisionObjectModel ( DtModel *  collisionObjectModel )

virtual

Set the particle collision object to be updated.

Parameters

[in]

collisionObjectModel

is a pointer to the model to be updated

DtUniqueID makVrv::DtParticleCollisionObjectUpdater::uniqueId

(

)

const

Returns the distributed object id of this updater.

Member Data Documentation

DtDe& makVrv::DtParticleCollisionObjectUpdater::myDe

protected

The display engine.

DtUniqueID makVrv::DtParticleCollisionObjectUpdater::myUniqueId

protected

This distributed object's unique identifier.

DtModel* makVrv::DtParticleCollisionObjectUpdater::myCollisionObjectModel

protected

A pointer to the current particle collision object being updated.

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrvCore/DtParticleCollisionObjectUpdater.h