Coin Logo http://www.sim.no
http://www.coin3d.org

Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | Related Pages

SoWrapperKit Class Reference
[Node Kits]

#include <Inventor/nodekits/SoWrapperKit.h>

Inheritance diagram for SoWrapperKit:

SoSeparatorKit SoBaseKit SoNode SoFieldContainer SoBase List of all members.

Detailed Description

The SoWrapperKit class is a simple kit for wrapping a transform and a sub-graph.

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

  CLASS SoWrapperKit
  -->"this"
        "callbackList"
        "topSeparator"
           "pickStyle"
           "appearance"
           "units"
           "transform"
           "texture2Transform"
           "childList"
  -->      "localTransform"
  -->      "contents"
  

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

Detailed information on catalog parts:

  CLASS SoWrapperKit
  PVT   "this",  SoWrapperKit  --- 
        "callbackList",  SoNodeKitListPart [ SoCallback, SoEventCallback ] 
  PVT   "topSeparator",  SoSeparator  --- 
        "pickStyle",  SoPickStyle  --- 
        "appearance",  SoAppearanceKit  --- 
        "units",  SoUnits  --- 
        "transform",  SoTransform  --- 
        "texture2Transform",  SoTexture2Transform  --- 
        "childList",  SoNodeKitListPart [ SoShapeKit, SoSeparatorKit ] 
        "localTransform",  SoTransform  --- 
        "contents",  SoSeparator  --- 
  

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


Public Member Functions

virtual SoType getTypeId (void) const
virtual const SoNodekitCataloggetNodekitCatalog (void) const
 SoWrapperKit (void)

Static Public Member Functions

static SoType getClassTypeId (void)
static const SoNodekitCataloggetClassNodekitCatalog (void)
static void initClass (void)

Protected Member Functions

virtual const SoFieldDatagetFieldData (void) const
virtual ~SoWrapperKit ()

Static Protected Member Functions

static const SoFieldData ** getFieldDataPtr (void)
static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void)

Protected Attributes

SoSFNode contents
SoSFNode localTransform


Constructor & Destructor Documentation

SoWrapperKit::SoWrapperKit void   ) 
 

Constructor.

SoWrapperKit::~SoWrapperKit  )  [protected, virtual]
 

Destructor.


Member Function Documentation

SoType SoWrapperKit::getClassTypeId void   )  [static]
 

This static method returns the SoType object associated with objects of this class.

Reimplemented from SoSeparatorKit.

SoType SoWrapperKit::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
    }
    else if (node->getTypeId().isOfType(SoGroup::getClassTypeId())) {
      SoGroup * group = (SoGroup *)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 SoSeparatorKit.

const SoFieldData ** SoWrapperKit::getFieldDataPtr void   )  [static, protected]
 

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Reimplemented from SoSeparatorKit.

const SoFieldData * SoWrapperKit::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 SoSeparatorKit.

const SoNodekitCatalog * SoWrapperKit::getClassNodekitCatalog void   )  [static]
 

Returns the nodekit catalog which defines the layout of this class' kit.

Reimplemented from SoSeparatorKit.

const SoNodekitCatalog * SoWrapperKit::getNodekitCatalog void   )  const [virtual]
 

Returns the nodekit catalog which defines the layout of this class' kit.

Reimplemented from SoSeparatorKit.

const SoNodekitCatalog ** SoWrapperKit::getClassNodekitCatalogPtr void   )  [static, protected]
 

Returns the pointer to the pointer of the nodekit catalog for this class.

Reimplemented from SoSeparatorKit.

void SoWrapperKit::initClass void   )  [static]
 

Does initialization common for all objects of the SoSeparatorKit class. This includes setting up the type system, among other things.

Reimplemented from SoSeparatorKit.


The documentation for this class was generated from the following files:

Copyright © 1998-2005 by Systems in Motion AS. All rights reserved.

Generated on Tue May 30 14:36:04 2006 for Coin by Doxygen. 1.4.4