gre/3dtextur.h

Go to the documentation of this file.

/*** 
 * \file gre/3dtextur.h
 * \brief Base class for texturing algorithm
 *
 * \if NODOC
 * $Id: 3dtextur.h_v 1.12 2003/10/02 16:18:21 linux32build!build Exp $
 *
 * $Log: 3dtextur.h_v $
 * Revision 1.12  2003/10/02 16:18:21  linux32build!build
 * Doxygen
 *
 * Revision 1.11  2003/09/15 13:48:59  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.10  2003/08/15 17:03:05  vdronov
 * nc
 *
 * Revision 1.9  2003/08/15 16:55:14  vdronov
 * add docs
 *
 * Revision 1.8  2003/07/30 14:27:36  mju
 * Check inclusion guards.
 * Ignore private section.
 * Make pure virtual methods private.
 *
 * Revision 1.2  2003/03/24 20:39:15  vdronov
 * added forward GRE_LAYER
 *
 * Revision 1.1  2003/03/10 15:08:04  vdronov
 * Initial revision
 * \endif
**/ 

#ifndef  INC_GRE_3DTEXTUR_H
#define  INC_GRE_3DTEXTUR_H

#ifndef  INC_GRE_3DUTILS
#include <gre/3dutils.h>
#endif

#ifndef  INC_GRE_3DSCENE
#include <gre/3dscene.h>
#endif

#ifndef  INC_MI32_MGD2
#include <mi32/mgd2.h>
#endif

#ifndef GENERATING_DOXYGEN_OUTPUT
class GRE_LAYER;
#endif // GENERATING_DOXYGEN_OUTPUT

namespace GRE {

#ifndef GENERATING_DOXYGEN_OUTPUT
class TEXTUREFILTER;
#endif // GENERATING_DOXYGEN_OUTPUT

//! Base class for 3D texture models.
class TEXTURE {
   public:

      enum MODEL {
         MODEL_Default = 0,
         MODEL_SimpleRaster = 0,
         MODEL_Count = 1
         };

      //! GetName returns a name of the given model enum
      //!
      //! @return char pointer of the name
      static const char* GetName (
         MODEL model
         );

      //! GetDescription returns a description of the given model enum
      //!
      //! @return char pointer of the description
      static const char* GetDescription (
         MODEL model
         );

      //! GetInstance returns a new instance of the given model enum
      //!
      //! @return pointer to new model
      static TEXTURE* GetInstance (
         MODEL model
         );

      virtual ~TEXTURE (                        //! Destructor
         );

      //! GetName returns a name of the model
      //!
      //! @return char pointer of the name
      const char* GetName (
         ) const;

      //! GetDescription returns a description of the model
      //!
      //! @return char pointer of the description
      const char* GetDescription (
         ) const;

      //! GetModel returns an enum of the model
      //!
      //! @return enum of the model
      const MODEL GetModel (
         ) const {return m_Model; };

      //! Create new instance of texture model
      //!
      //! @return instance of texture model
      TEXTURE* CreateInstance (
         ) { return v_CreateInstance(); };

      //!   Build internal structures for texture construction for given drape layer 
      //!
      //! @return 0 if built or < 0 if an error
      ERRVALUE Build (
         const GRE_LAYER* layer
         ) { return v_Build(layer); };

      //!   Free internal structures for texture construction 
      void Free (
         ) { v_Free(); return; };

      //!   Is internal structures for texture construction built? 
      //!
      //! @return true if built or false if an error
      bool IsBuilt (
         );

      //! Begining of texture retriving for given scene
      void Begin (
         const SCENE3D& scene
         ) { v_Begin(scene); return; };

      //! Rnding of texture retriving
      void End (
         ) { v_End(); return; };

      //! Get extents in map projection coordinates
      //!
      //! @return extents
      const DRECT2D& GetExtents (
         ) { return v_GetExtents(); };

      //! Set model map projection be used for output data
      void SetMapProjParm (
         const MAPPROJPARM& mapprojparm
         ) { v_SetMapProjParm(mapprojparm); return; };

      //! Get map projection be used for output data 
      //!
      //! @return MAPPROJPARM
      const MAPPROJPARM GetMapProjParm (
         ) { return v_GetMapProjParm(); };

      //! Get color for given cell and depth
      //!
      //! @return true if color was retrived
      bool GetColor (
         const INT32 line,
         const INT32 column,
         const UINT8 depth,
         COLOR& color 
         ) { return v_GetColor(line, column, depth, color); };

      //! Get color for given point in specifyed map projection and depth
      //!
      //! @return true if color was retrived
      bool GetColor (
         const DPOINT2D& point,
         const UINT8 depth,
         COLOR& color 
         ) { return v_GetColor(point, depth, color); };

      //! Check if for given depth pyramid tier exist
      //!
      //! @return the nearest lower depth
      UINT8 CheckDepth (
         const UINT8 depth
         ) { return v_CheckDepth(depth); };

      //! Get transformation from object coordinates ot specifyed map projection
      //!
      //! @return TRANS2D_MAPGEN&
      const TRANS2D_MAPGEN& GetTransformationInternalToModel (
         ) { return v_GetTransformationInternalToModel(); };

   protected:

      //! Register this model (Called by constructor)
      static void Register (
         TEXTURE* texture
         );

      TEXTURE (   
         const char* name,
         const char* desc,
         const MODEL model
         );

      //!   Set built state? 
      void SetBuilt (
         const bool built
         );

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT

      const char* m_Name;
      const char* m_Description;
      const MODEL m_Model;

      bool m_Built;                             //!<  Is an object built?

      static TEXTURE* s_TextureModels[MODEL_Count];

      TEXTURE (   
         );

      TEXTURE (                                 //! Copy constructor (not implemented)
         const TEXTURE &rhs
         );

      TEXTURE& operator= (                      //! Assignment operator (not implemented)
         const TEXTURE& rhs
         );

      #endif // GENERATING_DOXYGEN_OUTPUT

      virtual TEXTURE* v_CreateInstance (
         ) = 0;

      virtual ERRVALUE v_Build (
         const GRE_LAYER *layer
         ) = 0;

      virtual void v_Free (
         ) = 0;

      virtual void v_Begin (
         const SCENE3D& scene
         ) = 0;

      virtual void v_End (
         ) = 0;

      virtual const DRECT2D& v_GetExtents (
         ) = 0;

      virtual void v_SetMapProjParm (
         const MAPPROJPARM& mapprojparm
         ) = 0;

      virtual const MAPPROJPARM v_GetMapProjParm (
         ) = 0;

      virtual bool v_GetColor (
         const INT32 line,
         const INT32 column,
         const UINT8 depth,
         COLOR& color 
         ) = 0;

      virtual bool v_GetColor (
         const DPOINT2D& point,
         const UINT8 depth,
         COLOR& color 
         ) = 0;

      virtual UINT8 v_CheckDepth (
         const UINT8 depth
         ) = 0;

      virtual const TRANS2D_MAPGEN& v_GetTransformationInternalToModel (
         ) = 0;

   };

}     // End of GRE namespace

#endif

---