SoNodeKitListPart(3)

NAME
SoNodeKitListPart - The SoNodeKitListPart class is a container node.

SYNOPSIS

#include <Inventor/nodekits/SoNodeKitListPart.h>

Inherits SoNode.

  Public Member Functions
virtual SoType getTypeId (void) const
SoNodeKitListPart (void)
SoType getContainerType (void) const
void setContainerType (SoType newContainerType)
const SoTypeList & getChildTypes (void) const
void addChildType (SoType typeToAdd)
SbBool isTypePermitted (SoType typeToCheck) const
SbBool isChildPermitted (const SoNode *child) const
void containerSet (const char *fieldDataString)
void lockTypes (void)
SbBool isTypeLocked (void) const
void addChild (SoNode *child)
void insertChild (SoNode *child, int childIndex)
SoNode * getChild (int index) const
int findChild (SoNode *child) const
int getNumChildren (void) const
void removeChild (int index)
void removeChild (SoNode *child)
void replaceChild (int index, SoNode *newChild)
void replaceChild (SoNode *oldChild, SoNode *newChild)
virtual SbBool affectsState (void) const
virtual void doAction (SoAction *action)
virtual void callback (SoCallbackAction *action)
virtual void GLRender (SoGLRenderAction *action)
virtual void getBoundingBox (SoGetBoundingBoxAction *action)
virtual void getMatrix (SoGetMatrixAction *action)
virtual void handleEvent (SoHandleEventAction *action)
virtual void pick (SoPickAction *action)
virtual void search (SoSearchAction *action)
virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
virtual SoChildList * getChildren (void) const

  Static Public Member Functions
static SoType getClassTypeId (void)
static void initClass (void)

  Protected Member Functions
virtual const SoFieldData * getFieldData (void) const
virtual ~SoNodeKitListPart ()
SoGroup * getContainerNode (void)
virtual SbBool readInstance (SoInput *in, unsigned short flags)
virtual void copyContents (const SoFieldContainer *fromFC, SbBool copyConnections)

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

  Protected Attributes
SoChildList * children

  Additional Inherited Members

Detailed Description

The SoNodeKitListPart class is a container node. This node is basically just a container node with these differences versus the other group nodes:

1.  It is possible to make a list of which node class types are allowed as children.

2.  You can freely select which kind of group node behaviour you want this container to have. Default is to act like an SoGroup node, but by using SoNodeKitListPart::setContainerType(), you can change the behaviour to be like a separator, a switch or whatever else you have of node types inheriting SoGroup.

It might be necessary to get the container node, e.g. to change SoSwitch::whichChild if the container node is a SoSwitch. The container node is located in the first position of its children, i.e. (*getChildren())[0]. Note that getNumChildren() returns 0, while getChildren()->getLength() returns 1 after initialization. The former amount returns its internal group nodes, while the latter returns all the nodes containing the container node.

See also
    SoGroup, SoSeparator, SoSwitch

Constructor & Destructor Documentation

  SoNodeKitListPart::SoNodeKitListPart (void)
Constructor.

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

Member Function Documentation

  SoType SoNodeKitListPart::getClassTypeId (void) [static]
This static method returns the SoType object associated with objects of this class.

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

Implements SoBase.

  const SoFieldData ** SoNodeKitListPart::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.
 Returns the SoFieldData class which holds information about fields in this node.

  const SoFieldData * SoNodeKitListPart::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 SoFieldContainer.

  void SoNodeKitListPart::initClass (void) [static]
Does initialization common for all objects of the SoNodeKitListPart class. This includes setting up the type system, among other things.

  SoType SoNodeKitListPart::getContainerType (void) const
Return type id for the list container. Default is SoGroup.

  void SoNodeKitListPart::setContainerType (SoType newContainerType)
Change the behaviour of this container node. newContainerType must be derived from SoGroup.

  const SoTypeList & SoNodeKitListPart::getChildTypes (void) const
Return a list of all types which are allowed as children of this node. Default is to allow all node types.

  void SoNodeKitListPart::addChildType (SoType typeToAdd)
Add one more node class type which should be allowed to be used in the node list.

Note: the default single SoNode type in the list will be removed upon the first call to this method.

  SbBool SoNodeKitListPart::isTypePermitted (SoType typeToCheck) const
Return TRUE if nodes of the typeToCheck class type can be added to the list.

  SbBool SoNodeKitListPart::isChildPermitted (const SoNode * child) const
Return TRUE if child has a class type which is permitted to be in the list.

  void SoNodeKitListPart::containerSet (const char * fieldDataString)
Calls set() on the container node with fieldDataString.

  void SoNodeKitListPart::lockTypes (void)
Lock type list so no more node class types can be added by using addChildType(), and locks container type so it no longer can be changed by setContainerType().

  SbBool SoNodeKitListPart::isTypeLocked (void) const
Returns TRUE if the list of allowable node types and the container type have both been locked.

  void SoNodeKitListPart::addChild (SoNode * child)
Adds child to the internal list of children, if it is of a type permitted to be added.

  void SoNodeKitListPart::insertChild (SoNode * child, int childIndex)
Inserts child in the internal list of children at position childIndex, if it is of a type permitted to be added.

  SoNode * SoNodeKitListPart::getChild (int index) const
Return child node at position index.

  int SoNodeKitListPart::findChild (SoNode * child) const
Return position index of child in list of children.

  int SoNodeKitListPart::getNumChildren (void) const
Return number of children.

  void SoNodeKitListPart::removeChild (int index)

Remove node at childindex in our list of children.

Please note that this method is not virtual in the original SGI Inventor API.

  void SoNodeKitListPart::removeChild (SoNode * child)

Remove child from the set of children managed by this group node. Will decrease the reference count of child by 1.

This is a convenience method. It will simply call findChild() with child as argument, and then call removeChild(int) if the child is found.

Please note that this method is not virtual in the original SGI Inventor API.

  void SoNodeKitListPart::replaceChild (int index, SoNode * newChild)
Replace child at index with newChild, if newChild is of a permitted type.

  void SoNodeKitListPart::replaceChild (SoNode * oldChild, SoNode * newChild)
Replace oldChild with newChild, if newChild is of a permitted type.

  SbBool SoNodeKitListPart::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.

  void SoNodeKitListPart::doAction (SoAction * action) [virtual]
This just 'forwards' the call to the same method at the container node.

Reimplemented from SoNode.

  void SoNodeKitListPart::callback (SoCallbackAction * action) [virtual]
This just 'forwards' the call to the same method at the container node.

Reimplemented from SoNode.

  void SoNodeKitListPart::GLRender (SoGLRenderAction * action) [virtual]
This just 'forwards' the call to the same method at the container node.

Reimplemented from SoNode.

  void SoNodeKitListPart::getBoundingBox (SoGetBoundingBoxAction * action) [virtual]
This just 'forwards' the call to the same method at the container node.

Reimplemented from SoNode.

  void SoNodeKitListPart::getMatrix (SoGetMatrixAction * action) [virtual]
This just 'forwards' the call to the same method at the container node.

Reimplemented from SoNode.

  void SoNodeKitListPart::handleEvent (SoHandleEventAction * action) [virtual]
This just 'forwards' the call to the same method at the container node.

Reimplemented from SoNode.

  void SoNodeKitListPart::pick (SoPickAction * action) [virtual]
This just 'forwards' the call to the same method at the container node.

Reimplemented from SoNode.

  void SoNodeKitListPart::search (SoSearchAction * action) [virtual]
This just 'forwards' the call to the same method at the container node.

Reimplemented from SoNode.

  void SoNodeKitListPart::getPrimitiveCount (SoGetPrimitiveCountAction * action) [virtual]
This just 'forwards' the call to the same method at the container node.

Reimplemented from SoNode.

  SoChildList * SoNodeKitListPart::getChildren (void) const [virtual]
This just 'forwards' the call to the same method at the container node.

Reimplemented from SoNode.

  SoGroup * SoNodeKitListPart::getContainerNode (void) [protected]
Return the SoGroup container which is the parent of all the children which have been added.

  SbBool SoNodeKitListPart::readInstance (SoInput * in, unsigned short flags) [protected], [virtual]
This method is mainly intended for internal use during file import operations.

It reads a definition of an instance from the input stream in. The input stream state points to the start of a serialized / persistent representation of an instance of this class type.

TRUE or FALSE is returned, depending on if the instantiation and configuration of the new object of this class type went OK or not. The import process should be robust and handle corrupted input streams by returning FALSE.

flags is used internally during binary import when reading user extension nodes, group nodes or engines.

Reimplemented from SoNode.

  void SoNodeKitListPart::copyContents (const SoFieldContainer * from, SbBool copyconnections) [protected], [virtual]
Makes a deep copy of all data of from into this instance, except external scene graph references if copyconnections is FALSE.

This is the method that should be overridden by extension node / engine / dragger / whatever subclasses which need to account for internal data that are not handled automatically.

For copying nodes from application code, you should not invoke this function directly, but rather call the SoNode::copy() function:

SoNode * mynewnode = templatenode->copy();

The same also goes for engines.

Make sure that when you override the copyContents() method in your extension class that you also make it call upwards to its parent superclass in the inheritance hierarchy, as copyContents() in for instance SoNode and SoFieldContainer does important work. It should go something like this:

void
MyCoinExtensionNode::copyContents(const SoFieldContainer * from,
                                  SbBool copyconnections)
{
  // let parent superclasses do their thing (copy fields, copy
  // instance name, etc.)
  SoNode::copyContents(from, copyconnections);
  // [..then copy internal data..]
}

Reimplemented from SoNode.

Member Data Documentation

  SoChildList * SoNodeKitListPart::children [protected]
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Author

Generated automatically by Doxygen for Coin from the source code.