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
    VrmlData_Material Class Reference

    #include <VrmlData_Material.hxx>

    Inheritance diagram for VrmlData_Material:

    Public Member Functions

     VrmlData_Material ()
     VrmlData_Material (const VrmlData_Scene &theScene, const char *theName, const double theAmbientIntensity=-1., const double theShininess=-1., const double theTransparency=-1.)
    double AmbientIntensity () const
    double Shininess () const
    double Transparency () const
    const Quantity_ColorAmbientColor () const
    const Quantity_ColorDiffuseColor () const
    const Quantity_ColorEmissiveColor () const
    const Quantity_ColorSpecularColor () const
    void SetAmbientIntensity (const double theAmbientIntensity)
    void SetShininess (const double theShininess)
    void SetTransparency (const double theTransparency)
    void SetAmbientColor (const Quantity_Color &theColor)
    void SetDiffuseColor (const Quantity_Color &theColor)
    void SetEmissiveColor (const Quantity_Color &theColor)
    void SetSpecularColor (const Quantity_Color &theColor)
    occ::handle< VrmlData_NodeClone (const occ::handle< VrmlData_Node > &theOther) const override
    VrmlData_ErrorStatus Read (VrmlData_InBuffer &theBuffer) override
    VrmlData_ErrorStatus Write (const char *thePrefix) const override
    bool IsDefault () const override
    Public Member Functions inherited from VrmlData_Node
     VrmlData_Node ()
     ~VrmlData_Node () override=default
    const VrmlData_SceneScene () const
    const char * Name () const
    VrmlData_ErrorStatus ReadNode (VrmlData_InBuffer &theBuffer, occ::handle< VrmlData_Node > &theNode, const occ::handle< Standard_Type > &Type=nullptr)
    VrmlData_ErrorStatus WriteClosing () 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 Public Member Functions inherited from VrmlData_Node
    static VrmlData_ErrorStatus ReadBoolean (VrmlData_InBuffer &theBuffer, bool &theResult)
    static VrmlData_ErrorStatus ReadString (VrmlData_InBuffer &theBuffer, TCollection_AsciiString &theRes)
    static VrmlData_ErrorStatus ReadMultiString (VrmlData_InBuffer &theBuffer, NCollection_List< TCollection_AsciiString > &theRes)
    static VrmlData_ErrorStatus ReadInteger (VrmlData_InBuffer &theBuffer, long &theResult)
    static bool OK (const VrmlData_ErrorStatus theStat)
    static bool OK (VrmlData_ErrorStatus &outStat, const VrmlData_ErrorStatus theStat)
    static int GlobalIndent ()
    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.
    Protected Member Functions inherited from VrmlData_Node
     VrmlData_Node (const VrmlData_Scene &theScene, const char *theName)
    Static Protected Member Functions inherited from VrmlData_Node
    static VrmlData_ErrorStatus readBrace (VrmlData_InBuffer &theBuffer)

    Detailed Description

    Implementation of the Material node

    Constructor & Destructor Documentation

    ◆ VrmlData_Material() [1/2]

    VrmlData_Material::VrmlData_Material ( )

    Empty constructor

    ◆ VrmlData_Material() [2/2]

    VrmlData_Material::VrmlData_Material ( const VrmlData_Scene & theScene,
    const char * theName,
    const double theAmbientIntensity = -1.,
    const double theShininess = -1.,
    const double theTransparency = -1. )

    Constructor

    Member Function Documentation

    ◆ AmbientColor()

    const Quantity_Color & VrmlData_Material::AmbientColor ( ) const
    inline

    Query the Ambient color

    ◆ AmbientIntensity()

    double VrmlData_Material::AmbientIntensity ( ) const
    inline

    Query the Ambient Intensity value

    ◆ Clone()

    occ::handle< VrmlData_Node > VrmlData_Material::Clone ( const occ::handle< VrmlData_Node > & theOther) const
    overridevirtual

    Create a copy of this node. If the parameter is null, a new copied node is created. Otherwise new node is not created, but rather the given one is modified.

    Reimplemented from VrmlData_Node.

    ◆ DiffuseColor()

    const Quantity_Color & VrmlData_Material::DiffuseColor ( ) const
    inline

    Query the Diffuse color

    ◆ EmissiveColor()

    const Quantity_Color & VrmlData_Material::EmissiveColor ( ) const
    inline

    Query the Emissive color

    ◆ IsDefault()

    bool VrmlData_Material::IsDefault ( ) const
    overridevirtual

    Returns True if the node is default, so that it should not be written.

    Reimplemented from VrmlData_Node.

    ◆ Read()

    VrmlData_ErrorStatus VrmlData_Material::Read ( VrmlData_InBuffer & theBuffer)
    overridevirtual

    Read the Node from input stream.

    Implements VrmlData_Node.

    ◆ SetAmbientColor()

    void VrmlData_Material::SetAmbientColor ( const Quantity_Color & theColor)
    inline

    Query the Ambient color

    ◆ SetAmbientIntensity()

    void VrmlData_Material::SetAmbientIntensity ( const double theAmbientIntensity)
    inline

    Set the Ambient Intensity value

    ◆ SetDiffuseColor()

    void VrmlData_Material::SetDiffuseColor ( const Quantity_Color & theColor)
    inline

    Query the Diffuse color

    ◆ SetEmissiveColor()

    void VrmlData_Material::SetEmissiveColor ( const Quantity_Color & theColor)
    inline

    Query the Emissive color

    ◆ SetShininess()

    void VrmlData_Material::SetShininess ( const double theShininess)
    inline

    Set the Shininess value

    ◆ SetSpecularColor()

    void VrmlData_Material::SetSpecularColor ( const Quantity_Color & theColor)
    inline

    Query the Specular color

    ◆ SetTransparency()

    void VrmlData_Material::SetTransparency ( const double theTransparency)
    inline

    Set the Transparency value

    ◆ Shininess()

    double VrmlData_Material::Shininess ( ) const
    inline

    Query the Shininess value

    ◆ SpecularColor()

    const Quantity_Color & VrmlData_Material::SpecularColor ( ) const
    inline

    Query the Specular color

    ◆ Transparency()

    double VrmlData_Material::Transparency ( ) const
    inline

    Query the Transparency value

    ◆ Write()

    VrmlData_ErrorStatus VrmlData_Material::Write ( const char * thePrefix) const
    overridevirtual

    Write the Node to the Scene output.

    Reimplemented from VrmlData_Node.


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