Open CASCADE Technology  7.3.1.dev
Public Member Functions
Graphic3d_MarkerImage Class Reference

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. More...

#include <Graphic3d_MarkerImage.hxx>

Inheritance diagram for Graphic3d_MarkerImage:
Inheritance graph
[legend]

Public Member Functions

 Graphic3d_MarkerImage (const Handle< Image_PixMap > &theImage)
 
 Graphic3d_MarkerImage (const Handle< TColStd_HArray1OfByte > &theBitMap, const Standard_Integer &theWidth, const Standard_Integer &theHeight)
 Creates marker image from array of bytes (method for compatibility with old markers definition). More...
 
Handle< TColStd_HArray1OfByte > GetBitMapArray (const Standard_Real &theAlphaValue=0.5) const
 
const Handle< Image_PixMap > & GetImage ()
 
const Handle< Image_PixMap > & GetImageAlpha ()
 
const TCollection_AsciiStringGetImageId () const
 
const TCollection_AsciiStringGetImageAlphaId () const
 
void GetTextureSize (Standard_Integer &theWidth, Standard_Integer &theHeight) const
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
Standard_Boolean IsKind (const opencascade::handle< Standard_Type > &theType) const
 Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_Boolean IsKind (const Standard_CString theTypeName) const
 Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_TransientThis () const
 Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ Graphic3d_MarkerImage() [1/2]

Graphic3d_MarkerImage::Graphic3d_MarkerImage ( const Handle< Image_PixMap > &  theImage)
Parameters
theImage- source image

◆ Graphic3d_MarkerImage() [2/2]

Graphic3d_MarkerImage::Graphic3d_MarkerImage ( const Handle< TColStd_HArray1OfByte > &  theBitMap,
const Standard_Integer theWidth,
const Standard_Integer theHeight 
)

Creates marker image from array of bytes (method for compatibility with old markers definition).

Parameters
theBitMap- source bitmap stored as array of bytes
theWidth- number of bits in a row
theHeight- number of bits in a column

Member Function Documentation

◆ GetBitMapArray()

Handle< TColStd_HArray1OfByte > Graphic3d_MarkerImage::GetBitMapArray ( const Standard_Real theAlphaValue = 0.5) const
Parameters
theAlphaValuepixels 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"
Returns
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.

◆ GetImage()

const Handle< Image_PixMap >& Graphic3d_MarkerImage::GetImage ( )
Returns
marker image. If an instance of the class has been initialized with a bitmap, it will be converted to image.

◆ GetImageAlpha()

const Handle< Image_PixMap >& Graphic3d_MarkerImage::GetImageAlpha ( )
Returns
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()

◆ GetImageAlphaId()

const TCollection_AsciiString& Graphic3d_MarkerImage::GetImageAlphaId ( ) const
Returns
an unique ID. This ID will be used to manage resource in graphic driver.

◆ GetImageId()

const TCollection_AsciiString& Graphic3d_MarkerImage::GetImageId ( ) const
Returns
an unique ID. This ID will be used to manage resource in graphic driver.

◆ GetTextureSize()

void Graphic3d_MarkerImage::GetTextureSize ( Standard_Integer theWidth,
Standard_Integer theHeight 
) const
Returns
texture size

The documentation for this class was generated from the following file: