spatmod/imagepixel.h

Go to the documentation of this file.

#ifndef  INC_SPATMOD_IMAGEPIXEL_H
#define  INC_SPATMOD_IMAGEPIXEL_H

#ifndef  INC_SPATMOD_DATATYPE_H
#include <spatmod/datatype.h>
#endif

namespace SPATMOD {
namespace IMAGE {

class SAMPLE;

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

class PIXEL {
   public:

      enum TYPE {
         TYPE_Invalid =          0x0000,
         TYPE_Single =           0x0101,  
         TYPE_Multiple =         0x0200,  
         TYPE_Grayscale =        0x0301,  
         TYPE_GrayscaleAlpha =   0x8302,  
         TYPE_Indexed =          0x0401,  
         TYPE_RGB =              0x0503,  
         TYPE_RGBA =             0x8504,  
         TYPE_CMY =              0x0603,  
         TYPE_CMYA =             0x8604,  
         TYPE_CMYK =             0x0704,  
         TYPE_CMYKA =            0x8705,  
         TYPE_ComplexMP =        0x0802,  
         TYPE_ComplexRI =        0x0902,  
         TYPE_IHS =              0x0A03,  
         TYPE_IHSA =             0x8A04,  
         TYPE_BHS =              0x0B03,  
         TYPE_BHSA =             0x8B04,  
         TYPE_HSV =              0x0C03,  
         TYPE_HSVA =             0x8C04,  
         TYPE_Opacity =          0x8001,  
         TYPE_MASK_NumSamples =  0x00FF,
         TYPE_MASK_Alpha =       0x8000   
         };

      PIXEL ();

      PIXEL (
         TYPE PixelType,                  
         DATATYPE DataType,               
         UINT16 NumSamples = 0            
         );

      PIXEL (
         UINT16 NumSamples,               
         const SAMPLE *samples,           
         TYPE PixelType = TYPE_Invalid    
         );

      PIXEL (
         const PIXEL& rhs
         );

      ~PIXEL ();

      PIXEL& operator= (
         const PIXEL& rhs
         );

      void Exchange (
         PIXEL& other                        
         );

      DATATYPE GetDataType (
         ) const;

      UINT32 GetNumBytes (
         ) const;

      UINT16 GetNumSamples (
         ) const { return (m_NumSamples); }

      TYPE GetPixelType (
         ) const { return (m_PixelType); }

      const SAMPLE& GetSample (
         UINT16 index                        
         ) const;

      SAMPLE& GetSample (
         UINT16 index                        
         );

      const SAMPLE* GetSamples (
         ) const { return (m_Samples); }

      SAMPLE* GetSamples (
         ) { return (m_Samples); }

      bool HasAlpha (
         ) const { return ((m_PixelType & TYPE_MASK_Alpha) != 0); }

      bool IsEqual (
         const PIXEL& rhs
         ) const;

      bool IsSameType (
         const PIXEL& rhs
         ) const;

      void SetSample (
         UINT16 index,                       
         const SAMPLE& Sample                
         );

      ERRVALUE SetType (
         TYPE PixelType                      
         );

      void SetValueMinimum (
         );

      void SetValueMaximum (
         );

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      SAMPLE *m_Samples;
      UINT16 m_NumSamples;
      TYPE m_PixelType;

      void Copy (const PIXEL& rhs);

      #endif // GENERATING_DOXYGEN_OUTPUT
   };

inline bool operator== (
   const PIXEL& lhs,
   const PIXEL& rhs
   ) { return (lhs.IsEqual(rhs)); }

inline bool operator!= (
   const PIXEL& lhs,
   const PIXEL& rhs
   ) { return (!lhs.IsEqual(rhs)); }

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

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

#endif    // INC_SPATMOD_IMAGEPIXEL_H

---