SoMFEnum Class Reference
[Fields]
Multiple-value field containing any number of enumerated type values. More...
#include <Inventor/fields/SoMFEnum.h>
Public Member Functions | |
| virtual SoType | getTypeId () const |
| const SoMFEnum & | operator= (const SoMFEnum &f) |
| SoMFEnum () | |
| virtual | ~SoMFEnum () |
| int * | startEditing () |
| void | finishEditing () |
| int | operator[] (int i) const |
| const int * | getValues (int start) const |
| int | find (int targetValue, SbBool addIfNotFound=FALSE) |
| void | setValues (int start, int num, const int *newValues) |
| void | set1Value (int index, int newValue) |
| void | setValue (int newValue) |
| int | operator= (int newValue) |
| int | operator== (const SoMFEnum &f) const |
| int | operator!= (const SoMFEnum &f) const |
| virtual void | enableDeleteValues () |
| virtual void | disableDeleteValues () |
| virtual SbBool | isDeleteValuesEnabled () |
| virtual size_t | getValueSize () const |
| void | setValuesPointer (int num, const int *userData) |
| void | setValuesPointer (int num, int *userData) |
| void | setValue (const SbName &name) |
| void | getEnums (int &num, int *&vals, SbName *&names) |
| void | set1Value (int index, const SbName &name) |
Static Public Member Functions | |
| static SoType | getClassTypeId () |
Detailed Description
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:
- SoMF fields are a kind of "smart container", automatically expanding as necessary to hold the data provided by the application. This is very convenient, but for large blocks of data it may be desireable to avoid making a copy of the application data. The setValuesPointer() methods allow Open Inventor to directly use an array of values supplied by the application. The application data is not copied. Please see SoMFVec3f for more information and example code.
Constructor & Destructor Documentation
| SoMFEnum::SoMFEnum | ( | ) |
Default constructor.
| virtual SoMFEnum::~SoMFEnum | ( | ) | [virtual] |
Destructor.
Member Function Documentation
| virtual void SoMFEnum::disableDeleteValues | ( | ) | [inline, virtual] |
Temporary disable value deleting.
| virtual void SoMFEnum::enableDeleteValues | ( | ) | [inline, virtual] |
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.
| int SoMFEnum::find | ( | int | targetValue, | |
| SbBool | addIfNotFound = FALSE | |||
| ) |
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).
| void SoMFEnum::finishEditing | ( | ) | [inline] |
Indicates that batch edits have finished.
See startEditing().
| static SoType SoMFEnum::getClassTypeId | ( | ) | [static] |
Returns the type identifier for this class.
Reimplemented from SoMField.
Reimplemented in SoMFBitMask.
| void SoMFEnum::getEnums | ( | int & | num, | |
| int *& | vals, | |||
| SbName *& | names | |||
| ) |
Gets value/name correspondances.
| virtual SoType SoMFEnum::getTypeId | ( | ) | const [virtual] |
Returns the type identifier for this specific instance.
Implements SoTypedObject.
Reimplemented in SoMFBitMask.
| const int* SoMFEnum::getValues | ( | int | start | ) | const [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.
| virtual size_t SoMFEnum::getValueSize | ( | ) | const [inline, virtual] |
Get size of the value.
Reimplemented from SoField.
| virtual SbBool SoMFEnum::isDeleteValuesEnabled | ( | ) | [inline, virtual] |
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.
| int SoMFEnum::operator!= | ( | const SoMFEnum & | f | ) | const [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.
Reimplemented from SoField.
| int SoMFEnum::operator= | ( | int | newValue | ) | [inline] |
Sets the first value in the array to newValue, and deletes.
the second and subsequent values.
Reimplemented in SoMFBitMask.
Copy from another field of same type.
Reimplemented in SoMFBitMask.
| 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.
Reimplemented from SoField.
| int SoMFEnum::operator[] | ( | int | i | ) | const [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.
| 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, | |
| int * | userData | |||
| ) |
See setValuesPointer(int, const int *).
Reimplemented in SoMFBitMask.
| 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).
Reimplemented in SoMFBitMask.
| int* SoMFEnum::startEditing | ( | ) | [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.
The documentation for this class was generated from the following file:
- Inventor/fields/SoMFEnum.h