Coin  4.0.3
Coin3D core library
Loading...
Searching...
No Matches
SoNodeKitListPart Class Reference

The SoNodeKitListPart class is a container node. More...

#include <Inventor/nodekits/SoNodeKitListPart.h>

Inheritance diagram for SoNodeKitListPart:
SoNode SoFieldContainer SoBase

Public Member Functions

 SoNodeKitListPart (void)
 
void addChild (SoNode *child)
 
void addChildType (SoType typeToAdd)
 
virtual SbBool affectsState (void) const
 
virtual void callback (SoCallbackAction *action)
 
void containerSet (const char *fieldDataString)
 
virtual void doAction (SoAction *action)
 
int findChild (SoNode *child) const
 
virtual void getBoundingBox (SoGetBoundingBoxAction *action)
 
SoNodegetChild (int index) const
 
virtual SoChildListgetChildren (void) const
 
const SoTypeListgetChildTypes (void) const
 
SoType getContainerType (void) const
 
virtual void getMatrix (SoGetMatrixAction *action)
 
int getNumChildren (void) const
 
virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
 
virtual SoType getTypeId (void) const
 
virtual void GLRender (SoGLRenderAction *action)
 
virtual void handleEvent (SoHandleEventAction *action)
 
void insertChild (SoNode *child, int childIndex)
 
SbBool isChildPermitted (const SoNode *child) const
 
SbBool isTypeLocked (void) const
 
SbBool isTypePermitted (SoType typeToCheck) const
 
void lockTypes (void)
 
virtual void pick (SoPickAction *action)
 
void removeChild (int index)
 
void removeChild (SoNode *child)
 
void replaceChild (int index, SoNode *newChild)
 
void replaceChild (SoNode *oldChild, SoNode *newChild)
 
virtual void search (SoSearchAction *action)
 
void setContainerType (SoType newContainerType)
 
- Public Member Functions inherited from SoNode
virtual SoNodeaddToCopyDict (void) const
 
virtual void audioRender (SoAudioRenderAction *action)
 
virtual SoNodecopy (SbBool copyconnections=FALSE) const
 
virtual SoFieldContainercopyThroughConnection (void) const
 
SbUniqueId getNodeId (void) const
 
NodeType getNodeType (void) const
 
virtual void GLRenderBelowPath (SoGLRenderAction *action)
 
virtual void GLRenderInPath (SoGLRenderAction *action)
 
virtual void GLRenderOffPath (SoGLRenderAction *action)
 
virtual void grabEventsCleanup (void)
 
virtual void grabEventsSetup (void)
 
SbBool isOverride (void) const
 
virtual void notify (SoNotList *l)
 
virtual void rayPick (SoRayPickAction *action)
 
void setNodeType (const NodeType type)
 
void setOverride (const SbBool state)
 
virtual void startNotify (void)
 
virtual void write (SoWriteAction *action)
 
virtual void writeInstance (SoOutput *out)
 
- Public Member Functions inherited from SoFieldContainer
virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)
 
void copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=FALSE)
 
SbBool enableNotify (const SbBool flag)
 
SbBool fieldsAreEqual (const SoFieldContainer *container) const
 
void get (SbString &fielddata)
 
void get (SbString &fielddata, SoOutput *out)
 
virtual int getAllFields (SoFieldList &l) const
 
virtual SoFieldgetEventIn (const SbName &name) const
 
virtual SoFieldgetEventOut (const SbName &name) const
 
virtual SoFieldgetField (const SbName &name) const
 
SbBool getFieldName (const SoField *const field, SbName &name) const
 
virtual int getFields (SoFieldList &l) const
 
virtual void getFieldsMemorySize (size_t &managed, size_t &unmanaged) const
 
SbBool getIsBuiltIn (void) const
 
voidgetUserData (void) const
 
SbBool hasDefaultValues (void) const
 
SbBool isNotifyEnabled (void) const
 
SbBool set (const char *const fielddata)
 
SbBool set (const char *fielddata, SoInput *input)
 
void setToDefaults (void)
 
void setUserData (void *userdata) const
 
virtual SbBool validateNewFieldValue (SoField *field, void *newval)
 
- Public Member Functions inherited from SoBase
void addAuditor (void *const auditor, const SoNotRec::Type type)
 
void assertAlive (void) const
 
const SoAuditorListgetAuditors (void) const
 
virtual SbName getName (void) const
 
int32_t getRefCount (void) const
 
SbBool isOfType (SoType type) const
 Returns TRUE if the type of this object is either of the same type or inherited from type.
 
void ref (void) const
 
void removeAuditor (void *const auditor, const SoNotRec::Type type)
 
virtual void setName (const SbName &newname)
 
SbBool shouldWrite (void)
 
void touch (void)
 
void unref (void) const
 
void unrefNoDelete (void) const
 

Static Public Member Functions

static SoType getClassTypeId (void)
 
static void initClass (void)
 
- Static Public Member Functions inherited from SoNode
static void audioRenderS (SoAction *action, SoNode *node)
 
static void callbackS (SoAction *action, SoNode *node)
 
static int getActionMethodIndex (const SoType type)
 
static void getBoundingBoxS (SoAction *action, SoNode *node)
 
static SoNodegetByName (const SbName &name)
 
static int getByName (const SbName &name, SoNodeList &l)
 
static SoType getClassTypeId (void)
 
static uint32_t getCompatibilityTypes (const SoType &nodetype)
 
static void getMatrixS (SoAction *action, SoNode *node)
 
static SbUniqueId getNextNodeId (void)
 
static void getPrimitiveCountS (SoAction *action, SoNode *node)
 
static void GLRenderS (SoAction *action, SoNode *node)
 
static void handleEventS (SoAction *action, SoNode *node)
 
static void initClass (void)
 Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
 
static void initClasses (void)
 
static void pickS (SoAction *action, SoNode *node)
 
static void rayPickS (SoAction *action, SoNode *node)
 
static void searchS (SoAction *action, SoNode *node)
 
static void writeS (SoAction *action, SoNode *node)
 
- Static Public Member Functions inherited from SoFieldContainer
static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy)
 
static SoFieldContainercheckCopy (const SoFieldContainer *orig)
 
static void cleanupClass (void)
 
static void copyDone (void)
 
static SoFieldContainerfindCopy (const SoFieldContainer *orig, const SbBool copyconnections)
 
static SoType getClassTypeId (void)
 This static method returns the SoType object associated with objects of this class.
 
static void initClass (void)
 Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
 
static void initCopyDict (void)
 
- Static Public Member Functions inherited from SoBase
static void addName (SoBase *const base, const char *const name)
 
static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)
 
static void decrementCurrentWriteCounter (void)
 
static SoType getClassTypeId (void)
 This static method returns the SoType object associated with objects of this class.
 
static SoBasegetNamedBase (const SbName &name, SoType type)
 
static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type)
 
static SbBool getTraceRefs (void)
 
static void incrementCurrentWriteCounter (void)
 
static void initClass (void)
 Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
 
static SbBool read (SoInput *input, SoBase *&base, SoType expectedtype)
 
static SbBool readRoute (SoInput *input)
 
static void removeName (SoBase *const base, const char *const name)
 
static void setInstancePrefix (const SbString &c)
 
static void setTraceRefs (SbBool trace)
 

Protected Member Functions

virtual ~SoNodeKitListPart ()
 
virtual void copyContents (const SoFieldContainer *fromFC, SbBool copyConnections)
 
SoGroupgetContainerNode (void)
 
virtual const SoFieldDatagetFieldData (void) const
 
virtual SbBool readInstance (SoInput *in, unsigned short flags)
 
- Protected Member Functions inherited from SoNode
 SoNode (void)
 
virtual ~SoNode ()
 
- Protected Member Functions inherited from SoFieldContainer
 SoFieldContainer (void)
 
virtual ~SoFieldContainer ()
 
- Protected Member Functions inherited from SoBase
 SoBase (void)
 
virtual ~SoBase ()
 
virtual SoNotRec createNotRec (void)
 
virtual void destroy (void)
 
virtual const char * getFileFormatName (void) const
 
SbBool hasMultipleWriteRefs (void) const
 
void writeFooter (SoOutput *out) const
 
SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const
 

Static Protected Member Functions

static const SoFieldData ** getFieldDataPtr (void)
 
- Static Protected Member Functions inherited from SoNode
static const SoFieldData ** getFieldDataPtr (void)
 
static int getNextActionMethodIndex (void)
 
static void incNextActionMethodIndex (void)
 
static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask)
 
static void setNextActionMethodIndex (int index)
 
- Static Protected Member Functions inherited from SoBase
static uint32_t getCurrentWriteCounter (void)
 
static void staticDataLock (void)
 
static void staticDataUnlock (void)
 

Protected Attributes

SoChildListchildren
 
- Protected Attributes inherited from SoNode
SbUniqueId uniqueId
 
- Protected Attributes inherited from SoFieldContainer
SbBool isBuiltIn
 

Additional Inherited Members

- Public Types inherited from SoNode
enum  NodeType {
  INVENTOR = 0x0000 , VRML1 = 0x0001 , VRML2 = 0x0002 , INVENTOR_1 = 0x0004 ,
  INVENTOR_2_0 = 0x0008 , INVENTOR_2_1 = 0x0010 , INVENTOR_2_5 = 0x0020 , INVENTOR_2_6 = 0x0040 ,
  COIN_1_0 = 0x0080 , COIN_2_0 = 0x0100 , EXTENSION = 0x0200 , COIN_2_2 = 0x0400 ,
  COIN_2_3 = 0x0800 , COIN_2_4 = 0x1000 , INVENTOR_5_0 = 0x2000 , COIN_2_5 = 0x4000 ,
  COIN_3_0 = 0x8000 , INVENTOR_6_0 = 0x10000 , COIN_4_0 = 0x20000
}
 
- Protected Types inherited from SoBase
enum  BaseFlags { IS_ENGINE = 0x01 , IS_GROUP = 0x02 }
 
- Static Protected Attributes inherited from SoNode
static int nextActionMethodIndex = 0
 
static SbUniqueId nextUniqueId = 1
 

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::SoNodeKitListPart ( void )

Constructor.

◆ ~SoNodeKitListPart()

SoNodeKitListPart::~SoNodeKitListPart ( )
protectedvirtual

Destructor.

Member Function Documentation

◆ addChild()

void SoNodeKitListPart::addChild ( SoNode * child)

Adds child to the internal list of children, if it is of a type permitted to be added.

◆ addChildType()

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.

◆ affectsState()

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.

◆ callback()

void SoNodeKitListPart::callback ( SoCallbackAction * action)
virtual

This just "forwards" the call to the same method at the container node.

Reimplemented from SoNode.

◆ containerSet()

void SoNodeKitListPart::containerSet ( const char * fieldDataString)

Calls set() on the container node with fieldDataString.

◆ copyContents()

void SoNodeKitListPart::copyContents ( const SoFieldContainer * from,
SbBool copyconnections )
protectedvirtual

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:

The SbList class is a template container class for lists.
Definition SbList.h:70
void copy(const SbList< Type > &l)
Definition SbList.h:92
The SoNode class is the base class for nodes used in scene graphs.
Definition SoNode.h:56

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,
{
// let parent superclasses do their thing (copy fields, copy
// instance name, etc.)
// [..then copy internal data..]
}
The SoFieldContainer class is a base class for all classes that contain fields.
Definition SoFieldContainer.h:43
virtual void copyContents(const SoFieldContainer *from, SbBool copyconnections)
Definition SoNode.cpp:1483

Reimplemented from SoNode.

◆ doAction()

void SoNodeKitListPart::doAction ( SoAction * action)
virtual

This just "forwards" the call to the same method at the container node.

Reimplemented from SoNode.

◆ findChild()

int SoNodeKitListPart::findChild ( SoNode * child) const

Return position index of child in list of children.

◆ getBoundingBox()

void SoNodeKitListPart::getBoundingBox ( SoGetBoundingBoxAction * action)
virtual

This just "forwards" the call to the same method at the container node.

Reimplemented from SoNode.

◆ getChild()

SoNode * SoNodeKitListPart::getChild ( int index) const

Return child node at position index.

◆ getChildren()

SoChildList * SoNodeKitListPart::getChildren ( void ) const
virtual

This just "forwards" the call to the same method at the container node.

Reimplemented from SoNode.

◆ getChildTypes()

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.

◆ getClassTypeId()

SoType SoNodeKitListPart::getClassTypeId ( void )
static

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

◆ getContainerNode()

SoGroup * SoNodeKitListPart::getContainerNode ( void )
protected

Return the SoGroup container which is the parent of all the children which have been added.

◆ getContainerType()

SoType SoNodeKitListPart::getContainerType ( void ) const

Return type id for the list container. Default is SoGroup.

◆ getFieldData()

const SoFieldData * SoNodeKitListPart::getFieldData ( void ) const
protectedvirtual

Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, returns NULL.

Reimplemented from SoFieldContainer.

◆ getFieldDataPtr()

const SoFieldData ** SoNodeKitListPart::getFieldDataPtr ( void )
staticprotected

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.

◆ getMatrix()

void SoNodeKitListPart::getMatrix ( SoGetMatrixAction * action)
virtual

This just "forwards" the call to the same method at the container node.

Reimplemented from SoNode.

◆ getNumChildren()

int SoNodeKitListPart::getNumChildren ( void ) const

Return number of children.

◆ getPrimitiveCount()

void SoNodeKitListPart::getPrimitiveCount ( SoGetPrimitiveCountAction * action)
virtual

This just "forwards" the call to the same method at the container node.

Reimplemented from SoNode.

◆ getTypeId()

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.

◆ GLRender()

void SoNodeKitListPart::GLRender ( SoGLRenderAction * action)
virtual

This just "forwards" the call to the same method at the container node.

Reimplemented from SoNode.

◆ handleEvent()

void SoNodeKitListPart::handleEvent ( SoHandleEventAction * action)
virtual

This just "forwards" the call to the same method at the container node.

Reimplemented from SoNode.

◆ initClass()

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.

◆ insertChild()

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.

◆ isChildPermitted()

SbBool SoNodeKitListPart::isChildPermitted ( const SoNode * child) const

Return TRUE if child has a class type which is permitted to be in the list.

◆ isTypeLocked()

SbBool SoNodeKitListPart::isTypeLocked ( void ) const

Returns TRUE if the list of allowable node types and the container type have both been locked.

◆ isTypePermitted()

SbBool SoNodeKitListPart::isTypePermitted ( SoType typeToCheck) const

Return TRUE if nodes of the typeToCheck class type can be added to the list.

◆ lockTypes()

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().

◆ pick()

void SoNodeKitListPart::pick ( SoPickAction * action)
virtual

This just "forwards" the call to the same method at the container node.

Reimplemented from SoNode.

◆ readInstance()

SbBool SoNodeKitListPart::readInstance ( SoInput * in,
unsigned short flags )
protectedvirtual

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.

◆ removeChild() [1/2]

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.

◆ removeChild() [2/2]

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.

◆ replaceChild() [1/2]

void SoNodeKitListPart::replaceChild ( int index,
SoNode * newChild )

Replace child at index with newChild, if newChild is of a permitted type.

◆ replaceChild() [2/2]

void SoNodeKitListPart::replaceChild ( SoNode * oldChild,
SoNode * newChild )

Replace oldChild with newChild, if newChild is of a permitted type.

◆ search()

void SoNodeKitListPart::search ( SoSearchAction * action)
virtual

This just "forwards" the call to the same method at the container node.

Reimplemented from SoNode.

◆ setContainerType()

void SoNodeKitListPart::setContainerType ( SoType newContainerType)

Change the behaviour of this container node. newContainerType must be derived from SoGroup.

Member Data Documentation

◆ children

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.


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