A class which represents a single line segment.

Inheritance diagram for makVrv::DtLineSegment:

Public Member Functions
	DtLineSegment (DtOverlayRenderer &renderer)

	DtLineSegment (DtLineRenderer &renderer)

virtual	~DtLineSegment ()

	DtLineSegment (const DtLineSegment &other)=delete

DtLineSegment &	operator= (const DtLineSegment &other)=delete

void	setAltitudeBasedConfigurations (const DtLineRenderer::DtLineSegmentAltitudeBasedConfigurationCollection &configs)

void	clearAltitudeBasedConfigurations ()

virtual void	setIsUseForcedAltitudeEnabled (bool enabled)

virtual void	setForcedAltitudeToUse (double minimumAltitudeForUse)

void	setLodOutAltitude (double lodOutAltitude)

void	setIsLodOutAltitudeEnabled (bool isLodOutAltitudeEnabled)

void	setGroup (float group)

int	group () const

void	set2DPositions (float x1, float y1, float x2, float y2)

void	set2DPosition (unsigned int index0or1, float x, float y)

void	get2DPosition (unsigned int index0or1, float &x, float &y) const

void	setColors (float r1, float g1, float b1, float a1, float r2, float g2, float b2, float a2)

void	set3DPosition (int index0or1, float dx, float dy, float z, float w)

void	get3DPosition (int index0or1, float &dx, float &dy, float &z, float &w) const

void	set3DDirection (unsigned int index0or1, float x, float y, float z)

void	get3DDirection (unsigned int index0or1, float &x, float &y, float &z) const

void	setDirection2DLength (unsigned int index0or1, float length)

float	direction2DLength (unsigned int index0or1) const

void	setColor (unsigned int index0or1, float r, float g, float b, float a)

void	getColor (unsigned int index0or1, float &r, float &g, float &b, float &a) const

void	setColor1 (float r1, float g1, float b1, float a1)

void	setColor2 (float r2, float g2, float b2, float a2)

void	setColor (float r, float g, float b, float a)

void	setWidth (float w)

float	width () const

void	setStippleParameters (unsigned int scale, unsigned short pattern)

void	getStippleParameters (unsigned int &scale, unsigned short &pattern) const

Public Member Functions inherited from makVrv::DtLineSegmentInterface
	DtLineSegmentInterface ()

virtual	~DtLineSegmentInterface ()

void	setColor (float r, float g, float b, float a)

Static Public Attributes
static const unsigned short	NoStipple = 0xFFFF

static const unsigned short	NoLine = 0x0

Protected Attributes
DtLineSegmentProxy *	myProxy

Private Member Functions
	DtLineSegment ()

Constructor & Destructor Documentation

makVrv::DtLineSegment::DtLineSegment ( DtOverlayRenderer & renderer )

Create a a line segment.

makVrv::DtLineSegment::DtLineSegment ( DtLineRenderer & renderer )

Create a a line segment.

virtual makVrv::DtLineSegment::~DtLineSegment ( )

virtual

Line segment destructor.

makVrv::DtLineSegment::DtLineSegment ( const DtLineSegment & other )

delete

Copy Constructor not implemented - Copy not allowed.

makVrv::DtLineSegment::DtLineSegment ( )

inlineprivate

Member Function Documentation

DtLineSegment& makVrv::DtLineSegment::operator= ( const DtLineSegment & other )

delete

Assignment Operator not implemented - Assignment not allowed.

void makVrv::DtLineSegment::setAltitudeBasedConfigurations ( const DtLineRenderer::DtLineSegmentAltitudeBasedConfigurationCollection & configs )

Set the altitude-based configurations for this line segment.

void makVrv::DtLineSegment::clearAltitudeBasedConfigurations ( )

Clear the altitude-based configurations for this line segment. The line segment will no longer have a dynamic length but will fixed to the length specified by: setDirection2DLength(unsigned int, float).

See Also: setAltitudeBasedConfigurations

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

virtual

Set whether or not a particular altitude-based configuration is used, regardless of altitude. This only matters if altitude-based configurations are used. The altitude-based configuration used is provided by the configuration corresponding to the altitude provided using: setForcedAltitudeToUse(...)

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

virtual

Set the MSL altitude, in meters, to use when determining the altitude-based configuration to use. This is only used if setIsUseForcedAltitudeEnabled(true).

void makVrv::DtLineSegment::setLodOutAltitude ( double lodOutAltitude )

Set the minimum MSL altitude, in meters, at which the line will no longer appear.

void makVrv::DtLineSegment::setIsLodOutAltitudeEnabled ( bool isLodOutAltitudeEnabled )

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

void makVrv::DtLineSegment::setGroup ( float group )

virtual

Set the group of the line segment. Setting the group to zero causes the line to be hidden. Setting the group to negative numbers causes the line to be drawn relative to North. 1.

Implements makVrv::DtLineSegmentInterface.

int makVrv::DtLineSegment::group ( ) const

virtual

Get the group.

Implements makVrv::DtLineSegmentInterface.

void makVrv::DtLineSegment::set2DPositions	(	float	x1,
		float	y1,
		float	x2,
		float	y2
	)

virtual

Set the vertex positions.

Implements makVrv::DtLineSegmentInterface.

void makVrv::DtLineSegment::set2DPosition	(	unsigned int	index0or1,
		float	x,
		float	y
	)

virtual

Set the first vertex position.

Implements makVrv::DtLineSegmentInterface.

void makVrv::DtLineSegment::get2DPosition	(	unsigned int	index0or1,
		float &	x,
		float &	y
	)		const

virtual

Implements makVrv::DtLineSegmentInterface.

void makVrv::DtLineSegment::setColors	(	float	r1,
		float	g1,
		float	b1,
		float	a1,
		float	r2,
		float	g2,
		float	b2,
		float	a2
	)

virtual

Set the vertex colors.

Implements makVrv::DtLineSegmentInterface.

void makVrv::DtLineSegment::set3DPosition	(	int	index0or1,
		float	dx,
		float	dy,
		float	z,
		float	w
	)

virtual

Set the 3D location of the line. This will set the 3D location for each end of the line.

Implements makVrv::DtLineSegmentInterface.

void makVrv::DtLineSegment::get3DPosition	(	int	index0or1,
		float &	dx,
		float &	dy,
		float &	z,
		float &	w
	)		const

virtual

Implements makVrv::DtLineSegmentInterface.

void makVrv::DtLineSegment::set3DDirection	(	unsigned int	index0or1,
		float	x,
		float	y,
		float	z
	)

virtual

Set the normalized direction of the line in world space.

Implements makVrv::DtLineSegmentInterface.

void makVrv::DtLineSegment::get3DDirection	(	unsigned int	index0or1,
		float &	x,
		float &	y,
		float &	z
	)		const

virtual

Get the normalized direction of the vertex.

Implements makVrv::DtLineSegmentInterface.

void makVrv::DtLineSegment::setDirection2DLength	(	unsigned int	index0or1,
		float	length
	)

virtual

Set the length of the line in 2D space.

Implements makVrv::DtLineSegmentInterface.

float makVrv::DtLineSegment::direction2DLength ( unsigned int index0or1 ) const

virtual

Get the length of the line in 2D space.

Implements makVrv::DtLineSegmentInterface.

void makVrv::DtLineSegment::setColor	(	unsigned int	index0or1,
		float	r,
		float	g,
		float	b,
		float	a
	)

virtual

Implements makVrv::DtLineSegmentInterface.

void makVrv::DtLineSegment::getColor	(	unsigned int	index0or1,
		float &	r,
		float &	g,
		float &	b,
		float &	a
	)		const

virtual

Implements makVrv::DtLineSegmentInterface.

void makVrv::DtLineSegment::setColor1	(	float	r1,
		float	g1,
		float	b1,
		float	a1
	)

void makVrv::DtLineSegment::setColor2	(	float	r2,
		float	g2,
		float	b2,
		float	a2
	)

void makVrv::DtLineSegment::setColor	(	float	r,
		float	g,
		float	b,
		float	a
	)

inline

void makVrv::DtLineSegment::setWidth ( float w )

virtual

Set a line width, from 0.0 to 64.0); Default line width is 1.0.

Implements makVrv::DtLineSegmentInterface.

float makVrv::DtLineSegment::width ( ) const

virtual

Get the line width.

Implements makVrv::DtLineSegmentInterface.

void makVrv::DtLineSegment::setStippleParameters	(	unsigned int	scale,
		unsigned short	pattern
	)

virtual

Set the line Stipple parameters. Scale is from 1-256. Pattern is 16 bit mask. Warning Stippled lines are rendered significantly slower than non-Stippled lines. Setting the pattern to NoStipple causes the line not to be stippled anymore.

Implements makVrv::DtLineSegmentInterface.

void makVrv::DtLineSegment::getStippleParameters	(	unsigned int &	scale,
		unsigned short &	pattern
	)		const

virtual

Get the line stipple parameters Uses the two arguments as return values.

Implements makVrv::DtLineSegmentInterface.

Member Data Documentation

const unsigned short makVrv::DtLineSegment::NoStipple = 0xFFFF

static

const unsigned short makVrv::DtLineSegment::NoLine = 0x0

static

DtLineSegmentProxy* makVrv::DtLineSegment::myProxy

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrvGraphics/DtLineSegment.h

Public Member Functions

Static Public Attributes

Protected Attributes

Private Member Functions

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation