src/Image/Image_PixMapData.hxx

   1 // Created on: 2012-07-18
   2 // Created by: Kirill GAVRILOV
   3 // Copyright (c) 2012-2014 OPEN CASCADE SAS
   4 //
   5 // This file is part of Open CASCADE Technology software library.
   6 //
   7 // This library is free software; you can redistribute it and/or modify it under
   8 // the terms of the GNU Lesser General Public License version 2.1 as published
   9 // by the Free Software Foundation, with special exception defined in the file
  10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  11 // distribution for complete text of the license and disclaimer of any warranty.
  12 //
  13 // Alternatively, this file may be used under the terms of Open CASCADE
  14 // commercial license or contractual agreement.
  15
  16 #ifndef _Image_PixMapData_H__
  17 #define _Image_PixMapData_H__
  18
  19 #include <Image_Color.hxx>
  20 #include <NCollection_Buffer.hxx>
  21
  22 //! Structure to manage image buffer.
  23 class Image_PixMapData : public NCollection_Buffer
  24 {
  25 public:
  26
  27   //! Empty constructor.
  28   Image_PixMapData()
  29   : NCollection_Buffer (Handle(NCollection_BaseAllocator)()),
  30     myTopRowPtr  (NULL),
  31     SizeBPP      (0),
  32     SizeX        (0),
  33     SizeY        (0),
  34     SizeRowBytes (0),
  35     TopToDown    (Standard_Size(-1))
  36   {
  37     //
  38   }
  39
  40   //! Initializer.
  41   bool Init (const Handle(NCollection_BaseAllocator)& theAlloc,
  42              const Standard_Size                      theSizeBPP,
  43              const Standard_Size                      theSizeX,
  44              const Standard_Size                      theSizeY,
  45              const Standard_Size                      theSizeRowBytes,
  46              Standard_Byte*                           theDataPtr)
  47   {
  48     SetAllocator (theAlloc); // will free old data as well
  49
  50     myData       = theDataPtr;
  51     myTopRowPtr  = NULL;
  52     SizeBPP      = theSizeBPP;
  53     SizeX        = theSizeX;
  54     SizeY        = theSizeY;
  55     SizeRowBytes = theSizeRowBytes != 0 ? theSizeRowBytes : (theSizeX * theSizeBPP);
  56     mySize       = SizeRowBytes * SizeY;
  57     if (myData == NULL)
  58     {
  59       Allocate (mySize);
  60     }
  61     SetTopDown (TopToDown == 1);
  62     return !IsEmpty();
  63   }
  64
  65   //! Reset all values to zeros.
  66   void ZeroData()
  67   {
  68     if (myData != NULL)
  69     {
  70       memset (myData, 0, mySize);
  71     }
  72   }
  73
  74   //! @return data pointer to requested row (first column).
  75   inline const Standard_Byte* Row (const Standard_Size theRow) const
  76   {
  77     return myTopRowPtr + ptrdiff_t(SizeRowBytes * theRow * TopToDown);
  78   }
  79
  80   //! @return data pointer to requested row (first column).
  81   inline Standard_Byte* ChangeRow (const Standard_Size theRow)
  82   {
  83     return myTopRowPtr + ptrdiff_t(SizeRowBytes * theRow * TopToDown);
  84   }
  85
  86   //! @return data pointer to requested position.
  87   inline const Standard_Byte* Value (const Standard_Size theRow,
  88                                      const Standard_Size theCol) const
  89   {
  90     return myTopRowPtr + ptrdiff_t(SizeRowBytes * theRow * TopToDown) + SizeBPP * theCol;
  91   }
  92
  93   //! @return data pointer to requested position.
  94   inline Standard_Byte* ChangeValue (const Standard_Size theRow,
  95                                      const Standard_Size theCol)
  96   {
  97     return myTopRowPtr + ptrdiff_t(SizeRowBytes * theRow * TopToDown) + SizeBPP * theCol;
  98   }
  99
 100   //! Compute the maximal row alignment for current row size.
 101   //! @return maximal row alignment in bytes (up to 16 bytes).
 102   inline Standard_Size MaxRowAligmentBytes() const
 103   {
 104     Standard_Size anAlignment = 2;
 105     for (; anAlignment <= 16; anAlignment <<= 1)
 106     {
 107       if ((SizeRowBytes % anAlignment) != 0 || (Standard_Size(myData) % anAlignment) != 0)
 108       {
 109         return (anAlignment >> 1);
 110       }
 111     }
 112     return anAlignment;
 113   }
 114
 115   //! Setup scanlines order in memory - top-down or bottom-up.
 116   //! Drawers should explicitly specify this value if current state IsTopDown() was ignored!
 117   //! @param theIsTopDown top-down flag
 118   inline void SetTopDown (const bool theIsTopDown)
 119   {
 120     TopToDown   = (theIsTopDown ? 1 : Standard_Size(-1));
 121     myTopRowPtr = ((TopToDown == 1 || myData == NULL)
 122                 ? myData : (myData + SizeRowBytes * (SizeY - 1)));
 123   }
 124
 125 protected:
 126
 127   Standard_Byte* myTopRowPtr;  //!< pointer to the topmost row (depending on scanlines order in memory)
 128
 129 public:
 130
 131   Standard_Size  SizeBPP;      //!< bytes per pixel
 132   Standard_Size  SizeX;        //!< width  in pixels
 133   Standard_Size  SizeY;        //!< height in pixels
 134   Standard_Size  SizeRowBytes; //!< number of bytes per line (in most cases equal to 3 * sizeX)
 135   Standard_Size  TopToDown;    //!< image scanlines direction in memory from Top to the Down
 136
 137
 138 public:
 139
 140   DEFINE_STANDARD_RTTI_INLINE(Image_PixMapData,NCollection_Buffer) // Type definition
 141
 142 };
 143
 144 DEFINE_STANDARD_HANDLE(Image_PixMapData, NCollection_Buffer)
 145
 146 #endif // _Image_PixMapData_H__