Open CASCADE Technology  7.6.0
Public Member Functions | Protected Attributes

Graphic3d_MutableIndexBuffer Class Reference

Mutable index buffer. More...

#include <Graphic3d_MutableIndexBuffer.hxx>

Inheritance diagram for Graphic3d_MutableIndexBuffer:
Inheritance graph
[legend]

Public Member Functions

 Graphic3d_MutableIndexBuffer (const Handle< NCollection_BaseAllocator > &theAlloc)
 Empty constructor. More...
 
virtual Standard_Boolean IsMutable () const override
 Return TRUE if data can be invalidated. More...
 
virtual Graphic3d_BufferRange InvalidatedRange () const override
 Return invalidated range. More...
 
virtual void Validate () override
 Reset invalidated range. More...
 
virtual void Invalidate () override
 Invalidate the entire buffer data. More...
 
void Invalidate (Standard_Integer theIndexLower, Standard_Integer theIndexUpper)
 Invalidate the given indexes (starting from 0) More...
 
void invalidate (const Graphic3d_BufferRange &theRange)
 Invalidate specified sub-range of data (as byte offsets). More...
 
- Public Member Functions inherited from Graphic3d_IndexBuffer
 Graphic3d_IndexBuffer (const Handle< NCollection_BaseAllocator > &theAlloc)
 Empty constructor. More...
 
template<typename IndexType_t >
bool Init (const Standard_Integer theNbElems)
 Allocates new empty index array. More...
 
bool InitInt32 (const Standard_Integer theNbElems)
 Allocates new empty index array. More...
 
Standard_Integer Index (const Standard_Integer theIndex) const
 Access index at specified position. More...
 
void SetIndex (const Standard_Integer theIndex, const Standard_Integer theValue)
 Change index at specified position. More...
 
virtual void DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const override
 Dumps the content of me into the stream. More...
 
- Public Member Functions inherited from Graphic3d_Buffer
 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...
 
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...
 
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...
 
const Standard_ByteData () const
 
Standard_ByteChangeData ()
 
- 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...
 

Protected Attributes

Graphic3d_BufferRange myInvalidatedRange
 invalidated buffer data range (as byte offsets) 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...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Static Public Member Functions inherited from Graphic3d_Buffer
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...
 
- Data Fields inherited from Graphic3d_Buffer
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...
 

Detailed Description

Mutable index buffer.

Constructor & Destructor Documentation

◆ Graphic3d_MutableIndexBuffer()

Graphic3d_MutableIndexBuffer::Graphic3d_MutableIndexBuffer ( const Handle< NCollection_BaseAllocator > &  theAlloc)
inline

Empty constructor.

Member Function Documentation

◆ Invalidate() [1/2]

virtual void Graphic3d_MutableIndexBuffer::Invalidate ( )
inlineoverridevirtual

Invalidate the entire buffer data.

Reimplemented from Graphic3d_Buffer.

◆ invalidate()

void Graphic3d_MutableIndexBuffer::invalidate ( const Graphic3d_BufferRange theRange)
inline

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

◆ Invalidate() [2/2]

void Graphic3d_MutableIndexBuffer::Invalidate ( Standard_Integer  theIndexLower,
Standard_Integer  theIndexUpper 
)
inline

Invalidate the given indexes (starting from 0)

◆ InvalidatedRange()

virtual Graphic3d_BufferRange Graphic3d_MutableIndexBuffer::InvalidatedRange ( ) const
inlineoverridevirtual

Return invalidated range.

Reimplemented from Graphic3d_Buffer.

◆ IsMutable()

virtual Standard_Boolean Graphic3d_MutableIndexBuffer::IsMutable ( ) const
inlineoverridevirtual

Return TRUE if data can be invalidated.

Reimplemented from Graphic3d_Buffer.

◆ Validate()

virtual void Graphic3d_MutableIndexBuffer::Validate ( )
inlineoverridevirtual

Reset invalidated range.

Reimplemented from Graphic3d_Buffer.

Field Documentation

◆ myInvalidatedRange

Graphic3d_BufferRange Graphic3d_MutableIndexBuffer::myInvalidatedRange
protected

invalidated buffer data range (as byte offsets)


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