An interface for a single line segment.

Inheritance diagram for makVrv::DtLineSegmentInterface:

Classes
class	DtLineSegmentAltitudeBasedConfiguration

Public Types
typedef std::vector < DtLineSegmentAltitudeBasedConfiguration >	DtLineSegmentAltitudeBasedConfigurationCollection

Public Member Functions
	DtLineSegmentInterface ()

virtual	~DtLineSegmentInterface ()

virtual void	setAltitudeBasedConfigurations (const DtLineSegmentInterface::DtLineSegmentAltitudeBasedConfigurationCollection &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 (float group)=0

virtual int	group () const =0

virtual void	set2DPositions (float x1, float y1, float x2, float y2)=0

virtual void	set2DPosition (unsigned int index0or1, float x, float y)=0

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

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

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

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

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

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

virtual void	setDirection2DLength (unsigned int index0or1, float length)=0

virtual float	direction2DLength (unsigned int index0or1) const =0

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

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

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

virtual void	setWidth (float w)=0

virtual float	width () const =0

virtual void	setStippleParameters (unsigned int scale, unsigned short pattern)=0

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

Member Typedef Documentation

typedef std::vector<DtLineSegmentAltitudeBasedConfiguration> makVrv::DtLineSegmentInterface::DtLineSegmentAltitudeBasedConfigurationCollection

A collection of altitude-based configurations.

Constructor & Destructor Documentation

makVrv::DtLineSegmentInterface::DtLineSegmentInterface ( )

CTOR.

virtual makVrv::DtLineSegmentInterface::~DtLineSegmentInterface ( )

virtual

Line segment destructor.

Member Function Documentation

virtual void makVrv::DtLineSegmentInterface::setAltitudeBasedConfigurations ( const DtLineSegmentInterface::DtLineSegmentAltitudeBasedConfigurationCollection & configs )

pure virtual

Set the altitude-based configurations for this line segment.

Implemented in makVrv::DtTexturedLineSegment, and makVrv::DtLineSegment.

virtual void makVrv::DtLineSegmentInterface::clearAltitudeBasedConfigurations ( )

pure virtual

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

Implemented in makVrv::DtTexturedLineSegment, and makVrv::DtLineSegment.

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

pure 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(...)

Implemented in makVrv::DtTexturedLineSegment, and makVrv::DtLineSegment.

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

pure virtual

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

Implemented in makVrv::DtTexturedLineSegment, and makVrv::DtLineSegment.

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

pure virtual

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

Implemented in makVrv::DtTexturedLineSegment, and makVrv::DtLineSegment.

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

pure virtual

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

Implemented in makVrv::DtTexturedLineSegment, and makVrv::DtLineSegment.

virtual void makVrv::DtLineSegmentInterface::setGroup ( float group )

pure 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.

Implemented in makVrv::DtLineSegment, and makVrv::DtTexturedLineSegment.

virtual int makVrv::DtLineSegmentInterface::group ( ) const

pure virtual

Get the group.

Implemented in makVrv::DtLineSegment, and makVrv::DtTexturedLineSegment.

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

pure virtual

Set the vertex positions.

Implemented in makVrv::DtLineSegment, and makVrv::DtTexturedLineSegment.

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

pure virtual

Set the first vertex position.

Implemented in makVrv::DtLineSegment, and makVrv::DtTexturedLineSegment.

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

pure virtual

Implemented in makVrv::DtLineSegment, and makVrv::DtTexturedLineSegment.

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

pure virtual

Set the vertex colors.

Implemented in makVrv::DtLineSegment, and makVrv::DtTexturedLineSegment.

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

pure virtual

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

Implemented in makVrv::DtLineSegment, and makVrv::DtTexturedLineSegment.

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

pure virtual

Implemented in makVrv::DtLineSegment, and makVrv::DtTexturedLineSegment.

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

pure virtual

Set the normalized direction of the line in world space.

Implemented in makVrv::DtTexturedLineSegment, and makVrv::DtLineSegment.

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

pure virtual

Get the normalized direction of the vertex.

Implemented in makVrv::DtTexturedLineSegment, and makVrv::DtLineSegment.

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

pure virtual

Set the length of the line in 2D space.

Implemented in makVrv::DtTexturedLineSegment, and makVrv::DtLineSegment.

virtual float makVrv::DtLineSegmentInterface::direction2DLength ( unsigned int index0or1 ) const

pure virtual

Get the length of the line in 2D space.

Implemented in makVrv::DtTexturedLineSegment, and makVrv::DtLineSegment.

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

pure virtual

Implemented in makVrv::DtLineSegment, and makVrv::DtTexturedLineSegment.

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

pure virtual

Implemented in makVrv::DtLineSegment, and makVrv::DtTexturedLineSegment.

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

virtual

Reimplemented in makVrv::DtLineSegment, and makVrv::DtTexturedLineSegment.

virtual void makVrv::DtLineSegmentInterface::setWidth ( float w )

pure virtual

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

Implemented in makVrv::DtLineSegment, and makVrv::DtTexturedLineSegment.

virtual float makVrv::DtLineSegmentInterface::width ( ) const

pure virtual

Get the line width.

Implemented in makVrv::DtLineSegment, and makVrv::DtTexturedLineSegment.

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

pure 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.

Implemented in makVrv::DtTexturedLineSegment, and makVrv::DtLineSegment.

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

pure virtual

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

Implemented in makVrv::DtTexturedLineSegment, and makVrv::DtLineSegment.

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

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

Classes

Public Types

Public Member Functions

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation