RVC::SHAPE::ELEMENT Class Reference

Container for the geometric information pertaining to an element. More...

#include <rvc/shape.h>

List of all members.

Public Member Functions
	ELEMENT (const ELEMENT &rhs)
	ELEMENT ()
	~ELEMENT ()
void	Clear ()
void	ComputeExtents (DRECT3D &Extents) const
ERRVALUE	ConvertForward (const TRANS2D_MAPGEN &tmg)
void	ConvertForward (const TRANS2D_AFFINE &taf)
ERRVALUE	ConvertInverse (const TRANS2D_MAPGEN &tmg)
void	ConvertInverse (const TRANS2D_AFFINE &taf)
DIMENSION	GetDimension () const
ELEMTYPE	GetElemType () const
const DRECT2D *	GetExtentsIfKnown () const
void	GetLines (POLYLINELIST &PolyLineList) const
INT32	GetNumComponents () const
const POLYLINE &	GetPoints () const
void	GetPolygons (REGION2D &region) const
DBTABLE::RECORD &	GetRecord ()
const DBTABLE::RECORD &	GetRecord () const
bool	IsValid () const
ELEMENT &	operator= (const ELEMENT &rhs)
void	SetLine (const POLYLINE &PolyLine)
void	SetLines (const POLYLINELIST &PolyLineList)
void	SetPoints (const POLYLINE &PointList)
void	SetPolygon (const POLYLINE &Polygon)
void	SetPolygons (const REGION2D &region)
void	SetRecord (DBTABLE::RECORD &Record)

---

Detailed Description

Container for the geometric information pertaining to an element.

The ELEMENT class can represent one or more of lines, points, or polygons

---

Constructor & Destructor Documentation

RVC::SHAPE::ELEMENT::ELEMENT

(

)

Default constructor.

RVC::SHAPE::ELEMENT::ELEMENT

(

const ELEMENT &

rhs

)

Copy constructor.

RVC::SHAPE::ELEMENT::~ELEMENT

(

)

Destructor.

---

Member Function Documentation

void RVC::SHAPE::ELEMENT::Clear

(

)

Clear the element back to its constructed state.

void RVC::SHAPE::ELEMENT::ComputeExtents

(

DRECT3D &

Extents

)

const

Compute the extents of this element.

ERRVALUE RVC::SHAPE::ELEMENT::ConvertForward

(

const TRANS2D_MAPGEN &

tmg

)

Convert point coordinates using generic transformation.

void RVC::SHAPE::ELEMENT::ConvertForward

(

const TRANS2D_AFFINE &

taf

)

Convert point coordinates using affine transformation.

ERRVALUE RVC::SHAPE::ELEMENT::ConvertInverse

(

const TRANS2D_MAPGEN &

tmg

)

Convert point coordinates using generic transformation.

void RVC::SHAPE::ELEMENT::ConvertInverse

(

const TRANS2D_AFFINE &

taf

)

Convert point coordinates using affine transformation.

DIMENSION RVC::SHAPE::ELEMENT::GetDimension

(

)

const [inline]

Get the DIMENSION of this element.

Returns:

DIMENSION_2D or DIMENSION_3D

ELEMTYPE RVC::SHAPE::ELEMENT::GetElemType

(

)

const [inline]

Get the ELEMTYPE of this element.

Returns:

ELEMTYPE_Point, ELEMTYPE_Line, ELEMTYPE_Polygon or ELEMTYPE_Empty if no element

const DRECT2D* RVC::SHAPE::ELEMENT::GetExtentsIfKnown

(

)

const [inline]

Get the extents of the SHAPE::ELEMENT if known.

Returns:

Pointer to extents if known, NULL if not.

void RVC::SHAPE::ELEMENT::GetLines

(

POLYLINELIST &

PolyLineList

)

const

Get the lines if GetElemType() returns ELEMTYPE_Line If GetElemType() returns something different than ELEMTYPE_Line, 'PolyLineList' will be empty.

Parameters:

PolyLineList

List of lines RETURNED

INT32 RVC::SHAPE::ELEMENT::GetNumComponents

(

)

const

Get the number of 'components' for this element.

Returns:

The number of components for this element. Eg: if 5 lines compose this element, then the return value will be 5.

const POLYLINE& RVC::SHAPE::ELEMENT::GetPoints

(

)

const [inline]

Get the points if GetElemType() returns ELEMTYPE_Point.

Returns:

Array of point elements as a POLYLINE

void RVC::SHAPE::ELEMENT::GetPolygons

(

REGION2D &

region

)

const

Get the polygons if GetElemType() returns ELEMTYPE_Polygon If GetElemType() returns something different than ELEMTYPE_Polygon, 'region' will be empty.

Parameters:

region

List of polygons (with possible islands) RETURNED

DBTABLE::RECORD& RVC::SHAPE::ELEMENT::GetRecord

(

)

[inline]

Get the record associated with this element.

By the definition of the shape object, there will exist a database record for each element.

Returns:

Reference to a DBTABLE::RECORD.

const DBTABLE::RECORD& RVC::SHAPE::ELEMENT::GetRecord

(

)

const [inline]

Get the record associated with this element.

By the definition of the shape object, there will exist a database record for each element.

Returns:

Constant reference to a DBTABLE::RECORD.

bool RVC::SHAPE::ELEMENT::IsValid

(

)

const

Is the element a valid element.

Returns:

'true' for a valid element, 'false' if not

ELEMENT& RVC::SHAPE::ELEMENT::operator=

(

const ELEMENT &

rhs

)

Assignment.

void RVC::SHAPE::ELEMENT::SetLine

(

const POLYLINE &

PolyLine

)

Set a line.

void RVC::SHAPE::ELEMENT::SetLines

(

const POLYLINELIST &

PolyLineList

)

Set the lines.

void RVC::SHAPE::ELEMENT::SetPoints

(

const POLYLINE &

PointList

)

Set the points.

void RVC::SHAPE::ELEMENT::SetPolygon

(

const POLYLINE &

Polygon

)

Set a polygon.

void RVC::SHAPE::ELEMENT::SetPolygons

(

const REGION2D &

region

)

Set the polygons.

void RVC::SHAPE::ELEMENT::SetRecord

(

DBTABLE::RECORD &

Record

)

[inline]

Set the record associated with this element.

By the definition of the shape object, there will exist a database record for each element.

---

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

• rvc/shape.h