Multiple-value field containing any number of enumerated type values. More...
#include <Inventor/fields/SoMFEnum.h>
Public Member Functions | |
virtual SoType | getTypeId () const |
Returns the type identifier for this specific instance. | |
const SoMFEnum & | operator= (const SoMFEnum &f) |
Copy from another field of same type. | |
SoMFEnum () | |
Default constructor. | |
virtual | ~SoMFEnum () |
Destructor. | |
int * | startEditing () |
Returns a pointer to the internally maintained array that can be modified. | |
void | finishEditing () |
Indicates that batch edits have finished. | |
int | operator[] (int i) const |
Returns the i'th value of the field. | |
const int * | getValues (int start) const |
Returns a pointer into the array of values in the field, starting at index start. | |
int | find (int targetValue, SbBool addIfNotFound=FALSE) |
Finds the given targetValue in the array and returns the index of that value. | |
void | setValues (int start, int num, const int *newValues) |
Sets num values starting at index start to the values. | |
void | set1Value (int index, int newValue) |
Sets the index'th value in the array to newValue. | |
void | setValue (int newValue) |
Sets the first value in the array to newValue, and deletes. | |
int | operator= (int newValue) |
Sets the first value in the array to newValue, and deletes. | |
int | operator== (const SoMFEnum &f) const |
Returns TRUE if all of the values of this field equal those of. | |
int | operator!= (const SoMFEnum &f) const |
Returns TRUE if all of the values of this field do not equal. | |
virtual void | enableDeleteValues () |
Sets the enableDeleteValues flag. | |
virtual void | disableDeleteValues () |
Temporary disable value deleting. | |
virtual SbBool | isDeleteValuesEnabled () |
Returns FALSE if user data array has been given to | |
virtual size_t | getValueSize () const |
Get size of the value. | |
void | setValuesPointer (int num, const int *userData) |
Sets the field to contain the num values stored in userData array. | |
void | setValuesPointer (int num, int *userData) |
See setValuesPointer(int, const int *) | |
void | setValue (const SbName &name) |
Sets this field to contain one and only one value, which is the mnemonic name as a string. | |
void | getEnums (int &num, int *&vals, SbName *&names) |
Gets value/name correspondances. | |
void | set1Value (int index, const SbName &name) |
Sets the index 'th value to be the integer corresponding to the mnemonic name in the given string. | |
Public Member Functions inherited from SoMField | |
int | getNum () const |
Returns the number of values currently in the field. | |
void | setNum (int num) |
Forces this field to have exactly num values, inserting or deleting values as necessary. | |
virtual void | deleteValues (int start, int num=-1) |
Deletes num values beginning at index start (index start through start + num -1 will be deleted, and any leftover values will be moved down to fill in the gap created). | |
virtual void | insertSpace (int start, int num) |
Inserts space for num values at index start . | |
SoNONUNICODE SbBool | set1 (int index, const char *valueString) |
This is equivalent to the set() method of SoField, but operates on only one value. | |
SbBool | set1 (int index, const SbString &valueString) |
This is equivalent to the set() method of SoField, but operates on only one value. | |
void | get1 (int index, SbString &valueString) |
This is equivalent to the get() method of SoField, but operates on only one value. | |
Public Member Functions inherited from SoField | |
void | setIgnored (SbBool ig) |
Sets the ignore flag for this field. | |
SbBool | isIgnored () const |
Gets the ignore flag for this field. | |
SbBool | isDefault () const |
Gets the state of default flag of the field. | |
void | enableConnection (SbBool flag) |
Field connections may be enabled and disabled. | |
SbBool | isConnectionEnabled () const |
Returns FALSE if connections to this field are disabled. | |
SbBool | connectFrom (SoEngineOutput *engineOutput) |
Connects this field from an engine output. | |
SbBool | connectFrom (SoField *field) |
Connects this field to another field. | |
SbBool | connectFrom (SoVRMLInterpOutput *interpOutput) |
Connects this field from an interpOutput. | |
SbBool | appendConnection (SoEngineOutput *engineOutput) |
Appends this field to the list of connections from another engineOutput. | |
SbBool | appendConnection (SoField *field) |
Appends this field to the list of connections from another field. | |
SbBool | appendConnection (SoVRMLInterpOutput *interpOutput) |
Appends this field to the list of connections from another interpOutput. | |
void | disconnect (SoEngineOutput *engineOutput) |
Disconnect the field from the requested engineOutput. | |
void | disconnect (SoField *field) |
Disconnect the field from the requested field. | |
void | disconnect (SoVRMLInterpOutput *interpOutput) |
Disconnect the field from the requested interpOutput. | |
int | getNumConnections () const |
Returns the number of connections to this field. | |
int | getConnections (SoFieldList &list) |
Returns a list of the connections to this field. | |
void | disconnect () |
Disconnect the field from whatever it was connected to. | |
SbBool | isConnected () const |
Returns TRUE if the field is connected to anything. | |
SbBool | isConnectedFromVRMLInterp () const |
Returns TRUE if the field is connected to a VRML interpOutput. | |
SbBool | isConnectedFromEngine () const |
Returns TRUE if the field is connected to an engine's output. | |
SbBool | isConnectedFromField () const |
Returns TRUE if the field is connected to another field. | |
SbBool | getConnectedEngine (SoEngineOutput *&engineOutput) const |
Returns TRUE if this field is being written into by an engine, and returns the engine output it is connected to in engineOutput. | |
SbBool | getConnectedField (SoField *&writingField) const |
Returns TRUE if this field is being written into by another field, and returns the field it is connected to in writingField. | |
SbBool | getConnectedVRMLInterp (SoVRMLInterpOutput *&interpOutput) const |
Returns the VRMLInterpolator output field is connected to. | |
int | getForwardConnections (SoFieldList &list) const |
Adds references to all of the fields that this field is writing into (either fields in nodes, global fields or engine inputs) to the given field list, and returns the number of forward connections. | |
SoFieldContainer * | getContainer () const |
Returns the object that contains this field. | |
SoNONUNICODE SbBool | set (const char *valueString) |
Sets the field to the given value, which is an ASCII string in the Open Inventor file format. | |
SbBool | set (const SbString &valueString) |
Sets the field to the given value, which is an ASCII string in the Open Inventor file format. | |
void | get (SbString &valueString) |
Returns the value of the field in the Open Inventor file format, even if the field has its default value. | |
virtual void | touch () |
Simulates a change to the field, causing attached sensors to fire, connected fields and engines to be marked as needing evaluation, and so forth. | |
int | operator== (const SoField &f) const |
Return TRUE if this field is of the same type and has the same value as f. | |
int | operator!= (const SoField &f) const |
Return FALSE if this field is of the same type and has the same value as f. | |
Public Member Functions inherited from SoTypedObject | |
SbBool | isOfType (const SoType &type) const |
Returns TRUE if this object is of the type specified in type or is derived from that type. | |
template<typename TypedObjectClass > | |
SbBool | isOfType () const |
Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class. | |
Static Public Member Functions | |
static SoType | getClassTypeId () |
Returns the type identifier for this class. | |
Static Public Member Functions inherited from SoMField | |
static SoType | getClassTypeId () |
Return the type identifier for this field class. | |
Static Public Member Functions inherited from SoField | |
static SoType | getClassTypeId () |
Return the type identifier for this field class. | |
Static Public Member Functions inherited from SoTypedObject | |
static SoType | getClassTypeId () |
Returns the type identifier for this class. | |
Multiple-value field containing any number of enumerated type values.
A multiple-value field that contains any number of enumerated type values, stored as ints. Nodes that use this field class define mnemonic names for values. These names should be used when setting or testing the values of the field, even though the values are treated as integers in the methods.
SoMFEnums are written to file as a set of mnemonic enumerated type names. These names differ among uses of this field in various node classes. See the reference pages for specific nodes for the names.
When more than one value is present, all of the values are enclosed in square brackets and separated by commas.
Data copying:
Definition at line 95 of file SoMFEnum.h.
SoMFEnum::SoMFEnum | ( | ) |
Default constructor.
|
virtual |
Destructor.
|
inlinevirtual |
Temporary disable value deleting.
Definition at line 98 of file SoMFEnum.h.
|
inlinevirtual |
Sets the enableDeleteValues flag.
This flag (if TRUE) allows Open Inventor to destroy the user data array given to setValuesPointer(). This user data array will be managed exactly like internal field data values. Default is FALSE.
Definition at line 98 of file SoMFEnum.h.
Finds the given targetValue 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).
|
inline |
Indicates that batch edits have finished.
See startEditing().
Definition at line 98 of file SoMFEnum.h.
|
static |
Returns the type identifier for this class.
void SoMFEnum::getEnums | ( | int & | num, |
int *& | vals, | ||
SbName *& | names | ||
) |
Gets value/name correspondances.
|
virtual |
Returns the type identifier for this specific instance.
Implements SoTypedObject.
Reimplemented in SoMFBitMask.
|
inline |
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.
Definition at line 98 of file SoMFEnum.h.
|
inlinevirtual |
|
inlinevirtual |
Returns FALSE if user data array has been given to
setValuesPointer() and enableDeleteValues() has never been called, and memory for data has not been reallocated. Otherwise, returns TRUE.
Definition at line 98 of file SoMFEnum.h.
|
inline |
Returns TRUE if all of the values of this field do not equal.
those of the given f. If the fields are different types TRUE will always be returned.
Definition at line 98 of file SoMFEnum.h.
|
inline |
Sets the first value in the array to newValue, and deletes.
the second and subsequent values.
Definition at line 98 of file SoMFEnum.h.
int SoMFEnum::operator== | ( | const SoMFEnum & | f | ) | const |
Returns TRUE if all of the values of this field equal those of.
the given f. If the fields are different types FALSE will always be returned.
|
inline |
Returns the i'th value of the field.
Indexing past the end of the field (passing in i greater than getNum()) will return garbage.
Definition at line 98 of file SoMFEnum.h.
void SoMFEnum::set1Value | ( | int | index, |
const SbName & | name | ||
) |
Sets the index 'th value to be the integer corresponding to the mnemonic name in the given string.
void SoMFEnum::set1Value | ( | int | index, |
int | newValue | ||
) |
Sets the index'th value in the array to newValue.
The array will be automatically expanded, if necessary.
void SoMFEnum::setValue | ( | const SbName & | name | ) |
Sets this field to contain one and only one value, which is the mnemonic name as a string.
void SoMFEnum::setValue | ( | int | newValue | ) |
Sets the first value in the array to newValue, and deletes.
the second and subsequent values.
void SoMFEnum::setValues | ( | int | start, |
int | num, | ||
const int * | newValues | ||
) |
Sets num values starting at index start to the values.
in newValues. The array will automatically be made larger to accommodate the new values, if necessary.
void SoMFEnum::setValuesPointer | ( | int | num, |
const int * | userData | ||
) |
Sets the field to contain the num values stored in userData array.
This array will not be copied into the field: it will be directly used by the field. If num and userData are not correctly specified, the results are undefined (and probably undesirable). param num is the number of values that userData contains and must be a positive integer. param userData is an array allocated by malloc or realloc and can be deallocated by free (no constructor or destructor is called). userData must not be NULL. Its size must be at least num*sizeof(valueType).
void SoMFEnum::setValuesPointer | ( | int | num, |
int * | userData | ||
) |
|
inline |
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.
Definition at line 98 of file SoMFEnum.h.