OCCT3D OCCT 8.0.1
OCCT documentation

Search guides and API reference

Enter at least two characters.

    Open CASCADE Technology Reference Manual 8.0.1
    Vrml_SFImage Class Reference

    defines SFImage type of VRML field types. More...

    #include <Vrml_SFImage.hxx>

    Inheritance diagram for Vrml_SFImage:

    Public Member Functions

     Vrml_SFImage ()
     Vrml_SFImage (const int aWidth, const int aHeight, const Vrml_SFImageNumber aNumber, const occ::handle< NCollection_HArray1< int > > &anArray)
    void SetWidth (const int aWidth)
    int Width () const
    void SetHeight (const int aHeight)
    int Height () const
    void SetNumber (const Vrml_SFImageNumber aNumber)
    Vrml_SFImageNumber Number () const
    void SetArray (const occ::handle< NCollection_HArray1< int > > &anArray)
    occ::handle< NCollection_HArray1< int > > Array () const
    bool ArrayFlag () const
    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 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.

    Detailed Description

    defines SFImage type of VRML field types.

    Constructor & Destructor Documentation

    ◆ Vrml_SFImage() [1/2]

    Vrml_SFImage::Vrml_SFImage ( )

    ◆ Vrml_SFImage() [2/2]

    Vrml_SFImage::Vrml_SFImage ( const int aWidth,
    const int aHeight,
    const Vrml_SFImageNumber aNumber,
    const occ::handle< NCollection_HArray1< int > > & anArray )

    Member Function Documentation

    ◆ Array()

    occ::handle< NCollection_HArray1< int > > Vrml_SFImage::Array ( ) const

    ◆ ArrayFlag()

    bool Vrml_SFImage::ArrayFlag ( ) const

    ◆ Height()

    int Vrml_SFImage::Height ( ) const

    ◆ Number()

    Vrml_SFImageNumber Vrml_SFImage::Number ( ) const

    ◆ SetArray()

    void Vrml_SFImage::SetArray ( const occ::handle< NCollection_HArray1< int > > & anArray)

    ◆ SetHeight()

    void Vrml_SFImage::SetHeight ( const int aHeight)

    ◆ SetNumber()

    void Vrml_SFImage::SetNumber ( const Vrml_SFImageNumber aNumber)

    ◆ SetWidth()

    void Vrml_SFImage::SetWidth ( const int aWidth)

    ◆ Width()

    int Vrml_SFImage::Width ( ) const

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