Open CASCADE Technology  7.7.0
Public Member Functions | Static Public Member Functions

Graphic3d_Buffer Class Reference

Buffer of vertex attributes. More...

#include <Graphic3d_Buffer.hxx>

Inheritance diagram for Graphic3d_Buffer:
Inheritance graph
[legend]

Public Member Functions

 Graphic3d_Buffer (const Handle< NCollection_BaseAllocator > &theAlloc)
 Empty constructor. More...
 
Standard_Integer NbMaxElements () const
 Return number of initially allocated elements which can fit into this buffer, while NbElements can be overwritten to smaller value. More...
 
const Graphic3d_AttributeAttributesArray () const
 
const Graphic3d_AttributeAttribute (const Standard_Integer theAttribIndex) const
 
Graphic3d_AttributeChangeAttribute (const Standard_Integer theAttribIndex)
 
Standard_Integer FindAttribute (Graphic3d_TypeOfAttribute theAttrib) const
 Find attribute index. More...
 
data accessors for interleaved array
Standard_Integer AttributeOffset (const Standard_Integer theAttribIndex) const
 
const Standard_ByteData (const Standard_Integer theAttribIndex) const
 
Standard_ByteChangeData (const Standard_Integer theAttribIndex)
 
const Standard_Bytevalue (const Standard_Integer theElem) const
 Access specified element. More...
 
Standard_BytechangeValue (const Standard_Integer theElem)
 Access specified element. More...
 
template<typename Type_t >
const Type_t & Value (const Standard_Integer theElem) const
 Access element with specified position and type. More...
 
template<typename Type_t >
Type_t & ChangeValue (const Standard_Integer theElem)
 Access element with specified position and type. More...
 
- 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. More...
 
 ~NCollection_Buffer ()
 Destructor. More...
 
const Standard_ByteData () const
 
Standard_ByteChangeData ()
 
bool IsEmpty () const
 
Standard_Size Size () const
 Return buffer length in bytes. More...
 
const Handle< NCollection_BaseAllocator > & Allocator () const
 
void SetAllocator (const Handle< NCollection_BaseAllocator > &theAlloc)
 Assign new buffer allocator with de-allocation of buffer. More...
 
bool Allocate (const Standard_Size theSize)
 Allocate the buffer. More...
 
void Free ()
 De-allocate buffer. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
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. More...
 
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. More...
 
Standard_TransientThis () 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. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Static Public Member Functions

static const Handle< NCollection_BaseAllocator > & DefaultAllocator ()
 Return default vertex data allocator. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 

general accessors

Standard_Integer Stride
 the distance to the attributes of the next vertex within interleaved array More...
 
Standard_Integer NbElements
 number of the elements ( More...
 
Standard_Integer NbAttributes
 number of vertex attributes More...
 
Standard_ByteChangeAttributeData (Graphic3d_TypeOfAttribute theAttrib, Standard_Integer &theAttribIndex, Standard_Size &theAttribStride)
 Return the attribute data with stride size specific to this attribute. More...
 
const Standard_ByteAttributeData (Graphic3d_TypeOfAttribute theAttrib, Standard_Integer &theAttribIndex, Standard_Size &theAttribStride) const
 Return the attribute data with stride size specific to this attribute. More...
 
void release ()
 Release buffer. More...
 
bool Init (const Standard_Integer theNbElems, const Graphic3d_Attribute *theAttribs, const Standard_Integer theNbAttribs)
 Allocates new empty array. More...
 
bool Init (const Standard_Integer theNbElems, const Graphic3d_Array1OfAttribute &theAttribs)
 Allocates new empty array. More...
 
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). More...
 
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). More...
 
virtual Graphic3d_BufferRange InvalidatedRange () const
 Return invalidated range; EMPTY by default. Requires sub-classing for creating a mutable buffer (advanced usage). More...
 
virtual void Validate ()
 Reset invalidated range. Requires sub-classing for creating a mutable buffer (advanced usage). More...
 
virtual void Invalidate ()
 Invalidate entire buffer. More...
 
virtual void DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const override
 Dumps the content of me into the stream. More...
 
const Standard_ByteData () const
 
Standard_ByteChangeData ()
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Protected Attributes inherited from NCollection_Buffer
Standard_BytemyData
 data pointer More...
 
Standard_Size mySize
 buffer length in bytes More...
 
Handle< NCollection_BaseAllocatormyAllocator
 buffer allocator More...
 

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
theAttribattribute to find
theAttribIndexindex of found attribute
theAttribStridestride 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
theAttribattribute to find
theAttribIndexindex of found attribute
theAttribStridestride 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()

Standard_Byte* Graphic3d_Buffer::changeValue ( const Standard_Integer  theElem)
inline

Access specified element.

◆ ChangeValue()

template<typename Type_t >
Type_t& Graphic3d_Buffer::ChangeValue ( const Standard_Integer  theElem)
inline

Access element with specified position and type.

◆ Data() [1/2]

const Standard_Byte* NCollection_Buffer::Data
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
theAttribattribute 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_MutableIndexBuffer, and Graphic3d_AttribBuffer.

◆ 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_MutableIndexBuffer, and Graphic3d_AttribBuffer.

◆ 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_MutableIndexBuffer, and Graphic3d_AttribBuffer.

◆ 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_MutableIndexBuffer, and Graphic3d_AttribBuffer.

◆ value()

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

Access specified element.

◆ Value()

template<typename Type_t >
const Type_t& Graphic3d_Buffer::Value ( const Standard_Integer  theElem) const
inline

Access element with specified position and type.

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: