SoMFTime(3IV)NAMESoMFTime (SoMTime) - multiple-value field containing any number of SbTime
values
INHERITS FROM
SoField > SoMField > SoMFTimeSYNOPSIS
#include <Inventor_c/fields/SoMFTime.h>
typedef SoMFTime SoMTime
Functions from class SoMFTime:
SoType SoMTimeGetClassTypeId()
void SoMTimeGetTypeId(const SoMTime *this)
const SbTime * SoMTimeGet(const SoMTime *this, int i)
const SbTime * SoMTimeGetN(const SoMTime *this, int start)
int SoMTimeFind(SoMTime *this, const SbTime *
targetValue, SbBool addIfNotFound = FALSE)
void SoMTimeSetN(SoMTime *this, int start, int num, const
SbTime *newValues)
void SoMTimeSet1(SoMTime *this, int index, const SbTime *
newValue)
void SoMTimeSet(SoMTime *this, const SbTime * newValue)
int SoMTimeIsEq(const SoMTime *this, const SoMFTime *f)
int SoMTimeIsNEq(const SoMTime *this, const SoMFTime *f)
SbTime * SoMTimeStartEdit(SoMTime *this)
void SoMTimeFinishEdit(SoMTime *this)
Functions from class SoMField:
int SoMTimeGetNum(const SoMTime *this)
void SoMTimeSetNum(SoMTime *this, int num)
void SoMTimeDel(SoMTime *this, int start, int num = -1)
void SoMTimeInsertSpace(SoMTime *this, int start, int num)
void SoMTimeGet1(SoMTime *this, int index, SbString
*valueString)
Functions from class SoField:
void SoMTimeSetIgnored(SoMTime *this, SbBool ignore)
SbBool SoMTimeIsIgnored(const SoMTime *this)
SbBool SoMTimeIsDflt(const SoMTime *this)
SbBool SoMTimeIsOfType(const SoMTime *this, SoType type)
SbBool SoMTimeSetFromStr(SoMTime *this, const char
*valueString)
void SoMTimeGetIntoStr(SoMTime *this, SbString
*valueString)
void SoMTimeTouch(SoMTime *this)
SbBool SoMTimeConnFromField(SoMTime *this, SoField
*fromField)
Page 1SoMFTime(3IV)
SbBool SoMTimeConnFrom(SoMTime *this, SoEngineOutput
*fromEngine)
void SoMTimeDisconn(SoMTime *this)
SbBool SoMTimeIsConn(const SoMTime *this)
SbBool SoMTimeIsConnFromField(const SoMTime *this)
SbBool SoMTimeGetConnField(const SoMTime *this, SoField
**writingField)
SbBool SoMTimeIsConnFromEngine(const SoMTime *this)
SbBool SoMTimeGetConnEngine(const SoMTime *this,
SoEngineOutput **engineOutput)
void SoMTimeEnableConn(SoMTime *this, SbBool flag)
SbBool SoMTimeIsConnEnabled(const SoMTime *this)
int SoMTimeGetForwardConn(const SoMTime *this,
SoFieldList *list)
SoFieldContainer * SoMTimeGetContainer(const SoMTime *this)
DESCRIPTION
A multiple-value field that contains any number of SbTime values.
SoMFTimes are written to file as one or more double-precision floating
point values representing the length of time in seconds. Absolute times
are measured relative to 00:00:00 GMT, January 1, 1970.
When more than one value is present, all of the values are enclosed in
square brackets and separated by commas; for example:
[ 1.0, 1345600.1200055, 99.8 ]
FUNCTIONS
SoType SoMTimeGetClassTypeId()
void SoMTimeGetTypeId(const SoMTime *this)
Returns the type for this class or a particular object of this
class.
const SbTime * SoMTimeGet(const SoMTime *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 SbTime * SoMTimeGetN(const SoMTime *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 SoMTimeFind(SoMTime *this, const SbTime *
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
Page 2SoMFTime(3IV)
array (but -1 is still returned).
void SoMTimeSetN(SoMTime *this, int start, int num, const
SbTime *newValues)
Sets num values starting at index start to the values in newValues.
The array will be automatically be made larger to accomodate the new
values, if necessary.
void SoMTimeSet1(SoMTime *this, int index, const SbTime *
newValue)
Sets the index'th value in the array to newValue. The array will be
automatically expanded, if necessary.
void SoMTimeSet(SoMTime *this, const SbTime * newValue)
Sets the first value in the array to newValue, and deletes the
second and subsequent values.
int SoMTimeIsEq(const SoMTime *this, const SoMFTime *f)
int SoMTimeIsNEq(const SoMTime *this, const SoMFTime *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).
SbTime * SoMTimeStartEdit(SoMTime *this)
void SoMTimeFinishEdit(SoMTime *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.
SEE ALSO
SbTime
Page 3
