Open Inventor Release 2023.2.3
 
Loading...
Searching...
No Matches
SoSFMatrix Class Reference

Field containing a 4x4 matrix. More...

#include <Inventor/fields/SoSFMatrix.h>

+ Inheritance diagram for SoSFMatrix:

Public Member Functions

virtual SoType getTypeId () const
 Returns the type identifier for this specific instance.
 
const SoSFMatrixoperator= (const SoSFMatrix &f)
 Copy from another field of same type.
 
 SoSFMatrix ()
 Default constructor.
 
virtual ~SoSFMatrix ()
 Destructor.
 
const SbMatrixgetValue () const
 Returns this field's value.
 
void setValue (const SbMatrix &newValue)
 Sets this field to newValue.
 
const SbMatrixoperator= (const SbMatrix &newValue)
 Sets this field to newValue.
 
int operator== (const SoSFMatrix &f) const
 Returns TRUE if otherField is of the same type and has the same value as this field.
 
int operator!= (const SoSFMatrix &f) const
 Returns FALSE if otherField is of the same type and has the same value as this field.
 
virtual size_t getValueSize () const
 Get size of the value.
 
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)
 Sets this field to contain the matrix given by the 16 values.
 
void setValue (const SbMatrixd &md)
 Convenience method that allows you to specify a field value using a double precision variable.
 
- Public Member Functions inherited from SoField
void setIgnored (SbBool ig)
 Sets the ignore flag for this field.
 
SbBool isIgnored () const
 Gets the ignore flag for this field.
 
SbBool isDefault () const
 Gets the state of default flag of the field.
 
void enableConnection (SbBool flag)
 Field connections may be enabled and disabled.
 
SbBool isConnectionEnabled () const
 Returns FALSE if connections to this field are disabled.
 
SbBool connectFrom (SoEngineOutput *engineOutput)
 Connects this field from an engine output.
 
SbBool connectFrom (SoField *field)
 Connects this field to another field.
 
SbBool connectFrom (SoVRMLInterpOutput *interpOutput)
 Connects this field from an interpOutput.
 
SbBool appendConnection (SoEngineOutput *engineOutput)
 Appends this field to the list of connections from another engineOutput.
 
SbBool appendConnection (SoField *field)
 Appends this field to the list of connections from another field.
 
SbBool appendConnection (SoVRMLInterpOutput *interpOutput)
 Appends this field to the list of connections from another interpOutput.
 
void disconnect (SoEngineOutput *engineOutput)
 Disconnect the field from the requested engineOutput.
 
void disconnect (SoField *field)
 Disconnect the field from the requested field.
 
void disconnect (SoVRMLInterpOutput *interpOutput)
 Disconnect the field from the requested interpOutput.
 
int getNumConnections () const
 Returns the number of connections to this field.
 
int getConnections (SoFieldList &list)
 Returns a list of the connections to this field.
 
void disconnect ()
 Disconnect the field from whatever it was connected to.
 
SbBool isConnected () const
 Returns TRUE if the field is connected to anything.
 
SbBool isConnectedFromVRMLInterp () const
 Returns TRUE if the field is connected to a VRML interpOutput.
 
SbBool isConnectedFromEngine () const
 Returns TRUE if the field is connected to an engine's output.
 
SbBool isConnectedFromField () const
 Returns TRUE if the field is connected to another field.
 
SbBool getConnectedEngine (SoEngineOutput *&engineOutput) const
 Returns TRUE if this field is being written into by an engine, and returns the engine output it is connected to in engineOutput.
 
SbBool getConnectedField (SoField *&writingField) const
 Returns TRUE if this field is being written into by another field, and returns the field it is connected to in writingField.
 
SbBool getConnectedVRMLInterp (SoVRMLInterpOutput *&interpOutput) const
 Returns the VRMLInterpolator output field is connected to.
 
int getForwardConnections (SoFieldList &list) const
 Adds references to all of the fields that this field is writing into (either fields in nodes, global fields or engine inputs) to the given field list, and returns the number of forward connections.
 
SoFieldContainergetContainer () const
 Returns the object that contains this field.
 
SoNONUNICODE SbBool set (const char *valueString)
 Sets the field to the given value, which is an ASCII string in the Open Inventor file format.
 
SbBool set (const SbString &valueString)
 Sets the field to the given value, which is an ASCII string in the Open Inventor file format.
 
void get (SbString &valueString)
 Returns the value of the field in the Open Inventor file format, even if the field has its default value.
 
virtual void touch ()
 Simulates a change to the field, causing attached sensors to fire, connected fields and engines to be marked as needing evaluation, and so forth.
 
int operator== (const SoField &f) const
 Return TRUE if this field is of the same type and has the same value as f.
 
int operator!= (const SoField &f) const
 Return FALSE if this field is of the same type and has the same value as f.
 
- Public Member Functions inherited from SoTypedObject
SbBool isOfType (const SoType &type) const
 Returns TRUE if this object is of the type specified in type or is derived from that type.
 
template<typename TypedObjectClass >
SbBool isOfType () const
 Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.
 

Static Public Member Functions

static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
- Static Public Member Functions inherited from SoSField
static SoType getClassTypeId ()
 Return the type identifier for this field class.
 
- Static Public Member Functions inherited from SoField
static SoType getClassTypeId ()
 Return the type identifier for this field class.
 
- Static Public Member Functions inherited from SoTypedObject
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 

Detailed Description

Field containing a 4x4 matrix.

A field containing a transformation matrix (an SbMatrix).

SoSFMatrixs are written to file as 16 floating point numbers separated by whitespace. For example, an identity matrix is written as:

   1 0 0 0 0 1 0 0 0 0 1 0 0 0 0 1

SEE ALSO

SoField, SoSField, SoMFMatrix, SbMatrix

Definition at line 86 of file SoSFMatrix.h.

Constructor & Destructor Documentation

◆ SoSFMatrix()

SoSFMatrix::SoSFMatrix ( )

Default constructor.

◆ ~SoSFMatrix()

virtual SoSFMatrix::~SoSFMatrix ( )
virtual

Destructor.

Member Function Documentation

◆ getClassTypeId()

static SoType SoSFMatrix::getClassTypeId ( )
static

Returns the type identifier for this class.


◆ getTypeId()

virtual SoType SoSFMatrix::getTypeId ( ) const
virtual

Returns the type identifier for this specific instance.

Implements SoTypedObject.

◆ getValue()

const SbMatrix & SoSFMatrix::getValue ( ) const
inline

Returns this field's value.

Definition at line 89 of file SoSFMatrix.h.

◆ getValueSize()

virtual size_t SoSFMatrix::getValueSize ( ) const
inlinevirtual

Get size of the value.

Reimplemented from SoField.

Definition at line 89 of file SoSFMatrix.h.

◆ operator!=()

int SoSFMatrix::operator!= ( const SoSFMatrix f) const
inline

Returns FALSE if otherField is of the same type and has the same value as this field.

Definition at line 89 of file SoSFMatrix.h.

◆ operator=() [1/2]

const SbMatrix & SoSFMatrix::operator= ( const SbMatrix newValue)
inline

Sets this field to newValue.

Definition at line 89 of file SoSFMatrix.h.

◆ operator=() [2/2]

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

Copy from another field of same type.

◆ operator==()

int SoSFMatrix::operator== ( const SoSFMatrix f) const

Returns TRUE if otherField is of the same type and has the same value as this field.

◆ setValue() [1/3]

void SoSFMatrix::setValue ( const SbMatrix newValue)

Sets this field to newValue.

◆ setValue() [2/3]

void SoSFMatrix::setValue ( const SbMatrixd md)

Convenience method that allows you to specify a field value using a double precision variable.

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.

◆ setValue() [3/3]

void SoSFMatrix::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 
)

Sets this field to contain the matrix given by the 16 values.

For a translation matrix, the x, y and z translations should be in the a41, a42, and a43 arguments.


The documentation for this class was generated from the following file: