SoMFVec2i32 Class Reference
[Fields]
Multiple-value field containing any number of two-dimensional vectors. More...
#include <Inventor/fields/SoMFVec2i32.h>
Public Member Functions | |
| virtual SoType | getTypeId () const |
| const SoMFVec2i32 & | operator= (const SoMFVec2i32 &f) |
| SoMFVec2i32 () | |
| virtual | ~SoMFVec2i32 () |
| SbVec2i32 * | startEditing () |
| void | finishEditing () |
| const SbVec2i32 & | operator[] (int i) const |
| const SbVec2i32 * | getValues (int start) const |
| int | find (const SbVec2i32 &targetValue, SbBool addIfNotFound=FALSE) |
| void | setValues (int start, int num, const SbVec2i32 *newValues) |
| void | set1Value (int index, const SbVec2i32 &newValue) |
| void | setValue (const SbVec2i32 &newValue) |
| const SbVec2i32 & | operator= (const SbVec2i32 &newValue) |
| int | operator== (const SoMFVec2i32 &f) const |
| int | operator!= (const SoMFVec2i32 &f) const |
| virtual void | enableDeleteValues () |
| virtual void | disableDeleteValues () |
| virtual SbBool | isDeleteValuesEnabled () |
| virtual size_t | getValueSize () const |
| void | setValuesPointer (int num, const int32_t *userData) |
| void | setValuesPointer (int num, int32_t *userData) |
| void | setValuesPointer (int num, const SbVec2i32 *userData) |
| void | setValuesPointer (int num, SbVec2i32 *userData) |
| void | setValues (int start, int num, const int32_t xy[][2]) |
| void | set1Value (int index, int32_t x, int32_t y) |
| void | set1Value (int index, const int32_t xy[2]) |
| void | setValue (int32_t x, int32_t y) |
| void | setValue (const int32_t xy[2]) |
| void | set1Value (int index, const SbVec2f &vec2f) |
| void | set1Value (int index, const SbVec2d &vec2d) |
| void | setValue (const SbVec2f &vec2f) |
| void | setValue (const SbVec2d &vec2d) |
| void | setValues (int start, int num, const SbVec2f *vec2f) |
| void | setValues (int start, int num, const SbVec2d *vec2d) |
Static Public Member Functions | |
| static SoType | getClassTypeId () |
Detailed Description
Multiple-value field containing any number of two-dimensional vectors.
A multiple-value field that contains any number of two-dimensional vectors.
SoMFVec2i32s are written to file as one or more pairs of integer values separated by whitespace. When more than one value is present, all of the values are enclosed in square brackets and separated by commas; for example:
[ 0 0, 1 3, 98 10 ]
>
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
| SoMFVec2i32::SoMFVec2i32 | ( | ) |
Default constructor.
| virtual SoMFVec2i32::~SoMFVec2i32 | ( | ) | [virtual] |
Destructor.
Member Function Documentation
| virtual void SoMFVec2i32::disableDeleteValues | ( | ) | [inline, virtual] |
Temporary disable value deleting.
| virtual void SoMFVec2i32::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.
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 SoMFVec2i32::finishEditing | ( | ) | [inline] |
Indicates that batch edits have finished.
See startEditing().
| static SoType SoMFVec2i32::getClassTypeId | ( | ) | [static] |
Returns the type identifier for this class.
Reimplemented from SoMField.
| virtual SoType SoMFVec2i32::getTypeId | ( | ) | const [virtual] |
Returns the type identifier for this specific instance.
Implements SoTypedObject.
| const SbVec2i32* SoMFVec2i32::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 SoMFVec2i32::getValueSize | ( | ) | const [inline, virtual] |
Get size of the value.
Reimplemented from SoField.
| virtual SbBool SoMFVec2i32::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 SoMFVec2i32::operator!= | ( | const SoMFVec2i32 & | 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.
Sets the first value in the array to newValue, and deletes.
the second and subsequent values.
| const SoMFVec2i32& SoMFVec2i32::operator= | ( | const SoMFVec2i32 & | f | ) |
Copy from another field of same type.
| int SoMFVec2i32::operator== | ( | const SoMFVec2i32 & | 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.
| const SbVec2i32& SoMFVec2i32::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 SoMFVec2i32::set1Value | ( | int | index, | |
| const SbVec2d & | vec2d | |||
| ) |
Sets one value from double precision vector.
| void SoMFVec2i32::set1Value | ( | int | index, | |
| const SbVec2f & | vec2f | |||
| ) |
Sets one value from single precision vector.
| void SoMFVec2i32::set1Value | ( | int | index, | |
| const int32_t | xy[2] | |||
| ) |
Sets one value from 2 ints in array.
| void SoMFVec2i32::set1Value | ( | int | index, | |
| int32_t | x, | |||
| int32_t | y | |||
| ) |
Sets one value from 2 ints.
| void SoMFVec2i32::set1Value | ( | int | index, | |
| const SbVec2i32 & | newValue | |||
| ) |
Sets the index'th value in the array to newValue.
The array will be automatically expanded, if necessary.
| void SoMFVec2i32::setValue | ( | const SbVec2d & | vec2d | ) |
Sets to one value from double precision vector.
| void SoMFVec2i32::setValue | ( | const SbVec2f & | vec2f | ) |
Sets to one value from single precision vector.
| void SoMFVec2i32::setValue | ( | const int32_t | xy[2] | ) |
Sets to one value from 2 ints in array.
| void SoMFVec2i32::setValue | ( | int32_t | x, | |
| int32_t | y | |||
| ) |
Sets to one value from 2 ints.
| void SoMFVec2i32::setValue | ( | const SbVec2i32 & | newValue | ) |
Sets the first value in the array to newValue, and deletes.
the second and subsequent values.
| void SoMFVec2i32::setValues | ( | int | start, | |
| int | num, | |||
| const SbVec2d * | vec2d | |||
| ) |
Sets values from array of double precision vectors.
| void SoMFVec2i32::setValues | ( | int | start, | |
| int | num, | |||
| const SbVec2f * | vec2f | |||
| ) |
Sets values from array of single precision vectors.
| void SoMFVec2i32::setValues | ( | int | start, | |
| int | num, | |||
| const int32_t | xy[][2] | |||
| ) |
Sets values from array of arrays of 2 ints.
| void SoMFVec2i32::setValues | ( | int | start, | |
| int | num, | |||
| const SbVec2i32 * | 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 SoMFVec2i32::setValuesPointer | ( | int | num, | |
| SbVec2i32 * | userData | |||
| ) |
| void SoMFVec2i32::setValuesPointer | ( | int | num, | |
| const SbVec2i32 * | 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 SoMFVec2i32::setValuesPointer | ( | int | num, | |
| int32_t * | userData | |||
| ) |
| void SoMFVec2i32::setValuesPointer | ( | int | num, | |
| const int32_t * | 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).
| SbVec2i32* SoMFVec2i32::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/SoMFVec2i32.h