makVrv::DtWindowLineInstance Class Reference

Interface for a DtWindowLineInstance - an attachable model instance that draws a 2D line. More...

Inheritance diagram for makVrv::DtWindowLineInstance:

List of all members.

Public Member Functions
virtual	~DtWindowLineInstance ()
	DTOR.
virtual void	setVertex (unsigned int vertex, double x, double y)=0
	Set (or add) the specified vertex at <x,y>
virtual void	removeVertex (unsigned int vertex)=0
	Remove the specified vertex.
virtual void	setColor (float r, float g, float b, float a)=0
	Set the entire line color.
virtual void	setStipplePattern (unsigned int stipplePattern)=0
	Set the entire line stipple pattern.
virtual void	setWidth (unsigned int width)=0
	Set the entire line width.
virtual void	setStyleSegments (const std::vector< double > &segmentPercentages)=0
	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)=0
	Set the color of a segment.
virtual void	setSegmentStartColor (unsigned int index, float r, float g, float b, float a)=0
	Set the color of the firt vertex in a segment.
virtual void	setSegmentEndColor (unsigned int index, float r, float g, float b, float a)=0
	Set the color of the second vertex in a segment.
virtual void	setSegmentLightningStyle (unsigned int index, bool enableLightningStyle)=0
	Set a segment's lightning style (whether or not it looks like a lighting bolt)
virtual void	setSegmentStartArrow (unsigned int index, bool enableStartArrow)=0
	Turn on or off a segment's start arrow.
virtual void	setSegmentEndArrow (unsigned int index, bool enableEndArrow)=0
	Turn on or off a segment's end arrow.
virtual void	setSegmentStipplePattern (unsigned int index, unsigned int stipplePattern)=0
	Set the stipple pattern for a segment according to the OpenGL line stipple feature.
virtual void	setSegmentWidth (unsigned int index, unsigned int width)=0
	Set the width of a segment in pixels.
virtual void	update ()=0
	Called on signal_postUpdate; time to update render data.

---

Detailed Description

Interface for a DtWindowLineInstance - an attachable model instance that draws a 2D line.

A 2D line has a start position and end position, and is made up of segments. Each segment consists of a percentage, color, style, arrow style, stipple pattern, and thickness. Each segment is drawn as the specified percentage of length of the entire line, starting from the end of the previous segment.

---

Constructor & Destructor Documentation

virtual makVrv::DtWindowLineInstance::~DtWindowLineInstance

(

)

[virtual]

DTOR.

---

Member Function Documentation

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

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

Implemented in makVrv::DtOsgWindowLineInstance.

virtual void makVrv::DtWindowLineInstance::removeVertex

(

unsigned int

vertex

)

[pure virtual]

Remove the specified vertex.

Implemented in makVrv::DtOsgWindowLineInstance.

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

Set the entire line color.

Implemented in makVrv::DtOsgWindowLineInstance.

virtual void makVrv::DtWindowLineInstance::setStipplePattern

(

unsigned int

stipplePattern

)

[pure virtual]

Set the entire line stipple pattern.

Implemented in makVrv::DtOsgWindowLineInstance.

virtual void makVrv::DtWindowLineInstance::setWidth

(

unsigned int

width

)

[pure virtual]

Set the entire line width.

Implemented in makVrv::DtOsgWindowLineInstance.

virtual void makVrv::DtWindowLineInstance::setStyleSegments

(

const std::vector< double > &

segmentPercentages

)

[pure virtual]

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

Implemented in makVrv::DtOsgWindowLineInstance.

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

Set the color of a segment.

Implemented in makVrv::DtOsgWindowLineInstance.

virtual void makVrv::DtWindowLineInstance::setSegmentStartColor	(	unsigned int	index,
		float	r,
		float	g,
		float	b,
		float	a
	)		[pure virtual]

Set the color of the firt vertex in a segment.

This can be used for color blending between vertices.

Implemented in makVrv::DtOsgWindowLineInstance.

virtual void makVrv::DtWindowLineInstance::setSegmentEndColor	(	unsigned int	index,
		float	r,
		float	g,
		float	b,
		float	a
	)		[pure virtual]

Set the color of the second vertex in a segment.

This can be used for color blending between vertices.

Implemented in makVrv::DtOsgWindowLineInstance.

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

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

Implemented in makVrv::DtOsgWindowLineInstance.

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

Turn on or off a segment's start arrow.

Implemented in makVrv::DtOsgWindowLineInstance.

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

Turn on or off a segment's end arrow.

Implemented in makVrv::DtOsgWindowLineInstance.

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

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

Implemented in makVrv::DtOsgWindowLineInstance.

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

Set the width of a segment in pixels.

Implemented in makVrv::DtOsgWindowLineInstance.

virtual void makVrv::DtWindowLineInstance::update

(

)

[pure virtual]

Called on signal_postUpdate; time to update render data.

Implemented in makVrv::DtOsgWindowLineInstance.

---

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

• include/vrvCore/DtWindowLineInstance.h