Graphic3d_HatchStyle Class Reference

A class that provides an API to use standard OCCT hatch styles defined in Aspect_HatchStyle enum or to create custom styles from a user-defined bitmap. More...

#include <Graphic3d_HatchStyle.hxx>

Inheritance diagram for Graphic3d_HatchStyle:

Public Member Functions
	Graphic3d_HatchStyle (const occ::handle< Image_PixMap > &thePattern)
	Creates a new custom hatch style with the given pattern and unique style id.
	Graphic3d_HatchStyle (const Aspect_HatchStyle theType)
	Creates a new predefined hatch style with the given id in Aspect_HatchStyle enum. GPU memory for the pattern will not be allocated.
const uint8_t *	Pattern () const
	Returns the pattern of custom hatch style.
int	HatchType () const
	In case if predefined OCCT style is used, returns index in Aspect_HatchStyle enumeration. If the style is custom, returns unique index of the style.
void	DumpJson (Standard_OStream &theOStream, int theDepth=-1) const
	Dumps the content of me into the stream.
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 ()=default
	Destructor must be virtual.
virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.
bool	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.
bool	IsInstance (const char *const theTypeName) const
	Returns a true value if this is an instance of TypeName.
bool	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.
bool	IsKind (const char *const 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.
int	GetRefCount () const noexcept
	Get the reference counter of this object.
void	IncrementRefCounter () noexcept
	Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.
int	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.
virtual void	Delete () const
	Memory deallocator for transient classes.

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.
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.

Detailed Description

A class that provides an API to use standard OCCT hatch styles defined in Aspect_HatchStyle enum or to create custom styles from a user-defined bitmap.

Constructor & Destructor Documentation

Graphic3d_HatchStyle() [1/2]

Graphic3d_HatchStyle::Graphic3d_HatchStyle

(

const occ::handle< Image_PixMap > &

thePattern

)

Creates a new custom hatch style with the given pattern and unique style id.

Warning

Raises a program error if given pattern image is not a valid 32*32 bitmap

Graphic3d_HatchStyle() [2/2]

Graphic3d_HatchStyle::Graphic3d_HatchStyle ( const Aspect_HatchStyle theType )

inline

Creates a new predefined hatch style with the given id in Aspect_HatchStyle enum. GPU memory for the pattern will not be allocated.

Member Function Documentation

DumpJson()

void Graphic3d_HatchStyle::DumpJson	(	Standard_OStream &	theOStream,
		int	theDepth = -1 ) const

Dumps the content of me into the stream.

HatchType()

int Graphic3d_HatchStyle::HatchType ( ) const

inline

In case if predefined OCCT style is used, returns index in Aspect_HatchStyle enumeration. If the style is custom, returns unique index of the style.

Pattern()

const uint8_t * Graphic3d_HatchStyle::Pattern

(

)

const

Returns the pattern of custom hatch style.

---

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

• Graphic3d_HatchStyle.hxx