Open CASCADE Technology 7.8.2.dev
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 Standard_Real theAmbientIntensity=-1., const Standard_Real theShininess=-1., const Standard_Real theTransparency=-1.)
 
Standard_Real AmbientIntensity () const
 
Standard_Real Shininess () const
 
Standard_Real Transparency () const
 
const Quantity_ColorAmbientColor () const
 
const Quantity_ColorDiffuseColor () const
 
const Quantity_ColorEmissiveColor () const
 
const Quantity_ColorSpecularColor () const
 
void SetAmbientIntensity (const Standard_Real theAmbientIntensity)
 
void SetShininess (const Standard_Real theShininess)
 
void SetTransparency (const Standard_Real 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)
 
virtual Handle< VrmlData_NodeClone (const Handle< VrmlData_Node > &theOther) const override
 
virtual VrmlData_ErrorStatus Read (VrmlData_InBuffer &theBuffer) override
 
virtual VrmlData_ErrorStatus Write (const char *thePrefix) const override
 
virtual Standard_Boolean IsDefault () const override
 
- Public Member Functions inherited from VrmlData_Node
 VrmlData_Node ()
 
virtual ~VrmlData_Node ()
 
const VrmlData_SceneScene () const
 
const char * Name () const
 
VrmlData_ErrorStatus ReadNode (VrmlData_InBuffer &theBuffer, Handle< VrmlData_Node > &theNode, const Handle< Standard_Type > &Type=NULL)
 
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 ()
 Destructor must be virtual.
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object.
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type.
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName.
 
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.
 
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.
 
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.
 
Standard_Integer GetRefCount () const noexcept
 Get the reference counter of this object.
 
void IncrementRefCounter () noexcept
 Increments the reference counter of this object.
 
Standard_Integer DecrementRefCounter () noexcept
 Decrements the reference counter of this object; returns the decremented value.
 
virtual void Delete () const
 Memory deallocator for transient classes.
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
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, Standard_Boolean &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 Standard_Boolean OK (const VrmlData_ErrorStatus theStat)
 
static Standard_Boolean OK (VrmlData_ErrorStatus &outStat, const VrmlData_ErrorStatus theStat)
 
static Standard_Integer GlobalIndent ()
 
- Static Public Member Functions inherited from Standard_Transient
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 Standard_Real theAmbientIntensity = -1.,
const Standard_Real theShininess = -1.,
const Standard_Real theTransparency = -1. )

Constructor

Member Function Documentation

◆ AmbientColor()

const Quantity_Color & VrmlData_Material::AmbientColor ( ) const
inline

Query the Ambient color

◆ AmbientIntensity()

Standard_Real VrmlData_Material::AmbientIntensity ( ) const
inline

Query the Ambient Intensity value

◆ Clone()

virtual Handle< VrmlData_Node > VrmlData_Material::Clone ( const 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()

virtual Standard_Boolean VrmlData_Material::IsDefault ( ) const
overridevirtual

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

Reimplemented from VrmlData_Node.

◆ Read()

virtual 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 Standard_Real 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 Standard_Real 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 Standard_Real theTransparency)
inline

Set the Transparency value

◆ Shininess()

Standard_Real VrmlData_Material::Shininess ( ) const
inline

Query the Shininess value

◆ SpecularColor()

const Quantity_Color & VrmlData_Material::SpecularColor ( ) const
inline

Query the Specular color

◆ Transparency()

Standard_Real VrmlData_Material::Transparency ( ) const
inline

Query the Transparency value

◆ Write()

virtual 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: