OCCT 8.0.1
OCCT documentation

Search guides and API reference

Enter at least two characters.

    Open CASCADE Technology Reference Manual 8.0.1
    Graphic3d_IndexBuffer Class Reference

    Index buffer. More...

    #include <Graphic3d_IndexBuffer.hxx>

    Inheritance diagram for Graphic3d_IndexBuffer:

    Public Member Functions

     Graphic3d_IndexBuffer (const occ::handle< NCollection_BaseAllocator > &theAlloc)
     Empty constructor.
    template<typename IndexType_t>
    bool Init (const int theNbElems)
     Allocates new empty index array.
    bool InitInt32 (const int theNbElems)
     Allocates new empty index array.
    int Index (const int theIndex) const
     Access index at specified position.
    void SetIndex (const int theIndex, const int theValue)
     Change index at specified position.
    void DumpJson (Standard_OStream &theOStream, int theDepth=-1) const override
     Dumps the content of me into the stream.
    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_AttributeAttributesArray () const
    const Graphic3d_AttributeAttribute (const int theAttribIndex) const
    Graphic3d_AttributeChangeAttribute (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.
    virtual bool 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 bool 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.
    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_Transientoperator= (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_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.
    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.

    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
    Protected Attributes inherited from NCollection_Buffer
    uint8_t * myData
     data pointer
    size_t mySize
     buffer length in bytes
    occ::handle< NCollection_BaseAllocatormyAllocator
     buffer allocator

    Detailed Description

    Index buffer.

    Constructor & Destructor Documentation

    ◆ Graphic3d_IndexBuffer()

    Graphic3d_IndexBuffer::Graphic3d_IndexBuffer ( const occ::handle< NCollection_BaseAllocator > & theAlloc)
    inline

    Empty constructor.

    Member Function Documentation

    ◆ DumpJson()

    void Graphic3d_IndexBuffer::DumpJson ( Standard_OStream & theOStream,
    int theDepth = -1 ) const
    inlineoverridevirtual

    Dumps the content of me into the stream.

    Reimplemented from Graphic3d_Buffer.

    ◆ Index()

    int Graphic3d_IndexBuffer::Index ( const int theIndex) const
    inline

    Access index at specified position.

    ◆ Init()

    template<typename IndexType_t>
    bool Graphic3d_IndexBuffer::Init ( const int theNbElems)
    inline

    Allocates new empty index array.

    ◆ InitInt32()

    bool Graphic3d_IndexBuffer::InitInt32 ( const int theNbElems)
    inline

    Allocates new empty index array.

    ◆ SetIndex()

    void Graphic3d_IndexBuffer::SetIndex ( const int theIndex,
    const int theValue )
    inline

    Change index at specified position.


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