RVC::GEOMETRIC::LABEL Class Reference

#include <rvc/geometrc.h>

List of all members.

Public Types

enum  BASELINEFIT { BASELINEFIT_Straight, BASELINEFIT_Exact, BASELINEFIT_Spline }

Public Member Functions

 LABEL (const LABEL &rhs)
 LABEL ()
 ~LABEL ()
void Clear ()
const POLYLINEGetBaseline () const
BASELINEFIT GetBaselineFit () const
ERRVALUE GetExtents (DRECT3D &extents, bool IncludeLeaders=true) const
const LABELFRAMEPARMSGetFrameParms () const
INT32 GetNumLeaderLines () const
const TEXTSTYLEGetStyle () const
const MISTRINGGetText () const
POLYLINELIST::CONST_ITERATOR LeaderLineBegin () const
POLYLINELIST::CONST_ITERATOR LeaderLineEnd () const
LABELoperator= (const LABEL &rhs)

Member Enumeration Documentation

Enumerator:
BASELINEFIT_Straight 
BASELINEFIT_Exact 
BASELINEFIT_Spline 

Constructor & Destructor Documentation

RVC::GEOMETRIC::LABEL::LABEL (  ) 

Default constructor.

RVC::GEOMETRIC::LABEL::LABEL ( const LABEL rhs  ) 

Copy constructor.

RVC::GEOMETRIC::LABEL::~LABEL (  ) 

Destructor.


Member Function Documentation

void RVC::GEOMETRIC::LABEL::Clear (  ) 
const POLYLINE& RVC::GEOMETRIC::LABEL::GetBaseline (  )  const [inline]

Get label baseline points.

Returns:
Label baseline points
BASELINEFIT RVC::GEOMETRIC::LABEL::GetBaselineFit (  )  const [inline]

Get label baseline fit.

Returns:
Label baseline fit
ERRVALUE RVC::GEOMETRIC::LABEL::GetExtents ( DRECT3D extents,
bool  IncludeLeaders = true 
) const

Compute the extents of this label If the height specified in the TEXTSTYLE member is not in SCREENUNIT_Object units, then this method will return invalid extents for the label.

const LABELFRAMEPARMS& RVC::GEOMETRIC::LABEL::GetFrameParms (  )  const [inline]

Get the label frame parameters.

Returns:
The label frame parameters
INT32 RVC::GEOMETRIC::LABEL::GetNumLeaderLines (  )  const [inline]

Get number of leader lines.

const TEXTSTYLE& RVC::GEOMETRIC::LABEL::GetStyle (  )  const [inline]

Get the label style.

Returns:
The label style
const MISTRING& RVC::GEOMETRIC::LABEL::GetText (  )  const [inline]

Get the label text string.

Returns:
Label string
POLYLINELIST::CONST_ITERATOR RVC::GEOMETRIC::LABEL::LeaderLineBegin (  )  const [inline]

Get (const) iterator at beginning of leader list.

POLYLINELIST::CONST_ITERATOR RVC::GEOMETRIC::LABEL::LeaderLineEnd (  )  const [inline]

Get (const) iterator at end of leader list.

LABEL& RVC::GEOMETRIC::LABEL::operator= ( const LABEL rhs  ) 

Assignment.


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

Generated on Sun Oct 7 21:37:21 2012 for TNTsdk 2012 by  doxygen 1.6.1