Package com.openinventor.inventor.nodekits

Class SoLightKit

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.nodekits.SoBaseKit
com.openinventor.inventor.nodekits.SoLightKit
All Implemented Interfaces:
SafeDisposable
public class SoLightKit extends SoBaseKit
Light nodekit class. This nodekit class is used to create light nodes that have a local transformation and a geometry icon to represent the light source. SoLightKit adds three public parts to the basic nodekit: transform , light , and icon .

SoLightKit creates an SoDirectionalLight as the light part by default - all other parts are NULL at creation.

You can move the light relative to the rest of the scene by creating and editing the transform part.

You can add a geometrical representation for the light by setting the icon part to be any scene graph you like.

SoLightKit also adds two private parts. An SoTransformSeparator contains the effect of transform to move only the light and icon , while allowing the light to illuminate the rest of the scene. The second private part is an SoSeparator, which keeps property nodes within the icon geometry from affecting the rest of the scene. It also serves to cache the icon even when the light or transform is changing.

SoLightKit is derived from SoBaseKit and thus also includes a callbackList part for adding callback nodes.

PARTS

(SoTransform) transform
This part positions and orients the light and icon relative to the rest of the scene. Its effect is kept local to this nodekit by a private part of type SoTransformSeparator. The transform part is NULL by default. If you ask for transform using getPart(), an SoTransform will be returned. But you may set the part to be any subclass of SoTransform. For example, set the transform to be an SoDragPointManip and the light to be an SoPointLight. Then you can move the light by dragging the manipulator with the mouse.

(SoLight) light
The light node for this nodekit. This can be set to any node derived from SoLight. An SoDirectionalLight is created by default, and it is also the type of light returned when the you request that the nodekit build a light for you.

(SoNode) icon
This part is a user-supplied scene graph that represents the light source. It is NULL by default - an SoCube is created by the lightkit when a method requires it to build the part itself.

File format/default:

LightKit {

    callbackList NULL
    transform NULL
    light DirectionalLight {
    }
    icon NULL
}

CATALOG PARTS

All Parts

    Part NamePart TypeDefault TypeNULL Default
    callbackList NodeKitListPart yes
    transform Transform yes
    light Light DirectionalLight no
    icon Node Cube yes

Extra Information for List Parts from Above Table

    Part NameContainer TypePossible Types
    callbackList Separator Callback, EventCallback

See Also:

  • Constructor Details

    • SoLightKit

      public SoLightKit()
      Constructor.

  • Method Details