SoMFUShort(3IV)NAMESoMFUShort (SoMUShort) - multiple-value field containing any number of
unsigned short integers
INHERITS FROM
SoField > SoMField > SoMFUShortSYNOPSIS
#include <Inventor_c/fields/SoMFUShort.h>
typedef SoMFUShort SoMUShort
Functions from class SoMFUShort:
SoType SoMUShortGetClassTypeId()
void SoMUShortGetTypeId(const SoMUShort *this)
unsigned short SoMUShortGet(const SoMUShort *this, int i)
const unsigned short * SoMUShortGetN(const SoMUShort *this, int start)
int SoMUShortFind(SoMUShort *this, unsigned short
targetValue, SbBool addIfNotFound = FALSE)
void SoMUShortSetN(SoMUShort *this, int start, int
num, const unsigned short *newValues)
void SoMUShortSet1(SoMUShort *this, int index,
unsigned short newValue)
void SoMUShortSet(SoMUShort *this, unsigned short
newValue)
int SoMUShortIsEq(const SoMUShort *this, const
SoMFUShort *f)
int SoMUShortIsNEq(const SoMUShort *this, const
SoMFUShort *f)
unsigned short * SoMUShortStartEdit(SoMUShort *this)
void SoMUShortFinishEdit(SoMUShort *this)
Functions from class SoMField:
int SoMUShortGetNum(const SoMUShort *this)
void SoMUShortSetNum(SoMUShort *this, int num)
void SoMUShortDel(SoMUShort *this, int start, int num =
-1)
void SoMUShortInsertSpace(SoMUShort *this, int start, int
num)
void SoMUShortGet1(SoMUShort *this, int index, SbString
*valueString)
Functions from class SoField:
void SoMUShortSetIgnored(SoMUShort *this, SbBool ignore)
SbBool SoMUShortIsIgnored(const SoMUShort *this)
SbBool SoMUShortIsDflt(const SoMUShort *this)
SbBool SoMUShortIsOfType(const SoMUShort *this, SoType type)
SbBool SoMUShortSetFromStr(SoMUShort *this, const char
*valueString)
Page 1SoMFUShort(3IV)
void SoMUShortGetIntoStr(SoMUShort *this, SbString
*valueString)
void SoMUShortTouch(SoMUShort *this)
SbBool SoMUShortConnFromField(SoMUShort *this, SoField
*fromField)
SbBool SoMUShortConnFrom(SoMUShort *this, SoEngineOutput
*fromEngine)
void SoMUShortDisconn(SoMUShort *this)
SbBool SoMUShortIsConn(const SoMUShort *this)
SbBool SoMUShortIsConnFromField(const SoMUShort *this)
SbBool SoMUShortGetConnField(const SoMUShort *this, SoField
**writingField)
SbBool SoMUShortIsConnFromEngine(const SoMUShort *this)
SbBool SoMUShortGetConnEngine(const SoMUShort *this,
SoEngineOutput **engineOutput)
void SoMUShortEnableConn(SoMUShort *this, SbBool flag)
SbBool SoMUShortIsConnEnabled(const SoMUShort *this)
int SoMUShortGetForwardConn(const SoMUShort *this,
SoFieldList *list)
SoFieldContainer * SoMUShortGetContainer(const SoMUShort *this)
DESCRIPTION
A multiple-value field that contains any number of unsigned short
integers.
SoMFUShorts are written to file as one or more unsigned short integer
values, represented as decimal, hexadecimal (beginning with '0x') or
octal (beginning with '0') values. When more than one value is present,
all of the values are enclosed in square brackets and separated by
commas; for example:
[ 7, 0xFF, 033 ]
FUNCTIONS
SoType SoMUShortGetClassTypeId()
void SoMUShortGetTypeId(const SoMUShort *this)
Returns the type for this class or a particular object of this
class.
unsigned short SoMUShortGet(const SoMUShort *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 unsigned short * SoMUShortGetN(const SoMUShort *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.
Page 2SoMFUShort(3IV)
int SoMUShortFind(SoMUShort *this, unsigned short
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 SoMUShortSetN(SoMUShort *this, int start, int
num, const unsigned short *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 SoMUShortSet1(SoMUShort *this, int index,
unsigned short newValue)
Sets the index'th value in the array to newValue. The array will be
automatically expanded, if necessary.
void SoMUShortSet(SoMUShort *this, unsigned short
newValue)
Sets the first value in the array to newValue, and deletes the
second and subsequent values.
int SoMUShortIsEq(const SoMUShort *this, const
SoMFUShort *f)
int SoMUShortIsNEq(const SoMUShort *this, const
SoMFUShort *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).
unsigned short * SoMUShortStartEdit(SoMUShort *this)
void SoMUShortFinishEdit(SoMUShort *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
