VR-Forces 4.1 Class Documentation
List of all members | Public Types | Public Member Functions | Protected Attributes
DtSdcLineSegment Class Reference

SdcLine2DObject and SdcLine3DObject helper class. More...

Public Types

enum  DtSdcSegmentStyle { DtSdcSegmentStyleStraight, DtSdcSegmentStyleLightning }
 Supported Line Segment Styles. More...
enum  DtSdcSegmentArrowStyle { DtSdcSegmentArrowStyleNoArrow, DtSdcSegmentArrowStyleArrowEnd, DtSdcSegmentArrowStyleArrowStart, DtSdcSegmentArrowStyleArrowDouble }
 Supported Arrow Segment Styles. More...

Public Member Functions

 DtSdcLineSegment (double percentage, DtSdcColor color, unsigned pattern, unsigned thickness, DtSdcSegmentStyle style, DtSdcSegmentArrowStyle arrowStyle)
 DtSdcLineSegment ()
 DtSdcLineSegment (const DtSdcLineSegment &orig)
DtSdcLineSegment operator= (const DtSdcLineSegment &orig)
const DtSdcColorcolor () const
void setColor (const DtSdcColor &color)
unsigned pattern () const
void setPattern (unsigned pattern)
unsigned thickness () const
void setThickness (unsigned thickness)
double percentage () const
void setPercentage (double percentage)
DtSdcSegmentStyle style () const
void setStyle (DtSdcSegmentStyle style)
DtSdcSegmentArrowStyle arrowStyle () const
void setArrowStyle (DtSdcSegmentArrowStyle arrowStyle)

Protected Attributes

DtSdcColor myColor
unsigned myPattern
unsigned myThickness
double myPercentage
DtSdcSegmentStyle myStyle
DtSdcSegmentArrowStyle myArrowStyle

Detailed Description

SdcLine2DObject and SdcLine3DObject helper class.

DtSdcLineSegment is used by SdcLine2DObject and SdcLine3DObject to represent a single segment within the overall line. It defines the DtSdcSegmentStyle and DtSdcSegmentArrowStyle enumerations which are part of the public interface. The remainder of the class is for use by SdcLine2DObject and SdcLine3DObject, and is not intended to public use.

Member Enumeration Documentation

Supported Line Segment Styles.

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

Enumerator:
DtSdcSegmentStyleStraight 

Straight line.

DtSdcSegmentStyleLightning 

Lightning bolt line.

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:
DtSdcSegmentArrowStyleNoArrow 

No arrowhead on either end.

DtSdcSegmentArrowStyleArrowEnd 

Arrowhead on the segment end.

DtSdcSegmentArrowStyleArrowStart 

Arrowhead on the segment start.

DtSdcSegmentArrowStyleArrowDouble 

Arrowhead on both ends of the segment.

Constructor & Destructor Documentation

DtSdcLineSegment::DtSdcLineSegment ( double  percentage,
DtSdcColor  color,
unsigned  pattern,
unsigned  thickness,
DtSdcSegmentStyle  style,
DtSdcSegmentArrowStyle  arrowStyle 
)
DtSdcLineSegment::DtSdcLineSegment ( )
DtSdcLineSegment::DtSdcLineSegment ( const DtSdcLineSegment orig)

Member Function Documentation

DtSdcLineSegment DtSdcLineSegment::operator= ( const DtSdcLineSegment orig)
const DtSdcColor& DtSdcLineSegment::color ( ) const
void DtSdcLineSegment::setColor ( const DtSdcColor color)
unsigned DtSdcLineSegment::pattern ( ) const
void DtSdcLineSegment::setPattern ( unsigned  pattern)
unsigned DtSdcLineSegment::thickness ( ) const
void DtSdcLineSegment::setThickness ( unsigned  thickness)
double DtSdcLineSegment::percentage ( ) const
void DtSdcLineSegment::setPercentage ( double  percentage)
DtSdcSegmentStyle DtSdcLineSegment::style ( ) const
void DtSdcLineSegment::setStyle ( DtSdcSegmentStyle  style)
DtSdcSegmentArrowStyle DtSdcLineSegment::arrowStyle ( ) const
void DtSdcLineSegment::setArrowStyle ( DtSdcSegmentArrowStyle  arrowStyle)

Member Data Documentation

DtSdcColor DtSdcLineSegment::myColor
protected
unsigned DtSdcLineSegment::myPattern
protected
unsigned DtSdcLineSegment::myThickness
protected
double DtSdcLineSegment::myPercentage
protected
DtSdcSegmentStyle DtSdcLineSegment::myStyle
protected
DtSdcSegmentArrowStyle DtSdcLineSegment::myArrowStyle
protected

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

Document ID: Generated on Tue Jan 29 18:21:16 EST 2013 from SVN revision 123193
Copyright © 2005-2013 VT MÄK Inc. All Rights Reserved (www.mak.com)