RVC::AUTOLABEL Class Reference

#include <rvc/autolabl.h>

Classes
class	FILTER
	Interface class to filter vector elements to see what label goes with what element Currently used for line label conglomeration. More...
Public Types
enum	LABELORIENT { LABELORIENT_TopLtoR, LABELORIENT_TopRtoL }
enum	LINECURVE { LINECURVE_Straight, LINECURVE_Exact, LINECURVE_Spline }
enum	POSNMODE_POLYGON { POSNMODE_POLYGON_PolygonInsideIfFitElseOutsideWithLeader = 0, POSNMODE_POLYGON_PolygonInsideAlways = 1, POSNMODE_POLYGON_PolygonInsideIfFitElseNone = 2, POSNMODE_POLYGON_PolygonInsideIfFitElseOutsideNoLeader = 3 }
Public Member Functions
	AUTOLABEL ()
	~AUTOLABEL ()
ERRVALUE	GenerateConglomerateLineLabel (INT32 StartLineNum, const MISTRING &string, double height, const RVC::OBJECTNAME &StyleName, const TEXTSTYLE &TextStyle, MILIST< RVC::VECTOR::LABEL > &LabelList, FILTER &LineFilter)
ERRVALUE	GenerateLabel (ELEMTYPE ElemType, INT32 ElemNum, const MISTRING &string, double height, const RVC::OBJECTNAME &StyleName, const TEXTSTYLE &TextStyle, MILIST< RVC::VECTOR::LABEL > &LabelList, bool bOverrideAngle=false, double OverrideAngle=0.0)
ERRVALUE	GenerateLineLabel (INT32 LineNum, const MISTRING &string, double height, const RVC::OBJECTNAME &StyleName, const TEXTSTYLE &TextStyle, MILIST< RVC::VECTOR::LABEL > &LabelList, bool bOverrideAngle=false, double OverrideAngle=0.0)
ERRVALUE	GeneratePointLabel (INT32 PointNum, const MISTRING &string, double height, const RVC::OBJECTNAME &StyleName, const TEXTSTYLE &TextStyle, MILIST< RVC::VECTOR::LABEL > &LabelList, bool bOverrideAngle=false, double OverrideAngle=0.0)
ERRVALUE	GeneratePolygonLabel (INT32 PolyNum, const MISTRING &string, double height, const RVC::OBJECTNAME &StyleName, const TEXTSTYLE &TextStyle, MILIST< RVC::VECTOR::LABEL > &LabelList, bool bOverrideAngle=false, double OverrideAngle=0.0)
double	GetLabelSpace () const
LINECURVE	GetLineCurve () const
LABELORIENT	GetOrientation () const
POSNMODE_POLYGON	GetPosnModePolygon () const
ERRVALUE	Initialize (const RVC::OBJITEM &ObjItem)
bool	IsInitialized () const
bool	IsOrthogonalLabels () const
void	SetLabelSpace (double LabelSpace)
void	SetLineCurve (LINECURVE LineCurve)
void	SetMinLineLength (double MinLineLength)
void	SetOrientation (LABELORIENT Orientation)
void	SetOrthogonalLabels (bool value)
void	SetPosnModePolygon (POSNMODE_POLYGON PosnModePoly)
void	Stop ()

Member Enumeration Documentation

enum RVC::AUTOLABEL::LABELORIENT

Enumerator:

LABELORIENT_TopLtoR
LABELORIENT_TopRtoL

enum RVC::AUTOLABEL::LINECURVE

Enumerator:

LINECURVE_Straight
LINECURVE_Exact
LINECURVE_Spline

enum RVC::AUTOLABEL::POSNMODE_POLYGON

Enumerator:

POSNMODE_POLYGON_PolygonInsideIfFitElseOutsideWithLeader
POSNMODE_POLYGON_PolygonInsideAlways
POSNMODE_POLYGON_PolygonInsideIfFitElseNone
POSNMODE_POLYGON_PolygonInsideIfFitElseOutsideNoLeader

Constructor & Destructor Documentation

RVC::AUTOLABEL::AUTOLABEL ( )

Default ctor.

RVC::AUTOLABEL::~AUTOLABEL ( )

Destructor.

Member Function Documentation

ERRVALUE RVC::AUTOLABEL::GenerateConglomerateLineLabel	(	INT32	StartLineNum,
		const MISTRING &	string,
		double	height,
		const RVC::OBJECTNAME &	StyleName,
		const TEXTSTYLE &	TextStyle,
		MILIST< RVC::VECTOR::LABEL > &	LabelList,
		FILTER &	LineFilter
	)

Generate labels along a conglomerate line.

Which lines are "joined" is determined by the 'FILTER' interface class. Lines are joined by the label string and height returned from the filter being equal.

Parameters:

	StartLineNum	Initial line number to start with
	string	Label string
	height	Label height
	StyleName	Name of the text style entry to assign to the label
	TextStyle	Style information for the label
	LabelList	List of labels constructed (RETURNED)
	LineFilter	Filter for determining which lines to conglomerate

ERRVALUE RVC::AUTOLABEL::GenerateLabel	(	ELEMTYPE	ElemType,
		INT32	ElemNum,
		const MISTRING &	string,
		double	height,
		const RVC::OBJECTNAME &	StyleName,
		const TEXTSTYLE &	TextStyle,
		MILIST< RVC::VECTOR::LABEL > &	LabelList,
		bool	bOverrideAngle = `false`,
		double	OverrideAngle = `0.0`
	)

Auto-generate a label based on a vector element.

Parameters:

	ElemType	Vector element type to generate labels for
	ElemNum	Element number to generate the label for
	string	Label string
	height	Label height
	StyleName	Name of the text style entry to assign to the label
	TextStyle	Style information for the label
	LabelList	List of labels constructed (RETURNED)
	bOverrideAngle	Override computed baseline angle
	OverrideAngle	Angle to use

ERRVALUE RVC::AUTOLABEL::GenerateLineLabel	(	INT32	LineNum,
		const MISTRING &	string,
		double	height,
		const RVC::OBJECTNAME &	StyleName,
		const TEXTSTYLE &	TextStyle,
		MILIST< RVC::VECTOR::LABEL > &	LabelList,
		bool	bOverrideAngle = `false`,
		double	OverrideAngle = `0.0`
	)

Auto-generate a label based on a vector line element.

Parameters:

	LineNum	Line number to generate the label for
	string	Label string
	height	Label height
	StyleName	Name of the text style entry to assign to the label
	TextStyle	Style information for the label
	LabelList	List of labels constructed (RETURNED)
	bOverrideAngle	Override computed baseline angle
	OverrideAngle	Angle to use

ERRVALUE RVC::AUTOLABEL::GeneratePointLabel	(	INT32	PointNum,
		const MISTRING &	string,
		double	height,
		const RVC::OBJECTNAME &	StyleName,
		const TEXTSTYLE &	TextStyle,
		MILIST< RVC::VECTOR::LABEL > &	LabelList,
		bool	bOverrideAngle = `false`,
		double	OverrideAngle = `0.0`
	)

Auto-generate a label based on a vector point element.

Parameters:

	PointNum	Point number to generate the label for
	string	Label string
	height	Label height
	StyleName	Name of the text style entry to assign to the label
	TextStyle	Style information for the label
	LabelList	List of labels constructed (RETURNED)
	bOverrideAngle	Override computed baseline angle
	OverrideAngle	Angle to use

ERRVALUE RVC::AUTOLABEL::GeneratePolygonLabel	(	INT32	PolyNum,
		const MISTRING &	string,
		double	height,
		const RVC::OBJECTNAME &	StyleName,
		const TEXTSTYLE &	TextStyle,
		MILIST< RVC::VECTOR::LABEL > &	LabelList,
		bool	bOverrideAngle = `false`,
		double	OverrideAngle = `0.0`
	)

Auto-generate a label based on a vector polygon element.

Parameters:

	PolyNum	Polygon number to generate the label for
	string	Label string
	height	Label height
	StyleName	Name of the text style entry to assign to the label
	TextStyle	Style information for the label
	LabelList	List of labels constructed (RETURNED)
	bOverrideAngle	Override computed baseline angle
	OverrideAngle	Angle to use

double RVC::AUTOLABEL::GetLabelSpace ( ) const [inline]

Get the spacing between labels for large polygons and long lines.

Returns:: Label spacing in vector units

LINECURVE RVC::AUTOLABEL::GetLineCurve ( ) const [inline]

Get the label baseline curvature setting for line label generation.

Returns:: Current line label baseline curvature setting.

LABELORIENT RVC::AUTOLABEL::GetOrientation ( ) const [inline]

Get the label orientation setting for line labels.

Returns:: Line label orientation setting

POSNMODE_POLYGON RVC::AUTOLABEL::GetPosnModePolygon ( ) const [inline]

Get the current polygon label positioning setting.

Returns:: The current POSNMODE_POLYGON

ERRVALUE RVC::AUTOLABEL::Initialize ( const RVC::OBJITEM & ObjItem )

Initialize auto label polygon.

Parameters:

ObjItem

Vector object to auto-generate labels on

bool RVC::AUTOLABEL::IsInitialized ( ) const [inline]

Has the auto-generate label class instance been initialized?

bool RVC::AUTOLABEL::IsOrthogonalLabels ( ) const [inline]

Generate straight line labels orthogonal to the line?

void RVC::AUTOLABEL::SetLabelSpace ( double LabelSpace ) [inline]

Set the spacing between labels for large polygons and long lines Set to '0.0' to disable label spacing (default).

void RVC::AUTOLABEL::SetLineCurve ( LINECURVE LineCurve ) [inline]

Set to generate line label baselines from the section of the line.

void RVC::AUTOLABEL::SetMinLineLength ( double MinLineLength ) [inline]

Set the minimum line length necessary to generate a label The length is in vector units.

void RVC::AUTOLABEL::SetOrientation ( LABELORIENT Orientation ) [inline]

Set label orientation.

void RVC::AUTOLABEL::SetOrthogonalLabels ( bool value ) [inline]

Set to generate line label baselines orthogonal to the line.

void RVC::AUTOLABEL::SetPosnModePolygon ( POSNMODE_POLYGON PosnModePoly ) [inline]

Set the current polygon label positioning setting.

Returns:: The current POSNMODE_POLYGON

void RVC::AUTOLABEL::Stop ( )

Stop the auto-generate label toolkit.

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

rvc/autolabl.h

RVC::AUTOLABEL Class Reference

Classes

Public Types

Public Member Functions

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation