DtOverlayDirectionLineModel defines an abstract base class that all direction line models must implement. The model provides support for:

Drawing direction lines in an overlay layer based on a normalized direction vector and a fixed length.
The lengths of the drawn direction lines can also be dynamic based on the current MSL altitude of the camera viewing the direction line.

Inheritance diagram for makVrv::DtOverlayDirectionLineModel:

[legend]

Classes
class	DtDirectionLineAltitudeBasedConfiguration

Public Types
typedef std::vector < DtDirectionLineAltitudeBasedConfiguration >	DtDirectionLineAltitudeBasedConfigurationCollection

Public Member Functions
	DtOverlayDirectionLineModel (DtDe &de, DtUniqueID id)

virtual	~DtOverlayDirectionLineModel ()

virtual void	setDirection (int index, const DtVector &direction)=0

virtual void	setScale (int index, float scale)=0

virtual void	setLength (int index, float length)=0

virtual void	setAltitudeBasedConfigurations (const DtDirectionLineAltitudeBasedConfigurationCollection &configs)=0

virtual void	clearAltitudeBasedConfigurations ()=0

virtual void	setIsUseForcedAltitudeEnabled (bool enabled)=0

virtual void	setForcedAltitudeToUse (double minimumAltitudeForUse)=0

virtual void	setLodOutAltitude (double lodOutAltitude)=0

virtual void	setIsLodOutAltitudeEnabled (bool isLodOutAltitudeEnabled)=0

virtual void	setGroup (int)=0

Public Member Functions inherited from makVrv::DtOverlayLineModel
	DtOverlayLineModel (DtDe &de, DtUniqueID id)

virtual	~DtOverlayLineModel ()

virtual void	setEventsEnabled (bool)=0

Public Member Functions inherited from makVrv::DtLineModel
	DtLineModel (DtDe &de, DtUniqueID id)

virtual	~DtLineModel ()

virtual void	setColor (float r, float g, float b, float a)=0

virtual void	setWidth (float width)=0

virtual void	setStipplePattern (unsigned int pattern, int repeatFactor=1)=0

virtual const std::vector < DtVector > &	points () const =0

Public Member Functions inherited from makVrv::DtModel
	DtModel (DtDe &de, DtUniqueID id)

virtual	~DtModel ()

DtModelInstance *	createModelInstance (const std::string &modelDefName, bool realize=true)

virtual void	setModelDefinition (const std::string &str)

virtual const std::string &	modelDefinitionName ()

virtual void	saveModelToFile (const std::string &filename)

virtual const std::string &	className () const

virtual DtUniqueID	uniqueId () const

unsigned int	transformSize () const

virtual void	setPosition (int vtx, const DtVector &position)

virtual const DtVector &	position (int vtx=0) const

virtual void	removePosition (int vtx)

virtual void	setPositionOffset (const DtVector &positionOffset)

virtual const DtVector &	positionOffset () const

virtual void	setOrientation (int vtx, const DtTaitBryan &orientation)

virtual void	setPositionAndOrientation (int vtx, const DtVector &positionOffset, const DtTaitBryan &orientation)

virtual const DtTaitBryan &	orientation (int vtx=0) const

virtual void	setOrientationOffset (const DtTaitBryan &orientationOffset)

virtual const DtTaitBryan &	orientationOffset () const

virtual void	enableColorBlending (bool b)

virtual void	setBlendColor (float r, float g, float b, float a)

virtual void	getBlendColor (float &r, float &g, float &b, float &a)

virtual bool	colorBlendingEnabled () const

virtual void	enableLighting (bool l)

virtual DtModelSetId	modelSet () const

const DtVector &	boundingBoxExtents () const

void	getBoundingBoxExtents (double &x, double &y, double &z) const

const DtVector &	boundingBoxCenter () const

virtual void	getBoundingBoxCenter (double &x, double &y, double &z) const

virtual void	getBoundingBoxComponents (DtVector &minimum, DtVector &maximum)

void	setContributesToBound (bool trueOrFalse)

bool	contributesToBound () const

DtDe &	de ()

virtual void	setModelInstance (DtModelInstance *modelInstance)

virtual void	promoteBackgroundModelInstance (const DtModelDefinition &defintion)

virtual void	setVisible (bool isVisible)

virtual bool	visible () const

DtUniqueID	sceneObjectId () const

virtual void	addedToSceneObjectAsProp (const DtUniqueID &sceneObj)

virtual void	addedToSceneObject (const DtUniqueID &sceneObj, DtModelSetId modelSet, int visualizerType)

virtual void	setElementId (DtElementID id)

virtual void	removedFromSceneObject ()

virtual void	setIsSupportModel (bool isSupport)=0

virtual void	setSolid (bool isSolid)

virtual bool	isProp ()

virtual void	updateMinLastFrameDistance (float distance)

virtual void	resetLastFrameDistance ()

virtual float	minLastFrameDistance () const

virtual DtModelInstance *	modelInstance ()

virtual const DtModelInstance *	modelInstance () const

int	visualizerType () const

virtual bool	supportsMultithreadedLoad ()

virtual void	backgroundLoad ()

virtual void	foregroundLoad ()

virtual bool	isActivelyBackgroundLoading ()

virtual DtLoaderHandle *	getLoadQueueHandle ()

Additional Inherited Members
Public Attributes inherited from makVrv::DtModel
boost::signalslib::signal < void(DtModel *)>	signal_modelToBeDestroyed

boost::signalslib::signal < void(DtModel *)>	signal_modelChanged

boost::signalslib::signal < bool(DtModel *, bool), SlotReturnOR >	signal_visibilityChangeRequested

boost::signalslib::signal < void(DtModelInstance , DtModel )>	signal_modelInstanceCreated

boost::signalslib::signal < void(DtModelInstance , DtModel )>	signal_modelInstanceToBeDestroyed

Protected Types inherited from makVrv::DtModel
typedef std::vector < ObjectTransform >	TransformList

Protected Member Functions inherited from makVrv::DtModel
virtual void	addToScene (const DtUniqueID &sceneObjectId, DtModelSetId modelSet, int visualizerType)=0

virtual void	addToSceneAsProp (const DtUniqueID &sceneObjectId)

virtual void	removeFromScene ()=0

virtual void	initializeModelInstance ()

void	slot_modelInstanceChanged (DtModelInstance *instance)

virtual void	waitAndClearLoadHandle ()

virtual void	removedFromLoadQueue ()

virtual void	setDoneBackgroundLoading ()

virtual void	setActivelyBackgroundLoading ()

Protected Attributes inherited from makVrv::DtModel
DtLoaderHandle *	myInLoadQueueHandle

DtDe &	myDe

const DtUniqueID	myUniqueId

DtUniqueID	myElementId

DtUniqueID	myParentSceneObjectID

bool	myColorBlendingEnabled

DtModelInstance *	myBackgroundModelInstance

float	myMinLastFrameDistance

TransformList	myTransforms

DtModelInstance *	myModelInstance

DtModelSetId	myModelSet

int	myVisualizerType

bool	myContributesToBound

bool	myIsPropFlag

float	myBlendColor [4]

bool	myVisibleFlag

DtVector	myPositionOffset

DtTaitBryan	myOrientationOffset

std::string	myModelDefinitionName

bool	myRequireModelInstance = true

Static Protected Attributes inherited from makVrv::DtModel
static bool	theInittedState

Member Typedef Documentation

typedef std::vector<DtDirectionLineAltitudeBasedConfiguration> makVrv::DtOverlayDirectionLineModel::DtDirectionLineAltitudeBasedConfigurationCollection

A collection of altitude-based configurations.

Constructor & Destructor Documentation

makVrv::DtOverlayDirectionLineModel::DtOverlayDirectionLineModel	(	DtDe &	de,
		DtUniqueID	id
	)

Constructor.

virtual makVrv::DtOverlayDirectionLineModel::~DtOverlayDirectionLineModel ( )

virtual

Destructor.

Member Function Documentation

virtual void makVrv::DtOverlayDirectionLineModel::setDirection	(	int	index,
		const DtVector &	direction
	)

pure virtual

Sets the direction of the line in 3D space, will be normalized.

Implemented in makVrv::DtOsgOverlayDirectionLineModel.

virtual void makVrv::DtOverlayDirectionLineModel::setScale	(	int	index,
		float	scale
	)

pure virtual

Sets the scale factor to be applied to the line. The scale factor is applied whether altitude-based configurations are used or not.

Implemented in makVrv::DtOsgOverlayDirectionLineModel.

virtual void makVrv::DtOverlayDirectionLineModel::setLength	(	int	index,
		float	length
	)

pure virtual

Sets the fixed length of the line in 2D space. If no altitude-based configurations are specified for this line model, this length is always used.

Implemented in makVrv::DtOsgOverlayDirectionLineModel.

virtual void makVrv::DtOverlayDirectionLineModel::setAltitudeBasedConfigurations ( const DtDirectionLineAltitudeBasedConfigurationCollection & configs )

pure virtual

Set the altitude-based configurations for this line model.

Implemented in makVrv::DtOsgOverlayDirectionLineModel.

virtual void makVrv::DtOverlayDirectionLineModel::clearAltitudeBasedConfigurations ( )

pure virtual

Clear the altitude-based configurations for this model. The model will no longer have a dynamic length but will fixed to the length specified by setLength(float).

See Also: setAltitudeBasedConfigurations

Implemented in makVrv::DtOsgOverlayDirectionLineModel.

virtual void makVrv::DtOverlayDirectionLineModel::setIsUseForcedAltitudeEnabled ( bool enabled )

pure virtual

Set whether or not a forced altitude will be used when considering which altitude-based configuration to use, if there are any. This function has no effective result if altitude-based configurations are not used. This function can be used to temporarily force a particular altitude-based configuration to be used, e.g. on mouse hover. The actual altitude used when determining the forced altitude-based configuration can be specified using: setForcedAltitudeToUse(double minimumAltitudeForUse)

See Also: setAltitudeBasedConfigurations

Implemented in makVrv::DtOsgOverlayDirectionLineModel.

virtual void makVrv::DtOverlayDirectionLineModel::setForcedAltitudeToUse ( double minimumAltitudeForUse )

pure virtual

Set the MSL altitude, in meters, to use when determining the altitude-based configuration to use. This function only has an effect if setIsUseForcedAltitudeEnabled(true) has been called.

See Also: setIsUseForcedAltitudeEnabled

Implemented in makVrv::DtOsgOverlayDirectionLineModel.

virtual void makVrv::DtOverlayDirectionLineModel::setLodOutAltitude ( double lodOutAltitude )

pure virtual

Set the base MSL altitude, in meters, at which the direction line model will no longer appear.

Implemented in makVrv::DtOsgOverlayDirectionLineModel.

virtual void makVrv::DtOverlayDirectionLineModel::setIsLodOutAltitudeEnabled ( bool isLodOutAltitudeEnabled )

pure virtual

Set whether or not this model will use the LOD Out Altitude property.

Implemented in makVrv::DtOsgOverlayDirectionLineModel.

virtual void makVrv::DtOverlayDirectionLineModel::setGroup ( int )

pure virtual

The higher the Z order the "closer" to the eyepoint this element will be drawn. Use this variable to stack overlay objects in the particular order you want them displayed.

Implements makVrv::DtOverlayLineModel.

Implemented in makVrv::DtOsgOverlayDirectionLineModel.

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrvCore/DtOverlayDirectionLineModel.h

Classes

Public Types

Public Member Functions

Additional Inherited Members

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation