SoMFKernel2i32 Class Reference
[Fields]

ImageViz Multiple-value field containing any number of SbKernel2i32 objects. More...

#include <ImageViz/Fields/SoMFKernel2i32.h>

Inheritance diagram for SoMFKernel2i32:
SoMField SoField SoTypedObject

List of all members.

Public Member Functions

virtual SoType getTypeId () const
const SoMFKernel2i32operator= (const SoMFKernel2i32 &f)
 SoMFKernel2i32 ()
virtual ~SoMFKernel2i32 ()
SbKernel2i32startEditing ()
void finishEditing ()
SbKernel2i32 operator[] (int i) const
const SbKernel2i32getValues (int start) const
int find (SbKernel2i32 targetValue, SbBool addIfNotFound=FALSE)
void setValues (int start, int num, const SbKernel2i32 *newValues)
void set1Value (int index, SbKernel2i32 newValue)
void setValue (SbKernel2i32 newValue)
SbKernel2i32 operator= (SbKernel2i32 newValue)
int operator== (const SoMFKernel2i32 &f) const
int operator!= (const SoMFKernel2i32 &f) const
virtual void enableDeleteValues ()
virtual void disableDeleteValues ()
virtual SbBool isDeleteValuesEnabled ()
virtual size_t getValueSize () const
void setValuesPointer (int num, const SbKernel2i32 *userData)
void setValuesPointer (int num, SbKernel2i32 *userData)

Static Public Member Functions

static SoType getClassTypeId ()

Detailed Description

ImageViz Multiple-value field containing any number of SbKernel2i32 objects.

A multiple-value field that contains any number of SbKernel2i32 objects.

SEE ALSO

SbKernel2i32


Constructor & Destructor Documentation

SoMFKernel2i32::SoMFKernel2i32 (  ) 

Default constructor.

virtual SoMFKernel2i32::~SoMFKernel2i32 (  )  [virtual]

Destructor.


Member Function Documentation

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

Temporary disable value deleting.

virtual void SoMFKernel2i32::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 SoMFKernel2i32::find ( SbKernel2i32  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 SoMFKernel2i32::finishEditing (  )  [inline]

Indicates that batch edits have finished.

See startEditing().

static SoType SoMFKernel2i32::getClassTypeId (  )  [static]

Returns the type identifier for this class.

Reimplemented from SoMField.

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

Returns the type identifier for this specific instance.

Implements SoTypedObject.

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

Get size of the value.

Reimplemented from SoField.

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

SbKernel2i32 SoMFKernel2i32::operator= ( SbKernel2i32  newValue  )  [inline]

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

the second and subsequent values.

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

Copy from another field of same type.

int SoMFKernel2i32::operator== ( const SoMFKernel2i32 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.

SbKernel2i32 SoMFKernel2i32::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 SoMFKernel2i32::set1Value ( int  index,
SbKernel2i32  newValue 
)

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

The array will be automatically expanded, if necessary.

void SoMFKernel2i32::setValue ( SbKernel2i32  newValue  ) 

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

the second and subsequent values.

void SoMFKernel2i32::setValues ( int  start,
int  num,
const SbKernel2i32 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 SoMFKernel2i32::setValuesPointer ( int  num,
SbKernel2i32 userData 
)
void SoMFKernel2i32::setValuesPointer ( int  num,
const SbKernel2i32 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).

SbKernel2i32* SoMFKernel2i32::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 1 Nov 2022
Copyright © Thermo Fisher Scientific All rights reserved.
http://www.openinventor.com/