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

Inheritance diagram for makVrv::DtSegmentedLineModelUpdater:

[legend]

Classes
struct	PointInformation

Public Member Functions
	DtSegmentedLineModelUpdater (DtDe &de, DtElementID id, bool suppressTick=false)
	CTOR.
virtual	~DtSegmentedLineModelUpdater ()
	DTOR.
virtual void	setStartPoint (const DtVector &position)
	Sets the origin of the line (absolute)
virtual void	attachStartPoint (DtElementID id)
	Sets the origin of the line to be attached to an element.
virtual void	setStartPointOffset (const DtVector &offset)
	Sets the offset of the start attach point.
virtual void	setEndPoint (const DtVector &position)
	Sets the end of the Intervisibility line (absolute)
virtual void	attachEndPoint (DtElementID id)
	Sets the end of the line to be attached to an element.
virtual void	setEndPointOffset (const DtVector &offset)
	Sets the offset of the end attach point.
virtual DtVector	calculateStartPoint ()
	Accessor for the origin of the line.
virtual DtVector	calculateEndPoint ()
	Accessor for the end point of the line.
virtual void	setSceneObject (DtSceneObject *sceneObject)
	Override to set model set to use for intersections.
virtual void	update (DtTime tNow)
	Updates the scene object Stores the time in myLastUpdateTime and calls updateSceneObject().
Public Member Functions inherited from makVrv::DtAttachableUpdater
	DtAttachableUpdater (DtDe &de, DtUniqueID id, bool suppressTick=false)
	CTOR.
virtual	~DtAttachableUpdater ()
	DTOR.
virtual void	addAttachedPoint (const DtVector &position, int targetVertexIndex)
	Add a (vertex) attach point.
virtual void	addAttachedPoint (DtUniqueID uniqueID, int targetVertexIndex)
	Add a (object) attach point.
virtual void	addAttachedPoint (DtUniqueID uniqueID, int vtx1, int vtx2, double proportion, int targetVertexIndex)
	Add a (linear) attach point.
virtual const AttachedPoint &	attachedPoint (int targetVertexIndex) const
	Returns the attached point at the given vertex.
virtual void	setPositionOffset (const DtVector &offset)
	positionally offset the attach points by this amount.
virtual void	setPositionOffset (const DtVector &offset, int vtx)
	positionally offset the specific attach point by this amount.
virtual void	setOrientationOffset (const DtTaitBryan &offset)
	rotationally offset the attach points by this amount.
virtual void	setAttachedPointMode (unsigned int mode, int vtx)
	Set whether an attached point updates position, orientation, or both.
virtual void	doAttachment (DtTime tNow)
	Find the actual position and orientation based on the attach points and offsets.
Public Member Functions inherited from makVrv::DtSceneObjectUpdater
	DtSceneObjectUpdater (DtDe &de, DtUniqueID id, bool suppressTick=false)
	CTOR.
virtual	~DtSceneObjectUpdater ()
	Virtual DTOR.
virtual bool	needsUpdate (DtTime tNow)
	The check function called by DtTickableManager to verify if an update is required.
virtual DtTime	lastUpdateTime () const
	Get the time-stamp of the last update.
DtSceneObject *	findSceneObject ()
	Get the current scene object for this updater.
DtUniqueID	uniqueId () const
	Returns the distributed object id of this updater.
virtual void	setUpdaterPosition (int vtx, const DtVector &pos)
	Set the position of a scene object vertex.
virtual const DtVector &	updaterPosition (int vtx) const
	Get the position of a scene object vertex.
virtual void	setUpdaterOrientation (int vtx, const DtTaitBryan &ori)
	Set the orientation of a scene object vertex.
virtual const DtTaitBryan &	updaterOrientation (int vtx) const
	Get the orientation of a scene object vertex.
virtual void	terrainScaleTransformsIfNeeded ()
	Scales the transforms if the terrain scaling flag is set.

Protected Member Functions
virtual void	updateSceneObject (DtTime tNow)=0
	Update the scene object position and orientation at each vertex and set the last updated time-stamp.
Utility Methods
virtual void	cleanup (PointInformation &pointInfo)
	Cleans up (resets) information for given point.
virtual DtVector	offsetPoint (DtVector point, const DtVector &offset, const DtTaitBryan &ori=DtTaitBryan()) const
	Offsets the given point and returns new position Applies the given offset to the input point at the given orientation.
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.
virtual void	getSceneInformation (const PointInformation &info, DtUniqueID &sceneId)
	Gets the id of the attached element to use for positioning.
Slots
virtual void	slot_attachedSceneObjectToBeDeleted (DtUniqueID, PointInformation *)
	Called when scene object that this item is attached to is to be deleted.
virtual void	slot_attachedUpdaterToBeDeleted (DtUniqueID, PointInformation *)
	Called when updater of attached scene object is to be deleted.
Protected Member Functions inherited from makVrv::DtAttachableUpdater
virtual void	slot_attachedSceneObjectToBeDeleted (const DtUniqueID &)
virtual void	slot_attachedUpdaterToBeDeleted (const DtUniqueID &id)
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.
Protected Member Functions inherited from makVrv::DtSceneObjectUpdater
virtual void	slot_sceneObjectToBeDeleted (const DtUniqueID &id)
	Signal that this updater is being destroyed.

Protected Attributes
PointInformation	myStartPoint
PointInformation	myEndPoint
Protected Attributes inherited from makVrv::DtAttachableUpdater
AttachedPointsVector	myAttachedPoints
DtVector	myPositionOffset
DtTaitBryan	myOrientationOffset
Protected Attributes inherited from makVrv::DtSceneObjectUpdater
DtDe &	myDe
	The display engine.
DtUniqueID	myUniqueId
	This distributed object's unique identifier.
DtSceneObject *	mySceneObject
	A pointer to the current scene object being updated.
DtTime	myLastUpdateTime
	The last time stamp when the updateSceneObject() was called.
DtSceneObject::TransformList	myTransforms
	Local copy of the vertex positions and orientations.
const DtDeSharedState &	myDeSharedState
	This is kept to make terrain scale updating cheaper ( by one virtual function call ).
bool	myInManager
	If tick was suppressed, then this updater is not on the tickableManager.

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 Attributes inherited from makVrv::DtSceneObjectUpdater
boost::signal< void(const DtUniqueID &) >	signal_updaterToBeDeleted
	Signal that this updater is being destroyed.
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::DtSegmentedLineModelUpdater::DtSegmentedLineModelUpdater	(	DtDe &	de,
		DtElementID	id,
		bool	suppressTick = `false`
	)

CTOR.

virtual makVrv::DtSegmentedLineModelUpdater::~DtSegmentedLineModelUpdater ( )

virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtSegmentedLineModelUpdater::setStartPoint ( const DtVector & position )

virtual

Sets the origin of the line (absolute)

virtual void makVrv::DtSegmentedLineModelUpdater::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::DtSegmentedLineModelUpdater::setStartPointOffset ( const DtVector & offset )

virtual

Sets the offset of the start attach point.

virtual void makVrv::DtSegmentedLineModelUpdater::setEndPoint ( const DtVector & position )

virtual

Sets the end of the Intervisibility line (absolute)

virtual void makVrv::DtSegmentedLineModelUpdater::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::DtSegmentedLineModelUpdater::setEndPointOffset ( const DtVector & offset )

virtual

Sets the offset of the end attach point.

virtual DtVector makVrv::DtSegmentedLineModelUpdater::calculateStartPoint ( )

virtual

Accessor for the origin of the line.

virtual DtVector makVrv::DtSegmentedLineModelUpdater::calculateEndPoint ( )

virtual

Accessor for the end point of the line.

virtual void makVrv::DtSegmentedLineModelUpdater::setSceneObject ( DtSceneObject * sceneObject )

virtual

Override to set model set to use for intersections.

Reimplemented from makVrv::DtSceneObjectUpdater.

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

virtual

Updates the scene object Stores the time in myLastUpdateTime and calls updateSceneObject().

See Also: DtSegmentedLineModelUpdater::updateSceneObject()

Reimplemented from makVrv::DtAttachableUpdater.

virtual void makVrv::DtSegmentedLineModelUpdater::updateSceneObject ( DtTime tNow )

protectedpure virtual

Update the scene object position and orientation at each vertex and set the last updated time-stamp.

Parameters

[in] tNow is the current time-stamp.

Note: Derived classes should call this function in their implementation of the update function.

See Also: update( DtTime ).

Reimplemented from makVrv::DtSceneObjectUpdater.

virtual void makVrv::DtSegmentedLineModelUpdater::cleanup ( PointInformation & pointInfo )

protectedvirtual

Cleans up (resets) information for given point.

virtual DtVector makVrv::DtSegmentedLineModelUpdater::offsetPoint	(	DtVector	point,
		const DtVector &	offset,
		const DtTaitBryan &	ori = `DtTaitBryan()`
	)		const

protectedvirtual

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

Parameters

point	the point to offset from
offset	the offset to apply
ori	the orientation to apply to the offset before offsetting the point

virtual DtVector makVrv::DtSegmentedLineModelUpdater::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 void makVrv::DtSegmentedLineModelUpdater::getSceneInformation	(	const PointInformation &	info,
		DtUniqueID &	sceneId
	)

protectedvirtual

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

virtual void makVrv::DtSegmentedLineModelUpdater::slot_attachedSceneObjectToBeDeleted	(	DtUniqueID	,
		PointInformation *
	)

protectedvirtual

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

virtual void makVrv::DtSegmentedLineModelUpdater::slot_attachedUpdaterToBeDeleted	(	DtUniqueID	,
		PointInformation *
	)

protectedvirtual

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

Member Data Documentation

PointInformation makVrv::DtSegmentedLineModelUpdater::myStartPoint

protected

PointInformation makVrv::DtSegmentedLineModelUpdater::myEndPoint

protected

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

include/vrvCore/DtSegmentedLineModelUpdater.h

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation