makVrv::DtAttachableEntityFanUpdater Class Reference

Class which will keep track of EntityFan los object (spokes between an origin and the outer rim of the circle). More...

Inheritance diagram for makVrv::DtAttachableEntityFanUpdater:

Classes
struct	EntityFanIntersectionInformation

Public Member Functions
	DtAttachableEntityFanUpdater (DtDe &de, DtElementID id)
	CTOR.
virtual	~DtAttachableEntityFanUpdater ()
	DTOR.
virtual void	setEntityFanUpdateRate (double d)
virtual void	setCircleAgent (DtOverlayEllipseArcModelAgent *)
	Sets the agent used to draw the circle.
virtual void	setCircleAgent (DtExtrudedCircleModelAgent *)
virtual void	setMultiLineModelAgent (DtMultiLineModelAgent *)
	Sets the agent used to draw the lines between the center and the entities in the circle.
virtual void	setSceneObjectAgent (DtSceneObjectAgent *)
	Sets the agent used to manage scene objects.
virtual void	setMultilineSceneObjectAgent (DtSceneObjectAgent *)
Public Member Functions inherited from makVrv::DtAttachableIntervisibilityUpdater
	DtAttachableIntervisibilityUpdater (DtDe &de, DtElementID id)
	CTOR.
virtual	~DtAttachableIntervisibilityUpdater ()
	DTOR.
virtual void	setFixedDistance (bool)
	If true, sets the end point to be a fixed distance (given the current distance) from the start point, if the start points moves and the end point is not attached.
Public Member Functions inherited from makVrv::DtLineModelUpdater
	DtLineModelUpdater (DtDe &de, DtElementID id)
	CTOR.
virtual	~DtLineModelUpdater ()
	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.
Public Member Functions inherited from makVrv::DtAttachableUpdater
	DtAttachableUpdater (DtDe &de, DtUniqueID id)
	CTOR.
virtual	~DtAttachableUpdater ()
	DTOR.
virtual bool	needsUpdate (DtTime tNow)
	Does this updater need to update?
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.
DtTime	lastUpdateTime () const
Public Member Functions inherited from makVrv::DtTickable
virtual	~DtTickable ()
	Virtual DTOR.

Protected Types
typedef boost::unordered_map < DtElementID, EntityFanIntersectionInformation >	Intersections
	Map type for mapping entity ids to entity fan intersection info.

Protected Member Functions
virtual void	updateSceneObject (DtTime tNow)
virtual bool	doIntersection ()
	Does intersection if points have changed. Returns true if something has changed.
virtual void	update ()
	Calls update with current de sim time.
virtual void	update (DtTime tNow)
	Sees if inter-visibility needs to be recalculated, and, if so recalculates and sets all associated lines.
virtual bool	removeElement (DtElementID id, bool disconnect=true)
	Removes the element from the intersections list, if it exists.
virtual void	sceneObjectRemoved (DtUniqueID)
	Called when a scene object is removed, remove it as an element.
virtual bool	isIntersectableObject (const DtElementEntry &) const
	Returns true if the object should be checked for intersection.
Protected Member Functions inherited from makVrv::DtAttachableIntervisibilityUpdater
virtual double	calculateDistance (const DtVector &start, const DtVector &end, DtVector *circleOrigin=0) const
	Calculates distance based on topo coordinates in 3 dimensions.
virtual void	calculateFixedDistance ()
	Calculates the distance from the start to end point and assigns to myFixedDistance member.
virtual DtVector	fixedDistanceFrom (const DtVector &start, const DtVector &end, double heading, double distance) const
	Given a heading and distance, returns a fixed distance from the start point with altitude clamped at the new ground location.
virtual double	calculateHeading (const DtVector &start, const DtVector &end) const
	Calculates topographic heading from start to end point.
virtual DtVector	clamp (const DtVector &pt) const
	Returns the ground clamped position.
Protected Member Functions inherited from makVrv::DtLineModelUpdater
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.
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 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.
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.
	DtTickable ()
	Unimplemented default CTOR.

Protected Attributes
Intersections	myIntersections
double	myEntityFanUpdateRate
bool	myForceUpdate
double	myLastRadius
DtOverlayEllipseArcModelAgent *	my2DCircleAgent
DtExtrudedCircleModelAgent *	my3DCircleAgent
DtMultiLineModelAgent *	myMultiLineModelAgent
DtSceneObjectAgent *	mySceneObjectAgent
DtSceneObjectAgent *	myMultilineSceneObjectAgent
DtUniqueID	mySceneObjectId
Protected Attributes inherited from makVrv::DtAttachableIntervisibilityUpdater
IntersectionInformation	myIntersectionInformation
bool	myFixDistance
double	myFixedDistance
double	myFixedHeading
Protected Attributes inherited from makVrv::DtLineModelUpdater
PointInformation	myStartPoint
PointInformation	myEndPoint
Protected Attributes inherited from makVrv::DtAttachableUpdater
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 update()
AttachedPointsVector	myAttachedPoints
DtVector	myPositionOffset
DtTaitBryan	myOrientationOffset
Protected Attributes inherited from makVrv::DtTickable
DtTickableManagerInterface *	myManager
	Pointer to manager for removal during destruction.

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 }

Detailed Description

Class which will keep track of EntityFan los object (spokes between an origin and the outer rim of the circle).

This class is only ever meant to be used in the main thread. It is sub-classed from the DtAttachableintervisibilityUpdater only to reuse code from that class. This class intentionally does not have an agent as it cannot be used in a thread-safe way, so, it should only be used in the main thread (as it is currently used from the DtIntervisibilityEntityFanVisualizer).

Member Typedef Documentation

typedef boost::unordered_map<DtElementID,EntityFanIntersectionInformation> makVrv::DtAttachableEntityFanUpdater::Intersections

protected

Map type for mapping entity ids to entity fan intersection info.

Constructor & Destructor Documentation

makVrv::DtAttachableEntityFanUpdater::DtAttachableEntityFanUpdater	(	DtDe &	de,
		DtElementID	id
	)

CTOR.

Note

If suppressTick is set true, this objects update() callback gets connected to DtRenderer::signal_postUpdate() signal in the display engine.

virtual makVrv::DtAttachableEntityFanUpdater::~DtAttachableEntityFanUpdater ( )

virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtAttachableEntityFanUpdater::setEntityFanUpdateRate ( double  d )

virtual

virtual void makVrv::DtAttachableEntityFanUpdater::setCircleAgent ( DtOverlayEllipseArcModelAgent *  )

virtual

Sets the agent used to draw the circle.

virtual void makVrv::DtAttachableEntityFanUpdater::setCircleAgent ( DtExtrudedCircleModelAgent *  )

virtual

virtual void makVrv::DtAttachableEntityFanUpdater::setMultiLineModelAgent ( DtMultiLineModelAgent *  )

virtual

Sets the agent used to draw the lines between the center and the entities in the circle.

virtual void makVrv::DtAttachableEntityFanUpdater::setSceneObjectAgent ( DtSceneObjectAgent *  )

virtual

Sets the agent used to manage scene objects.

virtual void makVrv::DtAttachableEntityFanUpdater::setMultilineSceneObjectAgent ( DtSceneObjectAgent *  )

virtual

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

protectedvirtual

Reimplemented from makVrv::DtAttachableIntervisibilityUpdater.

virtual bool makVrv::DtAttachableEntityFanUpdater::doIntersection ( )

protectedvirtual

Does intersection if points have changed. Returns true if something has changed.

Reimplemented from makVrv::DtAttachableIntervisibilityUpdater.

virtual void makVrv::DtAttachableEntityFanUpdater::update ( )

protectedvirtual

Calls update with current de sim time.

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

protectedvirtual

Sees if inter-visibility needs to be recalculated, and, if so recalculates and sets all associated lines.

Reimplemented from makVrv::DtAttachableIntervisibilityUpdater.

virtual bool makVrv::DtAttachableEntityFanUpdater::removeElement ( DtElementID  id, bool  disconnect = true  )

protectedvirtual

Removes the element from the intersections list, if it exists.

Returns

true if removed

virtual void makVrv::DtAttachableEntityFanUpdater::sceneObjectRemoved ( DtUniqueID  )

protectedvirtual

Called when a scene object is removed, remove it as an element.

virtual bool makVrv::DtAttachableEntityFanUpdater::isIntersectableObject ( const DtElementEntry &  ) const

protectedvirtual

Returns true if the object should be checked for intersection.

Returns

true for entities

Member Data Documentation

Intersections makVrv::DtAttachableEntityFanUpdater::myIntersections

protected

double makVrv::DtAttachableEntityFanUpdater::myEntityFanUpdateRate

protected

bool makVrv::DtAttachableEntityFanUpdater::myForceUpdate

protected

double makVrv::DtAttachableEntityFanUpdater::myLastRadius

protected

DtOverlayEllipseArcModelAgent* makVrv::DtAttachableEntityFanUpdater::my2DCircleAgent

protected

DtExtrudedCircleModelAgent* makVrv::DtAttachableEntityFanUpdater::my3DCircleAgent

protected

DtMultiLineModelAgent* makVrv::DtAttachableEntityFanUpdater::myMultiLineModelAgent

protected

DtSceneObjectAgent* makVrv::DtAttachableEntityFanUpdater::mySceneObjectAgent

protected

DtSceneObjectAgent* makVrv::DtAttachableEntityFanUpdater::myMultilineSceneObjectAgent

protected

DtUniqueID makVrv::DtAttachableEntityFanUpdater::mySceneObjectId

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvCore/DtAttachableEntityFanUpdater.h