Main Page | Modules | Directories | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages | Search for 

GRE::TERRAIN Class Reference

Base class for 3D terrain models. More...

#include <gre/3dterra.h>

Inheritance diagram for GRE::TERRAIN:

Inheritance graph
[legend]
List of all members.

Public Types

enum  MODEL {
  MODEL_Default = 0, MODEL_TIN = 0, MODEL_SparseTriangulation = 1, MODEL_DenseTriangulation = 2,
  MODEL_RayCasting = 3, MODEL_DenseRayCasting = 4, MODEL_VariableTriangulation = 5, MODEL_PiecewiseTIN = 6,
  MODEL_FlatTriangulation = 7, MODEL_Count = 8
}

Public Member Functions

ERRVALUE Build (const GRE_LAYER *layer)
void ClearBoundary ()
ERRVALUE ComputeProfile (const POLYLINE &polyline, POLYLINE &profile, SIMPLE_ARRAY< INT32 > &index)
TERRAIN * CreateInstance ()
ERRVALUE DrawScene (CONTROLLER &controller, DRAWINGCONTEXT3D &drawing, TEXTURE *texture, TEXTUREFILTER *texturefilter)
void Free ()
const ABSTRACT_SURFACE * GetAbstractSurface ()
float GetAngleToNorth (const float x, const float y) const
const REGION2D & GetBoundary ()
const SPATREF::COORDREFSYS GetCoordRefSys () const
ERRVALUE GetDefaultScene (SCENE3D &scene)
const char * GetDescription () const
float GetElevation (const float x, const float y)
const DRECT3D & GetExtents ()
const MODEL GetModel () const
const char * GetName () const
bool HasNull () const
bool IsBoundaryChanged () const
bool IsBuilt () const
bool IsNull (const float x, const float y) const
bool IsObjectTypeSupported (const RVC::OBJTYPE objtype) const
bool IsTerrainDynamic () const
void SetCoordRefSys (const SPATREF::COORDREFSYS &CoordRefSys)
ERRVALUE SetScene (const SCENE3D &scene, const SIMPLE_ARRAY< TEXTURE * > &textures)
virtual ~TERRAIN ()

Static Public Member Functions

const char * GetDescription (const MODEL model)
TERRAIN * GetInstance (const MODEL model)
const char * GetName (const MODEL model)

Protected Member Functions

void SetBuilt (const bool built)
 TERRAIN (const char *name, const char *desc, const MODEL model)

Static Protected Member Functions

void Register (TERRAIN *terrain)

Private Member Functions

virtual ERRVALUE v_Build (const GRE_LAYER *layer)=0
virtual ERRVALUE v_ComputeProfile (const POLYLINE &polyline, POLYLINE &profile, SIMPLE_ARRAY< INT32 > &index)=0
virtual void v_CreateBoundary (REGION2D &boundary)=0
virtual TERRAIN * v_CreateInstance ()=0
virtual ERRVALUE v_DrawScene (CONTROLLER &controller, DRAWINGCONTEXT3D &drawing, TEXTURE *texture, TEXTUREFILTER *texturefilter)=0
virtual void v_Free ()=0
virtual const ABSTRACT_SURFACE * v_GetAbstractSurface ()=0
virtual float v_GetAngleToNorth (const float x, const float y) const =0
virtual const SPATREF::COORDREFSYS v_GetCoordRefSys () const =0
virtual ERRVALUE v_GetDefaultScene (SCENE3D &scene) const =0
virtual float v_GetElevation (const float x, const float y) const =0
virtual const DRECT3D & v_GetExtents ()=0
virtual bool v_HasNull () const =0
virtual bool v_IsNull (const float x, const float y) const =0
virtual bool v_IsObjectTypeSupported (const RVC::OBJTYPE objtype) const =0
virtual void v_SetCoordRefSys (const SPATREF::COORDREFSYS &CoordRefSys)=0
virtual ERRVALUE v_SetScene (const SCENE3D &scene, const SIMPLE_ARRAY< TEXTURE * > &textures)=0

Detailed Description

Base class for 3D terrain models.

Definition at line 96 of file 3dterra.h.

Member Enumeration Documentation

enum GRE::TERRAIN::MODEL
 

Enumeration values:
MODEL_Default 
MODEL_TIN 
MODEL_SparseTriangulation 
MODEL_DenseTriangulation 
MODEL_RayCasting 
MODEL_DenseRayCasting 
MODEL_VariableTriangulation 
MODEL_PiecewiseTIN 
MODEL_FlatTriangulation 
MODEL_Count 

Definition at line 99 of file 3dterra.h.

Constructor & Destructor Documentation

virtual GRE::TERRAIN::~TERRAIN (   )  [virtual]
 

GRE::TERRAIN::TERRAIN (  const char *  name,
const char *  desc,
const MODEL  model
)  [protected]
 

Parameters:
name  Constructor

Member Function Documentation

ERRVALUE GRE::TERRAIN::Build (  const GRE_LAYER *  layer  )  [inline]
 

Build internal structures for terrain construction for given surface layer.

Returns:
0 if built or < 0 if an error
Parameters:
layer  Constructor

Definition at line 163 of file 3dterra.h.

void GRE::TERRAIN::ClearBoundary (   )  [inline]
 

Definition at line 272 of file 3dterra.h.

ERRVALUE GRE::TERRAIN::ComputeProfile (  const POLYLINE &  polyline,
POLYLINE &  profile,
SIMPLE_ARRAY< INT32 > &  index
)  [inline]
 

Get profile on elevation along polyline.

Returns:
0 or an error

Definition at line 217 of file 3dterra.h.

TERRAIN* GRE::TERRAIN::CreateInstance (   )  [inline]
 

Create new instance of terrain model.

Returns:
instance of texture model

Definition at line 158 of file 3dterra.h.

ERRVALUE GRE::TERRAIN::DrawScene (  CONTROLLER &  controller,
DRAWINGCONTEXT3D &  drawing,
TEXTURE *  texture,
TEXTUREFILTER *  texturefilter
)  [inline]
 

Draw given texture with given texture filter on this terrain with preset scene.

Returns:
>= 0 if set is done

Definition at line 201 of file 3dterra.h.

void GRE::TERRAIN::Free (   )  [inline]
 

Free internal structures for terrain construction.

Definition at line 181 of file 3dterra.h.

const ABSTRACT_SURFACE* GRE::TERRAIN::GetAbstractSurface (   )  [inline]
 

Get abstract surface pointer.

Returns:
pointer ot abstruct surface maybe 0

Definition at line 243 of file 3dterra.h.

float GRE::TERRAIN::GetAngleToNorth (  const float  x,
const float  y
)  const [inline]
 

Get angle to elevation at map projection coordinates (x, y).

Returns:
angle to north in radians

Definition at line 235 of file 3dterra.h.

const REGION2D& GRE::TERRAIN::GetBoundary (   )  [inline]
 

Definition at line 278 of file 3dterra.h.

const SPATREF::COORDREFSYS GRE::TERRAIN::GetCoordRefSys (   )  const [inline]
 

Get map projection be used for output data.

Returns:
MAPPROJPARM

Definition at line 269 of file 3dterra.h.

ERRVALUE GRE::TERRAIN::GetDefaultScene (  SCENE3D &  scene  )  [inline]
 

GetDefaultScene initializes scene with default parameters for this model.

Returns:
>= 0 if initialization is done

Definition at line 186 of file 3dterra.h.

const char* GRE::TERRAIN::GetDescription (   )  const [inline]
 

GetDescription returns a description of the model.

Returns:
char pointer of the description

Definition at line 146 of file 3dterra.h.

const char* GRE::TERRAIN::GetDescription (  const MODEL  model  )  [static]
 

static GetDescription returns a description of the given model enum

Returns:
char pointer of the description

float GRE::TERRAIN::GetElevation (  const float  x,
const float  y
)  [inline]
 

Get elevation at map projection coordinates (x, y).

Returns:
elevation in meters

Definition at line 227 of file 3dterra.h.

const DRECT3D& GRE::TERRAIN::GetExtents (   )  [inline]
 

Get extents in map projection coordinates.

Returns:
extents

Definition at line 211 of file 3dterra.h.

TERRAIN* GRE::TERRAIN::GetInstance (  const MODEL  model  )  [static]
 

static GetInstance returns a new instance of the given model enum

Returns:
pointer to new model

const MODEL GRE::TERRAIN::GetModel (   )  const [inline]
 

GetModel returns an enum of the model.

Returns:
enum of the model

Definition at line 152 of file 3dterra.h.

const char* GRE::TERRAIN::GetName (   )  const [inline]
 

GetName returns a name of the model.

Returns:
char pointer of the name

Definition at line 140 of file 3dterra.h.

const char* GRE::TERRAIN::GetName (  const MODEL  model  )  [static]
 

static GetName returns a name of the given model enum

Returns:
char pointer of the name
Parameters:
model  Destructor Constructor Destructor

bool GRE::TERRAIN::HasNull (   )  const [inline]
 

Has null areas.

Returns:
true if has null areas

Definition at line 249 of file 3dterra.h.

bool GRE::TERRAIN::IsBoundaryChanged (   )  const [inline]
 

Definition at line 284 of file 3dterra.h.

bool GRE::TERRAIN::IsBuilt (   )  const [inline]
 

Is internal structures for terrain construction built?

Returns:
true if built or false if an error

Definition at line 170 of file 3dterra.h.

bool GRE::TERRAIN::IsNull (  const float  x,
const float  y
)  const [inline]
 

Is value at map projection coordinates (x, y) null.

Returns:
true if value is null

Definition at line 256 of file 3dterra.h.

bool GRE::TERRAIN::IsObjectTypeSupported (  const RVC::OBJTYPE  objtype  )  const [inline]
 

What rvc object type are supported in surface layer for this model (RVC::TIN or RVC::RASTER).

Returns:
true if built or false if an error

Definition at line 176 of file 3dterra.h.

bool GRE::TERRAIN::IsTerrainDynamic (   )  const [inline]
 

Definition at line 289 of file 3dterra.h.

void GRE::TERRAIN::Register (  TERRAIN *  terrain  )  [static, protected]
 

Register this model (Called by constructor).

void GRE::TERRAIN::SetBuilt (  const bool  built  )  [inline, protected]
 

Set built state.

Definition at line 308 of file 3dterra.h.

void GRE::TERRAIN::SetCoordRefSys (  const SPATREF::COORDREFSYS &  CoordRefSys  )  [inline]
 

Set model map projection be used for output data.

Definition at line 262 of file 3dterra.h.

ERRVALUE GRE::TERRAIN::SetScene (  const SCENE3D &  scene,
const SIMPLE_ARRAY< TEXTURE * > &  textures
)  [inline]
 

Set scene for the model and array of textures to be drawn on it.

Returns:
>= 0 if set is done

Definition at line 193 of file 3dterra.h.

virtual ERRVALUE GRE::TERRAIN::v_Build (  const GRE_LAYER *  layer  )  [private, pure virtual]
 

virtual ERRVALUE GRE::TERRAIN::v_ComputeProfile (  const POLYLINE &  polyline,
POLYLINE &  profile,
SIMPLE_ARRAY< INT32 > &  index
)  [private, pure virtual]
 

virtual void GRE::TERRAIN::v_CreateBoundary (  REGION2D &  boundary  )  [private, pure virtual]
 

virtual TERRAIN* GRE::TERRAIN::v_CreateInstance (   )  [private, pure virtual]
 

< GENERATING_DOXYGEN_OUTPUT

virtual ERRVALUE GRE::TERRAIN::v_DrawScene (  CONTROLLER &  controller,
DRAWINGCONTEXT3D &  drawing,
TEXTURE *  texture,
TEXTUREFILTER *  texturefilter
)  [private, pure virtual]
 

virtual void GRE::TERRAIN::v_Free (   )  [private, pure virtual]
 

virtual const ABSTRACT_SURFACE* GRE::TERRAIN::v_GetAbstractSurface (   )  [private, pure virtual]
 

virtual float GRE::TERRAIN::v_GetAngleToNorth (  const float  x,
const float  y
)  const [private, pure virtual]
 

virtual const SPATREF::COORDREFSYS GRE::TERRAIN::v_GetCoordRefSys (   )  const [private, pure virtual]
 

virtual ERRVALUE GRE::TERRAIN::v_GetDefaultScene (  SCENE3D &  scene  )  const [private, pure virtual]
 

virtual float GRE::TERRAIN::v_GetElevation (  const float  x,
const float  y
)  const [private, pure virtual]
 

virtual const DRECT3D& GRE::TERRAIN::v_GetExtents (   )  [private, pure virtual]
 

virtual bool GRE::TERRAIN::v_HasNull (   )  const [private, pure virtual]
 

virtual bool GRE::TERRAIN::v_IsNull (  const float  x,
const float  y
)  const [private, pure virtual]
 

virtual bool GRE::TERRAIN::v_IsObjectTypeSupported (  const RVC::OBJTYPE  objtype  )  const [private, pure virtual]
 

virtual void GRE::TERRAIN::v_SetCoordRefSys (  const SPATREF::COORDREFSYS &  CoordRefSys  )  [private, pure virtual]
 

virtual ERRVALUE GRE::TERRAIN::v_SetScene (  const SCENE3D &  scene,
const SIMPLE_ARRAY< TEXTURE * > &  textures
)  [private, pure virtual]
 

The documentation for this class was generated from the following file:
Generated on Tue Dec 14 13:20:33 2004 for TNTsdk by  doxygen 1.3.8-20040913