makVrv::DtWindowLine Class Reference

A model-like object that draws a 2D line. More...

Inheritance diagram for makVrv::DtWindowLine:

List of all members.

Public Member Functions
	DtWindowLine (DtDe &de, DtUniqueID id)
	CTOR.
virtual	~DtWindowLine ()
	DTOR.
virtual void	setVertex (unsigned int vertex, double x, double y)
	Set (or add) the specified vertex at <x,y>
virtual void	removeVertex (unsigned int vertex)
	Remove the specified vertex.
virtual void	setStartVertex (double x, double y)
	Set the start vertex of the line in screen coordinates from 0...1 Here for backward compatibility.
virtual void	setEndVertex (double x, double y)
	Set the end vertex of the line in screen coordinates from 0...1 Here for backward compatibility.
virtual void	setVisible (bool isVisible)
	Set the line visible or invisible.
virtual void	setWidth (unsigned int width)
	Set the entire line width.
virtual void	setColor (float r, float g, float b, float a)
	Set the color of the line.
virtual void	setStipplePattern (unsigned int pattern)
	Set a stipple pattern for the line.
virtual void	setStyleSegments (const std::vector< double > &segmentPercentages)
	Set the percentage lengths of the segments; creates and removes segments as necessary.
virtual void	setSegmentColor (unsigned int index, float r, float g, float b, float a)
	Set the color of a segment.
virtual void	setSegmentLightningStyle (unsigned int index, bool enableLightningStyle)
	Set a segment's lightning style (whether or not it looks like a lighting bolt)
virtual void	setSegmentStartArrow (unsigned int index, bool enableStartArrow)
	Turn on or off a segment's start arrow.
virtual void	setSegmentEndArrow (unsigned int index, bool enableEndArrow)
	Turn on or off a segment's end arrow.
virtual void	setSegmentStipplePattern (unsigned int index, unsigned int stipplePattern)
	Set the stipple pattern for a segment according to the OpenGL line stipple feature.
virtual void	setSegmentWidth (unsigned int index, unsigned int width)
	Set the width of a segment in pixels.
virtual void	setSegmentStartColor (unsigned int segmentIndex, float r, float g, float b, float a)
	Set the color of the firt vertex in a segment.
virtual void	setSegmentEndColor (unsigned int segmentIndex, float r, float g, float b, float a)
	Set the color of the end vertex in a segment.
virtual void	setInstance (DtWindowLineInstance *instance)
	Set or replace the line instance for the line Transfers ownership.
virtual DtWindowLineInstance *	instance ()
	Get the line instance for the line.
Protected Member Functions
virtual void	update ()
	Called on signal_postUpdate; time to update render data.
virtual void	needsUpdate ()
	Called by all mutators to set up a postUpdate signal if not already connected.
Protected Attributes
DtWindowLineInstance *	myInstance
bool	myConnectedToPostUpdate

---

Detailed Description

A model-like object that draws a 2D line.

A 2D line that can be represented in one of two ways: either it has a start position and end position, divided into segments, or it is multiple (> 2) vertices, each pair of which define a segment. Each segment consists of a percentage (first case only), color, style, arrow style, stipple pattern, and thickness.

---

Constructor & Destructor Documentation

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

CTOR.

virtual makVrv::DtWindowLine::~DtWindowLine

(

)

[virtual]

DTOR.

---

Member Function Documentation

virtual void makVrv::DtWindowLine::setVertex	(	unsigned int	vertex,
		double	x,
		double	y
	)		[virtual]

Set (or add) the specified vertex at <x,y>

virtual void makVrv::DtWindowLine::removeVertex

(

unsigned int

vertex

)

[virtual]

Remove the specified vertex.

virtual void makVrv::DtWindowLine::setStartVertex	(	double	x,
		double	y
	)		[virtual]

Set the start vertex of the line in screen coordinates from 0...1 Here for backward compatibility.

Same as setVertex(0, x, y)

virtual void makVrv::DtWindowLine::setEndVertex	(	double	x,
		double	y
	)		[virtual]

Set the end vertex of the line in screen coordinates from 0...1 Here for backward compatibility.

Same as setVertex(1, x, y)

virtual void makVrv::DtWindowLine::setVisible

(

bool

isVisible

)

[virtual]

Set the line visible or invisible.

Implements makVrv::DtWindowObject.

virtual void makVrv::DtWindowLine::setWidth

(

unsigned int

width

)

[virtual]

Set the entire line width.

virtual void makVrv::DtWindowLine::setColor	(	float	r,
		float	g,
		float	b,
		float	a
	)		[virtual]

Set the color of the line.

virtual void makVrv::DtWindowLine::setStipplePattern

(

unsigned int

pattern

)

[virtual]

Set a stipple pattern for the line.

Note that repeatFactor will not be used for overlay forms of the lines

virtual void makVrv::DtWindowLine::setStyleSegments

(

const std::vector< double > &

segmentPercentages

)

[virtual]

Set the percentage lengths of the segments; creates and removes segments as necessary.

virtual void makVrv::DtWindowLine::setSegmentColor	(	unsigned int	index,
		float	r,
		float	g,
		float	b,
		float	a
	)		[virtual]

Set the color of a segment.

virtual void makVrv::DtWindowLine::setSegmentLightningStyle	(	unsigned int	index,
		bool	enableLightningStyle
	)		[virtual]

Set a segment's lightning style (whether or not it looks like a lighting bolt)

virtual void makVrv::DtWindowLine::setSegmentStartArrow	(	unsigned int	index,
		bool	enableStartArrow
	)		[virtual]

Turn on or off a segment's start arrow.

virtual void makVrv::DtWindowLine::setSegmentEndArrow	(	unsigned int	index,
		bool	enableEndArrow
	)		[virtual]

Turn on or off a segment's end arrow.

virtual void makVrv::DtWindowLine::setSegmentStipplePattern	(	unsigned int	index,
		unsigned int	stipplePattern
	)		[virtual]

Set the stipple pattern for a segment according to the OpenGL line stipple feature.

virtual void makVrv::DtWindowLine::setSegmentWidth	(	unsigned int	index,
		unsigned int	width
	)		[virtual]

Set the width of a segment in pixels.

virtual void makVrv::DtWindowLine::setSegmentStartColor	(	unsigned int	segmentIndex,
		float	r,
		float	g,
		float	b,
		float	a
	)		[virtual]

Set the color of the firt vertex in a segment.

This can be used for color blending between vertices.

virtual void makVrv::DtWindowLine::setSegmentEndColor	(	unsigned int	segmentIndex,
		float	r,
		float	g,
		float	b,
		float	a
	)		[virtual]

Set the color of the end vertex in a segment.

This can be used for color blending between vertices.

virtual void makVrv::DtWindowLine::setInstance

(

DtWindowLineInstance *

instance

)

[virtual]

Set or replace the line instance for the line Transfers ownership.

virtual DtWindowLineInstance* makVrv::DtWindowLine::instance

(

)

[virtual]

Get the line instance for the line.

virtual void makVrv::DtWindowLine::update

(

)

[protected, virtual]

Called on signal_postUpdate; time to update render data.

virtual void makVrv::DtWindowLine::needsUpdate

(

)

[protected, virtual]

Called by all mutators to set up a postUpdate signal if not already connected.

---

Member Data Documentation

DtWindowLineInstance* makVrv::DtWindowLine::myInstance [protected]

bool makVrv::DtWindowLine::myConnectedToPostUpdate [protected]

---

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

• include/vrvCore/DtWindowLine.h