RVC::HYPERINDEX::SHAPE Class Reference

#include <rvc/hyperidx.h>

Inheritance diagram for RVC::HYPERINDEX::SHAPE:
Inheritance graph
[legend]

List of all members.

Public Types

enum  TYPE {
  TYPE_Deleted = -1, TYPE_Rect = 0, TYPE_Circle = 1, TYPE_Polygon = 2,
  TYPE_VectPointAny = 5, TYPE_VectLineAny = 6, TYPE_VectPolyAny = 7, TYPE_VectPoint = 8,
  TYPE_VectLine = 9, TYPE_VectPoly = 10, TYPE_CAD = 11, TYPE_CAD_Any = 12,
  TYPE_ShapeElem = 13, TYPE_ShapeElem_Any = 14, TYPE_TIN_Node = 15, TYPE_TIN_Node_Any = 16
}

Public Member Functions

 SHAPE ()
void Clear ()
const COLORGetColor () const
INT32 GetElemNum () const
const DRECT3DGetExtents () const
INT32 GetNumLinks () const
TYPE GetType () const
bool HasLinks () const
bool HasPoints () const
bool IsAnyElem () const
void SetColor (const COLOR &color)
void SetElemNum (INT32 ElemNum)
void SetExtents (const DRECT3D &extents)
void SetType (TYPE type)

Static Public Member Functions

static bool IsAnyElem (TYPE ShapeType)

Member Enumeration Documentation

Enumerator:
TYPE_Deleted 

Shape has been deleted.

TYPE_Rect 

2 points, min and max

TYPE_Circle 

Center (X,Y) followed by radius in meters (rx,ry).

TYPE_Polygon 

N points.

TYPE_VectPointAny 

Any (closest) vector point.

TYPE_VectLineAny 

Any (closest) vector line.

TYPE_VectPolyAny 

Any (closest) vector polygon.

TYPE_VectPoint 

Vector point.

TYPE_VectLine 

Vector line.

TYPE_VectPoly 

Vector polygon.

TYPE_CAD 

CAD.

TYPE_CAD_Any 

Any (closest) CAD element.

TYPE_ShapeElem 

Shape object element.

TYPE_ShapeElem_Any 

Any (closest) shape object element.

TYPE_TIN_Node 

TIN node.

TYPE_TIN_Node_Any 

Any (closest) TIN node.


Constructor & Destructor Documentation

RVC::HYPERINDEX::SHAPE::SHAPE (  ) 

Default constructor.


Member Function Documentation

void RVC::HYPERINDEX::SHAPE::Clear (  ) 

Reimplemented in GRE::HYPERSHAPE.

const COLOR& RVC::HYPERINDEX::SHAPE::GetColor (  )  const [inline]

Get color of the shape, if applicable.

Returns:
Shape color
INT32 RVC::HYPERINDEX::SHAPE::GetElemNum (  )  const [inline]

Element number for geometric links.

Returns:
Element number that the shape is attached to
const DRECT3D& RVC::HYPERINDEX::SHAPE::GetExtents (  )  const [inline]

Get extents of the shape, if applicable.

Returns:
Shape extents
INT32 RVC::HYPERINDEX::SHAPE::GetNumLinks (  )  const [inline]

Get number of links attached to this shape.

Returns:
Number of shape links
TYPE RVC::HYPERINDEX::SHAPE::GetType (  )  const [inline]

Get the type of the shape.

Returns:
RVC::HYPERINDEX::SHAPE::TYPE
bool RVC::HYPERINDEX::SHAPE::HasLinks (  )  const [inline]

Determine if the shape has links.

Returns:
'True' if the shape has links, false if not
bool RVC::HYPERINDEX::SHAPE::HasPoints (  )  const [inline]

Determine if the shape has points.

Returns:
'True' if the shape has points, false if not
bool RVC::HYPERINDEX::SHAPE::IsAnyElem (  )  const [inline]

Check if shape type matches any element.

Returns:
'True' if the shape type matches any element, false if not
static bool RVC::HYPERINDEX::SHAPE::IsAnyElem ( TYPE  ShapeType  )  [static]

Check if shape type matches any element.

Returns:
'True' if the shape type matches any element, false if not
void RVC::HYPERINDEX::SHAPE::SetColor ( const COLOR color  )  [inline]

Set color of the shape, if applicable.

void RVC::HYPERINDEX::SHAPE::SetElemNum ( INT32  ElemNum  )  [inline]

Set element number for geometric links.

void RVC::HYPERINDEX::SHAPE::SetExtents ( const DRECT3D extents  )  [inline]

Set extents of the shape, if applicable.

void RVC::HYPERINDEX::SHAPE::SetType ( TYPE  type  )  [inline]

Set the type of the shape.


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

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