SoMFMatrix Class Reference
[Fields]

Multiple-value field containing any number of 4x4 matrices. More...

#include <Inventor/fields/SoMFMatrix.h>

Inheritance diagram for SoMFMatrix:
SoMField SoField SoTypedObject

List of all members.

Public Member Functions

virtual SoType getTypeId () const
const SoMFMatrixoperator= (const SoMFMatrix &f)
 SoMFMatrix ()
virtual ~SoMFMatrix ()
SbMatrixstartEditing ()
void finishEditing ()
const SbMatrixoperator[] (int i) const
const SbMatrixgetValues (int start) const
int find (const SbMatrix &targetValue, SbBool addIfNotFound=FALSE)
void setValues (int start, int num, const SbMatrix *newValues)
void set1Value (int index, const SbMatrix &newValue)
void setValue (const SbMatrix &newValue)
const SbMatrixoperator= (const SbMatrix &newValue)
int operator== (const SoMFMatrix &f) const
int operator!= (const SoMFMatrix &f) const
virtual void enableDeleteValues ()
virtual void disableDeleteValues ()
virtual SbBool isDeleteValuesEnabled ()
virtual size_t getValueSize () const
void setValuesPointer (int num, const SbMatrix *userData)
void setValuesPointer (int num, SbMatrix *userData)
void setValue (float a11, float a12, float a13, float a14, float a21, float a22, float a23, float a24, float a31, float a32, float a33, float a34, float a41, float a42, float a43, float a44)
void set1Value (int index, const SbMatrixd &md)
void setValue (const SbMatrixd &md)
void setValues (int start, int num, const SbMatrixd *md)

Static Public Member Functions

static SoType getClassTypeId ()

Detailed Description

Multiple-value field containing any number of 4x4 matrices.

A multiple-value field that contains any number of 4x4 matrices.

SoMFMatrix are written to file as sets of 16 floating point numbers 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, two identity matrices might be written as:

      [ 1 0 0 0 0 1 0 0 0 0 1 0 0 0 0 1,
      1 0 0 0 0 1 0 0 0 0 1 0 0 0 0 1 ]
     

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

SoMFMatrix::SoMFMatrix (  ) 

Default constructor.

virtual SoMFMatrix::~SoMFMatrix (  )  [virtual]

Destructor.


Member Function Documentation

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

Temporary disable value deleting.

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

Indicates that batch edits have finished.

See startEditing().

static SoType SoMFMatrix::getClassTypeId (  )  [static]

Returns the type identifier for this class.

Reimplemented from SoMField.

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

Returns the type identifier for this specific instance.

Implements SoTypedObject.

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

Get size of the value.

Reimplemented from SoField.

virtual SbBool SoMFMatrix::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 SoMFMatrix::operator!= ( const SoMFMatrix 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 SbMatrix& SoMFMatrix::operator= ( const SbMatrix newValue  )  [inline]

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

the second and subsequent values.

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

Copy from another field of same type.

int SoMFMatrix::operator== ( const SoMFMatrix 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 SbMatrix& SoMFMatrix::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 SoMFMatrix::set1Value ( int  index,
const SbMatrixd md 
)

Sets the index 'th value in the array to newValue , a double precision matrix.

The array will be automatically expanded, if necessary. Note that Open Inventor fields still store only single precision values, not double precision values. The specified value is converted to single precision, then stored.

void SoMFMatrix::set1Value ( int  index,
const SbMatrix newValue 
)

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

The array will be automatically expanded, if necessary.

void SoMFMatrix::setValue ( const SbMatrixd md  ) 

Sets the first value in the array to newValue , a double precision matrix, and deletes the second and subsequent values.

Note that Open Inventor fields still store only single precision values, not double precision values. The specified value is converted to single precision, then stored.

void SoMFMatrix::setValue ( float  a11,
float  a12,
float  a13,
float  a14,
float  a21,
float  a22,
float  a23,
float  a24,
float  a31,
float  a32,
float  a33,
float  a34,
float  a41,
float  a42,
float  a43,
float  a44 
)

Makes this field contain one and only one value, which is the matrix given by the 16 values.

void SoMFMatrix::setValue ( const SbMatrix newValue  ) 

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

the second and subsequent values.

void SoMFMatrix::setValues ( int  start,
int  num,
const SbMatrixd md 
)

Sets num values starting at index start to the values in newValues , an array of double precision values.

The array will automatically be made larger to accommodate the new values, if necessary. Note that Open Inventor fields still store only single precision values, not double precision values. The specified values are converted to single precision, then stored.

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

SbMatrix* SoMFMatrix::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 12 Sep 2022
Copyright © Thermo Fisher Scientific All rights reserved.
http://www.openinventor.com/