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.

Inheritance diagram for makVrv::DtWindowLineInstance:

[legend]

Public Member Functions
virtual	~DtWindowLineInstance ()

virtual void	setVertex (unsigned int vertex, double x, double y)=0

virtual void	removeVertex (unsigned int vertex)=0

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

virtual void	setStipplePattern (unsigned int stipplePattern)=0

virtual void	setWidth (unsigned int width)=0

virtual void	setStyleSegments (const std::vector< double > &segmentPercentages)=0

virtual void	setSegmentColor (unsigned int index, float r, float g, float b, float a)=0

virtual void	setSegmentStartColor (unsigned int index, float r, float g, float b, float a)=0

virtual void	setSegmentEndColor (unsigned int index, float r, float g, float b, float a)=0

virtual void	setSegmentLightningStyle (unsigned int index, bool enableLightningStyle)=0

virtual void	setSegmentStartArrow (unsigned int index, bool enableStartArrow)=0

virtual void	setSegmentEndArrow (unsigned int index, bool enableEndArrow)=0

virtual void	setSegmentStipplePattern (unsigned int index, unsigned int stippleScale, unsigned int stipplePattern)=0

virtual void	setSegmentWidth (unsigned int index, unsigned int width)=0

virtual void	update ()=0

virtual void	setTransform (DtMatrix3< double > transform)=0

virtual void	setClipBox (DtVector2< double > bottomLeftLocation, DtVector2< double > topRightLocation)=0

virtual void	setGroup (int groupId)=0

virtual void	setChannelOverlay (const std::string &displayName, const std::string &windowName, const std::string &channelName)=0

Public Member Functions inherited from makVrv::DtSetVisibilityInterface
virtual	~DtSetVisibilityInterface ()

virtual void	setVisible (bool visible)=0

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	stippleScale,
		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.

virtual void makVrv::DtWindowLineInstance::setTransform ( DtMatrix3< double > transform )

pure virtual

Sets the line's transform matrix, used to update the position and clockwise rotation of the vertices.

Implemented in makVrv::DtOsgWindowLineInstance.

virtual void makVrv::DtWindowLineInstance::setClipBox	(	DtVector2< double >	bottomLeftLocation,
		DtVector2< double >	topRightLocation
	)

pure virtual

Set this objects clip box bounds.

Implemented in makVrv::DtOsgWindowLineInstance.

virtual void makVrv::DtWindowLineInstance::setGroup ( int groupId )

pure virtual

Set this object's group ID for z order. The higher the Z order the "closer" the element will be drawn to the eye point.

Implemented in makVrv::DtOsgWindowLineInstance.

virtual void makVrv::DtWindowLineInstance::setChannelOverlay	(	const std::string &	displayName,
		const std::string &	windowName,
		const std::string &	channelName
	)

pure virtual

By default window objects are placed on the RemoteDisplayWorldOverlay, which is rendered on all channels that have the "showRemoteGraphics" channel keyword. If a user wishes to draw a specific window object on a specific channel, use this method. This does not work for remote displays.

Implemented in makVrv::DtOsgWindowLineInstance, and makVrv::DtOsgWindowLineGroupInstance.

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

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

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation