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

SoMFNode Class Reference
[Field classes]

The SoMFNode class is a container for nodes.

This field container stores an array of pointers to nodes. It takes care of the necessary functionality for handling copy, import and export operations. More...

#include <Inventor/fields/SoMFNode.h>

Inheritance diagram for SoMFNode:

SoMField SoField

List of all members.

Public Member Functions

virtual SoType getTypeId (void) const
virtual void copyFrom (const SoField &field)
const SoMFNodeoperator= (const SoMFNode &field)
virtual SbBool isSame (const SoField &field) const
SoNodeoperator[] (const int idx) const
const SoNode ** getValues (const int start) const
int find (SoNode *value, SbBool addifnotfound=0)
void setValues (const int start, const int num, const SoNode **newvals)
void set1Value (const int idx, SoNode *value)
void setValue (SoNode *value)
SoNodeoperator= (SoNode *val)
SbBool operator== (const SoMFNode &field) const
SbBool operator!= (const SoMFNode &field) const
SoNode ** startEditing (void)
void finishEditing (void)
virtual void fixCopy (SbBool copyconnections)
virtual SbBool referencesCopy (void) const
void addNode (SoNode *node)
void insertNode (SoNode *node, int idx)
SoNodegetNode (int idx) const
int findNode (const SoNode *node) const
int getNumNodes (void) const
void removeNode (int index)
void removeNode (SoNode *node)
void removeAllNodes (void)
void replaceNode (int idx, SoNode *newnode)
void replaceNode (SoNode *oldnode, SoNode *newnode)
virtual void deleteValues (int start, int num=-1)
virtual void insertSpace (int start, int num)

Static Public Member Functions

static void * createInstance (void)
static SoType getClassTypeId (void)
static void initClass (void)

Protected Member Functions

virtual void deleteAllValues (void)
virtual void copyValue (int to, int from)
virtual int fieldSizeof (void) const
virtual void * valuesPtr (void)
virtual void setValuesPtr (void *ptr)
virtual void allocValues (int num)

Protected Attributes

SoNode ** values


Detailed Description

The SoMFNode class is a container for nodes.

This field container stores an array of pointers to nodes. It takes care of the necessary functionality for handling copy, import and export operations.

Note that node pointers stored in field instances of this type may be NULL pointers.

See also:
SoNode, SoSFNode

Member Function Documentation

SoType SoMFNode::getClassTypeId ( void   )  [static]

Returns a unique type identifier for this field class.

See also:
getTypeId(), SoType

Reimplemented from SoMField.

SoType SoMFNode::getTypeId ( void   )  const [virtual]

Returns the type identification instance which uniquely identifies the Coin field class the object belongs to.

See also:
getClassTypeId(), SoType

Implements SoField.

void SoMFNode::copyFrom ( const SoField f  )  [virtual]

Copy value(s) from f into this field. f must be of the same type as this field.

Implements SoField.

SbBool SoMFNode::isSame ( const SoField f  )  const [virtual]

Check for equal type and value(s).

Implements SoField.

const SoNode* * SoMFNode::getValues ( const int  start  )  const [inline]

\ Returns a pointer to the values array. \

Referenced by findNode(), SoVRMLSwitch::getChildren(), SoVRMLParent::getChildren(), SoVRMLLOD::getChildren(), and getNode().

void SoMFNode::initClass ( void   )  [static]

Internal method called upon initialization of the library (from SoDB::init()) to set up the type system.

Reimplemented from SoMField.

void SoMFNode::fixCopy ( SbBool  copyconnections  )  [virtual]

This method is internally called after SoField::copyFrom() during scene graph copies, and should do the operations necessary for fixing up the field instance after it has gotten a new value.

The default method in the SoField superclass does nothing.

The application programmer should normally not need to consider this method, unless he constructs a complex field type which contains new references to container instances (i.e. nodes or engines). Overriding this method is then necessary to update the reference pointers, as they could have been duplicated during the copy operation.

Reimplemented from SoField.

References SoBase::assertAlive(), SoNode::copy(), SoField::enableNotify(), SoFieldContainer::findCopy(), SoMField::getNum(), and SoField::valueChanged().

SbBool SoMFNode::referencesCopy ( void   )  const [virtual]

Returns TRUE if this field has references to any containers in the scene graph which are also duplicated during the copy operation.

Note that this method only is valid to call during copy operations.

See also the note about the relevance of the fixCopy() method for application programmers, as it is applicable on this method aswell.

Reimplemented from SoField.

References SoFieldContainer::checkCopy(), SoMField::getNum(), and SoField::referencesCopy().

void SoMFNode::addNode ( SoNode node  ) 

Adds a node at the end of the array.

This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

Since:
Coin 2.0

References SoMField::getNum().

Referenced by SoVRMLSwitch::addChild(), SoVRMLParent::addChild(), and SoVRMLLOD::addChild().

void SoMFNode::insertNode ( SoNode node,
int  idx 
)

Inserts a node at index idx.

This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

Since:
Coin 2.0

References SoMField::getNum(), and insertSpace().

Referenced by SoVRMLSwitch::insertChild(), SoVRMLParent::insertChild(), and SoVRMLLOD::insertChild().

SoNode * SoMFNode::getNode ( int  idx  )  const

Returns the node at index idx.

This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

Since:
Coin 2.0

References SoMField::getNum(), and getValues().

Referenced by SoVRMLSwitch::getChild(), SoVRMLParent::getChild(), and SoVRMLLOD::getChild().

int SoMFNode::findNode ( const SoNode node  )  const

Returns the index for the first instance of node in the field, or -1 if not found.

This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

Since:
Coin 2.0

References SoMField::getNum(), and getValues().

Referenced by SoVRMLSwitch::findChild(), SoVRMLParent::findChild(), SoVRMLLOD::findChild(), removeNode(), and replaceNode().

int SoMFNode::getNumNodes ( void   )  const

Returns the number of nodes in this field.

This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

Since:
Coin 2.0

References SoMField::getNum().

Referenced by SoVRMLSwitch::getNumChildren(), SoVRMLParent::getNumChildren(), and SoVRMLLOD::getNumChildren().

void SoMFNode::removeNode ( int  idx  ) 

Removes the node at index idx.

This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

Since:
Coin 2.0

References deleteValues(), and SoMField::getNum().

Referenced by SoVRMLSwitch::removeChild(), SoVRMLParent::removeChild(), SoVRMLLOD::removeChild(), and removeNode().

void SoMFNode::removeNode ( SoNode node  ) 

Removes the first instance of node in the field.

This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

Since:
Coin 2.0

References findNode(), and removeNode().

void SoMFNode::removeAllNodes ( void   ) 

Removes all nodes from the field.

This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

Since:
Coin 2.0

References SoMField::setNum().

Referenced by SoVRMLSwitch::removeAllChildren(), SoVRMLParent::removeAllChildren(), and SoVRMLLOD::removeAllChildren().

void SoMFNode::replaceNode ( int  idx,
SoNode newnode 
)

Replaces the node at index idx with newnode.

This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

Since:
Coin 2.0

References SoMField::getNum().

Referenced by SoVRMLSwitch::replaceChild(), SoVRMLParent::replaceChild(), SoVRMLLOD::replaceChild(), and replaceNode().

void SoMFNode::replaceNode ( SoNode oldnode,
SoNode newnode 
)

Replaces the first instance of oldnode with newnode.

This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

Since:
Coin 2.0

References findNode(), and replaceNode().

virtual void SoMFNode::deleteValues ( int  start,
int  numarg = -1 
) [virtual]

Remove value elements from index start up to and including index start + num - 1.

Elements with indices larger than the last deleted element will be moved downwards in the value array.

If num equals -1, delete from index start and to the end of the array.

Reimplemented from SoMField.

Referenced by removeNode().

virtual void SoMFNode::insertSpace ( int  start,
int  numarg 
) [virtual]

Insert num "slots" for new value elements from start. The elements already present from start will be moved "upward" in the extended array.

Reimplemented from SoMField.

Referenced by insertNode().


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

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

Generated on Mon Feb 23 16:33:53 2009 for Coin by Doxygen. 1.5.8