SoMFBufferObject Class Reference
[Fields]
Multiple-value field containing any number of buffer objects. More...
#include <Inventor/fields/SoMFBufferObject.h>
Public Member Functions | |
| virtual SoType | getTypeId () const |
| const SoMFBufferObject & | operator= (const SoMFBufferObject &f) |
| SoMFBufferObject () | |
| virtual | ~SoMFBufferObject () |
| SoBufferObject * | operator[] (int i) const |
| const SoBufferObject ** | getValues (int start) const |
| int | find (SoBufferObject *targetValue, SbBool addIfNotFound=FALSE) |
| void | setValues (int start, int num, const SoBufferObject **newValues) |
| void | set1Value (int index, SoBufferObject *newValue) |
| void | setValue (SoBufferObject *newValue) |
| SoBufferObject * | operator= (SoBufferObject *newValue) |
| int | operator== (const SoMFBufferObject &f) const |
| int | operator!= (const SoMFBufferObject &f) const |
| virtual void | enableDeleteValues () |
| virtual void | disableDeleteValues () |
| virtual SbBool | isDeleteValuesEnabled () |
| virtual size_t | getValueSize () const |
| void | setValuesPointer (int num, const SoBufferObject **userData) |
| void | setValuesPointer (int num, SoBufferObject **userData) |
Static Public Member Functions | |
| static SoType | getClassTypeId () |
Detailed Description
Multiple-value field containing any number of buffer objects.
This field maintains a set of SoBufferObject instances.
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
| SoMFBufferObject::SoMFBufferObject | ( | ) |
Default constructor.
| virtual SoMFBufferObject::~SoMFBufferObject | ( | ) | [virtual] |
Destructor.
Member Function Documentation
| virtual void SoMFBufferObject::disableDeleteValues | ( | ) | [inline, virtual] |
Temporary disable value deleting.
| virtual void SoMFBufferObject::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 SoMFBufferObject::find | ( | SoBufferObject * | 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).
| static SoType SoMFBufferObject::getClassTypeId | ( | ) | [static] |
Returns the type identifier for this class.
Reimplemented from SoMField.
| virtual SoType SoMFBufferObject::getTypeId | ( | ) | const [virtual] |
Returns the type identifier for this specific instance.
Implements SoTypedObject.
| const SoBufferObject* * SoMFBufferObject::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 SoMFBufferObject::getValueSize | ( | ) | const [inline, virtual] |
Get size of the value.
Reimplemented from SoField.
| virtual SbBool SoMFBufferObject::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 SoMFBufferObject::operator!= | ( | const SoMFBufferObject & | 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.
| SoBufferObject* SoMFBufferObject::operator= | ( | SoBufferObject * | newValue | ) | [inline] |
Sets the first value in the array to newValue, and deletes.
the second and subsequent values.
| const SoMFBufferObject& SoMFBufferObject::operator= | ( | const SoMFBufferObject & | f | ) |
Copy from another field of same type.
| int SoMFBufferObject::operator== | ( | const SoMFBufferObject & | 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.
| SoBufferObject* SoMFBufferObject::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 SoMFBufferObject::set1Value | ( | int | index, | |
| SoBufferObject * | newValue | |||
| ) |
Sets the index'th value in the array to newValue.
The array will be automatically expanded, if necessary.
| void SoMFBufferObject::setValue | ( | SoBufferObject * | newValue | ) |
Sets the first value in the array to newValue, and deletes.
the second and subsequent values.
| void SoMFBufferObject::setValues | ( | int | start, | |
| int | num, | |||
| const SoBufferObject ** | 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 SoMFBufferObject::setValuesPointer | ( | int | num, | |
| SoBufferObject ** | userData | |||
| ) |
| void SoMFBufferObject::setValuesPointer | ( | int | num, | |
| const SoBufferObject ** | 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).
The documentation for this class was generated from the following file:
- Inventor/fields/SoMFBufferObject.h