A 3D Line Stealth Draw Control Object.

DtLine3DObject represents a line that can be positioned and displayed in the scene. The line may be divided into multiple segments of varying relative lengths. A color, line style, arrow style, pattern and thickness may be specified for each segment; and the line can flash, if desired.

Inheritance diagram for vrvControlToolkit::DtLineObjectInterface:

[legend]

Public Member Functions
virtual int	numSegments () const =0

virtual void	setNumSegments (int numSegments)=0

virtual DtVdcLineSegment::DtVdcSegmentStyle	lineStyle (int segment=0) const =0

virtual void	setLineStyle (DtVdcLineSegment::DtVdcSegmentStyle lineStyle, int segment=0)=0

virtual DtVdcLineSegment::DtVdcSegmentArrowStyle	arrowStyle (int segment=0) const =0

virtual void	setArrowStyle (DtVdcLineSegment::DtVdcSegmentArrowStyle arrowStyle, int segment=0)=0

virtual unsigned	pattern (int segment=0) const =0

virtual void	setPattern (unsigned pattern, int segment=0)=0

virtual unsigned	thickness (int segment=0) const =0

virtual void	setThickness (unsigned thickness, int segment=0)=0

virtual double	percentage (int segment) const =0

virtual void	setPercentage (double percentage, int segment)=0

Member Function Documentation

virtual int vrvControlToolkit::DtLineObjectInterface::numSegments ( ) const

pure virtual

numSegments accessor

Get the number of segments in this line

Returns: 0 to N

Implemented in vrvControlToolkit::DtLine3DObject, and vrvControlToolkit::DtLine2DObject.

virtual void vrvControlToolkit::DtLineObjectInterface::setNumSegments ( int numSegments )

pure virtual

numSegments mutator

Set the number of individual segments that make up this line

Parameters

numSegments 0 to N

Implemented in vrvControlToolkit::DtLine3DObject, and vrvControlToolkit::DtLine2DObject.

virtual DtVdcLineSegment::DtVdcSegmentStyle vrvControlToolkit::DtLineObjectInterface::lineStyle ( int segment = 0 ) const

pure virtual

lineStyle accessor

Get the lineStyle assigned to the indicated segment

Parameters

segment The segment to retrieve the lineStyle from

Returns: A DtVdcLineSegment::DtVdcSegmentStyle indicating the segment's style

Implemented in vrvControlToolkit::DtLine3DObject, and vrvControlToolkit::DtLine2DObject.

virtual void vrvControlToolkit::DtLineObjectInterface::setLineStyle	(	DtVdcLineSegment::DtVdcSegmentStyle	lineStyle,
		int	segment = `0`
	)

pure virtual

lineStyle mutator

Set the lineStyle to use when drawing the indicated segment

Parameters

lineStyle	The lineStyle to use for the indicated segment
segment	The segment to apply the lineStyle to

Implemented in vrvControlToolkit::DtLine3DObject, and vrvControlToolkit::DtLine2DObject.

virtual DtVdcLineSegment::DtVdcSegmentArrowStyle vrvControlToolkit::DtLineObjectInterface::arrowStyle ( int segment = 0 ) const

pure virtual

arrowStyle accessor

Get the arrowStyle assigned to the indicated segment

Parameters

segment The segment to retrieve the arrowStyle from

Returns: A DtVdcLineSegment::DtVdcSegmentArrowStyle indicating the segment's arrow style

Implemented in vrvControlToolkit::DtLine3DObject, and vrvControlToolkit::DtLine2DObject.

virtual void vrvControlToolkit::DtLineObjectInterface::setArrowStyle	(	DtVdcLineSegment::DtVdcSegmentArrowStyle	arrowStyle,
		int	segment = `0`
	)

pure virtual

arrowStyle mutator

Set the arrowStyle to use when drawing the indicated segment

Parameters

arrowStyle	The arrowStyle to use for the indicated segment
segment	The segment to apply the arrowStyle to

Implemented in vrvControlToolkit::DtLine3DObject, and vrvControlToolkit::DtLine2DObject.

virtual unsigned vrvControlToolkit::DtLineObjectInterface::pattern ( int segment = 0 ) const

pure virtual

pattern accessor

Get the stipple pattern used when drawing the indicated segment

Parameters

segment The segment to retrieve the pattern from

Returns: The stipple pattern, 0x00000000 to 0xFFFFFFFF

Implemented in vrvControlToolkit::DtLine3DObject, and vrvControlToolkit::DtLine2DObject.

virtual void vrvControlToolkit::DtLineObjectInterface::setPattern	(	unsigned	pattern,
		int	segment = `0`
	)

pure virtual

pattern mutator

Set the stipple pattern to use when drawing the indicated segment

Parameters

pattern	The stipple pattern, 0x00000000 to 0xFFFFFFFF.
segment	The segment to apply the pattern to

Implemented in vrvControlToolkit::DtLine3DObject, and vrvControlToolkit::DtLine2DObject.

virtual unsigned vrvControlToolkit::DtLineObjectInterface::thickness ( int segment = 0 ) const

pure virtual

thickness accessor

Get the thickness assigned to the indicated segment

Parameters

segment The segment to retrieve the thickness from

Returns: The segments's thickness, in pixels (0-255)

Implemented in vrvControlToolkit::DtLine3DObject, and vrvControlToolkit::DtLine2DObject.

virtual void vrvControlToolkit::DtLineObjectInterface::setThickness	(	unsigned	thickness,
		int	segment = `0`
	)

pure virtual

thickness mutator

Set the thickness to use when drawing the indicated segment

Parameters

thickness	The thickness in pixels, (0-255). Note that GL may not actually be willing or able to draw a line 255 pixels wide. It is implementation dependent.
segment	The segment to apply the thickness to

Implemented in vrvControlToolkit::DtLine3DObject, and vrvControlToolkit::DtLine2DObject.

virtual double vrvControlToolkit::DtLineObjectInterface::percentage ( int segment ) const

pure virtual

percentage accessor

Get the percentage of the line that the indicated segment occupies

Parameters

segment The segment to retrieve the percentage from

Returns: The line's thickness, in pixels (0-255)

Implemented in vrvControlToolkit::DtLine3DObject, and vrvControlToolkit::DtLine2DObject.

virtual void vrvControlToolkit::DtLineObjectInterface::setPercentage	(	double	percentage,
		int	segment
	)

pure virtual

percentage mutator

Set the percentage of the line that the indicated segment should occupy. Note that it is the responsibility of the user to ensure that the sum of the individual segment's percentages is 1.

Parameters

percentage	The percentage (0. to 1.)
segment	The segment to apply the precentage to

Implemented in vrvControlToolkit::DtLine3DObject, and vrvControlToolkit::DtLine2DObject.

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrvDrawControl/DtLineObjectInterface.h

Public Member Functions

Member Function Documentation