com.openinventor.inventor.vrmlnodes

Class SoVRMLPointLight

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.misc.SoBase

com.openinventor.inventor.fields.SoFieldContainer

com.openinventor.inventor.nodes.SoNode

com.openinventor.inventor.vrmlnodes.SoVRMLNode

com.openinventor.inventor.vrmlnodes.SoVRMLLight

com.openinventor.inventor.vrmlnodes.SoVRMLPointLight

All Implemented Interfaces:

SafeDisposable

Direct Known Subclasses:

SoDirectVizPointLight

Deprecated.

As of Open Inventor 9500 See documentation for more details

public class SoVRMLPointLight
extends SoVRMLLight

Node representing a point light source. The SoVRMLPointLight node specifies a point light source at a 3D location in the local coordinate system. A point source emits light equally in all directions; that is, it is omnidirectional. SoVRMLPointLights are specified in their local coordinate system and are affected by parent transformations.

Note: SoVRMLPointLights only illuminate objects in their enclosing parent group (similar to Directional lights). This is a slight deviation from the behavior described by the VRML97 specification.

<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 SoVRMLPointLight node specifies a point light source at a 3D location in the local coordinate system. A point source emits light equally in all directions; that is, it is omnidirectional. SoVRMLPointLights are specified in their local coordinate system and are affected by parent transformations.

See "Concepts - Light Sources" for a detailed description of the ambientIntensity , color , and intensity fields.

A SoVRMLPointLight may illuminate geometry within radius (>= 0.0) meters of its location. Both radius and location are affected by parent transformations (scale radius and transform location).

A SoVRMLPointLight's illumination falls off with distance as specified by three attenuation coefficients. The attenuation factor is 1/( attenuation [0] + attenuation [1]*r + attenuation [2]*r^2) , where r is the distance of the light to the surface being illuminated. The default is no attenuation. An attenuation value of 0 0 0 is identical to 1 0 0 . Attenuation values must be >= 0.0. Renderers that do not support a full attenuation model may approximate as necessary. See "Concepts - Lighting Model" for a detailed description of VRML's lighting equations.

File format/default:

VRMLPointLight {

ambientIntensity	0
attenuation	1 0 0
color	1 1 1
intensity	1
location	0 0 0
on	true
radius	100
metadata	NULL

}

Action behavior:

SoGLRenderAction
Sets: SoGLLightIdElement

EVENTS

eventIn

SoSFFloat	set_ambientIntensity
SoSFVec3f	set_attenuation
SoSFColor	set_color
SoSFFloat	set_intensity
SoSFVec3f	set_location
SoSFBool	set_on
SoSFFloat	set_radius (Note: Not implemented)
SoSFNode	set_metadata

eventOut

SoSFFloat	ambientIntensity_changed
SoSFVec3f	attenuation_changed
SoSFColor	color_changed
SoSFFloat	intensity_changed
SoSFVec3f	location_changed
SoSFBool	on_changed
SoSFFloat	radius_changed (Note: Not implemented)
SoSFNode	metadata_changed

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.

Nested Class Summary

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Inventor.ConstructorCommand

Field Summary

Fields

Modifier and Type	Field and Description
SoSFVec3f	attenuation Deprecated. Attenuation coefficients.
SoSFVec3f	location Deprecated. Location of the source.
SoSFFloat	radius Deprecated. (Note: Not implemented) Meters from the location the light can illuminate.

Fields inherited from class com.openinventor.inventor.vrmlnodes.SoVRMLLight

ambientIntensity, color, intensity, on

Fields inherited from class com.openinventor.inventor.vrmlnodes.SoVRMLNode

metadata

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
SoVRMLPointLight() Deprecated. Constructor.

Method Summary

Methods inherited from class com.openinventor.inventor.nodes.SoNode

affectsState, callback, copy, copy, distribute, doAction, getAlternateRep, getBoundingBox, getByName, getMatrix, getPrimitiveCount, getRenderUnitID, GLRender, GLRenderBelowPath, GLRenderInPath, GLRenderOffPath, grabEventsCleanup, grabEventsSetup, handleEvent, isBoundingBoxIgnoring, isOverride, pick, rayPick, search, setOverride, touch, write

Methods inherited from class com.openinventor.inventor.fields.SoFieldContainer

copyFieldValues, copyFieldValues, enableNotify, fieldsAreEqual, get, getAllFields, getEventIn, getEventOut, getField, getFieldName, hasDefaultValues, isNotifyEnabled, set, setToDefaults

Methods inherited from class com.openinventor.inventor.misc.SoBase

dispose, getEXTERNPROTO, getName, getPROTO, isDisposable, isSynchronizable, setName, setSynchronizable

Methods inherited from class com.openinventor.inventor.Inventor

getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

location

public final SoSFVec3f location

Deprecated.

Location of the source.

radius

public final SoSFFloat radius

Deprecated.

(Note: Not implemented) Meters from the location the light can illuminate.

attenuation

public final SoSFVec3f attenuation

Deprecated.

Attenuation coefficients.

Constructor Detail

SoVRMLPointLight

public SoVRMLPointLight()

Deprecated.

Constructor.