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

Base class for updaters updating segmented line models Contains methods and information struct for working with line models. More...

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

Classes

struct  PointInformation
 

Public Member Functions

 DtLineModelUpdater (DtDe &de, DtElementID id)
 CTOR. More...
 
virtual ~DtLineModelUpdater ()
 DTOR. More...
 
virtual void setStartPoint (const DtVector &position)
 Sets the origin of the line (absolute) More...
 
virtual void attachStartPoint (DtElementID id)
 Sets the origin of the line to be attached to an element. More...
 
virtual void setStartPointOffset (const DtVector &offset)
 Sets the offset of the start attach point. More...
 
virtual void setEndPoint (const DtVector &position)
 Sets the end of the Intervisibility line (absolute) More...
 
virtual void attachEndPoint (DtElementID id)
 Sets the end of the line to be attached to an element. More...
 
virtual void setEndPointOffset (const DtVector &offset)
 Sets the offset of the end attach point. More...
 
virtual DtVector calculateStartPoint ()
 Accessor for the origin of the line. More...
 
virtual DtVector calculateEndPoint ()
 Accessor for the end point of the line. More...
 
virtual void setSceneObject (DtSceneObject *sceneObject)
 Override to set model set to use for intersections. More...
 
virtual void update (DtTime tNow)
 Updates the scene object Stores the time in myLastUpdateTime and calls updateSceneObject(). 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 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 Member Functions

virtual void updateSceneObject (DtTime tNow)=0
 
Utility Methods
virtual void cleanup (PointInformation &pointInfo)
 Cleans up (resets) information for given point. More...
 
virtual DtVector offsetPoint (const DtVector &point, const DtVector &offset, const DtTaitBryan &rootOri=DtTaitBryan()) const
 Offsets the given point and returns new position Applies the given offset to the input point at the given orientation. More...
 
virtual DtVector getAttachedPosition (PointInformation &pointInfo)
 Gets the attached position of the given point Attempts to get and return the attached position of the given point, and returns pointInfo.position if obtaining the attached scene object or updater failed. More...
 
virtual DtTaitBryan getAttachedOrientation (PointInformation &pointInfo)
 Gets the attached orientation of the given point Attempts to get and return the attached orientation of the given point, and returns DtTaitBryan() if obtaining the attached scene object failed. More...
 
virtual void getSceneInformation (const PointInformation &info, DtUniqueID &sceneId)
 Gets the id of the attached element to use for positioning. More...
 
Slots
virtual void slot_attachedSceneObjectToBeDeleted (DtUniqueID, PointInformation *)
 Called when scene object that this item is attached to is to be deleted. More...
 
virtual void slot_attachedUpdaterToBeDeleted (DtUniqueID, PointInformation *)
 Called when updater of attached scene object is to be deleted. More...
 
- 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 ()
 

Protected Attributes

PointInformation myStartPoint
 
PointInformation myEndPoint
 
- 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
 

Detailed Description

Base class for updaters updating segmented line models Contains methods and information struct for working with line models.

Constructor & Destructor Documentation

makVrv::DtLineModelUpdater::DtLineModelUpdater ( DtDe de,
DtElementID  id 
)

CTOR.

virtual makVrv::DtLineModelUpdater::~DtLineModelUpdater ( )
virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtLineModelUpdater::setStartPoint ( const DtVector position)
virtual

Sets the origin of the line (absolute)

virtual void makVrv::DtLineModelUpdater::attachStartPoint ( DtElementID  id)
virtual

Sets the origin of the line to be attached to an element.

The element's first model instance will be used for positioning.

virtual void makVrv::DtLineModelUpdater::setStartPointOffset ( const DtVector offset)
virtual

Sets the offset of the start attach point.

virtual void makVrv::DtLineModelUpdater::setEndPoint ( const DtVector position)
virtual

Sets the end of the Intervisibility line (absolute)

virtual void makVrv::DtLineModelUpdater::attachEndPoint ( DtElementID  id)
virtual

Sets the end of the line to be attached to an element.

The element's first model instance will be used for positioning.

virtual void makVrv::DtLineModelUpdater::setEndPointOffset ( const DtVector offset)
virtual

Sets the offset of the end attach point.

virtual DtVector makVrv::DtLineModelUpdater::calculateStartPoint ( )
virtual

Accessor for the origin of the line.

virtual DtVector makVrv::DtLineModelUpdater::calculateEndPoint ( )
virtual

Accessor for the end point of the line.

virtual void makVrv::DtLineModelUpdater::setSceneObject ( DtSceneObject sceneObject)
virtual

Override to set model set to use for intersections.

Reimplemented from makVrv::DtAttachableUpdater.

virtual void makVrv::DtLineModelUpdater::update ( DtTime  tNow)
virtual
virtual void makVrv::DtLineModelUpdater::updateSceneObject ( DtTime  tNow)
protectedpure virtual
virtual void makVrv::DtLineModelUpdater::cleanup ( PointInformation pointInfo)
protectedvirtual

Cleans up (resets) information for given point.

virtual DtVector makVrv::DtLineModelUpdater::offsetPoint ( const DtVector point,
const DtVector offset,
const DtTaitBryan &  rootOri = DtTaitBryan() 
) const
protectedvirtual

Offsets the given point and returns new position Applies the given offset to the input point at the given orientation.

Parameters
pointthe point to offset from
offsetthe offset to apply
orithe orientation to apply to the offset before offsetting the point
virtual DtVector makVrv::DtLineModelUpdater::getAttachedPosition ( PointInformation pointInfo)
protectedvirtual

Gets the attached position of the given point Attempts to get and return the attached position of the given point, and returns pointInfo.position if obtaining the attached scene object or updater failed.

virtual DtTaitBryan makVrv::DtLineModelUpdater::getAttachedOrientation ( PointInformation pointInfo)
protectedvirtual

Gets the attached orientation of the given point Attempts to get and return the attached orientation of the given point, and returns DtTaitBryan() if obtaining the attached scene object failed.

virtual void makVrv::DtLineModelUpdater::getSceneInformation ( const PointInformation info,
DtUniqueID sceneId 
)
protectedvirtual

Gets the id of the attached element to use for positioning.

virtual void makVrv::DtLineModelUpdater::slot_attachedSceneObjectToBeDeleted ( DtUniqueID  ,
PointInformation  
)
protectedvirtual

Called when scene object that this item is attached to is to be deleted.

virtual void makVrv::DtLineModelUpdater::slot_attachedUpdaterToBeDeleted ( DtUniqueID  ,
PointInformation  
)
protectedvirtual

Called when updater of attached scene object is to be deleted.

Member Data Documentation

PointInformation makVrv::DtLineModelUpdater::myStartPoint
protected
PointInformation makVrv::DtLineModelUpdater::myEndPoint
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)