SoMFVec4ub Class Reference
[Fields]

Multiple-value field containing any number of four-dimensional vectors. More...

#include <Inventor/fields/SoMFVec4ub.h>

Inheritance diagram for SoMFVec4ub:
SoMField SoField SoTypedObject

List of all members.

Public Member Functions

virtual SoType getTypeId () const
const SoMFVec4uboperator= (const SoMFVec4ub &f)
 SoMFVec4ub ()
virtual ~SoMFVec4ub ()
SbVec4ubstartEditing ()
void finishEditing ()
const SbVec4uboperator[] (int i) const
const SbVec4ubgetValues (int start) const
int find (const SbVec4ub &targetValue, SbBool addIfNotFound=FALSE)
void setValues (int start, int num, const SbVec4ub *newValues)
void set1Value (int index, const SbVec4ub &newValue)
void setValue (const SbVec4ub &newValue)
const SbVec4uboperator= (const SbVec4ub &newValue)
int operator== (const SoMFVec4ub &f) const
int operator!= (const SoMFVec4ub &f) const
virtual void enableDeleteValues ()
virtual void disableDeleteValues ()
virtual SbBool isDeleteValuesEnabled ()
virtual size_t getValueSize () const
void setValuesPointer (int num, const unsigned char *userData)
void setValuesPointer (int num, unsigned char *userData)
void setValuesPointer (int num, const SbVec4ub *userData)
void setValuesPointer (int num, SbVec4ub *userData)
void setValues (int start, int num, const unsigned char xyzw[][4])
void set1Value (int index, unsigned char x, unsigned char y, unsigned char z, unsigned char w)
void set1Value (int index, const unsigned char xyzw[4])
void setValue (unsigned char x, unsigned char y, unsigned char z, unsigned char w)
void setValue (const unsigned char xyzw[4])
void set1Value (int index, const SbVec4f &vec4f)
void setValue (const SbVec4f &vec4f)
void setValues (int start, int num, const SbVec4f *vec4f)

Static Public Member Functions

static SoType getClassTypeId ()

Detailed Description

Multiple-value field containing any number of four-dimensional vectors.

A multiple-value field that contains any number of four-dimensional vectors.

SoMFVec4ubs are written to file as one or more quadruplets of unsigned char 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 0 0, 1 3 8 4, 100 17 52 38]
    

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

SoMFVec4ub::SoMFVec4ub (  ) 

Default constructor.

virtual SoMFVec4ub::~SoMFVec4ub (  )  [virtual]

Destructor.


Member Function Documentation

virtual void SoMFVec4ub::disableDeleteValues (  )  [inline, virtual]

Temporary disable value deleting.

virtual void SoMFVec4ub::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 SoMFVec4ub::find ( const SbVec4ub 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 SoMFVec4ub::finishEditing (  )  [inline]

Indicates that batch edits have finished.

See startEditing().

static SoType SoMFVec4ub::getClassTypeId (  )  [static]

Returns the type identifier for this class.

Reimplemented from SoMField.

virtual SoType SoMFVec4ub::getTypeId (  )  const [virtual]

Returns the type identifier for this specific instance.

Implements SoTypedObject.

const SbVec4ub* SoMFVec4ub::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 SoMFVec4ub::getValueSize (  )  const [inline, virtual]

Get size of the value.

Reimplemented from SoField.

virtual SbBool SoMFVec4ub::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 SoMFVec4ub::operator!= ( const SoMFVec4ub 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.

const SbVec4ub& SoMFVec4ub::operator= ( const SbVec4ub newValue  )  [inline]

Sets the first value in the array to newValue, and deletes.

the second and subsequent values.

const SoMFVec4ub& SoMFVec4ub::operator= ( const SoMFVec4ub f  ) 

Copy from another field of same type.

int SoMFVec4ub::operator== ( const SoMFVec4ub 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 SbVec4ub& SoMFVec4ub::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 SoMFVec4ub::set1Value ( int  index,
const SbVec4f vec4f 
)

Sets one value from single precision vector.

void SoMFVec4ub::set1Value ( int  index,
const unsigned char  xyzw[4] 
)

Sets one value from 4 unsigned chars in array.

void SoMFVec4ub::set1Value ( int  index,
unsigned char  x,
unsigned char  y,
unsigned char  z,
unsigned char  w 
)

Sets one value from 4 unsigned chars.

void SoMFVec4ub::set1Value ( int  index,
const SbVec4ub newValue 
)

Sets the index'th value in the array to newValue.

The array will be automatically expanded, if necessary.

void SoMFVec4ub::setValue ( const SbVec4f vec4f  ) 

Sets to one value from single precision vector.

void SoMFVec4ub::setValue ( const unsigned char  xyzw[4]  ) 

Sets to one value from 4 unsigned chars in array.

void SoMFVec4ub::setValue ( unsigned char  x,
unsigned char  y,
unsigned char  z,
unsigned char  w 
)

Sets to one value from 4 unsigned chars.

void SoMFVec4ub::setValue ( const SbVec4ub newValue  ) 

Sets the first value in the array to newValue, and deletes.

the second and subsequent values.

void SoMFVec4ub::setValues ( int  start,
int  num,
const SbVec4f vec4f 
)

Sets values from array of single precision vectors.

void SoMFVec4ub::setValues ( int  start,
int  num,
const unsigned char  xyzw[][4] 
)

Sets values from array of arrays of 4 unsigned chars.

void SoMFVec4ub::setValues ( int  start,
int  num,
const SbVec4ub 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 SoMFVec4ub::setValuesPointer ( int  num,
SbVec4ub userData 
)
void SoMFVec4ub::setValuesPointer ( int  num,
const SbVec4ub 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 SoMFVec4ub::setValuesPointer ( int  num,
unsigned char *  userData 
)
void SoMFVec4ub::setValuesPointer ( int  num,
const unsigned char *  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).

SbVec4ub* SoMFVec4ub::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:

Open Inventor Toolkit reference manual, generated on 15 Mar 2023
Copyright © Thermo Fisher Scientific All rights reserved.
http://www.openinventor.com/