Click or drag to resize
SoGLLightIdElement Class

Note: This API is now obsolete.

Stores the id of the current light.

Inheritance Hierarchy

Namespace: OIV.Inventor.Elements
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 9.9.13.0 (9.9.13.0)
Syntax
Copy
[ObsoleteAttribute("See documentation for more details")]
[EditorBrowsableAttribute(EditorBrowsableState.Never)]
public class SoGLLightIdElement : SoInt32Element

The SoGLLightIdElement type exposes the following members.

Methods
  NameDescription
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodStatic memberGet

Returns current light id from the state.

Public methodStatic memberGetClassStackIndex Obsolete.

Returns the stack id for this element.

Public methodStatic memberGetDefault

Returns the default light id.

Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodStatic memberGetMaxGLSources

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

Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodStatic memberIncrement

Increments the current light id.

Public methodPop

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

(Overrides SoElement.Pop(SoState, SoElement).)
Public methodPush

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

(Overrides SoElement.Push(SoState).)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Remarks

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