VR-Forces 4.8 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Attributes
makVrv::DtOverlayPolygonEmbarkationUpdater Class Reference

A DtOverlayPolygonEmbarkationUpdater is a specialized DtMultiPointEmbarkationUpdater that manages the unique method by which overlay polygon vertices are updated. More...

Inheritance diagram for makVrv::DtOverlayPolygonEmbarkationUpdater:
Inheritance graph
[legend]

Public Member Functions

 DtOverlayPolygonEmbarkationUpdater (DtDe &de, DtUniqueID id)
 CTOR. More...
 
virtual ~DtOverlayPolygonEmbarkationUpdater ()
 DTOR. More...
 
virtual void setOutputPositions (const std::vector< DtVector > &positions)
 Override DtMultiPointSceneObjectUpdater::setOutputPositions() to call polygon->setPoints(). More...
 
virtual void slot_sceneObjectToBeDeleted (const DtUniqueID &id)
 Override DtMultiPointSceneObjectUpdater::slot_sceneObjectToBeDeleted to clean up the cached polygon. More...
 
- Public Member Functions inherited from makVrv::DtMultiPointEmbarkationUpdater
 DtMultiPointEmbarkationUpdater (DtDe &de, DtUniqueID id)
 CTOR. More...
 
virtual ~DtMultiPointEmbarkationUpdater ()
 DTOR. More...
 
virtual void embark (DtUniqueID uniqueID)
 Add a (object) attach point. More...
 
virtual void setInputPositions (const std::vector< DtVector > &offset)
 Set the position offset from the host object's position. More...
 
virtual void update (DtTime tNow)
 Calls doEmbarkation() and then the DtSceneUpdater base. More...
 
virtual void doEmbarkation (DtTime tNow)
 Find the actual position and orientation and update the scene object. More...
 
- Public Member Functions inherited from makVrv::DtMultiPointSceneObjectUpdater
 DtMultiPointSceneObjectUpdater (DtDe &de, DtUniqueID id)
 CTOR. More...
 
virtual ~DtMultiPointSceneObjectUpdater ()
 Virtual DTOR. More...
 
- Public Member Functions inherited from makVrv::DtSceneObjectUpdater
 DtSceneObjectUpdater (DtDe &de, DtUniqueID id)
 CTOR. More...
 
virtual ~DtSceneObjectUpdater ()
 Virtual DTOR. More...
 
virtual void setNextUpdater (DtSceneObjectUpdater *nextUpdater)
 Set the next updater in the updater chain. More...
 
virtual void setPrevUpdater (DtSceneObjectUpdater *prevUpdater)
 Set the previous updater in the updater chain. More...
 
virtual bool needsUpdate (DtTime tNow)
 The check function called by DtTickableManager to verify if an update is required. More...
 
virtual void updateAdaptiveTickrate (const DtVector &lastPos, const DtTime &deltaTime)
 This is called by the update function after all the original chaining updates happen. More...
 
virtual void setVertexToUpdate (unsigned int vertex)
 Specify which vertex in the scene object this updater updates. More...
 
virtual void setInputPosition (const DtVector &position)
 Set the position input to this updater. More...
 
virtual void setInputOrientation (const DtTaitBryan &orientation)
 Set the orientation input to this updater. More...
 
virtual void setOutputPosition (const DtVector &position)
 Output the resultant position. More...
 
virtual void setOutputOrientation (const DtTaitBryan &orientation)
 Output the resultant orientation. More...
 
virtual void setOutputPositionAndOrientation (const DtVector &position, const DtTaitBryan &orientation)
 Set both the position and orientation at the same time. More...
 
virtual DtTime lastUpdateTime () const
 Get the time-stamp of the last update. More...
 
virtual void setSceneObject (DtSceneObject *sceneObject, bool addToTickableMgrIfHead)
 Set the scene object to be updated. More...
 
virtual void setSceneObject (DtSceneObject *sceneObject)
 Set the scene object to be updated. More...
 
virtual void setLodSystemEnabled (bool enabled)
 brief set if the lod update system is on for this model More...
 
virtual bool lodSystemEnabled () const
 brief gets if the lod update system is on for this model More...
 
virtual void setLodScaleSpeedFactor (float factor)
 brief sets the value that linearly adjusts the range of the lod radii by the velocity More...
 
virtual float lodScaleSpeedFactor () const
 brief gets the value that linearly adjusts the range of the lod radii by the velocity More...
 
virtual void setLodRadiusStart (float ratius)
 brief sets the near radius where the update rate starts to fall off More...
 
virtual float lodRadiusStart () const
 brief gets the near radius where the update rate starts to fall off More...
 
virtual void setLodRadiusEnd (float ratius)
 brief sets the far radius where the update rate stops falling off More...
 
virtual float lodRadiusEnd () const
 brief gets the far radius where the update rate stops falling off More...
 
virtual void setNearLodUpdateRate (int nearRate)
 sets the update rate at the near radius, defaults to every six ticks More...
 
virtual int nearLodUpdateRate () const
 brief gets the update rate at the near radius, defaults to every six ticks More...
 
virtual void setFarLodUpdateRate (int maxRate)
 brief the update rate at the far radius, defaults to every 30 ticks More...
 
virtual int farLodUpdateRate () const
 brief gets the update rate at the far radius defaults to every 30 ticks More...
 
DtUniqueID uniqueId () const
 Returns the distributed object id of this updater. More...
 
DtSceneObjectUpdaterfindNextUpdater () const
 Return the next updater in the updater chain. More...
 
DtSceneObjectUpdaterfindPrevUpdater () const
 Return the previous updater in the updater chain. More...
 
virtual bool isChainThreadSafe (DtSceneObjectUpdater *firstUpdater)
 Check all the updaters in the current chain and determine if the chain is thread safe. More...
 
virtual DtSceneObjectUpdaterchainHead ()
 Find the first updater in the chain. More...
 
virtual void setIsThreadSafe (bool safe)
 Override the DtTickable base class' method so retest the entire chain this updater belongs to. More...
 
DtSceneObjectfindSceneObject ()
 Get the current scene object for this updater. More...
 
DtSceneObject *const findSceneObject () const
 const correct version 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 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
 

Protected Attributes

bool myCheckedForArea
 Flag to tell if the polygon model has been found / cached yet. More...
 
DtOverlayPolygonModelmyArea
 The polygon model cache. More...
 
- Protected Attributes inherited from makVrv::DtMultiPointEmbarkationUpdater
ObjectEmbarkationPoint myEmbarkationPoint
 
bool myNeedsUpdate
 
DtVector myLastUpdatedOrigin
 
DtTaitBryan myLastUpdatedOrientation
 
- Protected Attributes inherited from makVrv::DtMultiPointSceneObjectUpdater
std::vector< DtVectormyInputPositions
 Input positions. More...
 
- Protected Attributes inherited from makVrv::DtSceneObjectUpdater
DtDemyDe
 The display engine. More...
 
DtUniqueID myUniqueId
 This distributed object's unique identifier. More...
 
DtSceneObjectmySceneObject
 A pointer to the current scene object being updated. More...
 
int myModelSet
 This updater is registered as a modelset-specific tickable; this is the modelset it's registered with. More...
 
boost::signalslib::connection mySceneObjectConnection
 
DtSceneObjectUpdatermyNextUpdater
 The next updater in the chain (or NULL) More...
 
DtSceneObjectUpdatermyPrevUpdater
 The previous updater in the chain (or NULL) More...
 
unsigned int myVertexToUpdate
 The default scene object vertex to update. More...
 
DtVector myInputPosition
 Input position. More...
 
DtTaitBryan myInputOrientation
 Input Orientation. More...
 
bool myPositionDataOutputted
 Flag to indicate if setOutputPosition has been called this tick. More...
 
bool myOrientationDataOutputted
 Flag to indicate if setOutputOrientation has been called this tick. More...
 
UpdateLODParams myLodUpdateParams
 automatic lod system params More...
 
- Protected Attributes inherited from makVrv::DtTickable
DtTickableManagerInterfacemyManager
 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...
 
- Public Attributes inherited from makVrv::DtSceneObjectUpdater
boost::signal< void(const
DtUniqueID &) > 
signal_updaterToBeDeleted
 
- Protected Member Functions inherited from makVrv::DtSceneObjectUpdater
virtual void removeThreadSafeChainFromManager (DtSceneObjectUpdater *head)
 Helper method to remove an updater (not necessarily this one, but rather the one at the head of the chain that this updater belongs to) from the DtTickableManager's thread-safe tickable list. More...
 
virtual void removeUnThreadSafeChainFromManager (DtSceneObjectUpdater *head)
 Helper method to remove an updater (not necessarily this one, but rather the one at the head of the chain that this updater belongs to) from the DtTickableManager's un-thread-safe tickable list. More...
 
virtual void addThreadSafeChainToManager (DtSceneObjectUpdater *head)
 Helper method to add an updater (not necessarily this one, but rather the one at the head of the chain that this updater belongs to) to the DtTickableManager's thread-safe tickable list. More...
 
virtual void addUnThreadSafeChainToManager (DtSceneObjectUpdater *head)
 Helper method to add an updater (not necessarily this one, but rather the one at the head of the chain that this updater belongs to) to the DtTickableManager's un-thread-safe tickable list. More...
 
virtual void placeChainOnCorrectTickableList (DtSceneObjectUpdater *head)
 Examines the chain for the given head updater, removes the head from the approriate ticable list if necessary, and then adds the head to the correct (threaded or unthreaded) tickable list. More...
 
- Protected Member Functions inherited from makVrv::DtTickable
 DtTickable (DtTickableManagerInterface *manager)
 CTOR. More...
 
 DtTickable ()
 Unimplemented default CTOR. More...
 
virtual void slot_managerAboutToBeDeleted ()
 

Detailed Description

A DtOverlayPolygonEmbarkationUpdater is a specialized DtMultiPointEmbarkationUpdater that manages the unique method by which overlay polygon vertices are updated.

For other multipoint objects, vertices are kept in the scene object (for a four point object, e.g., the vertices would be set calling DtSceneObject::setPosition( 0, ... ) through DtSceneObject::setPosition(3, ... ). The overlay polygon, however, needs to have the actual model vertices updated, using polygon->setPoints() as well.

Constructor & Destructor Documentation

makVrv::DtOverlayPolygonEmbarkationUpdater::DtOverlayPolygonEmbarkationUpdater ( DtDe de,
DtUniqueID  id 
)

CTOR.

virtual makVrv::DtOverlayPolygonEmbarkationUpdater::~DtOverlayPolygonEmbarkationUpdater ( )
virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtOverlayPolygonEmbarkationUpdater::setOutputPositions ( const std::vector< DtVector > &  positions)
virtual

Override DtMultiPointSceneObjectUpdater::setOutputPositions() to call polygon->setPoints().

This will look up and cache the polygon model and set a flag when found

Reimplemented from makVrv::DtMultiPointSceneObjectUpdater.

virtual void makVrv::DtOverlayPolygonEmbarkationUpdater::slot_sceneObjectToBeDeleted ( const DtUniqueID id)
virtual

Override DtMultiPointSceneObjectUpdater::slot_sceneObjectToBeDeleted to clean up the cached polygon.

Reimplemented from makVrv::DtSceneObjectUpdater.

Member Data Documentation

bool makVrv::DtOverlayPolygonEmbarkationUpdater::myCheckedForArea
protected

Flag to tell if the polygon model has been found / cached yet.

DtOverlayPolygonModel* makVrv::DtOverlayPolygonEmbarkationUpdater::myArea
protected

The polygon model cache.


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

Document ID: Generated on Thu Aug 27 10:56:05 EDT 2020 from SVN revision 217100
Copyright © 2005-2020 MAK Technologies. All Rights Reserved (www.mak.com)