NAME

       SoLightKit -

       The SoLightKit class provides a kit with a transform, a light and a shape or subgraph.

       Node kit structure (new entries versus parent class marked with arrow prefix):

SYNOPSIS

       #include <Inventor/nodekits/SoLightKit.h>

       Inherits SoBaseKit.

   Public Member Functions
       virtual SoType getTypeId (void) const
           Returns the type identification of an object derived from a class inheriting SoBase.
           This is used for run-time type checking and 'downward' casting.
       virtual const SoNodekitCatalog * getNodekitCatalog (void) const
       SoLightKit (void)

   Static Public Member Functions
       static SoType getClassTypeId (void)
       static const SoNodekitCatalog * getClassNodekitCatalog (void)
       static void initClass (void)

   Protected Member Functions
       virtual const SoFieldData * getFieldData (void) const
       virtual ~SoLightKit ()

   Static Protected Member Functions
       static const SoFieldData ** getFieldDataPtr (void)
       static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void)

   Protected Attributes
       SoSFNode icon
       SoSFNode iconSeparator
       SoSFNode light
       SoSFNode transform
       SoSFNode transformGroup

   Additional Inherited Members

Detailed Description

       The SoLightKit class provides a kit with a transform, a light and a shape or subgraph.

       Node kit structure (new entries versus parent class marked with arrow prefix):

       CLASS SoLightKit
       -->"this"
             "callbackList"
       -->   "transformGroup"
       -->      "transform"
       -->      "light"
       -->      "iconSeparator"
       -->         "icon"

       (See SoBaseKit::printDiagram() for information about the output formatting.)

       Detailed information on catalog parts:

       CLASS SoLightKit
       PVT   "this",  SoLightKit  ---
             "callbackList",  SoNodeKitListPart [ SoCallback, SoEventCallback ]
       PVT   "transformGroup",  SoTransformSeparator  ---
             "transform",  SoTransform  ---
             "light",  SoLight  --- , (default type = SoDirectionalLight)
       PVT   "iconSeparator",  SoSeparator  ---
             "icon",  SoNode  --- , (default type = SoCube)

       (See SoBaseKit::printTable() for information about the output formatting.)

Constructor & Destructor Documentation

   SoLightKit::SoLightKit (void)
       Constructor.

   SoLightKit::~SoLightKit () [protected],  [virtual]
       Destructor.

Member Function Documentation

   SoType SoLightKit::getTypeId (void) const [virtual]
       Returns the type identification of an object derived from a class inheriting SoBase. This
       is used for run-time type checking and 'downward' casting. Usage example:

       void foo(SoNode * node)
       {
         if (node->getTypeId() == SoFile::getClassTypeId()) {
           SoFile * filenode = (SoFile *)node;  // safe downward cast, knows the type
         }
       }

       For application programmers wanting to extend the library with new nodes, engines,
       nodekits, draggers or others: this method needs to be overridden in all subclasses. This
       is typically done as part of setting up the full type system for extension classes, which
       is usually accomplished by using the pre-defined macros available through for instance
       Inventor/nodes/SoSubNode.h (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes),
       Inventor/engines/SoSubEngine.h (for engine classes) and so on.

       For more information on writing Coin extensions, see the class documentation of the
       toplevel superclasses for the various class groups.

       Reimplemented from SoBaseKit.

   const SoFieldData * SoLightKit::getFieldData (void) const [protected],  [virtual]
       Returns a pointer to the class-wide field data storage object for this instance. If no
       fields are present, returns NULL.

       Reimplemented from SoBaseKit.

   const SoNodekitCatalog * SoLightKit::getNodekitCatalog (void) const [virtual]
       Returns the nodekit catalog which defines the layout of this class' kit.

       Reimplemented from SoBaseKit.

Author

       Generated automatically by Doxygen for Coin from the source code.