SoMFPath(3IV)NAMESoMFPath (SoMPath) - multiple-value field containing any number of
pointers to paths
INHERITS FROM
SoField > SoMField > SoMFPathSYNOPSIS
#include <Inventor_c/fields/SoMFPath.h>
typedef SoMFPath SoMPath
Functions from class SoMFPath:
SoType SoMPathGetClassTypeId()
void SoMPathGetTypeId(const SoMPath *this)
SoPath * SoMPathGet(const SoMPath *this, int i)
const SoPath * * SoMPathGetN(const SoMPath *this, int start)
int SoMPathFind(SoMPath *this, SoPath * targetValue,
SbBool addIfNotFound = FALSE)
void SoMPathSetN(SoMPath *this, int start, int num, const
SoPath * *newValues)
void SoMPathSet1(SoMPath *this, int index, SoPath *
newValue)
void SoMPathSet(SoMPath *this, SoPath * newValue)
int SoMPathIsEq(const SoMPath *this, const SoMFPath *f)
int SoMPathIsNEq(const SoMPath *this, const SoMFPath *f)
SoPath * * SoMPathStartEdit(SoMPath *this)
void SoMPathFinishEdit(SoMPath *this)
Functions from class SoMField:
int SoMPathGetNum(const SoMPath *this)
void SoMPathSetNum(SoMPath *this, int num)
void SoMPathDel(SoMPath *this, int start, int num = -1)
void SoMPathInsertSpace(SoMPath *this, int start, int num)
void SoMPathGet1(SoMPath *this, int index, SbString
*valueString)
Functions from class SoField:
void SoMPathSetIgnored(SoMPath *this, SbBool ignore)
SbBool SoMPathIsIgnored(const SoMPath *this)
SbBool SoMPathIsDflt(const SoMPath *this)
SbBool SoMPathIsOfType(const SoMPath *this, SoType type)
SbBool SoMPathSetFromStr(SoMPath *this, const char
*valueString)
void SoMPathGetIntoStr(SoMPath *this, SbString
*valueString)
void SoMPathTouch(SoMPath *this)
SbBool SoMPathConnFromField(SoMPath *this, SoField
*fromField)
Page 1SoMFPath(3IV)
SbBool SoMPathConnFrom(SoMPath *this, SoEngineOutput
*fromEngine)
void SoMPathDisconn(SoMPath *this)
SbBool SoMPathIsConn(const SoMPath *this)
SbBool SoMPathIsConnFromField(const SoMPath *this)
SbBool SoMPathGetConnField(const SoMPath *this, SoField
**writingField)
SbBool SoMPathIsConnFromEngine(const SoMPath *this)
SbBool SoMPathGetConnEngine(const SoMPath *this,
SoEngineOutput **engineOutput)
void SoMPathEnableConn(SoMPath *this, SbBool flag)
SbBool SoMPathIsConnEnabled(const SoMPath *this)
int SoMPathGetForwardConn(const SoMPath *this,
SoFieldList *list)
SoFieldContainer * SoMPathGetContainer(const SoMPath *this)
DESCRIPTION
This field maintains a set of pointers to SoPath instances, correctly
maintaining their reference counts.
SoMFPaths are written to file as one or more paths (see the SoPath manual
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.
FUNCTIONS
SoType SoMPathGetClassTypeId()
void SoMPathGetTypeId(const SoMPath *this)
Returns the type for this class or a particular object of this
class.
SoPath * SoMPathGet(const SoMPath *this, int i)
Returns the i'th value of the field. Indexing past the end of the
field (passing in i greater than getNum()) will return garbage.
const SoPath * * SoMPathGetN(const SoMPath *this, int start)
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.
int SoMPathFind(SoMPath *this, SoPath * targetValue,
SbBool addIfNotFound = FALSE)
Finds the given value 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 SoMPathSetN(SoMPath *this, int start, int num, const
SoPath * *newValues)
Sets num values starting at index start to the values in newValues.
Page 2SoMFPath(3IV)
The array will be automatically be made larger to accomodate the new
values, if necessary.
void SoMPathSet1(SoMPath *this, int index, SoPath *
newValue)
Sets the index'th value in the array to newValue. The array will be
automatically expanded, if necessary.
void SoMPathSet(SoMPath *this, SoPath * newValue)
Sets the first value in the array to newValue, and deletes the
second and subsequent values.
int SoMPathIsEq(const SoMPath *this, const SoMFPath *f)
int SoMPathIsNEq(const SoMPath *this, const SoMFPath *f)
Returns TRUE if all of the values of this field equal (do not equal)
those of the given field. If the fields are different types FALSE
will always be returned (even if one field is an SoMFFloat with one
value of 1.0 and the other is an SoMFInt with a value of 1, for
example).
SoPath * * SoMPathStartEdit(SoMPath *this)
void SoMPathFinishEdit(SoMPath *this)
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 StartEdit() and FinishEdit() (e.g. Set1(),
Set(), etc).
Fields, engines or sensors connected to this field and sensors are
not notified that this field has changed until FinishEdit() is
called. Calling FinishEdit() always sets the IsDflt flag to FALSE
and informs engines and sensors that the field changed, even if none
of the values actually were changed.
Page 3
