Buffer of vertex attributes. More...

#include <Graphic3d_Buffer.hxx>

Inheritance diagram for Graphic3d_Buffer:

[legend]

Public Member Functions
	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.

data accessors for interleaved array
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.

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.

Static Public Member Functions
static const 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.

general accessors
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

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 Standard_Boolean	IsInterleaved () const
	Flag indicating that attributes in the buffer are interleaved; TRUE by default. Requires sub-classing for creating a non-interleaved buffer (advanced usage).

virtual Standard_Boolean	IsMutable () const
	Return TRUE if data can be invalidated; FALSE by default. Requires sub-classing for creating a mutable buffer (advanced usage).

virtual Graphic3d_BufferRange	InvalidatedRange () const
	Return invalidated range; EMPTY by default. Requires sub-classing for creating a mutable buffer (advanced usage).

virtual void	Validate ()
	Reset invalidated range. Requires sub-classing for creating a mutable buffer (advanced usage).

virtual void	Invalidate ()
	Invalidate entire buffer.

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

Standard_Byte *	ChangeData ()

const Standard_Byte *	Data () const

Additional Inherited Members
typedef void	base_type
	Returns a type descriptor about this object.

Protected Attributes inherited from NCollection_Buffer
Standard_Byte *	myData
	data pointer

Standard_Size	mySize
	buffer length in bytes

Handle< NCollection_BaseAllocator >	myAllocator
	buffer allocator

Detailed Description

Buffer of vertex attributes.

Constructor & Destructor Documentation

◆ Graphic3d_Buffer()

Graphic3d_Buffer::Graphic3d_Buffer ( const Handle< NCollection_BaseAllocator > & theAlloc )

inline

Empty constructor.

Member Function Documentation

◆ Attribute()

const Graphic3d_Attribute & Graphic3d_Buffer::Attribute ( const Standard_Integer theAttribIndex ) const

inline

Returns: attribute definition

◆ AttributeData()

const Standard_Byte * Graphic3d_Buffer::AttributeData	(	Graphic3d_TypeOfAttribute	theAttrib,
		Standard_Integer &	theAttribIndex,
		Standard_Size &	theAttribStride ) const

inline

Return the attribute data with stride size specific to this attribute.

Parameters

theAttrib	attribute to find
theAttribIndex	index of found attribute
theAttribStride	stride in bytes between values of this attribute within returned data pointer

◆ AttributeOffset()

Standard_Integer Graphic3d_Buffer::AttributeOffset ( const Standard_Integer theAttribIndex ) const

inline

Returns: data offset to specified attribute

◆ AttributesArray()

const Graphic3d_Attribute * Graphic3d_Buffer::AttributesArray ( ) const

inline

Returns: array of attributes definitions

◆ ChangeAttribute()

Graphic3d_Attribute & Graphic3d_Buffer::ChangeAttribute ( const Standard_Integer theAttribIndex )

inline

Returns: attribute definition

◆ ChangeAttributeData()

Standard_Byte * Graphic3d_Buffer::ChangeAttributeData	(	Graphic3d_TypeOfAttribute	theAttrib,
		Standard_Integer &	theAttribIndex,
		Standard_Size &	theAttribStride )

inline

Return the attribute data with stride size specific to this attribute.

Parameters

theAttrib	attribute to find
theAttribIndex	index of found attribute
theAttribStride	stride in bytes between values of this attribute within returned data pointer

◆ ChangeData() [1/2]

Standard_Byte * NCollection_Buffer::ChangeData ( )

inline

Returns: buffer data

◆ ChangeData() [2/2]

Standard_Byte * Graphic3d_Buffer::ChangeData ( const Standard_Integer theAttribIndex )

inline

Returns: data for specified attribute

◆ ChangeValue()

template<typename Type_t>

Type_t & Graphic3d_Buffer::ChangeValue ( const Standard_Integer theElem )

inline

Access element with specified position and type.

◆ changeValue()

Standard_Byte * Graphic3d_Buffer::changeValue ( const Standard_Integer theElem )

inline

Access specified element.

◆ Data() [1/2]

const Standard_Byte * NCollection_Buffer::Data ( ) const

inline

Returns: buffer data

◆ Data() [2/2]

const Standard_Byte * Graphic3d_Buffer::Data ( const Standard_Integer theAttribIndex ) const

inline

Returns: data for specified attribute

◆ DefaultAllocator()

static const Handle< NCollection_BaseAllocator > & Graphic3d_Buffer::DefaultAllocator ( )

static

Return default vertex data allocator.

◆ DumpJson()

virtual void Graphic3d_Buffer::DumpJson	(	Standard_OStream &	theOStream,
		Standard_Integer	theDepth = -1 ) const

overridevirtual

Dumps the content of me into the stream.

Reimplemented from NCollection_Buffer.

Reimplemented in Graphic3d_IndexBuffer.

◆ FindAttribute()

Standard_Integer Graphic3d_Buffer::FindAttribute ( Graphic3d_TypeOfAttribute theAttrib ) const

inline

Find attribute index.

Parameters

theAttrib attribute to find

Returns: attribute index or -1 if not found

◆ Init() [1/2]

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

inline

Allocates new empty array.

◆ Init() [2/2]

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

inline

Allocates new empty array.

◆ Invalidate()

virtual void Graphic3d_Buffer::Invalidate ( )

inlinevirtual

Invalidate entire buffer.

Reimplemented in Graphic3d_AttribBuffer, and Graphic3d_MutableIndexBuffer.

◆ InvalidatedRange()

virtual Graphic3d_BufferRange Graphic3d_Buffer::InvalidatedRange ( ) const

inlinevirtual

Return invalidated range; EMPTY by default. Requires sub-classing for creating a mutable buffer (advanced usage).

Reimplemented in Graphic3d_AttribBuffer, and Graphic3d_MutableIndexBuffer.

◆ IsInterleaved()

virtual Standard_Boolean Graphic3d_Buffer::IsInterleaved ( ) const

inlinevirtual

Flag indicating that attributes in the buffer are interleaved; TRUE by default. Requires sub-classing for creating a non-interleaved buffer (advanced usage).

Reimplemented in Graphic3d_AttribBuffer.

◆ IsMutable()

virtual Standard_Boolean Graphic3d_Buffer::IsMutable ( ) const

inlinevirtual

Return TRUE if data can be invalidated; FALSE by default. Requires sub-classing for creating a mutable buffer (advanced usage).

Reimplemented in Graphic3d_AttribBuffer, and Graphic3d_MutableIndexBuffer.

◆ NbMaxElements()

Standard_Integer Graphic3d_Buffer::NbMaxElements ( ) const

inline

Return number of initially allocated elements which can fit into this buffer, while NbElements can be overwritten to smaller value.

◆ release()

void Graphic3d_Buffer::release ( )

inline

Release buffer.

◆ Validate()

virtual void Graphic3d_Buffer::Validate ( )

inlinevirtual

Reset invalidated range. Requires sub-classing for creating a mutable buffer (advanced usage).

Reimplemented in Graphic3d_AttribBuffer, and Graphic3d_MutableIndexBuffer.

◆ Value()

template<typename Type_t>

const Type_t & Graphic3d_Buffer::Value ( const Standard_Integer theElem ) const

inline

Access element with specified position and type.

◆ value()

const Standard_Byte * Graphic3d_Buffer::value ( const Standard_Integer theElem ) const

inline

Access specified element.

Field Documentation

◆ NbAttributes

Standard_Integer Graphic3d_Buffer::NbAttributes

number of vertex attributes

◆ NbElements

Standard_Integer Graphic3d_Buffer::NbElements

number of the elements (

See also: NbMaxElements() specifying the number of initially allocated number of elements)

◆ Stride

Standard_Integer Graphic3d_Buffer::Stride

the distance to the attributes of the next vertex within interleaved array

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

Graphic3d_Buffer.hxx

Public Member Functions

Static Public Member Functions

general accessors

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Graphic3d_Buffer()

Member Function Documentation

◆ Attribute()

◆ AttributeData()

◆ AttributeOffset()

◆ AttributesArray()

◆ ChangeAttribute()

◆ ChangeAttributeData()

◆ ChangeData() [1/2]

◆ ChangeData() [2/2]

◆ ChangeValue()

◆ changeValue()

◆ Data() [1/2]

◆ Data() [2/2]

◆ DefaultAllocator()

◆ DumpJson()

◆ FindAttribute()

◆ Init() [1/2]

◆ Init() [2/2]

◆ Invalidate()

◆ InvalidatedRange()

◆ IsInterleaved()

◆ IsMutable()

◆ NbMaxElements()

◆ release()

◆ Validate()

◆ Value()

◆ value()

Field Documentation

◆ NbAttributes

◆ NbElements

◆ Stride