SoSceneKit(3)

NAME
SoSceneKit - The SoSceneKit class collects node kits needed to set up a scene: camera, light and shapes.

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

SYNOPSIS

#include <Inventor/nodekits/SoSceneKit.h>

Inherits SoBaseKit.

  Public Member Functions
virtual SoType getTypeId (void) const
virtual const SoNodekitCatalog * getNodekitCatalog (void) const
SoSceneKit (void)
int getCameraNumber (void)
void setCameraNumber (int camNum)
virtual SbBool affectsState (void) const

  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 ~SoSceneKit ()

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

  Protected Attributes
SoSFNode cameraList
SoSFNode childList
SoSFNode lightList
SoSFNode topSeparator

  Additional Inherited Members

Detailed Description

The SoSceneKit class collects node kits needed to set up a scene: camera, light and shapes.

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

CLASS SoSceneKit
-->"this"
      "callbackList"
-->   "topSeparator"
-->      "cameraList"
-->      "lightList"
-->      "childList"

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

Detailed information on catalog parts:

CLASS SoSceneKit
PVT   "this",  SoSceneKit  ---
      "callbackList",  SoNodeKitListPart [ SoCallback, SoEventCallback ]
PVT   "topSeparator",  SoSeparator  ---
      "cameraList",  SoNodeKitListPart [ SoCameraKit ]
      "lightList",  SoNodeKitListPart [ SoLightKit ]
      "childList",  SoNodeKitListPart [ SoShapeKit, SoSeparatorKit ]

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

Constructor & Destructor Documentation

  SoSceneKit::SoSceneKit (void)
Constructor.

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

Member Function Documentation

  SoType SoSceneKit::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 * SoSceneKit::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 * SoSceneKit::getNodekitCatalog (void) const [virtual]
Returns the nodekit catalog which defines the layout of this class' kit.

Reimplemented from SoBaseKit.

  int SoSceneKit::getCameraNumber (void)
Returns the index of the current active camera in cameraList.

  void SoSceneKit::setCameraNumber (int camnum)
Sets the current active camera in cameraList.

  SbBool SoSceneKit::affectsState (void) const [virtual]
Returns TRUE if the node could have any effect on the state during traversal.

If it returns FALSE, no data in the traversal-state will change from the pre-traversal state to the post-traversal state. The SoSeparator node will for instance return FALSE, as it pushes and pops the state before and after traversal of its children. All SoShape nodes will also return FALSE, as just pushing out geometry data to the rendering engine won't affect the actual rendering state.

The default method returns TRUE, on a 'better safe than sorry' philosophy.

Reimplemented from SoNode.

Author

Generated automatically by Doxygen for Coin from the source code.