GRE::TEXTURE Class Reference

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

#include <gre/3dtextur.h>

Inheritance diagram for GRE::TEXTURE:
Inheritance graph
[legend]

List of all members.

Classes

class  IMPL_FACTORY

Public Types

enum  MODEL { MODEL_Default = 0, MODEL_SimpleRaster = 0, MODEL_Formula = 1, MODEL_Count = 2 }

Public Member Functions

virtual ~TEXTURE ()
void Begin (const SCENE3D &scene)
ERRVALUE Build (const GRE::LAYER *layer)
UINT8 CheckDepth (const UINT8 depth)
void ClearBoundary ()
void ClearPedestal ()
TEXTURECreateInstance ()
ERRVALUE DrawBoundaryWall (CONTROLLER &controller, DRAWINGCONTEXT3D &drawing, const GRE::BOUNDPARM &boundparm)
void End ()
void Free ()
const REGION2DGetBoundary ()
bool GetColor (const DPOINT2D &point, const UINT8 depth, COLOR &color)
bool GetColor (const INT32 line, const INT32 column, const UINT8 depth, COLOR &color)
const SPATREF::COORDREFSYS GetCoordRefSys ()
const char * GetDescription () const
const DRECT2DGetExtents ()
const MODEL GetModel () const
const char * GetName () const
const TRANS2D_MAPGENGetTransformationInternalToModel ()
bool IsBoundaryChanged () const
bool IsBuilt ()
ERRVALUE SetBoundaryWall (const SCENE3D &scene, TERRAIN *terrain)
void SetCoordRefSys (const SPATREF::COORDREFSYS &CoordRefSys)

Static Public Member Functions

static const char * GetDescription (MODEL model)
static TEXTUREGetInstance (MODEL model)
static const char * GetName (MODEL model)
static void Register (IMPL_FACTORY *factory, const MODEL model)

Protected Member Functions

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

Private Member Functions

void SetPedestalCoordRefSys (const SPATREF::COORDREFSYS &CoordRefSys)
virtual void v_Begin (const SCENE3D &scene)=0
virtual ERRVALUE v_Build (const GRE::LAYER *layer)=0
virtual UINT8 v_CheckDepth (const UINT8 depth)=0
virtual void v_CreateBoundary (REGION2D &boundary)=0
virtual TEXTUREv_CreateInstance ()=0
virtual void v_End ()=0
virtual void v_Free ()=0
virtual bool v_GetColor (const DPOINT2D &point, const UINT8 depth, COLOR &color)=0
virtual bool v_GetColor (const INT32 line, const INT32 column, const UINT8 depth, COLOR &color)=0
virtual const SPATREF::COORDREFSYS v_GetCoordRefSys ()=0
virtual const DRECT2Dv_GetExtents ()=0
virtual const TRANS2D_MAPGENv_GetTransformationInternalToModel ()=0
virtual void v_SetCoordRefSys (const SPATREF::COORDREFSYS &CoordRefSys)=0

Detailed Description

Base class for 3D texture models.


Member Enumeration Documentation

Enumerator:
MODEL_Default 
MODEL_SimpleRaster 
MODEL_Formula 
MODEL_Count 

Constructor & Destructor Documentation

virtual GRE::TEXTURE::~TEXTURE (  )  [virtual]
GRE::TEXTURE::TEXTURE ( const char *  name,
const char *  desc,
const MODEL  model 
) [protected]

Member Function Documentation

void GRE::TEXTURE::Begin ( const SCENE3D scene  )  [inline]

Begining of texture retriving for given scene.

ERRVALUE GRE::TEXTURE::Build ( const GRE::LAYER layer  )  [inline]

Build internal structures for texture construction for given drape layer.

Returns:
0 if built or < 0 if an error
UINT8 GRE::TEXTURE::CheckDepth ( const UINT8  depth  )  [inline]

Check if for given depth pyramid tier exist.

Returns:
the nearest lower depth
void GRE::TEXTURE::ClearBoundary (  )  [inline]
void GRE::TEXTURE::ClearPedestal (  )  [inline]
TEXTURE* GRE::TEXTURE::CreateInstance (  )  [inline]

Create new instance of texture model.

Returns:
instance of texture model
ERRVALUE GRE::TEXTURE::DrawBoundaryWall ( CONTROLLER controller,
DRAWINGCONTEXT3D drawing,
const GRE::BOUNDPARM boundparm 
)

Draw given pedestal.

Returns:
>= 0 if set is done
void GRE::TEXTURE::End (  )  [inline]

Rnding of texture retriving.

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

Free internal structures for texture construction.

const REGION2D& GRE::TEXTURE::GetBoundary (  )  [inline]
bool GRE::TEXTURE::GetColor ( const DPOINT2D point,
const UINT8  depth,
COLOR color 
) [inline]

Get color for given point in specifyed map projection and depth.

Returns:
true if color was retrived
bool GRE::TEXTURE::GetColor ( const INT32  line,
const INT32  column,
const UINT8  depth,
COLOR color 
) [inline]

Get color for given cell and depth.

Returns:
true if color was retrived
const SPATREF::COORDREFSYS GRE::TEXTURE::GetCoordRefSys (  )  [inline]

Get map projection be used for output data.

const char* GRE::TEXTURE::GetDescription (  )  const

GetDescription returns a description of the model.

Returns:
char pointer of the description
static const char* GRE::TEXTURE::GetDescription ( MODEL  model  )  [static]

GetDescription returns a description of the given model enum.

Returns:
char pointer of the description
const DRECT2D& GRE::TEXTURE::GetExtents (  )  [inline]

Get extents in map projection coordinates.

Returns:
extents
static TEXTURE* GRE::TEXTURE::GetInstance ( MODEL  model  )  [static]

GetInstance returns a new instance of the given model enum.

Returns:
pointer to new model
const MODEL GRE::TEXTURE::GetModel (  )  const [inline]

GetModel returns an enum of the model.

Returns:
enum of the model
const char* GRE::TEXTURE::GetName (  )  const

GetName returns a name of the model.

Returns:
char pointer of the name
static const char* GRE::TEXTURE::GetName ( MODEL  model  )  [static]

GetName returns a name of the given model enum.

Returns:
char pointer of the name
const TRANS2D_MAPGEN& GRE::TEXTURE::GetTransformationInternalToModel (  )  [inline]

Get transformation from object coordinates to specifyed map projection.

Returns:
TRANS2D_MAPGEN&
bool GRE::TEXTURE::IsBoundaryChanged (  )  const [inline]
bool GRE::TEXTURE::IsBuilt (  ) 

Is internal structures for texture construction built?

Returns:
true if built or false if an error
static void GRE::TEXTURE::Register ( IMPL_FACTORY factory,
const MODEL  model 
) [static]
ERRVALUE GRE::TEXTURE::SetBoundaryWall ( const SCENE3D scene,
TERRAIN terrain 
)

Set boundary wall pedestal for terrain and texture.

Returns:
>= 0 if set is done
void GRE::TEXTURE::SetBuilt ( const bool  built  )  [protected]

Set built state?

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

Set model map projection be used for output data.

void GRE::TEXTURE::SetPedestalCoordRefSys ( const SPATREF::COORDREFSYS CoordRefSys  )  [private]
virtual void GRE::TEXTURE::v_Begin ( const SCENE3D scene  )  [private, pure virtual]
virtual ERRVALUE GRE::TEXTURE::v_Build ( const GRE::LAYER layer  )  [private, pure virtual]
virtual UINT8 GRE::TEXTURE::v_CheckDepth ( const UINT8  depth  )  [private, pure virtual]
virtual void GRE::TEXTURE::v_CreateBoundary ( REGION2D boundary  )  [private, pure virtual]
virtual TEXTURE* GRE::TEXTURE::v_CreateInstance (  )  [private, pure virtual]
virtual void GRE::TEXTURE::v_End (  )  [private, pure virtual]
virtual void GRE::TEXTURE::v_Free (  )  [private, pure virtual]
virtual bool GRE::TEXTURE::v_GetColor ( const DPOINT2D point,
const UINT8  depth,
COLOR color 
) [private, pure virtual]
virtual bool GRE::TEXTURE::v_GetColor ( const INT32  line,
const INT32  column,
const UINT8  depth,
COLOR color 
) [private, pure virtual]
virtual const SPATREF::COORDREFSYS GRE::TEXTURE::v_GetCoordRefSys (  )  [private, pure virtual]
virtual const DRECT2D& GRE::TEXTURE::v_GetExtents (  )  [private, pure virtual]
virtual const TRANS2D_MAPGEN& GRE::TEXTURE::v_GetTransformationInternalToModel (  )  [private, pure virtual]
virtual void GRE::TEXTURE::v_SetCoordRefSys ( const SPATREF::COORDREFSYS CoordRefSys  )  [private, pure virtual]

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

Generated on Sun Oct 7 21:34:51 2012 for TNTsdk 2012 by  doxygen 1.6.1