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:

[legend]

Public Member Functions
	Graphic3d_MarkerImage (const Handle< Image_PixMap > &theImage, const Handle< Image_PixMap > &theImageAlpha=Handle< Image_PixMap >())
	Constructor from existing pixmap.

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

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

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

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

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

void	GetTextureSize (Standard_Integer &theWidth, Standard_Integer &theHeight) const
	Return texture size.

bool	IsColoredImage () const
	Return TRUE if marker image has colors (e.g. RGBA and not grayscale).

Handle< TColStd_HArray1OfByte >	GetBitMapArray (const Standard_Real theAlphaValue=0.5, const Standard_Boolean theIsTopDown=false) const
	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.

Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.

	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.

Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.

virtual	~Standard_Transient ()
	Destructor must be virtual.

virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.

Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.

Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.

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.

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.

Standard_Transient *	This () 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.

Standard_Integer	GetRefCount () const noexcept
	Get the reference counter of this object.

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.

Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.

virtual void	Delete () const
	Memory deallocator for transient classes.

Static Public Member Functions
static Handle< Graphic3d_MarkerImage >	StandardMarker (const Aspect_TypeOfMarker theMarkerType, const Standard_ShortReal theScale, const Graphic3d_Vec4 &theColor)
	Returns a marker image for the marker of the specified type, scale and color.

Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.

static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

Protected Member Functions
	Graphic3d_MarkerImage (const TCollection_AsciiString &theId, const TCollection_AsciiString &theAlphaId, const Handle< Image_PixMap > &theImage, const Handle< Image_PixMap > &theImageAlpha=Handle< Image_PixMap >())
	Constructor from existing pixmap with predefined ids.

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.

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/3]

Graphic3d_MarkerImage::Graphic3d_MarkerImage	(	const Handle< Image_PixMap > &	theImage,
		const Handle< Image_PixMap > &	theImageAlpha = `Handle< Image_PixMap >()`
	)

Constructor from existing pixmap.

Parameters

theImage	[in] source image
theImageAlpha	[in] colorless image

◆ Graphic3d_MarkerImage() [2/3]

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	[in] source bitmap stored as array of bytes
theWidth	[in] number of bits in a row
theHeight	[in] number of bits in a column

◆ Graphic3d_MarkerImage() [3/3]

Graphic3d_MarkerImage::Graphic3d_MarkerImage	(	const TCollection_AsciiString &	theId,
		const TCollection_AsciiString &	theAlphaId,
		const Handle< Image_PixMap > &	theImage,
		const Handle< Image_PixMap > &	theImageAlpha = `Handle< Image_PixMap >()`
	)

protected

Constructor from existing pixmap with predefined ids.

Member Function Documentation

◆ GetBitMapArray()

Handle< TColStd_HArray1OfByte > Graphic3d_MarkerImage::GetBitMapArray	(	const Standard_Real	theAlphaValue = `0.5`,
		const Standard_Boolean	theIsTopDown = `false`
	)		const

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.

Parameters

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"
theIsTopDown	[in] flag indicating expected rows order in returned bitmap, which is bottom-up by default

◆ GetImage()

const Handle< Image_PixMap > & Graphic3d_MarkerImage::GetImage ( )

Return 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 ( )

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()

◆ GetImageAlphaId()

const TCollection_AsciiString & Graphic3d_MarkerImage::GetImageAlphaId ( ) const

Return an unique ID. This ID will be used to manage resource in graphic driver.

◆ GetImageId()

const TCollection_AsciiString & Graphic3d_MarkerImage::GetImageId ( ) const

Return 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

Return texture size.

◆ IsColoredImage()

bool Graphic3d_MarkerImage::IsColoredImage ( ) const

Return TRUE if marker image has colors (e.g. RGBA and not grayscale).

◆ StandardMarker()

static Handle< Graphic3d_MarkerImage > Graphic3d_MarkerImage::StandardMarker	(	const Aspect_TypeOfMarker	theMarkerType,
		const Standard_ShortReal	theScale,
		const Graphic3d_Vec4 &	theColor
	)

static

Returns a marker image for the marker of the specified type, scale and color.

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

Graphic3d_MarkerImage.hxx

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Graphic3d_MarkerImage() [1/3]

◆ Graphic3d_MarkerImage() [2/3]

◆ Graphic3d_MarkerImage() [3/3]

Member Function Documentation

◆ GetBitMapArray()

◆ GetImage()

◆ GetImageAlpha()

◆ GetImageAlphaId()

◆ GetImageId()

◆ GetTextureSize()

◆ IsColoredImage()

◆ StandardMarker()