OCC Main Page | Visualization | Toolkits | Packages | Class Hierarchy | Data Structures | File List | Data Fields | Globals

Visualization
TKV3d
Graphic3d

Graphic3d_MaterialAspect Class Reference

This class allows the definition of the type of a surface.
Keywords: Material, FillArea, Shininess, Ambient, Color, Diffuse,
Specular, Transparency, Emissive, ReflectionMode,
BackFace, FrontFace, Reflection, Absorbtion
.

#include <Graphic3d_MaterialAspect.hxx>


Public Member Functions

void * operator new (size_t, void *anAddress)
void * operator new (size_t size)
void operator delete (void *anAddress)
Standard_EXPORT Graphic3d_MaterialAspect ()
 Creates a material from default values.
.
Standard_EXPORT Graphic3d_MaterialAspect (const Graphic3d_NameOfMaterial AName)
 Creates a generic material calls <aname>
.
Standard_EXPORT void IncreaseShine (const Standard_Real ADelta)
 Increases or decreases the luminosity of <me>.
<adelta> is a signed percentage.
.
Standard_EXPORT void SetAmbient (const Standard_Real AValue)
 Modifies the reflection properties of the surface.
Category: Methods to modify the class definition
Warning: Raises MaterialDefinitionError if <avalue> is
a negative value or greater than 1.0.
.
Standard_EXPORT void SetDiffuse (const Standard_Real AValue)
 Modifies the reflection properties of the surface.
Category: Methods to modify the class definition
Warning: Raises MaterialDefinitionError if <avalue> is a
negative value or greater than 1.0.
.
Standard_EXPORT void SetEmissive (const Standard_Real AValue)
 Modifies the reflection properties of the surface.
Category: Methods to modify the class definition
Warning: Raises MaterialDefinitionError if <avalue> is a
negative value or greater than 1.0.
.
Standard_EXPORT void SetShininess (const Standard_Real AValue)
 Modifies the luminosity of the surface.
Category: Methods to modify the class definition
Warning: Raises MaterialDefinitionError if <avalue> is a
negative value or greater than 1.0.
.
Standard_EXPORT void SetSpecular (const Standard_Real AValue)
 Modifies the reflection properties of the surface.
Category: Methods to modify the class definition
Warning: Raises MaterialDefinitionError if <avalue> is a
negative value or greater than 1.0.
.
Standard_EXPORT void SetTransparency (const Standard_Real AValue)
 Modifies the transparency coefficient of the surface.
<avalue> = 0. opaque. (default)
<avalue> = 1. transparent.
Transparency is applicable to materials that have at least
one of reflection modes (ambient, diffuse, specular or emissive)
enabled. See also SetReflectionModeOn() and SetReflectionModeOff() methods.

NOTE: In order for transparency specified through this method to
take effect, it is necessary to enable transparency
in the viewer. This can be done either directly -
see Visual3d_ViewManager::SetTransparency(Standard_Boolean),
or indirectly - by calling AIS_InteractiveObject::SetTransparency()
before an object is added to an interactive context, or by
calling AIS_InteractiveContext::SetTransparency() for a given
interactive object already displayed.
Category: Methods to modify the class definition
Warning: Raises MaterialDefinitionError if <avalue> is a
negative value or greater than 1.0.
.
Standard_EXPORT void SetColor (const Quantity_Color &AColor)
 Modifies the ambient colour of the surface.
Category: Methods to modify the class definition
.
Standard_EXPORT void SetAmbientColor (const Quantity_Color &AColor)
 Modifies the ambient colour of the surface.
.
Standard_EXPORT void SetDiffuseColor (const Quantity_Color &AColor)
 Modifies the difuse colour of the surface.
.
Standard_EXPORT void SetSpecularColor (const Quantity_Color &AColor)
 Modifies the specular colour of the surface.
.
Standard_EXPORT void SetEmissiveColor (const Quantity_Color &AColor)
 Modifies the emissive colour of the surface.
.
Standard_EXPORT void SetReflectionModeOn (const Graphic3d_TypeOfReflection AType)
 Activates the reflective properties of the surface <atype>.
.
Standard_EXPORT void SetReflectionModeOff (const Graphic3d_TypeOfReflection AType)
 Deactivates the reflective properties of
the surface <atype>.
.
Standard_EXPORT void SetMaterialType (const Graphic3d_TypeOfMaterial AType)
 Set MyMaterialType to the value of parameter <atype>
.
Standard_EXPORT void SetMaterialName (const Standard_CString AName)
 The current matarial become a "UserDefined" material.
Set the name of the "UserDefined" material.
.
Standard_EXPORT void SetEnvReflexion (const Standard_ShortReal AValue)
Standard_EXPORT void Reset ()
 Resets the material with the original values according to
the material name but leave the current color values untouched
for the material of type ASPECT.
.
Standard_EXPORT Quantity_Color Color () const
 Returns the ambient colour of the surface.
.
Standard_EXPORT Quantity_Color AmbientColor () const
 Returns the ambient colour of the surface.
.
Standard_EXPORT Quantity_Color DiffuseColor () const
 Returns the diffuse colour of the surface.
.
Standard_EXPORT Quantity_Color SpecularColor () const
 Returns the specular colour of the surface.
.
Standard_EXPORT Quantity_Color EmissiveColor () const
 Returns the emissive colour of the surface.
.
Standard_EXPORT Standard_Real Ambient () const
 Returns the reflection properties of the surface.
.
Standard_EXPORT Standard_Real Diffuse () const
 Returns the reflection properties of the surface.
.
Standard_EXPORT Standard_Real Specular () const
 Returns the reflection properties of the surface.
.
Standard_EXPORT Standard_Real Transparency () const
 Returns the transparency coefficient of the surface.
.
Standard_EXPORT Standard_Real Emissive () const
 Returns the emissive coefficient of the surface.
.
Standard_EXPORT Standard_Real Shininess () const
 Returns the luminosity of the surface.
.
Standard_EXPORT Standard_Boolean ReflectionMode (const Graphic3d_TypeOfReflection AType) const
 Returns Standard_True if the reflection mode is active,
Standard_False otherwise.
.
Standard_EXPORT Standard_Boolean MaterialType (const Graphic3d_TypeOfMaterial AType) const
 Returns Standard_True if MyMaterialType equal the parameter AType,
Standard_False otherwise.
.
Standard_EXPORT Standard_ShortReal EnvReflexion () const
Standard_EXPORT Graphic3d_NameOfMaterial Name () const
 Returns the material name.
.
Standard_EXPORT Standard_Boolean IsDifferent (const Graphic3d_MaterialAspect &Other) const
 Returns Standard_True if the materials <me> and
<other> are different.
.
Standard_Boolean operator!= (const Graphic3d_MaterialAspect &Other) const
Standard_EXPORT Standard_Boolean IsEqual (const Graphic3d_MaterialAspect &Other) const
 Returns Standard_True if the materials <me> and
<other> are identical.
.
Standard_Boolean operator== (const Graphic3d_MaterialAspect &Other) const
Standard_EXPORT Standard_CString MaterialName () const
 Returns the name of this material
.

Static Public Member Functions

static Standard_EXPORT Standard_Integer NumberOfMaterials ()
 Returns the number of predefined textures.
.
static Standard_EXPORT Standard_CString MaterialName (const Standard_Integer aRank)
 Returns the name of the predefined material of rank <arank>
Trigger: when <arank> is < 1 or > NumberOfMaterials.
.
static Standard_EXPORT Graphic3d_TypeOfMaterial MaterialType (const Standard_Integer aRank)
 Returns the type of the predefined material of rank <arank>
Trigger: when <arank> is < 1 or > NumberOfMaterials.
.

Private Member Functions

Standard_EXPORT void Init (const Graphic3d_NameOfMaterial AName)

Private Attributes

Standard_ShortReal MyDiffuseCoef
Quantity_Color MyDiffuseColor
Standard_Boolean MyDiffuseActivity
Standard_ShortReal MyAmbientCoef
Quantity_Color MyAmbientColor
Standard_Boolean MyAmbientActivity
Standard_ShortReal MySpecularCoef
Quantity_Color MySpecularColor
Standard_Boolean MySpecularActivity
Standard_ShortReal MyEmissiveCoef
Quantity_Color MyEmissiveColor
Standard_Boolean MyEmissiveActivity
Standard_ShortReal MyTransparencyCoef
Standard_ShortReal MyShininess
Standard_ShortReal MyEnvReflexion
Graphic3d_TypeOfMaterial MyMaterialType
Graphic3d_NameOfMaterial MyMaterialName
Graphic3d_NameOfMaterial MyRequestedMaterialName
TCollection_AsciiString MyStringName

Constructor & Destructor Documentation

Standard_EXPORT Graphic3d_MaterialAspect::Graphic3d_MaterialAspect (   ) 
 

Standard_EXPORT Graphic3d_MaterialAspect::Graphic3d_MaterialAspect (  const Graphic3d_NameOfMaterial  AName  ) 
 

Member Function Documentation

Standard_EXPORT Standard_Real Graphic3d_MaterialAspect::Ambient (   )  const
 

Standard_EXPORT Quantity_Color Graphic3d_MaterialAspect::AmbientColor (   )  const
 

Standard_EXPORT Quantity_Color Graphic3d_MaterialAspect::Color (   )  const
 

Standard_EXPORT Standard_Real Graphic3d_MaterialAspect::Diffuse (   )  const
 

Standard_EXPORT Quantity_Color Graphic3d_MaterialAspect::DiffuseColor (   )  const
 

Standard_EXPORT Standard_Real Graphic3d_MaterialAspect::Emissive (   )  const
 

Standard_EXPORT Quantity_Color Graphic3d_MaterialAspect::EmissiveColor (   )  const
 

Standard_EXPORT Standard_ShortReal Graphic3d_MaterialAspect::EnvReflexion (   )  const
 

Standard_EXPORT void Graphic3d_MaterialAspect::IncreaseShine (  const Standard_Real  ADelta  ) 
 

Standard_EXPORT void Graphic3d_MaterialAspect::Init (  const Graphic3d_NameOfMaterial  AName  )  [private]
 

Standard_EXPORT Standard_Boolean Graphic3d_MaterialAspect::IsDifferent (  const Graphic3d_MaterialAspect &  Other  )  const
 

Standard_EXPORT Standard_Boolean Graphic3d_MaterialAspect::IsEqual (  const Graphic3d_MaterialAspect &  Other  )  const
 

Standard_EXPORT Standard_CString Graphic3d_MaterialAspect::MaterialName (   )  const
 

static Standard_EXPORT Standard_CString Graphic3d_MaterialAspect::MaterialName (  const Standard_Integer  aRank  )  [static]
 

static Standard_EXPORT Graphic3d_TypeOfMaterial Graphic3d_MaterialAspect::MaterialType (  const Standard_Integer  aRank  )  [static]
 

Standard_EXPORT Standard_Boolean Graphic3d_MaterialAspect::MaterialType (  const Graphic3d_TypeOfMaterial  AType  )  const
 

Standard_EXPORT Graphic3d_NameOfMaterial Graphic3d_MaterialAspect::Name (   )  const
 

static Standard_EXPORT Standard_Integer Graphic3d_MaterialAspect::NumberOfMaterials (   )  [static]
 

void Graphic3d_MaterialAspect::operator delete (  void *  anAddress  )  [inline]
 

void* Graphic3d_MaterialAspect::operator new (  size_t  size  )  [inline]
 

void* Graphic3d_MaterialAspect::operator new (  size_t  ,
void *  anAddress
)  [inline]
 

Standard_Boolean Graphic3d_MaterialAspect::operator!= (  const Graphic3d_MaterialAspect &  Other  )  const [inline]
 

Standard_Boolean Graphic3d_MaterialAspect::operator== (  const Graphic3d_MaterialAspect &  Other  )  const [inline]
 

Standard_EXPORT Standard_Boolean Graphic3d_MaterialAspect::ReflectionMode (  const Graphic3d_TypeOfReflection  AType  )  const
 

Standard_EXPORT void Graphic3d_MaterialAspect::Reset (   ) 
 

Standard_EXPORT void Graphic3d_MaterialAspect::SetAmbient (  const Standard_Real  AValue  ) 
 

Standard_EXPORT void Graphic3d_MaterialAspect::SetAmbientColor (  const Quantity_Color &  AColor  ) 
 

Standard_EXPORT void Graphic3d_MaterialAspect::SetColor (  const Quantity_Color &  AColor  ) 
 

Standard_EXPORT void Graphic3d_MaterialAspect::SetDiffuse (  const Standard_Real  AValue  ) 
 

Standard_EXPORT void Graphic3d_MaterialAspect::SetDiffuseColor (  const Quantity_Color &  AColor  ) 
 

Standard_EXPORT void Graphic3d_MaterialAspect::SetEmissive (  const Standard_Real  AValue  ) 
 

Standard_EXPORT void Graphic3d_MaterialAspect::SetEmissiveColor (  const Quantity_Color &  AColor  ) 
 

Standard_EXPORT void Graphic3d_MaterialAspect::SetEnvReflexion (  const Standard_ShortReal  AValue  ) 
 

Standard_EXPORT void Graphic3d_MaterialAspect::SetMaterialName (  const Standard_CString  AName  ) 
 

Standard_EXPORT void Graphic3d_MaterialAspect::SetMaterialType (  const Graphic3d_TypeOfMaterial  AType  ) 
 

Standard_EXPORT void Graphic3d_MaterialAspect::SetReflectionModeOff (  const Graphic3d_TypeOfReflection  AType  ) 
 

Standard_EXPORT void Graphic3d_MaterialAspect::SetReflectionModeOn (  const Graphic3d_TypeOfReflection  AType  ) 
 

Standard_EXPORT void Graphic3d_MaterialAspect::SetShininess (  const Standard_Real  AValue  ) 
 

Standard_EXPORT void Graphic3d_MaterialAspect::SetSpecular (  const Standard_Real  AValue  ) 
 

Standard_EXPORT void Graphic3d_MaterialAspect::SetSpecularColor (  const Quantity_Color &  AColor  ) 
 

Standard_EXPORT void Graphic3d_MaterialAspect::SetTransparency (  const Standard_Real  AValue  ) 
 

Standard_EXPORT Standard_Real Graphic3d_MaterialAspect::Shininess (   )  const
 

Standard_EXPORT Standard_Real Graphic3d_MaterialAspect::Specular (   )  const
 

Standard_EXPORT Quantity_Color Graphic3d_MaterialAspect::SpecularColor (   )  const
 

Standard_EXPORT Standard_Real Graphic3d_MaterialAspect::Transparency (   )  const
 

Field Documentation

Standard_Boolean Graphic3d_MaterialAspect::MyAmbientActivity [private]
 

Standard_ShortReal Graphic3d_MaterialAspect::MyAmbientCoef [private]
 

Quantity_Color Graphic3d_MaterialAspect::MyAmbientColor [private]
 

Standard_Boolean Graphic3d_MaterialAspect::MyDiffuseActivity [private]
 

Standard_ShortReal Graphic3d_MaterialAspect::MyDiffuseCoef [private]
 

Quantity_Color Graphic3d_MaterialAspect::MyDiffuseColor [private]
 

Standard_Boolean Graphic3d_MaterialAspect::MyEmissiveActivity [private]
 

Standard_ShortReal Graphic3d_MaterialAspect::MyEmissiveCoef [private]
 

Quantity_Color Graphic3d_MaterialAspect::MyEmissiveColor [private]
 

Standard_ShortReal Graphic3d_MaterialAspect::MyEnvReflexion [private]
 

Graphic3d_NameOfMaterial Graphic3d_MaterialAspect::MyMaterialName [private]
 

Graphic3d_TypeOfMaterial Graphic3d_MaterialAspect::MyMaterialType [private]
 

Graphic3d_NameOfMaterial Graphic3d_MaterialAspect::MyRequestedMaterialName [private]
 

Standard_ShortReal Graphic3d_MaterialAspect::MyShininess [private]
 

Standard_Boolean Graphic3d_MaterialAspect::MySpecularActivity [private]
 

Standard_ShortReal Graphic3d_MaterialAspect::MySpecularCoef [private]
 

Quantity_Color Graphic3d_MaterialAspect::MySpecularColor [private]
 

TCollection_AsciiString Graphic3d_MaterialAspect::MyStringName [private]
 

Standard_ShortReal Graphic3d_MaterialAspect::MyTransparencyCoef [private]
 

The documentation for this class was generated from the following file:
Generated on Mon Aug 25 13:55:41 2008 for OpenCASCADE by  doxygen 1.4.1