SoVRMLMaterial Class

Note: This API is now obsolete.

Surface material definition node.

Inheritance Hierarchy

SystemObject
  OIV.InventorSoNetBase
    OIV.InventorSoDisposable
      OIV.Inventor.MiscSoBase
        OIV.Inventor.FieldsSoFieldContainer
          OIV.Inventor.NodesSoNode
            OIV.Inventor.VRMLnodesSoVRMLNode
              OIV.Inventor.VRMLnodesSoVRMLMaterial

Namespace: OIV.Inventor.VRMLnodes
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 9.9.13.0 (9.9.13.0)

Syntax

C++

Copy

[EditorBrowsableAttribute(EditorBrowsableState.Never)]
[ObsoleteAttribute("See documentation for more details")]
public class SoVRMLMaterial : SoVRMLNode

<EditorBrowsableAttribute(EditorBrowsableState.Never)>
<ObsoleteAttribute("See documentation for more details")>
Public Class SoVRMLMaterial
	Inherits SoVRMLNode

[EditorBrowsableAttribute(EditorBrowsableState::Never)]
[ObsoleteAttribute(L"See documentation for more details")]
public ref class SoVRMLMaterial : public SoVRMLNode

[<EditorBrowsableAttribute(EditorBrowsableState.Never)>]
[<ObsoleteAttribute("See documentation for more details")>]
type SoVRMLMaterial =  
    class
        inherit SoVRMLNode
    end

The SoVRMLMaterial type exposes the following members.

Constructors

	Name	Description
	SoVRMLMaterial	Constructor.

Top

Methods

	Name	Description
	AffectsState	Returns true if a node has an effect on the state during traversal. (Inherited from SoNode.)
	Callback	(Overrides SoNodeCallback(SoCallbackAction).)
	Copy	Calls Copy(false). (Inherited from SoNode.)
	Copy(Boolean)	Creates and returns an exact copy of the node. (Inherited from SoNode.)
	CopyFieldValues(SoFieldContainer)	Calls CopyFieldValues(fc, false). (Inherited from SoFieldContainer.)
	CopyFieldValues(SoFieldContainer, Boolean)	Copies the contents of fc's fields into this object's fields. (Inherited from SoFieldContainer.)
	Dispose	Releases all resources used by SoDisposable. (Inherited from SoDisposable.)
	Distribute	(Inherited from SoNode.)
	DoAction	(Overrides SoNodeDoAction(SoAction).)
	EnableNotify	Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false). (Inherited from SoFieldContainer.)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	FieldsAreEqual	Returns true if this object's fields are exactly equal to fc's fields. (Inherited from SoFieldContainer.)
	Get	Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. (Inherited from SoFieldContainer.)
	GetAllFields	Returns a list of fields, including the eventIn's and eventOut's. (Inherited from SoFieldContainer.)
	GetAlternateRep	This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type). (Inherited from SoNode.)
	GetBoundingBox	(Inherited from SoNode.)
	GetEventIn	Returns a the eventIn with the given name. (Inherited from SoFieldContainer.)
	GetEventOut	Returns the eventOut with the given name. (Inherited from SoFieldContainer.)
	GetField	Returns a the field of this object whose name is fieldName. (Inherited from SoFieldContainer.)
	GetFieldName	Returns the name of the given field in the fieldName argument. (Inherited from SoFieldContainer.)
	GetFields	Appends references to all of this object's fields to resultList, and returns the number of fields appended. (Inherited from SoFieldContainer.)
	GetHashCode	Overrides GetHashCode(). (Inherited from SoNetBase.)
	GetMatrix	(Inherited from SoNode.)
	GetName	Returns the name of an instance. (Inherited from SoBase.)
	GetPrimitiveCount	(Inherited from SoNode.)
	GetRenderUnitID	(Inherited from SoNode.)
	GetStringName	(Inherited from SoBase.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GLRender	(Overrides SoVRMLNodeGLRender(SoGLRenderAction).)
	GLRenderBelowPath	(Inherited from SoNode.)
	GLRenderInPath	(Inherited from SoNode.)
	GLRenderOffPath	(Inherited from SoNode.)
	GrabEventsCleanup	(Inherited from SoNode.)
	GrabEventsSetup	(Inherited from SoNode.)
	HandleEvent	(Inherited from SoNode.)
	HasDefaultValues	Returns true if all of the object's fields have their default values. (Inherited from SoFieldContainer.)
	IsBoundingBoxIgnoring	This method is used by getBoundingBox action traversal to know if the current node must be traversed or not, ie the bounding should be ignored. (Inherited from SoNode.)
	IsNotifyEnabled	Notification is the process of telling interested objects that this object has changed. (Inherited from SoFieldContainer.)
	IsOverride	Returns the state of the override field. (Overrides SoNodeIsOverride.)
	IsSynchronizable	Gets the ScaleViz synchronizable state of this object. (Inherited from SoBase.)
	Pick	(Inherited from SoNode.)
	RayPick	(Inherited from SoNode.)
	Search	(Inherited from SoNode.)
	Set	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format. (Inherited from SoFieldContainer.)
	SetName	(Inherited from SoBase.)
	SetOverride	Set the state of the override field. (Overrides SoNodeSetOverride(Boolean).)
	SetSynchronizable	Sets this to be a ScaleViz synchronizable object. (Inherited from SoBase.)
	SetToDefaults	Sets all fields in this object to their default values. (Inherited from SoFieldContainer.)
	ToString	Converts this SoBase structure to a human readable string. (Inherited from SoBase.)
	Touch	Marks an instance as modified, simulating a change to it. (Inherited from SoNode.)
	Write	(Inherited from SoNode.)

Top

Properties

	Name	Description
	ambientIntensity	Specifies how much ambient light from the light sources this surface should reflect.
	diffuseColor	Diffuse color of the surface.
	emissiveColor	Emissive color of the surface.
	IsDisposable	ISafeDisposable interface implementation. (Inherited from SoDisposable.)
	metadata	Specifies the metadata node. (Inherited from SoVRMLNode.)
	receiveShadow	DirectViz parameter.
	reflectiveColor	DirectViz parameter.
	shininess	Shininess coefficient of the surface.
	specularColor	Specular color of the surface.
	transparency	Transparency value of the surface.
	UserData	Gets or sets the user data to be contained by the field container. (Inherited from SoFieldContainer.)

Top

Remarks

See the VRML97 Specification, below.

<font color="#0000FF">NOTE:</font> This class does not exist in Open Inventor 10.0 and later.

VRML97 SPECIFICATION

This section describes the expected behavior of the node in a conforming VRML97 browser application. In some cases, the application is responsible for implementing portions of the expected behavior. Open Inventor viewer classes and IVF classes implement some of the application behaviors.

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 highlightsfor 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

VRMLMaterial {
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
Obsoletesince 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.

Reference

OIV.Inventor.VRMLnodes Namespace

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

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

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