com.openinventor.inventor.elements

Class SoGLLightIdElement

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.elements.SoElement

com.openinventor.inventor.elements.SoInt32Element

com.openinventor.inventor.elements.SoGLLightIdElement

Deprecated.

As of Open Inventor 9620 See documentation for more details

public class SoGLLightIdElement
extends SoInt32Element

Stores the id of the current light. This element stores the id of the current light. The first light active in a scene has id 0, the next has 1, and so on. This element can be used to determine how many lights are currently active. The initial value of this element is -1 to indicate that there are no lights active.

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

Note that even though the effects of this element accumulate (each light source increments the id), it is derived from SoInt32Element. This is because each call to increment() effectively does a "get" of the current top instance, so caching knows about the dependency of each instance on the previous one.

See also:

SoDirectionalLight, SoPointLight, SoSpotLight, SoVRMLDirectionalLight, SoVRMLPointLight, SoVRMLSpotLightDeprecated since Open Inventor 9620
SoGLLightIdElement are no longer supported. See section http://oivdoc96.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 inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Method Summary

Modifier and Type	Method and Description
static int	get(SoState state) Deprecated. Returns current light id from the state.
static int	getClassStackIndex() Deprecated. As of Open Inventor 9.3 replaced by SoElement.getClassStackIndex(Class)
static int	getDefault() Deprecated. Returns the default light id.
static int	getMaxGLSources() Deprecated. Returns the maximum number of concurrent light sources supported by GL implementation.
static int	increment(SoState state) Deprecated. Increments the current light id.
void	pop(SoState state, SoElement prevTopElement) Deprecated. Overrides pop() method so side effects can occur in GL.
void	push(SoState state) Deprecated. Overrides push() method to copy values from next instance in the stack.

Methods inherited from class com.openinventor.inventor.elements.SoElement

getClassStackIndex

Methods inherited from class com.openinventor.inventor.Inventor

dispose, getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

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

Method Detail

push

public void push(SoState state)

Deprecated.

Overrides push() method to copy values from next instance in the stack.

Overrides:

push in class SoElement

getDefault

public static int getDefault()

Deprecated.

Returns the default light id.

getMaxGLSources

public static int getMaxGLSources()

Deprecated.

Returns the maximum number of concurrent light sources supported by GL implementation.

get

public static int get(SoState state)

Deprecated.

Returns current light id from the state.

increment

public static int increment(SoState state)

Deprecated.

Increments the current light id. This should be called when a light source becomes active. This returns the new id, or -1 if the maximum number of GL light sources has been exceeded. Otherwise, enables light source.

getClassStackIndex

@Deprecated
public static int getClassStackIndex()

Deprecated. As of Open Inventor 9.3 replaced by SoElement.getClassStackIndex(Class)

Returns the stack id for this element. *

pop

public void pop(SoState state,
                SoElement prevTopElement)

Deprecated.

Overrides pop() method so side effects can occur in GL.

Overrides:

pop in class SoElement