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::DtAttachableRectangularPyramidUpdater Class Reference

A DtAttachableRectangularPyramidUpdater is used to update a rectangular pyramid sensor field of view object that can be positioned and oriented in the scene by attaching it to another object. More...

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

Public Member Functions

 DtAttachableRectangularPyramidUpdater (DtDe &de, DtUniqueID id)
 CTOR. More...
 
virtual ~DtAttachableRectangularPyramidUpdater ()
 DTOR. More...
 
virtual void update (double simTime)
 Update the scene object. More...
 
virtual void setHostObject (DtUniqueID hostId)
 Sets the ID of the host object. More...
 
virtual void setTargetObject (DtUniqueID targetId)
 Sets the ID of the target object. More...
 
virtual void setTargetLocation (double x, double y, double z)
 Sets the target location. More...
 
virtual void setDesiredOrientationOffset (double psi, double theta, double phi)
 Sets the desired orientation offset and clears the current target. More...
 
- Public Member Functions inherited from makVrv::DtAttachableUpdater
 DtAttachableUpdater (DtDe &de, DtUniqueID id)
 CTOR. More...
 
virtual ~DtAttachableUpdater ()
 DTOR. More...
 
virtual bool needsUpdate (DtTime tNow)
 Does this updater need to update? More...
 
virtual void addAttachedPoint (const DtVector &position, int targetVertexIndex)
 Add a (vertex) attach point. More...
 
virtual void addAttachedPoint (DtUniqueID uniqueID, int targetVertexIndex)
 Add a (object) attach point. More...
 
virtual void addAttachedPoint (DtUniqueID uniqueID, int vtx1, int vtx2, double proportion, int targetVertexIndex)
 Add a (linear) attach point. More...
 
virtual const AttachedPointattachedPoint (int targetVertexIndex) const
 Returns the attached point at the given vertex. More...
 
virtual void setPositionOffset (const DtVector &offset)
 positionally offset the attach points by this amount. More...
 
virtual void setWorldPositionOffset (const DtVector &offset)
 positionally offset the specific attach point by this amount in world (database) coordinates. More...
 
virtual void setPositionOffset (const DtVector &offset, int vtx)
 positionally offset the specific attach point by this amount. More...
 
virtual void setOrientationOffset (const DtTaitBryan &offset)
 rotationally offset the attach points by this amount. More...
 
virtual void setWorldOrientationOffset (const DtTaitBryan &offset)
 rotationally offset the attach points by this amount in world (database) coordinates More...
 
virtual void setAttachedPointMode (unsigned int mode, int vtx)
 Set whether an attached point updates position, orientation, or both. More...
 
virtual void update (DtTime tNow)
 Calls doAttachment() More...
 
virtual void setSceneObject (DtSceneObject *sceneObject)
 Set the scene object to be updated. More...
 
virtual void doAttachment (DtTime tNow)
 Find the actual position and orientation based on the attach points and offsets. More...
 
DtTime lastUpdateTime () const
 
- 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 Attributes

DtUniqueID myHostId
 
DtUniqueID myTargetId
 
DtVector myTargetLocation
 
DtTaitBryan myDesiredOrientationOffset
 
bool myIsTargetingObject
 
bool myIsTargetingLocation
 
- Protected Attributes inherited from makVrv::DtAttachableUpdater
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...
 
boost::signalslib::connection mySceneObjectConnection
 
boost::signalslib::connection mySceneObjectUpdaterConnection
 
DtTime myLastUpdateTime
 The last time stamp when the update() More...
 
AttachedPointsVector myAttachedPoints
 
DtVector myPositionOffset
 
DtTaitBryan myOrientationOffset
 
DtVector myWorldPositionOffset
 
DtTaitBryan myWorldOrientationOffset
 
DtUniqueID mySceneObjectId
 
- 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::DtAttachableUpdater
enum  AttachedPointType {
  AttachedPointTypeVertex, AttachedPointTypeObject, AttachedPointTypeProportional, AttachedPointTypeDeprecatedObject,
  AttachedPointTypeInvalidObject
}
 Types of attachments. More...
 
enum  AttachedPointMode { AttachedPointModePositionAndOrientation, AttachedPointModePositionOnly, AttachedPointModeOrientationOnly }
 
- 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...
 
- Protected Types inherited from makVrv::DtAttachableUpdater
typedef std::vector
< AttachedPoint * > 
AttachedPointsVector
 
- Protected Member Functions inherited from makVrv::DtAttachableUpdater
virtual bool pointLocationAndOrientation (AttachedPoint *point, double simTime, DtVector &location, DtTaitBryan &orientation)
 
virtual void removeAttachedPoint (int vtx, DtVector *positionOffset=0)
 Returns current position offset in supplied pointer. More...
 
virtual void slot_sceneObjectToBeDeleted (const DtUniqueID &id)
 
virtual void slot_attachedSceneObjectToBeDeleted (const DtUniqueID &)
 
virtual void slot_attachedUpdaterToBeDeleted (const DtUniqueID &id)
 
- Protected Member Functions inherited from makVrv::DtTickable
 DtTickable (DtTickableManagerInterface *manager)
 CTOR. More...
 
 DtTickable ()
 Unimplemented default CTOR. More...
 
virtual void slot_managerAboutToBeDeleted ()
 

Detailed Description

A DtAttachableRectangularPyramidUpdater is used to update a rectangular pyramid sensor field of view object that can be positioned and oriented in the scene by attaching it to another object.

Constructor & Destructor Documentation

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

CTOR.

virtual makVrv::DtAttachableRectangularPyramidUpdater::~DtAttachableRectangularPyramidUpdater ( )
virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtAttachableRectangularPyramidUpdater::update ( double  simTime)
virtual

Update the scene object.

virtual void makVrv::DtAttachableRectangularPyramidUpdater::setHostObject ( DtUniqueID  hostId)
virtual

Sets the ID of the host object.

virtual void makVrv::DtAttachableRectangularPyramidUpdater::setTargetObject ( DtUniqueID  targetId)
virtual

Sets the ID of the target object.

virtual void makVrv::DtAttachableRectangularPyramidUpdater::setTargetLocation ( double  x,
double  y,
double  z 
)
virtual

Sets the target location.

virtual void makVrv::DtAttachableRectangularPyramidUpdater::setDesiredOrientationOffset ( double  psi,
double  theta,
double  phi 
)
virtual

Sets the desired orientation offset and clears the current target.

Member Data Documentation

DtUniqueID makVrv::DtAttachableRectangularPyramidUpdater::myHostId
protected
DtUniqueID makVrv::DtAttachableRectangularPyramidUpdater::myTargetId
protected
DtVector makVrv::DtAttachableRectangularPyramidUpdater::myTargetLocation
protected
DtTaitBryan makVrv::DtAttachableRectangularPyramidUpdater::myDesiredOrientationOffset
protected
bool makVrv::DtAttachableRectangularPyramidUpdater::myIsTargetingObject
protected
bool makVrv::DtAttachableRectangularPyramidUpdater::myIsTargetingLocation
protected

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)