vrvControlToolkit::DtVdcLineSegment Class Reference

DtLine2DObject and DtLine3DObject helper class.

DtVdcLineSegment is used by DtLine2DObject and DtLine3DObject to represent a single segment within the overall line. It defines the DtVdcSegmentStyle and DtVdcSegmentArrowStyle enumerations which are part of the public interface. The remainder of the class is for use by DtLine2DObject and DtLine3DObject, and is not intended to public use.

Public Types
enum	DtVdcSegmentStyle { DtVdcSegmentStyleStraight, DtVdcSegmentStyleLightning }
enum	DtVdcSegmentArrowStyle { DtVdcSegmentArrowStyleNoArrow, DtVdcSegmentArrowStyleArrowEnd, DtVdcSegmentArrowStyleArrowStart, DtVdcSegmentArrowStyleArrowDouble }

Public Member Functions
	DtVdcLineSegment (double percentage, const DtVdcColor &color, unsigned pattern, unsigned thickness, DtVdcSegmentStyle style, DtVdcSegmentArrowStyle arrowStyle)
	DtVdcLineSegment ()
	DtVdcLineSegment (const DtVdcLineSegment &orig)
DtVdcLineSegment &	operator= (const DtVdcLineSegment &orig)
const DtVdcColor &	color () const
void	setColor (const DtVdcColor &color)
unsigned	pattern () const
void	setPattern (unsigned pattern)
unsigned	thickness () const
void	setThickness (unsigned thickness)
double	percentage () const
void	setPercentage (double percentage)
DtVdcSegmentStyle	style () const
void	setStyle (DtVdcSegmentStyle style)
DtVdcSegmentArrowStyle	arrowStyle () const
void	setArrowStyle (DtVdcSegmentArrowStyle arrowStyle)

Protected Attributes
DtVdcColor	myColor
unsigned	myPattern
unsigned	myThickness
double	myPercentage
DtVdcSegmentStyle	myStyle
DtVdcSegmentArrowStyle	myArrowStyle

Member Enumeration Documentation

enum vrvControlToolkit::DtVdcLineSegment::DtVdcSegmentStyle

Supported Line Segment Styles.

This enumeration is used to indicate the line style that the remote drawer should use for a line segment

Enumerator
DtVdcSegmentStyleStraight	Straight line.
DtVdcSegmentStyleLightning	Lightning bolt line.

enum vrvControlToolkit::DtVdcLineSegment::DtVdcSegmentArrowStyle

Supported Arrow Segment Styles.

This enumeration is used to indicate the arrow style that the remote drawer should use for the ends of a line segment

Enumerator
DtVdcSegmentArrowStyleNoArrow	No arrowhead on either end.
DtVdcSegmentArrowStyleArrowEnd	Arrowhead on the segment end.
DtVdcSegmentArrowStyleArrowStart	Arrowhead on the segment start.
DtVdcSegmentArrowStyleArrowDouble	Arrowhead on both ends of the segment.

Constructor & Destructor Documentation

vrvControlToolkit::DtVdcLineSegment::DtVdcLineSegment	(	double	percentage,
		const DtVdcColor &	color,
		unsigned	pattern,
		unsigned	thickness,
		DtVdcSegmentStyle	style,
		DtVdcSegmentArrowStyle	arrowStyle
	)

vrvControlToolkit::DtVdcLineSegment::DtVdcLineSegment

(

)

vrvControlToolkit::DtVdcLineSegment::DtVdcLineSegment

(

const DtVdcLineSegment &

orig

)

Member Function Documentation

DtVdcLineSegment& vrvControlToolkit::DtVdcLineSegment::operator=

(

const DtVdcLineSegment &

orig

)

const DtVdcColor& vrvControlToolkit::DtVdcLineSegment::color

(

)

const

void vrvControlToolkit::DtVdcLineSegment::setColor

(

const DtVdcColor &

color

)

unsigned vrvControlToolkit::DtVdcLineSegment::pattern

(

)

const

void vrvControlToolkit::DtVdcLineSegment::setPattern

(

unsigned

pattern

)

unsigned vrvControlToolkit::DtVdcLineSegment::thickness

(

)

const

void vrvControlToolkit::DtVdcLineSegment::setThickness

(

unsigned

thickness

)

double vrvControlToolkit::DtVdcLineSegment::percentage

(

)

const

void vrvControlToolkit::DtVdcLineSegment::setPercentage

(

double

percentage

)

DtVdcSegmentStyle vrvControlToolkit::DtVdcLineSegment::style

(

)

const

void vrvControlToolkit::DtVdcLineSegment::setStyle

(

DtVdcSegmentStyle

style

)

DtVdcSegmentArrowStyle vrvControlToolkit::DtVdcLineSegment::arrowStyle

(

)

const

void vrvControlToolkit::DtVdcLineSegment::setArrowStyle

(

DtVdcSegmentArrowStyle

arrowStyle

)

Member Data Documentation

DtVdcColor vrvControlToolkit::DtVdcLineSegment::myColor

protected

unsigned vrvControlToolkit::DtVdcLineSegment::myPattern

protected

unsigned vrvControlToolkit::DtVdcLineSegment::myThickness

protected

double vrvControlToolkit::DtVdcLineSegment::myPercentage

protected

DtVdcSegmentStyle vrvControlToolkit::DtVdcLineSegment::myStyle

protected

DtVdcSegmentArrowStyle vrvControlToolkit::DtVdcLineSegment::myArrowStyle

protected

---

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

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