makVrv::DtLineSegmentProxy Class Reference

A line segment proxy is a flyweight class for controlling a single line segment.

Public Member Functions
	~DtLineSegmentProxy ()
const DtLineRenderer::LineSegmentPrimitive &	mapReadOnly () const
DtLineRenderer::LineSegmentPrimitive &	mapReadWrite ()
void	enableStipple ()
void	disableStipple ()
void	setLodOutAltitude (double lodOutAltitude)
double	lodOutAltitude () const
void	setIsLodOutAltitudeEnabled (bool isLodOutAltitudeEnabled)
bool	isLodOutAltitudeEnabled () const
void	setWidth (float w)
float	width () const
void	setAltitudeBasedLineLengths (const DtLineRenderer::DtLineSegmentAltitudeBasedConfigurationCollection &)
void	clearAltitudeBasedLineLengths ()
void	setIsUseForcedAltitudeEnabled (bool enabled)
bool	isUseForcedAltitudeEnabled () const
void	setForcedAltitudeToUse (double minimumAltitudeForUse)
double	forcedAltitudeToUse () const
void	setGroup (float group)
float	group () const

Static Public Member Functions
static void	swap (DtLineSegmentProxy *&v1, DtLineSegmentProxy *&v2)
static bool	less (DtLineSegmentProxy *&v1, DtLineSegmentProxy *&v2)
static bool	equal (DtLineSegmentProxy *&v1, DtLineSegmentProxy *&v2)

Protected Member Functions
	DtLineSegmentProxy (DtLineRenderer &parent, int index)

Protected Attributes
DtLineRenderer *	myParent
bool	myDirtyFlag
int	mySegmentIndex
int	myIndex
float	myWidth
double	myLodOutAltitude
bool	myIsLodOutAltitudeEnabled
bool	myIsForcedAltitudeEnabled
double	myForcedAltitudeToUse

Friends
class	DtLineRenderer

Constructor & Destructor Documentation

makVrv::DtLineSegmentProxy::~DtLineSegmentProxy

(

)

makVrv::DtLineSegmentProxy::DtLineSegmentProxy ( DtLineRenderer &  parent, int  index  )

protected

Member Function Documentation

const DtLineRenderer::LineSegmentPrimitive& makVrv::DtLineSegmentProxy::mapReadOnly

(

)

const

DtLineRenderer::LineSegmentPrimitive& makVrv::DtLineSegmentProxy::mapReadWrite

(

)

void makVrv::DtLineSegmentProxy::enableStipple

(

)

Enable line stippling.

void makVrv::DtLineSegmentProxy::disableStipple

(

)

Disable line stippling.

void makVrv::DtLineSegmentProxy::setLodOutAltitude

(

double

lodOutAltitude

)

Set the minimum altitude, in meters, at which this line segment will no longer render. Only used if setIsLodOutAltitudeEnabled(true). Default is the maximum value a double can hold.

double makVrv::DtLineSegmentProxy::lodOutAltitude

(

)

const

Get the minimum altitude, in meters, at which this line segment will no longer render.

void makVrv::DtLineSegmentProxy::setIsLodOutAltitudeEnabled

(

bool

isLodOutAltitudeEnabled

)

Set whether or not to use the LOD Out Altitude property. Default is true.

bool makVrv::DtLineSegmentProxy::isLodOutAltitudeEnabled

(

)

const

Get whether or not to use the LOD Out Altitude property.

void makVrv::DtLineSegmentProxy::setWidth

(

float

w

)

Set the width.

float makVrv::DtLineSegmentProxy::width

(

)

const

Get the width.

void makVrv::DtLineSegmentProxy::setAltitudeBasedLineLengths

(

const DtLineRenderer::DtLineSegmentAltitudeBasedConfigurationCollection &

)

Set the altitude-based line length configurations for this line segment proxy.

void makVrv::DtLineSegmentProxy::clearAltitudeBasedLineLengths

(

)

Clear out the altitude-based line length configurations for this line segment proxy.

void makVrv::DtLineSegmentProxy::setIsUseForcedAltitudeEnabled

(

bool

enabled

)

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

bool makVrv::DtLineSegmentProxy::isUseForcedAltitudeEnabled

(

)

const

Get whether or not a particular altitude-based is always used.

void makVrv::DtLineSegmentProxy::setForcedAltitudeToUse

(

double

minimumAltitudeForUse

)

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

double makVrv::DtLineSegmentProxy::forcedAltitudeToUse

(

)

const

Get the MSL altitude, in meters, to use when determining the altitude-based configuration to use.

void makVrv::DtLineSegmentProxy::setGroup

(

float

group

)

Set the group.

float makVrv::DtLineSegmentProxy::group

(

)

const

Set the group.

static void makVrv::DtLineSegmentProxy::swap ( DtLineSegmentProxy *&  v1, DtLineSegmentProxy *&  v2  )

inlinestatic

References myIndex, makVrv::DtLineRenderer::myLines, myParent, mySegmentIndex, and myWidth.

static bool makVrv::DtLineSegmentProxy::less ( DtLineSegmentProxy *&  v1, DtLineSegmentProxy *&  v2  )

inlinestatic

References int(), makVrv::DtLineVertex::lineParams, myIndex, makVrv::DtLineRenderer::myLines, myParent, mySegmentIndex, myWidth, and makVrv::DtLineRenderer::LineSegmentPrimitive::p1.

static bool makVrv::DtLineSegmentProxy::equal ( DtLineSegmentProxy *&  v1, DtLineSegmentProxy *&  v2  )

inlinestatic

References int(), makVrv::DtLineVertex::lineParams, myIndex, makVrv::DtLineRenderer::myLines, myParent, mySegmentIndex, myWidth, and makVrv::DtLineRenderer::LineSegmentPrimitive::p1.

Friends And Related Function Documentation

friend class DtLineRenderer

friend

Member Data Documentation

DtLineRenderer* makVrv::DtLineSegmentProxy::myParent

protected

Referenced by equal(), less(), and swap().

bool makVrv::DtLineSegmentProxy::myDirtyFlag

protected

int makVrv::DtLineSegmentProxy::mySegmentIndex

protected

Referenced by equal(), less(), and swap().

int makVrv::DtLineSegmentProxy::myIndex

protected

Referenced by equal(), less(), and swap().

float makVrv::DtLineSegmentProxy::myWidth

protected

Referenced by equal(), less(), and swap().

double makVrv::DtLineSegmentProxy::myLodOutAltitude

protected

bool makVrv::DtLineSegmentProxy::myIsLodOutAltitudeEnabled

protected

bool makVrv::DtLineSegmentProxy::myIsForcedAltitudeEnabled

protected

double makVrv::DtLineSegmentProxy::myForcedAltitudeToUse

protected

---

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

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