![]() |
Coin3D is Free Software, published under the BSD 3-clause license. |
https://coin3d.github.io https://www.kongsberg.com/en/kogt/ |
The SoNodeKitListPart class is a container node. More...
#include <Inventor/nodekits/SoNodeKitListPart.h>
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) |
![]() | |
SoNode (void) | |
virtual | ~SoNode () |
![]() | |
SoFieldContainer (void) | |
virtual | ~SoFieldContainer () |
![]() | |
SoBase (void) | |
virtual | ~SoBase () |
virtual void | destroy (void) |
SbBool | hasMultipleWriteRefs (void) const |
SbBool | writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const |
void | writeFooter (SoOutput *out) const |
virtual const char * | getFileFormatName (void) const |
virtual SoNotRec | createNotRec (void) |
Static Protected Member Functions | |
static const SoFieldData ** | getFieldDataPtr (void) |
![]() | |
static const SoFieldData ** | getFieldDataPtr (void) |
static void | setNextActionMethodIndex (int index) |
static int | getNextActionMethodIndex (void) |
static void | incNextActionMethodIndex (void) |
static void | setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask) |
![]() | |
static uint32_t | getCurrentWriteCounter (void) |
static void | staticDataLock (void) |
static void | staticDataUnlock (void) |
Protected Attributes | |
SoChildList * | children |
![]() | |
SbUniqueId | uniqueId |
![]() | |
SbBool | isBuiltIn |
Additional Inherited Members | |
![]() | |
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 } |
![]() | |
enum | BaseFlags { IS_ENGINE = 0x01 , IS_GROUP = 0x02 } |
![]() | |
static SbUniqueId | nextUniqueId = 1 |
static int | nextActionMethodIndex = 0 |
The SoNodeKitListPart class is a container node.
This node is basically just a container node with these differences versus the other group nodes:
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.
SoNodeKitListPart::SoNodeKitListPart | ( | void | ) |
Constructor.
|
protectedvirtual |
Destructor.
This static method returns the SoType object associated with objects of this class.
|
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.
|
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.
Does initialization common for all objects of the SoNodeKitListPart class. This includes setting up the type system, among other things.
Return type id for the list container. Default is SoGroup.
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.
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.
Return TRUE
if child has a class type which is permitted to be in the list.
Calls set() on the container node with fieldDataString.
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.
Adds child to the internal list of children, if it is of a type permitted to be added.
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.
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.
Replace child at index with newChild, if newChild is of a permitted type.
Replace oldChild with newChild, if newChild is of a permitted type.
|
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.
This just "forwards" the call to the same method at the container node.
Reimplemented from SoNode.
|
virtual |
This just "forwards" the call to the same method at the container node.
Reimplemented from SoNode.
|
virtual |
This just "forwards" the call to the same method at the container node.
Reimplemented from SoNode.
|
virtual |
This just "forwards" the call to the same method at the container node.
Reimplemented from SoNode.
|
virtual |
This just "forwards" the call to the same method at the container node.
Reimplemented from SoNode.
|
virtual |
This just "forwards" the call to the same method at the container node.
Reimplemented from SoNode.
|
virtual |
This just "forwards" the call to the same method at the container node.
Reimplemented from SoNode.
|
virtual |
This just "forwards" the call to the same method at the container node.
Reimplemented from SoNode.
|
virtual |
This just "forwards" the call to the same method at the container node.
Reimplemented from SoNode.
|
virtual |
This just "forwards" the call to the same method at the container node.
Reimplemented from SoNode.
Return the SoGroup container which is the parent of all the children which have been added.
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.
|
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 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:
Reimplemented from SoNode.
|
protected |
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.