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:

[legend]

Public Member Functions
	Graphic3d_AttribBuffer (const Handle< NCollection_BaseAllocator > &theAlloc)
	Empty constructor.

bool	Init (const Standard_Integer theNbElems, const Graphic3d_Attribute *theAttribs, const Standard_Integer theNbAttribs)
	Allocates new empty array.

bool	Init (const Standard_Integer theNbElems, const Graphic3d_Array1OfAttribute &theAttribs)
	Allocates new empty array.

virtual Standard_Boolean	IsMutable () const override
	Return TRUE if data can be invalidated; FALSE by default.

void	SetMutable (Standard_Boolean theMutable)
	Set if data can be invalidated.

virtual Standard_Boolean	IsInterleaved () const override
	Return TRUE for interleaved array; TRUE by default.

void	SetInterleaved (Standard_Boolean 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.

virtual Graphic3d_BufferRange	InvalidatedRange () const override
	Return invalidated range.

virtual void	Validate () override
	Reset invalidated range.

virtual void	Invalidate () override
	Invalidate the entire buffer data.

void	Invalidate (Standard_Integer theAttributeIndex)
	Invalidate the entire attribute data.

void	Invalidate (Standard_Integer theAttributeIndex, Standard_Integer theVertexLower, Standard_Integer theVertexUpper)
	Invalidate attribute data within specified sub-range (starting from 0).

void	Invalidate (Standard_Integer theVertexLower, Standard_Integer 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 Handle< NCollection_BaseAllocator > &theAlloc)
	Empty constructor.

Standard_Integer	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 Standard_Integer theAttribIndex) const

Graphic3d_Attribute &	ChangeAttribute (const Standard_Integer theAttribIndex)

Standard_Integer	FindAttribute (Graphic3d_TypeOfAttribute theAttrib) const
	Find attribute index.

Standard_Integer	AttributeOffset (const Standard_Integer theAttribIndex) const

const Standard_Byte *	Data (const Standard_Integer theAttribIndex) const

Standard_Byte *	ChangeData (const Standard_Integer theAttribIndex)

const Standard_Byte *	value (const Standard_Integer theElem) const
	Access specified element.

Standard_Byte *	changeValue (const Standard_Integer theElem)
	Access specified element.

template<typename Type_t >
const Type_t &	Value (const Standard_Integer theElem) const
	Access element with specified position and type.

template<typename Type_t >
Type_t &	ChangeValue (const Standard_Integer theElem)
	Access element with specified position and type.

Standard_Byte *	ChangeAttributeData (Graphic3d_TypeOfAttribute theAttrib, Standard_Integer &theAttribIndex, Standard_Size &theAttribStride)
	Return the attribute data with stride size specific to this attribute.

const Standard_Byte *	AttributeData (Graphic3d_TypeOfAttribute theAttrib, Standard_Integer &theAttribIndex, Standard_Size &theAttribStride) const
	Return the attribute data with stride size specific to this attribute.

void	release ()
	Release buffer.

bool	Init (const Standard_Integer theNbElems, const Graphic3d_Attribute *theAttribs, const Standard_Integer theNbAttribs)
	Allocates new empty array.

bool	Init (const Standard_Integer theNbElems, const Graphic3d_Array1OfAttribute &theAttribs)
	Allocates new empty array.

virtual void	DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const override
	Dumps the content of me into the stream.

const Standard_Byte *	Data () const

Standard_Byte *	ChangeData ()

Public Member Functions inherited from NCollection_Buffer
	NCollection_Buffer (const Handle< NCollection_BaseAllocator > &theAlloc, const Standard_Size theSize=0, Standard_Byte *theData=NULL)
	Default constructor. When theData is NULL but theSize is not 0 than buffer of specified size will be allocated.

	~NCollection_Buffer ()
	Destructor.

const Standard_Byte *	Data () const

Standard_Byte *	ChangeData ()

bool	IsEmpty () const

Standard_Size	Size () const
	Return buffer length in bytes.

const Handle< NCollection_BaseAllocator > &	Allocator () const

void	SetAllocator (const Handle< NCollection_BaseAllocator > &theAlloc)
	Assign new buffer allocator with de-allocation of buffer.

bool	Allocate (const Standard_Size 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 ()
	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.

Protected Attributes
Graphic3d_BufferRange	myInvalidatedRange
	invalidated buffer data range (as byte offsets)

Standard_Boolean	myIsInterleaved
	flag indicating the vertex attributes being interleaved

Standard_Boolean	myIsMutable
	flag indicating that data can be invalidated

Protected Attributes inherited from NCollection_Buffer
Standard_Byte *	myData
	data pointer

Standard_Size	mySize
	buffer length in bytes

Handle< NCollection_BaseAllocator >	myAllocator
	buffer allocator

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 Graphic3d_Buffer
static const Handle< NCollection_BaseAllocator > &	DefaultAllocator ()
	Return default vertex data allocator.

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.

Data Fields inherited from Graphic3d_Buffer
Standard_Integer	Stride
	the distance to the attributes of the next vertex within interleaved array

Standard_Integer	NbElements
	number of the elements (

Standard_Integer	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 Handle< NCollection_BaseAllocator > & theAlloc )

Empty constructor.

Member Function Documentation

◆ Init() [1/2]

bool Graphic3d_AttribBuffer::Init	(	const Standard_Integer	theNbElems,
		const Graphic3d_Array1OfAttribute &	theAttribs )

inline

Allocates new empty array.

◆ Init() [2/2]

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

Allocates new empty array.

◆ Invalidate() [1/4]

virtual void Graphic3d_AttribBuffer::Invalidate ( )

overridevirtual

Invalidate the entire buffer data.

Reimplemented from Graphic3d_Buffer.

◆ Invalidate() [2/4]

void Graphic3d_AttribBuffer::Invalidate ( Standard_Integer theAttributeIndex )

Invalidate the entire attribute data.

◆ Invalidate() [3/4]

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

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

◆ Invalidate() [4/4]

void Graphic3d_AttribBuffer::Invalidate	(	Standard_Integer	theVertexLower,
		Standard_Integer	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()

virtual Graphic3d_BufferRange Graphic3d_AttribBuffer::InvalidatedRange ( ) const

inlineoverridevirtual

Return invalidated range.

Reimplemented from Graphic3d_Buffer.

◆ IsInterleaved()

virtual Standard_Boolean Graphic3d_AttribBuffer::IsInterleaved ( ) const

inlineoverridevirtual

Return TRUE for interleaved array; TRUE by default.

Reimplemented from Graphic3d_Buffer.

◆ IsMutable()

virtual Standard_Boolean Graphic3d_AttribBuffer::IsMutable ( ) const

inlineoverridevirtual

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

Reimplemented from Graphic3d_Buffer.

◆ SetInterleaved()

void Graphic3d_AttribBuffer::SetInterleaved ( Standard_Boolean 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 ( Standard_Boolean theMutable )

Set if data can be invalidated.

◆ Validate()

virtual 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

Standard_Boolean Graphic3d_AttribBuffer::myIsInterleaved

protected

flag indicating the vertex attributes being interleaved

◆ myIsMutable

Standard_Boolean 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

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Graphic3d_AttribBuffer()

Member Function Documentation

◆ Init() [1/2]

◆ Init() [2/2]

◆ Invalidate() [1/4]

◆ Invalidate() [2/4]

◆ Invalidate() [3/4]

◆ Invalidate() [4/4]

◆ invalidate()

◆ InvalidatedRange()

◆ IsInterleaved()

◆ IsMutable()

◆ SetInterleaved()

◆ SetMutable()

◆ Validate()

Field Documentation

◆ myInvalidatedRange

◆ myIsInterleaved

◆ myIsMutable