SoMFPath Class Reference
[Fields]

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

#include <Inventor/fields/SoMFPath.h>

Inheritance diagram for SoMFPath:
SoMField SoField SoTypedObject

List of all members.

Public Member Functions

virtual SoType getTypeId () const
const SoMFPathoperator= (const SoMFPath &f)
 SoMFPath ()
virtual ~SoMFPath ()
SoPath ** startEditing ()
void finishEditing ()
SoPathoperator[] (int i) const
const SoPath ** getValues (int start) const
int find (SoPath *targetValue, SbBool addIfNotFound=FALSE)
void setValues (int start, int num, const SoPath **newValues)
void set1Value (int index, SoPath *newValue)
void setValue (SoPath *newValue)
SoPathoperator= (SoPath *newValue)
int operator== (const SoMFPath &f) const
int operator!= (const SoMFPath &f) const
virtual void enableDeleteValues ()
virtual void disableDeleteValues ()
virtual SbBool isDeleteValuesEnabled ()
virtual size_t getValueSize () const
void setValuesPointer (int num, const SoPath **userData)
void setValuesPointer (int num, SoPath **userData)
SoPathgetPath (int index) const

Static Public Member Functions

static SoType getClassTypeId ()

Detailed Description

Multiple-value field containing any number of paths.

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

SoMFPaths are written to file as one or more paths (see the SoPath reference page for a description of the file format for a path). When more than one value is present, all of the values are enclosed in square brackets and separated by commas.

SoMFPaths are not able to write "per instance" information to a file for instancing nodes like SoMultipleInstance and SoMultipleCopy. The path(s) will reference the whole set of instances under the instancing node.

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

SoMFPath::SoMFPath (  ) 

Default constructor.

virtual SoMFPath::~SoMFPath (  )  [virtual]

Destructor.


Member Function Documentation

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

Temporary disable value deleting.

virtual void SoMFPath::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 SoMFPath::find ( SoPath 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).

void SoMFPath::finishEditing (  )  [inline]

Indicates that batch edits have finished.

See startEditing().

static SoType SoMFPath::getClassTypeId (  )  [static]

Returns the type identifier for this class.

Reimplemented from SoMField.

SoPath* SoMFPath::getPath ( int  index  )  const

Returns pointer to nth path.

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

Returns the type identifier for this specific instance.

Implements SoTypedObject.

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

Get size of the value.

Reimplemented from SoField.

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

SoPath* SoMFPath::operator= ( SoPath newValue  )  [inline]

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

the second and subsequent values.

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

Copy from another field of same type.

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

SoPath* SoMFPath::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 SoMFPath::set1Value ( int  index,
SoPath newValue 
)

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

The array will be automatically expanded, if necessary.

void SoMFPath::setValue ( SoPath newValue  ) 

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

the second and subsequent values.

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

SoPath* * SoMFPath::startEditing (  )  [inline]

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 25 Feb 2021
Copyright © Thermo Fisher Scientific All rights reserved.
http://www.openinventor.com/