SoLightKit Class Reference
[NodeKits]
Light nodekit class. More...
#include <Inventor/nodekits/SoLightKit.h>
Public Member Functions | |
| virtual SoType | getTypeId () const |
| virtual const SoNodekitCatalog * | getNodekitCatalog () const |
| SoLightKit () | |
Static Public Member Functions | |
| static SoType | getClassTypeId () |
| static const SoNodekitCatalog * | getClassNodekitCatalog () |
Detailed Description
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 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 |
SEE ALSO
SoAppearanceKit, SoBaseKit, SoCameraKit, SoNodeKit, SoNodeKitDetail, SoNodeKitListPart, SoNodeKitPath, SoNodekitCatalog, SoSceneKit, SoSeparatorKit, SoShapeKit, SoWrapperKit
Constructor & Destructor Documentation
| SoLightKit::SoLightKit | ( | ) |
Constructor.
Member Function Documentation
| static const SoNodekitCatalog* SoLightKit::getClassNodekitCatalog | ( | ) | [static] |
Returns the SoNodekitCatalog for this class.
Reimplemented from SoBaseKit.
| static SoType SoLightKit::getClassTypeId | ( | ) | [static] |
Returns the type identifier for this class.
Reimplemented from SoBaseKit.
| virtual const SoNodekitCatalog* SoLightKit::getNodekitCatalog | ( | ) | const [virtual] |
Returns the SoNodekitCatalog for this instance.
Reimplemented from SoBaseKit.
| virtual SoType SoLightKit::getTypeId | ( | ) | const [virtual] |
Returns the type identifier for this specific instance.
Reimplemented from SoBaseKit.
The documentation for this class was generated from the following file:
- Inventor/nodekits/SoLightKit.h