SoVRMLMaterial Class Reference
[VRML97 nodes]

Surface material definition node. More...

#include <Inventor/VRMLnodes/SoVRMLMaterial.h>

Inheritance diagram for SoVRMLMaterial:

Public Member Functions
virtual SoType	getTypeId () const
	SoVRMLMaterial ()
virtual void	setOverride (const SbBool state)
virtual SbBool	isOverride () const
Static Public Member Functions
static SoType	getClassTypeId ()
Public Attributes
SoSFColor	diffuseColor
SoSFFloat	ambientIntensity
SoSFColor	specularColor
SoSFColor	emissiveColor
SoSFFloat	shininess
SoSFFloat	transparency
SoSFColor	reflectiveColor
SoSFBool	receiveShadow

Detailed Description

Surface material definition node.

See the VRML97 Specification, below.

NOTE: This class does not exist in Open Inventor 10.0 and later.

VRML97 SPECIFICATION

This section may reference portions of the VRML97 specification that are not present in this help file. The complete VRML97 spec is available at http://www.web3d.org .

The SoVRMLMaterial node specifies surface material properties for associated geometry nodes and are used by the VRML lighting equations during rendering. See "Concepts - Lighting Model" for a detailed description of the VRML lighting model equations.

All of the fields in the SoVRMLMaterial node range from 0.0 to 1.0.

The fields in the SoVRMLMaterial node determine the way light reflects off an object to create color:

The diffuseColor reflects all VRML light sources depending on the angle of the surface with respect to the light source. The more directly the surface faces the light, the more diffuse light reflects.

The ambientIntensity field specifies how much ambient light from light sources this surface should reflect. Ambient light is omnidirectional and depends only on the number of light sources, not their positions with respect to the surface. Ambient color is calculated as ambientIntensity * diffuseColor.

The specularColor and shininess determine the specular highlights--for example, the shiny spots on an apple. When the angle from the light to the surface is close to the angle from the surface to the viewer, the specularColor is added to the diffuse and ambient color calculations. Lower shininess values produce soft glows, while higher values result in sharper, smaller highlights.

Emissive color models "glowing" objects. This can be useful for displaying radiosity-based models (where the light energy of the room is computed explicitly), or for displaying scientific data.

Transparency is how "clear" the object is, with 1.0 being completely transparent, and 0.0 completely opaque.

FILE FORMAT/DEFAULT

ambientIntensity	0.2
diffuseColor	0.8 0.8 0.8
emissiveColor	0 0 0
shininess	0.2
specularColor	0 0 0
transparency	0
metadata	NULL
reflectiveColor	0 0 0
receiveShadow	FALSE

ACTION BEHAVIOR

SoGLRenderAction

SoCallbackAction

EVENTS

eventIn

SoSFFloat	set_ambientIntensity
SoSFColor	set_diffuseColor
SoSFColor	set_emissiveColor
SoSFFloat	set_shininess
SoSFColor	set_specularColor
SoSFFloat	set_transparency
SoSFNode	set_metadata

eventOut

SoSFFloat	ambientIntensity_changed
SoSFColor	diffuseColor_changed
SoSFColor	emissiveColor_changed
SoSFFloat	shininess_changed
SoSFColor	specularColor_changed
SoSFFloat	transparency_changed
SoSFNode	metadata_changed

Deprecated:: Deprecated since Open Inventor 9500
The VRML API is no longer supported. See section http://oivdoc95.vsg3d.com/content/compatibility-notes-4#Deprecation of the Reference Manual.

Constructor & Destructor Documentation

SoVRMLMaterial::SoVRMLMaterial ( )

Constructor.

Member Function Documentation

static SoType SoVRMLMaterial::getClassTypeId ( ) [static]

Returns the type identifier for this class.

Reimplemented from SoVRMLNode.

virtual SoType SoVRMLMaterial::getTypeId ( ) const [virtual]

Returns the type identifier for this specific instance.

Reimplemented from SoVRMLNode.

virtual SbBool SoVRMLMaterial::isOverride ( ) const [inline, virtual]

Returns the state of the override field.

Reimplemented from SoNode.

virtual void SoVRMLMaterial::setOverride ( const SbBool state ) [inline, virtual]

Set the state of the override field.

see SoNode::setOverride doc.

Reimplemented from SoNode.

Member Data Documentation

SoSFFloat SoVRMLMaterial::ambientIntensity

Specifies how much ambient light from the light sources this surface should reflect.

SoSFColor SoVRMLMaterial::diffuseColor

Diffuse color of the surface.

SoSFColor SoVRMLMaterial::emissiveColor

Emissive color of the surface.

SoSFBool SoVRMLMaterial::receiveShadow

DirectViz parameter.

Indicates that all the shapes using this material node will receive shadows from other shapes when doing DirectViz rendering. This field has no effect when not doing DirectViz rendering. NOTE: This field is not part of the VRML specification.

NOTE: field available since Open Inventor 6.1

SoSFColor SoVRMLMaterial::reflectiveColor

DirectViz parameter.

Reflective color of the shape. When set to black, the object is not reflective. The reflective component is added to the overall color of the object. This field has no effect when not doing DirectViz rendering. NOTE: This field is not part of the VRML specification.

NOTE: field available since Open Inventor 6.1

SoSFFloat SoVRMLMaterial::shininess

Shininess coefficient of the surface.

Values range from 0.0 for no shininess to 1.0 for maximum shininess.

SoSFColor SoVRMLMaterial::specularColor

Specular color of the surface.

SoSFFloat SoVRMLMaterial::transparency

Transparency value of the surface.

Values range from 0.0 for opaque to 1.0 for completely transparent surfaces.