SoMFFieldContainer Class Reference

Multiple-value field containing any number of pointers to fieldContainers. More...

#include <Inventor/fields/SoMFFieldContainer.h>

Inheritance diagram for SoMFFieldContainer:
SoMField SoField SoTypedObject

List of all members.

Public Member Functions

virtual SoType getTypeId () const
const SoMFFieldContaineroperator= (const SoMFFieldContainer &f)
 SoMFFieldContainer ()
virtual ~SoMFFieldContainer ()
SoFieldContaineroperator[] (int i) const
const SoFieldContainer ** getValues (int start) const
int find (SoFieldContainer *targetValue, SbBool addIfNotFound=FALSE)
void setValues (int start, int num, const SoFieldContainer **newValues)
void set1Value (int index, SoFieldContainer *newValue)
void setValue (SoFieldContainer *newValue)
SoFieldContaineroperator= (SoFieldContainer *newValue)
int operator== (const SoMFFieldContainer &f) const
int operator!= (const SoMFFieldContainer &f) const
virtual void enableDeleteValues ()
virtual void disableDeleteValues ()
virtual SbBool isDeleteValuesEnabled ()
virtual size_t getValueSize () const
void setValuesPointer (int num, const SoFieldContainer **userData)
void setValuesPointer (int num, SoFieldContainer **userData)
void addFieldContainer (SoFieldContainer *fieldContainer)
void insertFieldContainer (SoFieldContainer *fieldContainer, int newFieldContainerIndex)
SoFieldContainergetFieldContainer (int index) const
int findFieldContainer (const SoFieldContainer *fieldContainer) const
int getNumFieldContainers () const
void removeFieldContainer (int index)
void removeFieldContainer (SoFieldContainer *fieldContainer)
void removeAllFieldContainers ()
void replaceFieldContainer (int index, SoFieldContainer *newFieldContainer)
void replaceFieldContainer (SoFieldContainer *oldFieldContainer, SoFieldContainer *newFieldContainer)
SoFieldContainer ** startEditing ()
void finishEditing ()

Static Public Member Functions

static SoType getClassTypeId ()

Detailed Description

Multiple-value field containing any number of pointers to fieldContainers.

This field maintains a set of pointers to SoFieldContainer instances, correctly maintaining their reference counts.

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

Constructor & Destructor Documentation

SoMFFieldContainer::SoMFFieldContainer (  ) 

Default constructor.

virtual SoMFFieldContainer::~SoMFFieldContainer (  )  [virtual]


Member Function Documentation

void SoMFFieldContainer::addFieldContainer ( SoFieldContainer fieldContainer  ) 

Adds a fieldContainer as last one in group.

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

Temporary disable value deleting.

virtual void SoMFFieldContainer::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 SoMFFieldContainer::find ( SoFieldContainer 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 SoMFFieldContainer::findFieldContainer ( const SoFieldContainer fieldContainer  )  const

Finds index of given fieldContainer within group.

void SoMFFieldContainer::finishEditing (  ) 

Indicates that batch edits have finished.

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

Returns the type identifier for this class.

Reimplemented from SoMField.

SoFieldContainer* SoMFFieldContainer::getFieldContainer ( int  index  )  const

Returns pointer to nth fieldContainer.

int SoMFFieldContainer::getNumFieldContainers (  )  const

Returns number of fieldContainers.

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

Returns the type identifier for this specific instance.

Implements SoTypedObject.

const SoFieldContainer* * SoMFFieldContainer::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 SoMFFieldContainer::getValueSize (  )  const [inline, virtual]

Get size of the value.

Reimplemented from SoField.

void SoMFFieldContainer::insertFieldContainer ( SoFieldContainer fieldContainer,
int  newFieldContainerIndex 

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

virtual SbBool SoMFFieldContainer::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 SoMFFieldContainer::operator!= ( const SoMFFieldContainer 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.

SoFieldContainer* SoMFFieldContainer::operator= ( SoFieldContainer newValue  )  [inline]

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

the second and subsequent values.

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

Copy from another field of same type.

int SoMFFieldContainer::operator== ( const SoMFFieldContainer 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.

SoFieldContainer* SoMFFieldContainer::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 SoMFFieldContainer::removeAllFieldContainers (  ) 

Removes all fieldContainers from group.

void SoMFFieldContainer::removeFieldContainer ( SoFieldContainer fieldContainer  )  [inline]

Removes first instance of given fieldContainer from group.

void SoMFFieldContainer::removeFieldContainer ( int  index  ) 

Removes fieldContainer with given index from group.

void SoMFFieldContainer::replaceFieldContainer ( SoFieldContainer oldFieldContainer,
SoFieldContainer newFieldContainer 
) [inline]

Replaces first instance of given fieldContainer with new fieldContainer.

void SoMFFieldContainer::replaceFieldContainer ( int  index,
SoFieldContainer newFieldContainer 

Replaces fieldContainer with given index with new fieldContainer.

void SoMFFieldContainer::set1Value ( int  index,
SoFieldContainer newValue 

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

The array will be automatically expanded, if necessary.

void SoMFFieldContainer::setValue ( SoFieldContainer newValue  ) 

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

the second and subsequent values.

void SoMFFieldContainer::setValues ( int  start,
int  num,
const SoFieldContainer **  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 SoMFFieldContainer::setValuesPointer ( int  num,
SoFieldContainer **  userData 
void SoMFFieldContainer::setValuesPointer ( int  num,
const SoFieldContainer **  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).

SoFieldContainer** SoMFFieldContainer::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 12 Sep 2022
Copyright © Thermo Fisher Scientific All rights reserved.