Node that defines the lighting model to use when rendering. More...

#include <Inventor/nodes/SoLightModel.h>

Inheritance diagram for SoLightModel:

Public Types
enum	Model { BASE_COLOR = SoLightModelElement::BASE_COLOR , PHONG = SoLightModelElement::PHONG , PER_VERTEX_PHONG = SoLightModelElement::PER_VERTEX_PHONG , PER_PIXEL_PHONG = SoLightModelElement::PER_PIXEL_PHONG }
	Lighting model. More...

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.

	SoLightModel ()
	Creates a light model node with default settings.

virtual void	setOverride (const SbBool state)
	Set the state of the override field.

virtual SbBool	isOverride () const
	Returns the state of the override field.

Public Member Functions inherited from SoNode
virtual SoNode *	copy (SbBool copyConnections=FALSE) const
	Creates and returns an exact copy of the node.

virtual SbBool	affectsState () const
	Returns TRUE if a node has an effect on the state during traversal.

virtual void	touch ()
	Marks an instance as modified, simulating a change to it.

Public Member Functions inherited from SoFieldContainer
void	setToDefaults ()
	Sets all fields in this object to their default values.

SbBool	hasDefaultValues () const
	Returns TRUE if all of the object's fields have their default values.

SbBool	fieldsAreEqual (const SoFieldContainer *fc) const
	Returns TRUE if this object's fields are exactly equal to fc's fields.

void	copyFieldValues (const SoFieldContainer *fc, SbBool copyConnections=FALSE)
	Copies the contents of fc's fields into this object's fields.

SoNONUNICODE SbBool	set (const char *fieldDataString)
	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.

SbBool	set (const SbString &fieldDataString)
	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.

void	get (SbString &fieldDataString)
	Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.

virtual int	getFields (SoFieldList &list) const
	Appends references to all of this object's fields to resultList, and returns the number of fields appended.

virtual int	getAllFields (SoFieldList &list) const
	Returns a list of fields, including the eventIn's and eventOut's.

virtual SoField *	getField (const SbName &fieldName) const
	Returns a the field of this object whose name is fieldName.

virtual SoField *	getEventIn (const SbName &fieldName) const
	Returns a the eventIn with the given name.

virtual SoField *	getEventOut (const SbName &fieldName) const
	Returns the eventOut with the given name.

SbBool	getFieldName (const SoField *field, SbName &fieldName) const
	Returns the name of the given field in the fieldName argument.

SbBool	enableNotify (SbBool flag)
	Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).

SbBool	isNotifyEnabled () const
	Notification is the process of telling interested objects that this object has changed.

virtual void	setUserData (void *data)
	Sets application data.

void *	getUserData (void) const
	Gets user application data.

Public Member Functions inherited from SoBase
virtual SbName	getName () const
	Returns the name of an instance.

virtual void	setName (const SbName &name)
	Sets the name of an instance.

void	setSynchronizable (const bool b)
	Sets this to be a ScaleViz synchronizable object.

bool	isSynchronizable () const
	Gets the ScaleViz synchronizable state of this object.

Public Member Functions inherited from SoRefCounter
void	ref () const
	Adds a reference to an instance.

void	unref () const
	Removes a reference from an instance.

void	unrefNoDelete () const
	unrefNoDelete() should be called when it is desired to decrement the reference count, but not delete the instance if this brings the reference count to zero.

int	getRefCount () const
	Returns current reference count.

void	lock () const
	lock this instance.

void	unlock () const
	unlock this instance.

Public Member Functions inherited from SoTypedObject
SbBool	isOfType (const SoType &type) const
	Returns TRUE if this object is of the type specified in type or is derived from that type.

template<typename TypedObjectClass >
SbBool	isOfType () const
	Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.

Static Public Member Functions
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Static Public Member Functions inherited from SoNode
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

static SoNode *	getByName (const SbName &name)
	A node's name can be set using SoBase::setName().

static int	getByName (const SbName &name, SoNodeList &list)
	A node's name can be set using SoBase::setName().

Static Public Member Functions inherited from SoFieldContainer
static SoType	getClassTypeId ()
	Returns the type of this class.

Static Public Member Functions inherited from SoBase
static SoType	getClassTypeId ()
	Returns type identifier for this class.

Static Public Member Functions inherited from SoTypedObject
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Public Attributes
SoSFEnum	model
	Lighting model to use Use enum Model.

Detailed Description

Node that defines the lighting model to use when rendering.

This node defines the lighting model to be used when rendering subsequent shapes. The lighting model is specified in the model field.

Lighting is enabled by default (default model is PER_VERTEX_PHONG). When lighting is enabled, there must be light nodes (e.g. SoDirectionalLight) in the scene graph for objects to be easily visible. When using the Open Inventor viewer classes (e.g. SoWinExaminerViewer), the viewer will create a "headlight" (directional light attached to the camera) if no other light nodes exist when setSceneGraph() is called. When using the Open Inventor viewer components (e.g. SceneExaminer), a "headlight" is automatically added to the scene graph.

An SoEnvironment node can be used to specify additional options related to lighting:

The ambient light component of the Phong reflection model.
Light attenuation for SoPointLight and SoSpotLight nodes.
Ambient occlusion.

When model is set to BASE_COLOR, the lighting computation is disabled for subsequent shapes. This can be useful for annotation, data visualization and other special cases.

By default, lighting is only computed for the "front" faces of geometry, so the back face of the geometry will be dark. The front face is determined by the normal vector, if specified, or by the vertex ordering (see SoShapeHints) if normals are computed by Open Inventor. To enable "two sided" lighting (lighting both front and back faces) see SoShapeHints.

VolumeViz:

SoLightModel controls lighting for most VolumeViz shapes, but not for SoVolumeRender. Lighting for volume rendering is controlled by the SoVolumeRenderingQuality node.
Two sided lighting is automatically enabled for "slice" shapes, such as SoOrthoSlice.

FILE FORMAT/DEFAULT

model

PER_VERTEX_PHONG

ACTION BEHAVIOR

SoGLRenderAction

SoCallbackAction

Member Enumeration Documentation

◆ Model

enum SoLightModel::Model

Lighting model.

Enumerator
BASE_COLOR	Use only the base (diffuse) object color. Effectively lighting is turned off and light nodes are not considered.
PHONG	Use Phong lighting model.
PER_VERTEX_PHONG	Use Vertex-based Phong lighting model (default). A lighting computation is done at each vertex of the shape and the color of each pixel (fragment) is determined by interpolating between these values. This model produces less realistic results than pixel-based lighting, especially for Point and Spot lights.
PER_PIXEL_PHONG	Use Pixel-based Phong lighting model. A lighting computation is done for each pixel (fragment) affected by the shape.

Definition at line 129 of file SoLightModel.h.

Constructor & Destructor Documentation

◆ SoLightModel()

SoLightModel::SoLightModel ( )

Creates a light model node with default settings.

Member Function Documentation

◆ getClassTypeId()

static SoType SoLightModel::getClassTypeId ( )

static

Returns the type identifier for this class.

◆ getTypeId()

virtual SoType SoLightModel::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from SoNode.

◆ isOverride()

virtual SbBool SoLightModel::isOverride ( ) const

inlinevirtual

Returns the state of the override field.

Reimplemented from SoNode.

Definition at line 177 of file SoLightModel.h.

◆ setOverride()

virtual void SoLightModel::setOverride ( const SbBool state )

inlinevirtual

Set the state of the override field.

see SoNode::setOverride doc.

Reimplemented from SoNode.

Definition at line 171 of file SoLightModel.h.

Member Data Documentation

◆ model

SoSFEnum SoLightModel::model

Lighting model to use Use enum Model.

Default is PER_VERTEX_PHONG.

Definition at line 160 of file SoLightModel.h.

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

Inventor/nodes/SoLightModel.h

Open Inventor Release 2023.2.3

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

FILE FORMAT/DEFAULT

ACTION BEHAVIOR

SEE ALSO

Member Enumeration Documentation

◆ Model

Constructor & Destructor Documentation

◆ SoLightModel()

Member Function Documentation

◆ getClassTypeId()

◆ getTypeId()

◆ isOverride()

◆ setOverride()

Member Data Documentation

◆ model