Class SoLightKit
- java.lang.Object
-
- 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 anSoDirectionalLight
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. AnSoTransformSeparator
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 anSoSeparator
, 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 fromSoBaseKit
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 typeSoTransformSeparator
. The transform part is NULL by default. If you ask for transform usinggetPart()
, anSoTransform
will be returned. But you may set the part to be any subclass ofSoTransform
. For example, set the transform to be an SoDragPointManip and the light to be anSoPointLight
. 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 fromSoLight
. AnSoDirectionalLight
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 - anSoCube
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 Name Part Type Default Type NULL Default callbackList NodeKitListPart yes transform Transform yes light Light DirectionalLight no icon Node Cube yes Extra Information for List Parts from Above Table
Part Name Container Type Possible Types callbackList Separator Callback, EventCallback
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.openinventor.inventor.nodes.SoNode
SoNode.RenderModes
-
Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor
Inventor.ConstructorCommand
-
-
Field Summary
-
Fields inherited from class com.openinventor.inventor.nodekits.SoBaseKit
boundingBoxIgnoring
-
Fields inherited from class com.openinventor.inventor.Inventor
VERBOSE_LEVEL, ZeroHandle
-
-
Constructor Summary
Constructors Constructor Description SoLightKit()
Constructor.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static SoNodekitCatalog
getClassNodekitCatalog()
Returns theSoNodekitCatalog
for this class.-
Methods inherited from class com.openinventor.inventor.nodekits.SoBaseKit
getNodekitCatalog, getPart, getPart, getPartString, getViewportIsEnabled, getViewportOrigin, getViewportSize, isSearchingChildren, set, set, setPart, setSearchingChildren
-
Methods inherited from class com.openinventor.inventor.nodes.SoNode
affectsState, callback, copy, copy, distribute, doAction, getAlternateRep, getBoundingBox, getByName, getMatrix, getPrimitiveCount, getRenderEngineMode, 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, setToDefaults
-
Methods inherited from class com.openinventor.inventor.misc.SoBase
dispose, getName, isDisposable, isSynchronizable, setName, setSynchronizable
-
Methods inherited from class com.openinventor.inventor.Inventor
getNativeResourceHandle
-
-
-
-
Method Detail
-
getClassNodekitCatalog
public static SoNodekitCatalog getClassNodekitCatalog()
Returns theSoNodekitCatalog
for this class.
-
-