0024131: TKOpenGL redesign GPU memory management for markers presentation

[occt.git] / src / Graphic3d / Graphic3d_MarkerImage.hxx

diff --git a/src/Graphic3d/Graphic3d_MarkerImage.hxx b/src/Graphic3d/Graphic3d_MarkerImage.hxx
new file mode 100644 (file)
index 0000000..848cb86
--- /dev/null
+++ b/src/Graphic3d/Graphic3d_MarkerImage.hxx
@@ -0,0 +1,90 @@
+// Created on: 2013-06-25
+// Created by: Dmitry BOBYLEV
+// Copyright (c) 2013 OPEN CASCADE SAS
+//
+// The content of this file is subject to the Open CASCADE Technology Public
+// License Version 6.5 (the "License"). You may not use the content of this file
+// except in compliance with the License. Please obtain a copy of the License
+// at http://www.opencascade.org and read it completely before using this file.
+//
+// The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
+// main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
+//
+// The Original Code and all software distributed under the License is
+// distributed on an "AS IS" basis, without warranty of any kind, and the
+// Initial Developer hereby disclaims all such warranties, including without
+// limitation, any warranties of merchantability, fitness for a particular
+// purpose or non-infringement. Please see the License for the specific terms
+// and conditions governing the rights and limitations under the License.
+
+#ifndef _Graphic3d_MarkerImage_H__
+#define _Graphic3d_MarkerImage_H__
+
+#include <Graphic3d_MarkerImage_Handle.hxx>
+
+#include <Handle_TColStd_HArray1OfByte.hxx>
+#include <Image_PixMap_Handle.hxx>
+#include <Quantity_Parameter.hxx>
+#include <TCollection_AsciiString.hxx>
+
+//! This class is used to store bitmaps and images for markers rendering.
+//! It can convert bitmap texture stored in TColStd_HArray1OfByte to Image_PixMap and vice versa.
+class Graphic3d_MarkerImage : public Standard_Transient
+{
+public:
+
+  //! @param theImage - source image
+  Standard_EXPORT Graphic3d_MarkerImage (const Handle(Image_PixMap)& theImage);
+
+  //! Creates marker image from array of bytes
+  //! (method for compatibility with old markers definition).
+  //! @param theBitMap - source bitmap stored as array of bytes
+  //! @param theWidth  - number of bits in a row
+  //! @param theHeight - number of bits in a column
+  Standard_EXPORT Graphic3d_MarkerImage (const Handle(TColStd_HArray1OfByte)& theBitMap,
+                                         const Standard_Integer& theWidth,
+                                         const Standard_Integer& theHeight);
+
+  //! @param theAlphaValue pixels in the image that have alpha value greater than
+  //!                      or equal to this parameter will be stored in bitmap as "1",
+  //!                      others will be stored as "0"
+  //! @return marker image as array of bytes. If an instance of the class has been
+  //! initialized with image, it will be converted to bitmap based on the parameter theAlphaValue.
+  Standard_EXPORT Handle(TColStd_HArray1OfByte) GetBitMapArray (const Standard_Real& theAlphaValue = 0.5) const;
+
+  //! @return marker image. If an instance of the class has been initialized with a bitmap, it will be
+  //! converted to image.
+  Standard_EXPORT const Handle(Image_PixMap)& GetImage();
+
+  //! @return image alpha as grayscale image. Note that if an instance of the class has been initialized
+  //! with a bitmap or with grayscale image this method will return exactly the same image as GetImage()
+  Standard_EXPORT const Handle(Image_PixMap)& GetImageAlpha();
+
+  //! @return an unique ID. This ID will be used to manage resource in graphic driver.
+  Standard_EXPORT const TCollection_AsciiString& GetImageId() const;
+
+  //! @return an unique ID. This ID will be used to manage resource in graphic driver.
+  Standard_EXPORT const TCollection_AsciiString& GetImageAlphaId() const;
+
+  //! @return texture size
+  Standard_EXPORT void GetTextureSize (Standard_Integer& theWidth,
+                                       Standard_Integer& theHeight) const;
+
+private:
+
+  TCollection_AsciiString       myImageId;      //!< resource identifier
+  TCollection_AsciiString       myImageAlphaId; //!< resource identifier
+  Handle(TColStd_HArray1OfByte) myBitMap;       //!< bytes array with bitmap definition (for compatibility with old code)
+  Handle(Image_PixMap)          myImage;        //!< full-color  marker definition
+  Handle(Image_PixMap)          myImageAlpha;   //!< alpha-color marker definition (for dynamic hi-lighting)
+  Standard_Integer              myMargin;       //!< extra margin from boundaries for bitmap -> point sprite conversion, 1 px by default
+  Standard_Integer              myWidth;        //!< marker width
+  Standard_Integer              myHeight;       //!< marker height
+
+public:
+
+  DEFINE_STANDARD_RTTI(Graphic3d_MarkerImage) // Type definition
+
+};
+
+#endif // _Graphic3d_MarkerImage_H__