spatmod/imagetargettilesetfile.h

Go to the documentation of this file.

#ifndef  INC_SPATMOD_IMAGETARGETTILESETFILE_H
#define  INC_SPATMOD_IMAGETARGETTILESETFILE_H

#ifndef  INC_SPATMOD_IMAGETARGETTILESET_H
#include <spatmod/imagetargettileset.h>
#endif

#ifndef  INC_MI32_FILEPATH_H
#include <mi32/filepath.h>
#endif

namespace SPATMOD {
namespace IMAGE {

class TARGET_FILE;

//=====================================================================================================================

class TARGET_TILESET_FILE : public TARGET_TILESET {
   public:

      virtual ~TARGET_TILESET_FILE ();

      bool GetCreateAdditionalFiles (
         ) const { return (m_CreateAdditionalFiles); }

      bool GetDeleteAfterZip (
         ) const { return (m_DeleteAfterZip); }

      bool GetMakeTileMap (
         ) const { return (m_MakeTileMap); }

      const FILEPATH& GetTileFolderBasePath (
         ) const { return (m_TileFolderBasePath); }

      bool GetUsePalette (
         ) const { return (m_UsePalette); }

      ERRVALUE CreateCatalogExcludeFile ();

      double GetScale () const { return (m_Scale); }

      INT32 GetScaleNumerator () const { return (m_ScaleNumerator); }

      INT32 GetScaleDenominator () const { return (m_ScaleDenominator); }

      INT64 GetPrescaleOffset () const { return (m_PrescaleOffset); }

      INT64 GetPostscaleOffset () const { return (m_PostscaleOffset); }

      double GetPixelValueMin () const { return (m_PixelValueMin); }

      double GetPixelValueMax () const { return (m_PixelValueMax); }

      bool GetZipOutput (
         ) const { return (m_ZipOutput); }

      void SetCreateAdditionalFiles (
         bool CreateAdditionalFiles
         ) { m_CreateAdditionalFiles = CreateAdditionalFiles; }

      void SetMakeTileMap (
         bool MakeTileMap
         ) { m_MakeTileMap = MakeTileMap; }

      void SetPixelValueRange (
         double PixelValueMin,
         double PixelValueMax
         ) { m_PixelValueMin = PixelValueMin; m_PixelValueMax = PixelValueMax; }

      void SetScale (
         double Scale
         ) { m_Scale = Scale; }

      void SetScaleRational (
         INT32 Numerator,
         INT32 Denominator
         ) { m_ScaleNumerator = Numerator; m_ScaleDenominator = Denominator; m_Scale = (double)Numerator/(double)Denominator; }

      void SetPrescaleOffset (
         INT64 offset
         ) { m_PrescaleOffset = offset; }

      void SetPostscaleOffset (
         INT64 offset
         ) { m_PostscaleOffset = offset; }

      void SetTileFolderBasePath (
         const FILEPATH& filepath
         ) { m_TileFolderBasePath = filepath; }

      void SetUsePalette (
         bool UsePalette = true
         ) { m_UsePalette = UsePalette; }

      void SetZipOutput (
         bool ZipOutput = true,
         bool DeleteAfterZip = false
         ) { m_ZipOutput = ZipOutput; m_DeleteAfterZip = DeleteAfterZip; }

   protected:

      TARGET_TILESET_FILE (
         STAGE *pInputStage,                    
         const IMAGE::TILESET& tileset          
         );

      TARGET_TILESET_FILE (
         STAGE *pInputStage,                    
         INT32 TileSize,                        
         IMAGE::TILESET::PROFILE profile,       
         const IMAGE::FORMAT format             
         );

      TARGET_TILESET_FILE (
         STAGE *pInputStage,                    
         INT32 TileSize,                        
         IMAGE::TILESET::PROFILE profile        
         );

      ERRVALUE CreateTargetFile (
         IMAGE::STAGE *pStageInput,             
         const FILEPATH& filepath,              
         const IMAGE::FORMAT& format,           
         IMAGE::TARGET_FILE *& pTargetFile      
         ) const;

      ERRVALUE CreateTargetFile (
         IMAGE::STAGE *pStageInput,             
         const FILEPATH& filepath,              
         bool HasNullCells,                     
         IMAGE::TARGET_FILE *& pTargetFile      
         ) const;

      const IMAGE::FORMAT* FindTileFile (
         FILEPATH& filepath,                    
         const LPOINT3D& TileIdx                
         ) const { return (v_FindTileFile(filepath,TileIdx)); }

      ERRVALUE GenerateTileFilePath (
         FILEPATH& filepath,                    
         const LPOINT3D& TileIdx,               
         bool HasNullCells,                     
         bool CreateFolder                      
         ) const { return (v_GenerateTileFilePath(filepath,TileIdx,HasNullCells,CreateFolder)); }

      virtual const IMAGE::FORMAT* v_FindTileFile (
         FILEPATH& filepath,                    
         const LPOINT3D& TileIdx                
         ) const;

      virtual ERRVALUE v_GenerateTileFilePath (
         FILEPATH& filepath,                    
         const LPOINT3D& TileIdx,               
         bool HasNullCells,                     
         bool CreateFolder                      
         ) const;

      virtual ERRVALUE v_WriteTile (
         SOURCE_MEMORY& SourceTile,             
         const LPOINT3D& TileIdx,               
         bool HasNullCells                      
         );

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      FILEPATH m_TileFolderBasePath;
      bool m_ZipOutput;
      bool m_DeleteAfterZip;
      bool m_CreateAdditionalFiles;
      bool m_UsePalette;
      bool m_MakeTileMap;
      double m_PixelValueMin;
      double m_PixelValueMax;
      double m_Scale;
      INT32 m_ScaleNumerator;
      INT32 m_ScaleDenominator;
      INT64 m_PrescaleOffset;
      INT64 m_PostscaleOffset;

      // Unimplemented
      TARGET_TILESET_FILE (const TARGET_TILESET_FILE&);
      TARGET_TILESET_FILE& operator= (const TARGET_TILESET_FILE&);
      #endif // GENERATING_DOXYGEN_OUTPUT

      virtual ERRVALUE v_CreateTargetFile (
         IMAGE::STAGE *pStageInput,             
         const FILEPATH& filepath,              
         const IMAGE::FORMAT& format,           
         IMAGE::TARGET_FILE *& pTargetFile      
         ) const;

   };

//=====================================================================================================================

}  // End namespace IMAGE
}  // End namespace SPATMOD

#endif   // INC_SPATMOD_IMAGETARGETTILESETFILE_H

---