GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  SOMFMATRIX (3)

NAME

SoMFMatrix — multiple-value field containing any number of 4x4 matrices

CONTENTS

Inherits From
Synopsis
Description
Methods

INHERITS FROM

SoField > SoMField > SoMFMatrix

SYNOPSIS

#include <Inventor/fields/SoMFMatrix.h>

Methods from class SoMFMatrix:

    void    
                    
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)    
static SoType    
                    
static SoType        getClassTypeId()    
virtual void    
                    
virtual void         getTypeId() const    
const SbMatrix &    
                    
const SbMatrix &     operator [](int i) const    
const SbMatrix *    
                    
const SbMatrix *     getValues(int start) const    
int    
                    
int                  find(const SbMatrix & targetValue, SbBool addIfNotFound = FALSE)    
void    
                    
void                 setValues(int start, int num, const SbMatrix *newValues)    
void    
                    
void                 set1Value(int index, const SbMatrix & newValue)    
const SbMatrix &    
                    
const SbMatrix &     operator =(const SbMatrix & newValue)    
void    
                    
void                 setValue(const SbMatrix & newValue)    
int    
                    
int                  operator ==(const SoMFMatrix &f) const    
int    
                    
int                  operator !=(const SoMFMatrix &f) const    
SbMatrix *    
                    
SbMatrix *           startEditing()    
void    
                    
void                 finishEditing()

Methods from class SoMField:

    int    
                    
int                  getNum() const    
void    
                    
void                 setNum(int num)    
virtual void    
                    
virtual void         deleteValues(int start, int num = -1)    
virtual void    
                    
virtual void         insertSpace(int start, int num)    
SbBool    
                    
SbBool               set1(int index, const char *valueString)    
void    
                    
void                 get1(int index, SbString &valueString)

Methods from class SoField:

    void    
                    
void                 setIgnored(SbBool ignore)    
SbBool    
                    
SbBool               isIgnored() const    
SbBool    
                    
SbBool               isDefault() const    
virtual SbBool    
                    
virtual SbBool       isOfType(SoType type) const    
SbBool    
                    
SbBool               set(const char *valueString)    
void    
                    
void                 get(SbString &valueString)    
void    
                    
void                 touch()    
SbBool    
                    
SbBool               connectFrom(SoField *fromField)    
SbBool    
                    
SbBool               connectFrom(SoEngineOutput *fromEngine)    
void    
                    
void                 disconnect()    
SbBool    
                    
SbBool               isConnected() const    
SbBool    
                    
SbBool               isConnectedFromField() const    
SbBool    
                    
SbBool               getConnectedField(SoField *&writingField) const    
SbBool    
                    
SbBool               isConnectedFromEngine() const    
SbBool    
                    
SbBool               getConnectedEngine(SoEngineOutput *&engineOutput) const    
void    
                    
void                 enableConnection(SbBool flag)    
SbBool    
                    
SbBool               isConnectionEnabled() const    
int    
                    
int                  getForwardConnections(SoFieldList &list) const    
SoFieldContainer *    
                    
SoFieldContainer *   getContainer() const

DESCRIPTION

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

SoMFMatrices 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 ]

METHODS

    void    
                    
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)
Makes this field contain one and only one value, which is the matrix given by the 16 values.

    static SoType    
                    
static SoType        getClassTypeId()    
virtual void    
                    
virtual void         getTypeId() const
Returns the type for this class or a particular object of this class.

    const SbMatrix &    
                    
const SbMatrix &     operator [](int i) const
Returns the i’th value of the field. Indexing past the end of the field (passing in i greater than getNum()) will return garbage.

    const SbMatrix *    
                    
const SbMatrix *     getValues(int start) const
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.

    int    
                    
int                  find(const SbMatrix & targetValue, SbBool addIfNotFound = FALSE)
Finds the given value 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    
                    
void                 setValues(int start, int num, const SbMatrix *newValues)
Sets num values starting at index start to the values in newValues. The array will be automatically be made larger to accomodate the new values, if necessary.

    void    
                    
void                 set1Value(int index, const SbMatrix & newValue)
Sets the index’th value in the array to newValue. The array will be automatically expanded, if necessary.

    const SbMatrix &    
                    
const SbMatrix &     operator =(const SbMatrix & newValue)    
void    
                    
void                 setValue(const SbMatrix & newValue)
Sets the first value in the array to newValue, and deletes the second and subsequent values.

    int    
                    
int                  operator ==(const SoMFMatrix &f) const    
int    
                    
int                  operator !=(const SoMFMatrix &f) const
Returns TRUE if all of the values of this field equal (do not equal) those of the given field. If the fields are different types FALSE will always be returned (even if one field is an SoMFFloat with one value of 1.0 and the other is an SoMFInt with a value of 1, for example).

    SbMatrix *    
                    
SbMatrix *           startEditing()    
void    
                    
void                 finishEditing()
startEditing() 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.

Search for    or go to Top of page |  Section 3 |  Main Index


SOMFMATRIX(3IV) (-->)

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.