RVC::VECTOR::LABEL Class Reference

Vector label class. More...

#include <rvc/vector.h>

List of all members.

Classes
class	LEADERLINE
Public Types
typedef MILIST< LEADERLINE > ::CONST_ITERATOR	CONST_LEADERLINEITERATOR
typedef MILIST< LEADERLINE > ::ITERATOR	LEADERLINEITERATOR
Public Member Functions
	LABEL (const LABEL &rhs)
	LABEL ()
	~LABEL ()
void	AddLeaderLine (const LEADERLINE &LeaderLine)
void	Clear ()
void	ClearLeaderLines ()
void	DeleteLeaderLine (MILIST< LEADERLINE >::ITERATOR it)
const POLYLINE &	GetBaselinePoints () const
ERRVALUE	GetExtents (DRECT3D &extents, const TEXTSTYLE &TextStyle) const
ERRVALUE	GetExtents (DRECT3D &extents, RVC::STYLE *StyleObj=0) const
double	GetHeight () const
INT32	GetNumLeaderLines () const
const MISTRING &	GetString () const
INT32	GetStyleIndex () const
const RVC::OBJECTNAME &	GetStyleName () const
bool	IsBaselineFit () const
bool	IsBaselineSplineFit () const
bool	IsClipUnderSet () const
bool	IsEquivalentTo (const LABEL &rhs, double threshold) const
bool	IsValid () const
MILIST< LEADERLINE >::ITERATOR	LeaderLineBegin ()
MILIST< LEADERLINE > ::CONST_ITERATOR	LeaderLineBegin () const
MILIST< LEADERLINE >::ITERATOR	LeaderLineEnd ()
MILIST< LEADERLINE > ::CONST_ITERATOR	LeaderLineEnd () const
LABEL &	operator= (const LABEL &rhs)
void	SetBaselineFit (bool value)
void	SetBaselinePoints (const POLYLINE &baseline)
void	SetBaselineSplineFit (bool value)
void	SetClipUnder (bool value)
void	SetHeight (double height)
void	SetString (const MISTRING &string)
void	SetStyle (const RVC::OBJECTNAME &StyleName, INT32 StyleIndex=-1)
ERRVALUE	Translate (const TRANS2D_MAPGEN &tmg)

---

Detailed Description

Vector label class.

---

Member Typedef Documentation

typedef MILIST<LEADERLINE>::CONST_ITERATOR RVC::VECTOR::LABEL::CONST_LEADERLINEITERATOR

typedef MILIST<LEADERLINE>::ITERATOR RVC::VECTOR::LABEL::LEADERLINEITERATOR

---

Constructor & Destructor Documentation

RVC::VECTOR::LABEL::LABEL

(

)

Default constructor.

RVC::VECTOR::LABEL::LABEL

(

const LABEL &

rhs

)

Copy constructor.

RVC::VECTOR::LABEL::~LABEL

(

)

Destructor.

---

Member Function Documentation

void RVC::VECTOR::LABEL::AddLeaderLine

(

const LEADERLINE &

LeaderLine

)

Add a leader line to the label.

void RVC::VECTOR::LABEL::Clear

(

)

Clear the label of the string and base points and leader lines.

void RVC::VECTOR::LABEL::ClearLeaderLines

(

)

Clear the leader lines of the label.

void RVC::VECTOR::LABEL::DeleteLeaderLine

(

MILIST< LEADERLINE >::ITERATOR

it

)

Delete a leader line from the label.

const POLYLINE& RVC::VECTOR::LABEL::GetBaselinePoints

(

)

const

Get label baseline points.

Returns:

Label baseline points

ERRVALUE RVC::VECTOR::LABEL::GetExtents	(	DRECT3D &	extents,
		const TEXTSTYLE &	TextStyle
	)			const

Compute the extents of this label.

ERRVALUE RVC::VECTOR::LABEL::GetExtents	(	DRECT3D &	extents,
		RVC::STYLE *	StyleObj = 0
	)			const

Compute the extents of this label.

double RVC::VECTOR::LABEL::GetHeight

(

)

const

Get the label height in object units.

Returns:

Label height

INT32 RVC::VECTOR::LABEL::GetNumLeaderLines

(

)

const

const MISTRING& RVC::VECTOR::LABEL::GetString

(

)

const

Get the label string.

Returns:

Label string

INT32 RVC::VECTOR::LABEL::GetStyleIndex

(

)

const

Get the label style index.

Returns:

Label style index

const RVC::OBJECTNAME& RVC::VECTOR::LABEL::GetStyleName

(

)

const

Get the label style name.

Returns:

Label style name

bool RVC::VECTOR::LABEL::IsBaselineFit

(

)

const

Does the label follow the baseline?

Returns:

'True' if label follows baseline

bool RVC::VECTOR::LABEL::IsBaselineSplineFit

(

)

const

Does the label follow the splined baseline?

Returns:

'True' if label follows the splined baseline

bool RVC::VECTOR::LABEL::IsClipUnderSet

(

)

const

Clip vector features under the label when rendering.

Returns:

'True' if features under the label needs to be clipped

bool RVC::VECTOR::LABEL::IsEquivalentTo	(	const LABEL &	rhs,
		double	threshold
	)			const

Determine if the two label elements are equivalent This method uses "Fuzzy" vertex comparisons and the direction and order of the elements are not relevant.

Returns:

'True' if they are, 'False' if not

bool RVC::VECTOR::LABEL::IsValid

(

)

const

Is label valid.

Returns:

'True' if the label is valid

MILIST<LEADERLINE>::ITERATOR RVC::VECTOR::LABEL::LeaderLineBegin

(

)

Obtain beginning label leader line iterator.

Returns:

ITERATOR

MILIST<LEADERLINE>::CONST_ITERATOR RVC::VECTOR::LABEL::LeaderLineBegin

(

)

const

Obtain beginning label leader line const iterator.

Returns:

CONST_ITERATOR

MILIST<LEADERLINE>::ITERATOR RVC::VECTOR::LABEL::LeaderLineEnd

(

)

Obtain ending label leader line iterator.

Returns:

ITERATOR

MILIST<LEADERLINE>::CONST_ITERATOR RVC::VECTOR::LABEL::LeaderLineEnd

(

)

const

Obtain ending label leader line const iterator.

Returns:

CONST_ITERATOR

LABEL& RVC::VECTOR::LABEL::operator=

(

const LABEL &

rhs

)

Assignment.

void RVC::VECTOR::LABEL::SetBaselineFit

(

bool

value

)

Set the label to follow the baseline.

void RVC::VECTOR::LABEL::SetBaselinePoints

(

const POLYLINE &

baseline

)

Set label baseline points.

void RVC::VECTOR::LABEL::SetBaselineSplineFit

(

bool

value

)

Set the label to follow the splined baseline.

void RVC::VECTOR::LABEL::SetClipUnder

(

bool

value

)

Set the label clip under flag.

void RVC::VECTOR::LABEL::SetHeight

(

double

height

)

Set the label height in object units.

void RVC::VECTOR::LABEL::SetString

(

const MISTRING &

string

)

Set the label string.

void RVC::VECTOR::LABEL::SetStyle	(	const RVC::OBJECTNAME &	StyleName,
		INT32	StyleIndex = -1
	)

ERRVALUE RVC::VECTOR::LABEL::Translate

(

const TRANS2D_MAPGEN &

tmg

)

Translate label through a generic coordinate transformation.

---

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

• rvc/vector.h