rvc/opacitymask.h

Go to the documentation of this file.

/***
 * \file rvc/opacitymask.h 
 * \brief interface for the RVC::OPACITYMASK class.
 *
 * \if NODOC
 * $Id: opacitymask.h_v 1.17 2011/12/21 22:23:24 mju Exp $
 *
 * $Log: opacitymask.h_v $
 * Revision 1.17  2011/12/21 22:23:24  mju
 * Remove redundant hdrs.
 *
 * Revision 1.16  2008/01/22 23:30:42  scowan
 * Support optional object filter for opacity masks.
 *
 * Revision 1.15  2007/01/19 16:10:27  mju
 * Use color_array.
 *
 * Revision 1.14  2006/10/27 22:50:18  scowan
 * Made getCellType virtual.
 *
 * Revision 1.13  2006/10/19 20:40:23  mju
 * Use pyramid_default instead of pyramid_none.
 *
 * Revision 1.11  2006/06/27 15:04:40  scowan
 * Make method now fills in objitem with created object info.
 *
 * Revision 1.10  2006/05/31 15:06:09  scowan
 * Added setCacheRect virtual method.
 *
 * Revision 1.9  2006/04/14 21:15:01  mju
 * Add makeparm setting for initial value.
 *
 * Revision 1.1  2004/02/24 18:36:22  scowan
 * Initial revision
 * \endif
***/

#ifndef INC_RVC_OPACITYMASK_H
#define INC_RVC_OPACITYMASK_H

#ifndef INC_RVC_NULLMASK_H
   #include <rvc/nullmask.h>
#endif


namespace RVC {

class OPACITYMASK : public RVC::IMAGE {
   public:
      
      #ifndef GENERATING_DOXYGEN_OUTPUT
      class GETOBJFILTER_ISVALIDOPACITYMASK;
      class MAKEPARMS;
      class OBJECT_FILTER;
      #endif // GENERATING_DOXYGEN_OUTPUT

      OPACITYMASK (
         );

      OPACITYMASK (
         const RVC::OPACITYMASK& rhs
         );

      virtual ~OPACITYMASK (
         );

      RVC::OPACITYMASK& operator= (
         const RVC::OPACITYMASK& rhs
         );

      INT32 GetNumTileColumns (
         ) const;

      INT32 GetNumTileLines (
         ) const;

      INT32 GetNumXTiles (
         ) const;

      INT32 GetNumYTiles (
         ) const;

      ERRVALUE GetPyramidList (
         SIMPLE_ARRAY<INT32>& SampleList,       
         RVC::OBJITEMLIST& PyramidList          
         );
         
      INT32 GetTileSizeBytes (
         ) const;

      bool HasOpacityValues (
         ) const;

      ERRVALUE Make (
         const RVC::IMAGE& parent,              
         const RVC::DESCRIPTOR& Descriptor,
         const MAKEPARMS& MakeParms,
         const CREDENTIALS* Credentials RVC_DEFAULT_CREDENTIALS            
         );

      ERRVALUE Make (
         RVC::OBJITEM& OpacityItem,             
         const MAKEPARMS& MakeParms,
         const char* Source = 0,                
         const CREDENTIALS* Credentials RVC_DEFAULT_CREDENTIALS            
         );

      ERRVALUE MakePyramidSet (
         IMAGE::PYRAMID flags = IMAGE::PYRAMID_Default,
         const CREDENTIALS* Credentials RVC_DEFAULT_CREDENTIALS            
         );

      ERRVALUE Open (
         const RVC::IMAGE& parent,              
         OBJECT::OPENMODE OpenMode = OBJECT::OPENMODE_Read,
         const CREDENTIALS* Credentials RVC_DEFAULT_CREDENTIALS            
         );       

      ERRVALUE Open (
         const RVC::IMAGE& parent,                    
         const RVC::OBJITEM& OpacityMaskItem,         
         OBJECT::OPENMODE OpenMode = OBJECT::OPENMODE_Read,
         const CREDENTIALS* Credentials RVC_DEFAULT_CREDENTIALS            
         );       

      int Read (
         INT32 Line,                            
         INT32 StartColumn,                     
         UINT8 *data,                           
         INT32 Length = 1                       
         ) const;

      int ReadColumn (
         INT32 StartLine,                       
         INT32 Column,                          
         UINT8 *data,                           
         INT32 Length = 1                       
         ) const;
         
      // Set the color map to use to obtain opacity value from the color map
      ERRVALUE SetColorMap (
         const COLOR_ARRAY& ColorMap
         );

      ERRVALUE Write (
         INT32 Line,                            
         INT32 StartColumn,                     
         const UINT8* data,                           
         INT32 Length = 1                       
         );

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT

      IMAGE* m_Image;         
      RASTER m_OpacityObj;    
      NULLMASK m_NullObj;        
      IMAGE::CELLTYPE m_CellType;
      IMAGE::CELLTYPE m_ParentCellType;
      mutable SIMPLE_ARRAY<UINT8> m_Buffer;
      SIMPLE_ARRAY<UINT8> m_OpacityMap;
      OBJITEM m_ParentObjItem;
      
      virtual ERRVALUE v_CloseObject ();
      virtual ERRVALUE v_CopyObject (RVC::OBJECT& DestParentObj, RVC::OBJECT& DestObj, FILTER* filter, COPYFLAGS CopyFlags, const CREDENTIALS* Credentials) const;
      virtual RVC::OBJTYPE v_GetDftObjectType () const;
      virtual FILTER* v_GetObjectFilter () const;
      virtual bool v_IsObjectOpen () const;              
      virtual ERRVALUE v_OpenObject (OPENMODE OpenFlags, MDLGPARENT parent, const CREDENTIALS* Credentials);
         
      virtual void v_GetExtents (DRECT3D &extents) const;
      virtual void v_GetScale (double& xscale, double& yscale) const;
      virtual double v_GetZScale () const;
      virtual double v_GetZOffset () const;
      virtual bool v_HasCapability (int Capability) const;
      virtual void v_SetScale (double xscale, double yscale);
      virtual void v_SetZScale (double zscale);
      virtual void v_SetZOffset (double zoffset);
      
      virtual ERRVALUE v_GetBandParms (INT32 BandNum, BANDPARMS& BandParms) const;
      virtual CELLTYPE v_GetCellType () const;
      virtual double v_GetColumnScale () const;
      virtual double v_GetLineScale () const;
      virtual ERRVALUE v_GetNullValue (INT32 BandNum, NULLVALUE& NullValue) const;
      virtual INT32 v_GetNumBands () const;
      virtual INT32 v_GetNumColumns () const;
      virtual INT32 v_GetNumLines () const;
      virtual bool v_HasNullValue (INT32 BandNum) const;
      virtual ERRVALUE v_ReadBand (INT32 Band, INT32 Line, INT32 StartColumn, void *data, INT32 Length, CONVMODE Convert) const;
      virtual ERRVALUE v_ReadColumnBand (INT32 Band, INT32 Line, INT32 StartColumn, void *data, INT32 Length, CONVMODE Convert) const;
      virtual ERRVALUE v_SetCacheRect (const LRECT2D& Rect);
      virtual ERRVALUE v_SetCacheSize (INT32 NumTiles);
      virtual ERRVALUE v_SetCacheSize (CACHEMODE CacheFlags);
      virtual ERRVALUE v_SetNullValue (INT32 BandNum, const NULLVALUE* NullValue);
      virtual ERRVALUE v_WriteBand (INT32 Band, INT32 Line, INT32 StartColumn, const void *data, INT32 Length, CONVMODE Convert);
      #endif // GENERATING_DOXYGEN_OUTPUT

   };


class OPACITYMASK::GETOBJFILTER_ISVALIDOPACITYMASK : public GETOBJFILTER {
   public:
      explicit GETOBJFILTER_ISVALIDOPACITYMASK (
         const RASTER& RastObj
         );
         
      explicit GETOBJFILTER_ISVALIDOPACITYMASK (
         const RASTER::MAKEPARMS& MakeParms
         );
         
      GETOBJFILTER_ISVALIDOPACITYMASK (
         INT32 NumLines,
         INT32 NumColumns
         );
         
   private:
      INT32 m_NumLines;
      INT32 m_NumColumns;
      
      virtual bool v_HasSelectableSubObjects (const RVC::OBJITEM& objitem);
      virtual bool v_IsSelectable (const RVC::OBJITEM& objitem, int position = -1);
   };
   
class OPACITYMASK::MAKEPARMS {
   public:

      MAKEPARMS (
         IMAGE::CELLTYPE CellType = IMAGE::CELLTYPE_Unsigned_8,
         RASTER::COMPTYPE CompType = RASTER::COMPTYPE_None,
         UINT8 InitialValue = 255
         );

      IMAGE::CELLTYPE GetCellType (
         ) const { return (m_CellType); }
         
      RASTER::COMPTYPE GetCompressionType (
         ) const { return (m_CompType); }

      UINT8 GetInitialValue (
         ) const { return (m_InitValue); }

      void SetCompression (
         RASTER::COMPTYPE CompType        
         );
               
      void SetCellType (
         CELLTYPE CellType
         );

      void SetInitialValue (
         UINT8 InitValue
         ) { m_InitValue = InitValue; }

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      CELLTYPE m_CellType;                   // Image cell type
      RASTER::COMPTYPE m_CompType;           // Compression type
      UINT8 m_InitValue;
      #endif // GENERATING_DOXYGEN_OUTPUT
   }; // End of MAKEPARMS nested class.


class OPACITYMASK::OBJECT_FILTER : public OBJECT::FILTER {
   public:
      OBJECT_FILTER () {}
   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      virtual bool Filter (const RVC::OBJECT& obj);
      #endif // GENERATING_DOXYGEN_OUTPUT
   };

}     // End of RVC namespace

#endif      // INC_RVC_OPACITYMASK_H

---