SoMFNode Class Reference

Multiple-value field containing any number of nodes. More...

#include <Inventor/fields/SoMFNode.h>

Inheritance diagram for SoMFNode:
SoMField SoField SoTypedObject

List of all members.

Public Member Functions

virtual SoType getTypeId () const
const SoMFNodeoperator= (const SoMFNode &f)
 SoMFNode ()
virtual ~SoMFNode ()
SoNodeoperator[] (int i) const
const SoNode ** getValues (int start) const
int find (SoNode *targetValue, SbBool addIfNotFound=FALSE)
void setValues (int start, int num, const SoNode **newValues)
void set1Value (int index, SoNode *newValue)
void setValue (SoNode *newValue)
SoNodeoperator= (SoNode *newValue)
int operator== (const SoMFNode &f) const
int operator!= (const SoMFNode &f) const
virtual void enableDeleteValues ()
virtual void disableDeleteValues ()
virtual SbBool isDeleteValuesEnabled ()
virtual size_t getValueSize () const
void setValuesPointer (int num, const SoNode **userData)
void setValuesPointer (int num, SoNode **userData)
void addNode (SoNode *node)
void insertNode (SoNode *node, int newNodeIndex)
SoNodegetNode (int index) const
int findNode (const SoNode *node) const
int getNumNodes () const
void removeNode (int index)
void removeNode (SoNode *node)
void removeAllNodes ()
void replaceNode (int index, SoNode *newNode)
void replaceNode (SoNode *oldNode, SoNode *newNode)
SoNode ** startEditing ()
void finishEditing ()

Static Public Member Functions

static SoType getClassTypeId ()

Detailed Description

Multiple-value field containing any number of nodes.

This field maintains a set of SoNode instances , correctly maintaining their reference counts.

SoMFNodes are written to file as one or more nodes. When more than one value is present, all of the values are enclosed in square brackets and separated by commas; for example:

     [ Cube {} , Sphere { radius 2.0 }, USE myTranslation ]

Data copying:

SoMF fields are a kind of "smart container", automatically expanding as necessary to hold the data provided by the application. This is very convenient, but for large blocks of data it may be desireable to avoid making a copy of the application data. The setValuesPointer() methods allow Open Inventor to directly use an array of values supplied by the application. The application data is not copied. Please see SoMFVec3f for more information and example code.

Constructor & Destructor Documentation

SoMFNode::SoMFNode (  ) 

Default constructor.

virtual SoMFNode::~SoMFNode (  )  [virtual]


Member Function Documentation

void SoMFNode::addNode ( SoNode node  ) 

Adds a node as last one in group.

virtual void SoMFNode::disableDeleteValues (  )  [inline, virtual]

Temporary disable value deleting.

virtual void SoMFNode::enableDeleteValues (  )  [inline, virtual]

Sets the enableDeleteValues flag.

This flag (if TRUE) allows Open Inventor to destroy the user data array given to setValuesPointer(). This user data array will be managed exactly like internal field data values. Default is FALSE.

int SoMFNode::find ( SoNode targetValue,
SbBool  addIfNotFound = FALSE 

Finds the given targetValue in the array and returns the index of that value.

in the array. If the value is not found, -1 is returned. If addIfNotFound is set, then targetValue is added to the end of the array (but -1 is still returned).

int SoMFNode::findNode ( const SoNode node  )  const

Finds index of given node within group.

void SoMFNode::finishEditing (  ) 

Indicates that batch edits have finished.

See also:
static SoType SoMFNode::getClassTypeId (  )  [static]

Returns the type identifier for this class.

Reimplemented from SoMField.

SoNode* SoMFNode::getNode ( int  index  )  const

Returns pointer to nth node node.

int SoMFNode::getNumNodes (  )  const

Returns number of nodes.

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

Returns the type identifier for this specific instance.

Implements SoTypedObject.

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

Returns a pointer into the array of values in the field, starting at index start.

The values are read-only. See the startEditing()/finishEditing() methods for a way of modifying values in place.

virtual size_t SoMFNode::getValueSize (  )  const [inline, virtual]

Get size of the value.

Reimplemented from SoField.

void SoMFNode::insertNode ( SoNode node,
int  newNodeIndex 

Adds a node so that it becomes the one with the given index.

virtual SbBool SoMFNode::isDeleteValuesEnabled (  )  [inline, virtual]

Returns FALSE if user data array has been given to.

setValuesPointer() and enableDeleteValues() has never been called, and memory for data has not been reallocated. Otherwise, returns TRUE.

int SoMFNode::operator!= ( const SoMFNode f  )  const [inline]

Returns TRUE if all of the values of this field do not equal.

those of the given f. If the fields are different types TRUE will always be returned.

Reimplemented from SoField.

SoNode* SoMFNode::operator= ( SoNode newValue  )  [inline]

Sets the first value in the array to newValue, and deletes.

the second and subsequent values.

const SoMFNode& SoMFNode::operator= ( const SoMFNode f  ) 

Copy from another field of same type.

int SoMFNode::operator== ( const SoMFNode f  )  const

Returns TRUE if all of the values of this field equal those of.

the given f. If the fields are different types FALSE will always be returned.

Reimplemented from SoField.

SoNode* SoMFNode::operator[] ( int  i  )  const [inline]

Returns the i'th value of the field.

Indexing past the end of the field (passing in i greater than getNum()) will return garbage.

void SoMFNode::removeAllNodes (  ) 

Removes all nodes from group.

void SoMFNode::removeNode ( SoNode node  )  [inline]

Removes first instance of given node from group.

void SoMFNode::removeNode ( int  index  ) 

Removes node with given index from group.

void SoMFNode::replaceNode ( SoNode oldNode,
SoNode newNode 
) [inline]

Replaces first instance of given node with new node.

void SoMFNode::replaceNode ( int  index,
SoNode newNode 

Replaces node with given index with new node.

void SoMFNode::set1Value ( int  index,
SoNode newValue 

Sets the index'th value in the array to newValue.

The array will be automatically expanded, if necessary.

void SoMFNode::setValue ( SoNode newValue  ) 

Sets the first value in the array to newValue, and deletes.

the second and subsequent values.

void SoMFNode::setValues ( int  start,
int  num,
const SoNode **  newValues 

Sets num values starting at index start to the values.

in newValues. The array will automatically be made larger to accommodate the new values, if necessary.

void SoMFNode::setValuesPointer ( int  num,
SoNode **  userData 
void SoMFNode::setValuesPointer ( int  num,
const SoNode **  userData 

Sets the field to contain the num values stored in userData array.

This array will not be copied into the field: it will be directly used by the field. If num and userData are not correctly specified, the results are undefined (and probably undesirable). param num is the number of values that userData contains and must be a positive integer. param userData is an array allocated by malloc or realloc and can be deallocated by free (no constructor or destructor is called). userData must not be NULL. Its size must be at least num*sizeof(valueType).

SoNode** SoMFNode::startEditing (  ) 

Returns a pointer to the internally maintained array that can be modified.

The values in the array may be changed, but values cannot be added or removed. It is illegal to call any other editing methods between startEditing() and finishEditing() (e.g. set1Value(), setValue(), etc.).

Fields, engines or sensors connected to this field and sensors are not notified that this field has changed until finishEditing() is called. Calling finishEditing() always sets the isDefault() flag to FALSE and informs engines and sensors that the field changed, even if none of the values actually were changed.

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

Open Inventor Toolkit reference manual, generated on 31 Jan 2023
Copyright © Thermo Fisher Scientific All rights reserved.