Provided by: inventor-doc_2.1.5-10+dfsg-2_all
NAME
SoMFShort — multiple-value field containing any number of short integers
INHERITS FROM
SoField > SoMField > SoMFShort
SYNOPSIS
#include <Inventor/fields/SoMFShort.h> Methods from class SoMFShort: static SoType getClassTypeId() virtual void getTypeId() const short operator [](int i) const const short * getValues(int start) const int find(short targetValue, SbBool addIfNotFound = FALSE) void setValues(int start, int num, const short *newValues) void set1Value(int index, short newValue) short operator =(short newValue) void setValue(short newValue) int operator ==(const SoMFShort &f) const int operator !=(const SoMFShort &f) const short * startEditing() void finishEditing() Methods from class SoMField: int getNum() const void setNum(int num) virtual void deleteValues(int start, int num = -1) virtual void insertSpace(int start, int num) SbBool set1(int index, const char *valueString) void get1(int index, SbString &valueString) Methods from class SoField: void setIgnored(SbBool ignore) SbBool isIgnored() const SbBool isDefault() const virtual SbBool isOfType(SoType type) const SbBool set(const char *valueString) void get(SbString &valueString) void touch() SbBool connectFrom(SoField *fromField) SbBool connectFrom(SoEngineOutput *fromEngine) void disconnect() SbBool isConnected() const SbBool isConnectedFromField() const SbBool getConnectedField(SoField *&writingField) const SbBool isConnectedFromEngine() const SbBool getConnectedEngine(SoEngineOutput *&engineOutput) const void enableConnection(SbBool flag) SbBool isConnectionEnabled() const int getForwardConnections(SoFieldList &list) const SoFieldContainer * getContainer() const
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 ]
METHODS
static SoType getClassTypeId() virtual void getTypeId() const Returns the type for this class or a particular object of this class. short operator [](int i) const 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 * getValues(int start) const 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 find(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 setValues(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 set1Value(int index, short newValue) Sets the index'th value in the array to newValue. The array will be automatically expanded, if necessary. short operator =(short newValue) void setValue(short newValue) Sets the first value in the array to newValue, and deletes the second and subsequent values. int operator ==(const SoMFShort &f) const int operator !=(const SoMFShort &f) const 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 * startEditing() void finishEditing() 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 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. SoMFShort(3IV)()