Graphic3d_AttribBuffer Class Reference

Buffer of vertex attributes. This class is intended for advanced usage allowing invalidation of entire buffer content or its sub-part. More...

#include <Graphic3d_AttribBuffer.hxx>

Inheritance diagram for Graphic3d_AttribBuffer:

Public Member Functions
	Graphic3d_AttribBuffer (const occ::handle< NCollection_BaseAllocator > &theAlloc)
	Empty constructor.
bool	Init (const int theNbElems, const Graphic3d_Attribute *theAttribs, const int theNbAttribs)
	Allocates new empty array.
bool	Init (const int theNbElems, const NCollection_Array1< Graphic3d_Attribute > &theAttribs)
	Allocates new empty array.
bool	IsMutable () const override
	Return TRUE if data can be invalidated; FALSE by default.
void	SetMutable (bool theMutable)
	Set if data can be invalidated.
bool	IsInterleaved () const override
	Return TRUE for interleaved array; TRUE by default.
void	SetInterleaved (bool theIsInterleaved)
	Setup interleaved/non-interleaved array. WARNING! Filling non-interleaved buffer should be implemented on user side without Graphic3d_Buffer auxiliary methods designed for interleaved data.
Graphic3d_BufferRange	InvalidatedRange () const override
	Return invalidated range.
void	Validate () override
	Reset invalidated range.
void	Invalidate () override
	Invalidate the entire buffer data.
void	Invalidate (int theAttributeIndex)
	Invalidate the entire attribute data.
void	Invalidate (int theAttributeIndex, int theVertexLower, int theVertexUpper)
	Invalidate attribute data within specified sub-range (starting from 0).
void	Invalidate (int theVertexLower, int theVertexUpper)
	Invalidate all attribute data within specified vertex sub-range (starting from 0).
void	invalidate (const Graphic3d_BufferRange &theRange)
	Invalidate specified sub-range of data (as byte offsets).
Public Member Functions inherited from Graphic3d_Buffer
	Graphic3d_Buffer (const occ::handle< NCollection_BaseAllocator > &theAlloc)
	Empty constructor.
int	NbMaxElements () const
	Return number of initially allocated elements which can fit into this buffer, while NbElements can be overwritten to smaller value.
const Graphic3d_Attribute *	AttributesArray () const
const Graphic3d_Attribute &	Attribute (const int theAttribIndex) const
Graphic3d_Attribute &	ChangeAttribute (const int theAttribIndex)
int	FindAttribute (Graphic3d_TypeOfAttribute theAttrib) const
	Find attribute index.
int	AttributeOffset (const int theAttribIndex) const
const uint8_t *	Data (const int theAttribIndex) const
uint8_t *	ChangeData (const int theAttribIndex)
const uint8_t *	value (const int theElem) const
	Access specified element.
uint8_t *	changeValue (const int theElem)
	Access specified element.
template<typename Type_t>
const Type_t &	Value (const int theElem) const
	Access element with specified position and type.
template<typename Type_t>
Type_t &	ChangeValue (const int theElem)
	Access element with specified position and type.
uint8_t *	ChangeAttributeData (Graphic3d_TypeOfAttribute theAttrib, int &theAttribIndex, size_t &theAttribStride)
	Return the attribute data with stride size specific to this attribute.
const uint8_t *	AttributeData (Graphic3d_TypeOfAttribute theAttrib, int &theAttribIndex, size_t &theAttribStride) const
	Return the attribute data with stride size specific to this attribute.
void	release ()
	Release buffer.
bool	Init (const int theNbElems, const Graphic3d_Attribute *theAttribs, const int theNbAttribs)
	Allocates new empty array.
bool	Init (const int theNbElems, const NCollection_Array1< Graphic3d_Attribute > &theAttribs)
	Allocates new empty array.
void	DumpJson (Standard_OStream &theOStream, int theDepth=-1) const override
	Dumps the content of me into the stream.
uint8_t *	ChangeData () noexcept
const uint8_t *	Data () const noexcept
Public Member Functions inherited from NCollection_Buffer
	NCollection_Buffer (const occ::handle< NCollection_BaseAllocator > &theAlloc, const size_t theSize=0, uint8_t *theData=nullptr)
	Default constructor. When theData is NULL but theSize is not 0 than buffer of specified size will be allocated.
	~NCollection_Buffer () override
	Destructor.
const uint8_t *	Data () const noexcept
uint8_t *	ChangeData () noexcept
bool	IsEmpty () const noexcept
size_t	Size () const noexcept
	Return buffer length in bytes.
const occ::handle< NCollection_BaseAllocator > &	Allocator () const noexcept
void	SetAllocator (const occ::handle< NCollection_BaseAllocator > &theAlloc)
	Assign new buffer allocator with de-allocation of buffer.
bool	Allocate (const size_t theSize)
	Allocate the buffer.
void	Free ()
	De-allocate buffer.
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.

Protected Attributes
Graphic3d_BufferRange	myInvalidatedRange
	invalidated buffer data range (as byte offsets)
bool	myIsInterleaved
	flag indicating the vertex attributes being interleaved
bool	myIsMutable
	flag indicating that data can be invalidated
Protected Attributes inherited from NCollection_Buffer
uint8_t *	myData
	data pointer
size_t	mySize
	buffer length in bytes
occ::handle< NCollection_BaseAllocator >	myAllocator
	buffer allocator

Additional Inherited Members
typedef void	base_type
	Returns a type descriptor about this object.
Static Public Member Functions inherited from Graphic3d_Buffer
static const occ::handle< NCollection_BaseAllocator > &	DefaultAllocator ()
	Return default vertex data allocator.
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.
int	Stride
	the distance to the attributes of the next vertex within interleaved array
int	NbElements
	number of the elements (
int	NbAttributes
	number of vertex attributes

Detailed Description

Buffer of vertex attributes. This class is intended for advanced usage allowing invalidation of entire buffer content or its sub-part.

Constructor & Destructor Documentation

Graphic3d_AttribBuffer()

Graphic3d_AttribBuffer::Graphic3d_AttribBuffer

(

const occ::handle< NCollection_BaseAllocator > &

theAlloc

)

Empty constructor.

Member Function Documentation

Init() [1/2]

bool Graphic3d_AttribBuffer::Init	(	const int	theNbElems,
		const Graphic3d_Attribute *	theAttribs,
		const int	theNbAttribs )

Allocates new empty array.

Init() [2/2]

bool Graphic3d_AttribBuffer::Init ( const int theNbElems, const NCollection_Array1< Graphic3d_Attribute > & theAttribs )

inline

Allocates new empty array.

Invalidate() [1/4]

void Graphic3d_AttribBuffer::Invalidate ( )

overridevirtual

Invalidate the entire buffer data.

Reimplemented from Graphic3d_Buffer.

Invalidate() [2/4]

void Graphic3d_AttribBuffer::Invalidate

(

int

theAttributeIndex

)

Invalidate the entire attribute data.

Invalidate() [3/4]

void Graphic3d_AttribBuffer::Invalidate	(	int	theAttributeIndex,
		int	theVertexLower,
		int	theVertexUpper )

Invalidate attribute data within specified sub-range (starting from 0).

Invalidate() [4/4]

void Graphic3d_AttribBuffer::Invalidate	(	int	theVertexLower,
		int	theVertexUpper )

Invalidate all attribute data within specified vertex sub-range (starting from 0).

invalidate()

void Graphic3d_AttribBuffer::invalidate

(

const Graphic3d_BufferRange &

theRange

)

Invalidate specified sub-range of data (as byte offsets).

InvalidatedRange()

Graphic3d_BufferRange Graphic3d_AttribBuffer::InvalidatedRange ( ) const

inlineoverridevirtual

Return invalidated range.

Reimplemented from Graphic3d_Buffer.

IsInterleaved()

bool Graphic3d_AttribBuffer::IsInterleaved ( ) const

inlineoverridevirtual

Return TRUE for interleaved array; TRUE by default.

Reimplemented from Graphic3d_Buffer.

IsMutable()

bool Graphic3d_AttribBuffer::IsMutable ( ) const

inlineoverridevirtual

Return TRUE if data can be invalidated; FALSE by default.

Reimplemented from Graphic3d_Buffer.

SetInterleaved()

void Graphic3d_AttribBuffer::SetInterleaved

(

bool

theIsInterleaved

)

Setup interleaved/non-interleaved array. WARNING! Filling non-interleaved buffer should be implemented on user side without Graphic3d_Buffer auxiliary methods designed for interleaved data.

SetMutable()

void Graphic3d_AttribBuffer::SetMutable

(

bool

theMutable

)

Set if data can be invalidated.

Validate()

void Graphic3d_AttribBuffer::Validate ( )

inlineoverridevirtual

Reset invalidated range.

Reimplemented from Graphic3d_Buffer.

Field Documentation

myInvalidatedRange

Graphic3d_BufferRange Graphic3d_AttribBuffer::myInvalidatedRange

protected

invalidated buffer data range (as byte offsets)

myIsInterleaved

bool Graphic3d_AttribBuffer::myIsInterleaved

protected

flag indicating the vertex attributes being interleaved

myIsMutable

bool Graphic3d_AttribBuffer::myIsMutable

protected

flag indicating that data can be invalidated

---

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

• Graphic3d_AttribBuffer.hxx