SoMFShort(3IV)NAMESoMFShort (SoMShort) - multiple-value field containing any number of
short integers
INHERITS FROM
SoField > SoMField > SoMFShortSYNOPSIS
#include <Inventor_c/fields/SoMFShort.h>
typedef SoMFShort SoMShort
Functions from class SoMFShort:
SoType SoMShortGetClassTypeId()
void SoMShortGetTypeId(const SoMShort *this)
short SoMShortGet(const SoMShort *this, int i)
const short * SoMShortGetN(const SoMShort *this, int start)
int SoMShortFind(SoMShort *this, short targetValue,
SbBool addIfNotFound = FALSE)
void SoMShortSetN(SoMShort *this, int start, int num,
const short *newValues)
void SoMShortSet1(SoMShort *this, int index, short
newValue)
void SoMShortSet(SoMShort *this, short newValue)
int SoMShortIsEq(const SoMShort *this, const SoMFShort
*f)
int SoMShortIsNEq(const SoMShort *this, const SoMFShort
*f)
short * SoMShortStartEdit(SoMShort *this)
void SoMShortFinishEdit(SoMShort *this)
Functions from class SoMField:
int SoMShortGetNum(const SoMShort *this)
void SoMShortSetNum(SoMShort *this, int num)
void SoMShortDel(SoMShort *this, int start, int num = -1)
void SoMShortInsertSpace(SoMShort *this, int start, int
num)
void SoMShortGet1(SoMShort *this, int index, SbString
*valueString)
Functions from class SoField:
void SoMShortSetIgnored(SoMShort *this, SbBool ignore)
SbBool SoMShortIsIgnored(const SoMShort *this)
SbBool SoMShortIsDflt(const SoMShort *this)
SbBool SoMShortIsOfType(const SoMShort *this, SoType type)
SbBool SoMShortSetFromStr(SoMShort *this, const char
*valueString)
void SoMShortGetIntoStr(SoMShort *this, SbString
*valueString)
Page 1SoMFShort(3IV)
void SoMShortTouch(SoMShort *this)
SbBool SoMShortConnFromField(SoMShort *this, SoField
*fromField)
SbBool SoMShortConnFrom(SoMShort *this, SoEngineOutput
*fromEngine)
void SoMShortDisconn(SoMShort *this)
SbBool SoMShortIsConn(const SoMShort *this)
SbBool SoMShortIsConnFromField(const SoMShort *this)
SbBool SoMShortGetConnField(const SoMShort *this, SoField
**writingField)
SbBool SoMShortIsConnFromEngine(const SoMShort *this)
SbBool SoMShortGetConnEngine(const SoMShort *this,
SoEngineOutput **engineOutput)
void SoMShortEnableConn(SoMShort *this, SbBool flag)
SbBool SoMShortIsConnEnabled(const SoMShort *this)
int SoMShortGetForwardConn(const SoMShort *this,
SoFieldList *list)
SoFieldContainer * SoMShortGetContainer(const SoMShort *this)
DESCRIPTION
A multiple-value field that contains any number of short (16-bit)
integers.
SoMFShorts are written to file as one or more 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 SoMShortGetClassTypeId()
void SoMShortGetTypeId(const SoMShort *this)
Returns the type for this class or a particular object of this
class.
short SoMShortGet(const SoMShort *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 short * SoMShortGetN(const SoMShort *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 SoMShortFind(SoMShort *this, short targetValue,
SbBool addIfNotFound = FALSE)
Page 2SoMFShort(3IV)
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 SoMShortSetN(SoMShort *this, int start, int num,
const 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 SoMShortSet1(SoMShort *this, int index, short
newValue)
Sets the index'th value in the array to newValue. The array will be
automatically expanded, if necessary.
void SoMShortSet(SoMShort *this, short newValue)
Sets the first value in the array to newValue, and deletes the
second and subsequent values.
int SoMShortIsEq(const SoMShort *this, const SoMFShort
*f)
int SoMShortIsNEq(const SoMShort *this, const SoMFShort
*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).
short * SoMShortStartEdit(SoMShort *this)
void SoMShortFinishEdit(SoMShort *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
