.TH "SoSFMatrix" 3 "Tue Dec 26 2023 17:59:22" "Version 4.0.2" "Coin" \" -*- nroff -*-
.ad l
.nh
.SH NAME
SoSFMatrix \- The \fBSoSFMatrix\fP class is a container for an \fBSbMatrix\fP\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <Inventor/fields/SoSFMatrix\&.h>\fP
.PP
Inherits \fBSoSField\fP\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBvirtual\fP \fBSoType\fP \fBgetTypeId\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBcopyFrom\fP (\fBconst\fP \fBSoField\fP &\fBfield\fP)"
.br
.ti -1c
.RI "\fBconst\fP \fBSoSFMatrix\fP & \fBoperator=\fP (\fBconst\fP \fBSoSFMatrix\fP &\fBfield\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP SbBool \fBisSame\fP (\fBconst\fP \fBSoField\fP &\fBfield\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBconst\fP \fBSbMatrix\fP & \fBgetValue\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetValue\fP (\fBconst\fP \fBSbMatrix\fP &\fBnewvalue\fP)"
.br
.ti -1c
.RI "\fBconst\fP \fBSbMatrix\fP & \fBoperator=\fP (\fBconst\fP \fBSbMatrix\fP &\fBnewvalue\fP)"
.br
.ti -1c
.RI "int \fBoperator==\fP (\fBconst\fP \fBSoSFMatrix\fP &\fBfield\fP) \fBconst\fP"
.br
.ti -1c
.RI "int \fBoperator!=\fP (\fBconst\fP \fBSoSFMatrix\fP &\fBfield\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetValue\fP (\fBconst\fP float \fBa11\fP, \fBconst\fP float \fBa12\fP, \fBconst\fP float \fBa13\fP, \fBconst\fP float \fBa14\fP, \fBconst\fP float \fBa21\fP, \fBconst\fP float \fBa22\fP, \fBconst\fP float \fBa23\fP, \fBconst\fP float \fBa24\fP, \fBconst\fP float \fBa31\fP, \fBconst\fP float \fBa32\fP, \fBconst\fP float \fBa33\fP, \fBconst\fP float \fBa34\fP, \fBconst\fP float \fBa41\fP, \fBconst\fP float \fBa42\fP, \fBconst\fP float \fBa43\fP, \fBconst\fP float \fBa44\fP)"
.br
.in -1c

Public Member Functions inherited from \fBSoSField\fP
.in +1c
.ti -1c
.RI "\fBvirtual\fP \fB~SoSField\fP ()"
.br
.in -1c

Public Member Functions inherited from \fBSoField\fP
.in +1c
.ti -1c
.RI "\fBvirtual\fP \fB~SoField\fP ()"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetIgnored\fP (SbBool \fBignore\fP)"
.br
.ti -1c
.RI "SbBool \fBisIgnored\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetDefault\fP (SbBool \fBdefaultVal\fP)"
.br
.ti -1c
.RI "SbBool \fBisDefault\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBisOfType\fP (\fBconst\fP \fBSoType\fP type) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBenableConnection\fP (SbBool \fBflag\fP)"
.br
.ti -1c
.RI "SbBool \fBisConnectionEnabled\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBconnectFrom\fP (\fBSoEngineOutput\fP *master, SbBool \fBnotnotify\fP=FALSE, SbBool append=FALSE)"
.br
.ti -1c
.RI "SbBool \fBappendConnection\fP (\fBSoEngineOutput\fP *master, SbBool \fBnotnotify\fP=FALSE)"
.br
.ti -1c
.RI "\fBvoid\fP \fBdisconnect\fP (\fBSoEngineOutput\fP *\fBengineoutput\fP)"
.br
.ti -1c
.RI "SbBool \fBisConnectedFromEngine\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBgetConnectedEngine\fP (\fBSoEngineOutput\fP *&master) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBconnectFrom\fP (\fBSoField\fP *master, SbBool \fBnotnotify\fP=FALSE, SbBool append=FALSE)"
.br
.ti -1c
.RI "SbBool \fBappendConnection\fP (\fBSoField\fP *master, SbBool \fBnotnotify\fP=FALSE)"
.br
.ti -1c
.RI "\fBvoid\fP \fBdisconnect\fP (\fBSoField\fP *\fBfield\fP)"
.br
.ti -1c
.RI "SbBool \fBisConnectedFromField\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBgetConnectedField\fP (\fBSoField\fP *&master) \fBconst\fP"
.br
.ti -1c
.RI "int \fBgetNumConnections\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "int \fBgetForwardConnections\fP (\fBSoFieldList\fP &\fBslavelist\fP) \fBconst\fP"
.br
.ti -1c
.RI "int \fBgetConnections\fP (\fBSoFieldList\fP &\fBmasterlist\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBdisconnect\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "SbBool \fBisConnected\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetContainer\fP (\fBSoFieldContainer\fP *\fBcont\fP)"
.br
.ti -1c
.RI "\fBSoFieldContainer\fP * \fBgetContainer\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBset\fP (\fBconst\fP char *\fBvaluestring\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBget\fP (\fBSbString\fP &\fBvaluestring\fP)"
.br
.ti -1c
.RI "SbBool \fBshouldWrite\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBtouch\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBstartNotify\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBnotify\fP (\fBSoNotList\fP *\fBnlist\fP)"
.br
.ti -1c
.RI "SbBool \fBenableNotify\fP (SbBool on)"
.br
.ti -1c
.RI "SbBool \fBisNotifyEnabled\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBaddAuditor\fP (\fBvoid\fP *f, \fBSoNotRec::Type\fP type)"
.br
.ti -1c
.RI "\fBvoid\fP \fBremoveAuditor\fP (\fBvoid\fP *f, \fBSoNotRec::Type\fP type)"
.br
.ti -1c
.RI "int \fBoperator==\fP (\fBconst\fP \fBSoField\fP &f) \fBconst\fP"
.br
.ti -1c
.RI "int \fBoperator!=\fP (\fBconst\fP \fBSoField\fP &f) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBconnectionStatusChanged\fP (int \fBnumconnections\fP)"
.br
.ti -1c
.RI "SbBool \fBisReadOnly\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBfixCopy\fP (SbBool \fBcopyconnections\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP SbBool \fBreferencesCopy\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBcopyConnection\fP (\fBconst\fP \fBSoField\fP *fromfield)"
.br
.ti -1c
.RI "\fBvirtual\fP SbBool \fBread\fP (\fBSoInput\fP *input, \fBconst\fP \fBSbName\fP &name)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBwrite\fP (\fBSoOutput\fP *\fBout\fP, \fBconst\fP \fBSbName\fP &name) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBcountWriteRefs\fP (\fBSoOutput\fP *\fBout\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetFieldType\fP (int type)"
.br
.ti -1c
.RI "int \fBgetFieldType\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBgetDirty\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetDirty\fP (SbBool dirty)"
.br
.ti -1c
.RI "\fBvoid\fP \fBevaluate\fP (\fBvoid\fP) \fBconst\fP"
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP * \fBcreateInstance\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)"
.br
.in -1c

Static Public Member Functions inherited from \fBSoSField\fP
.in +1c
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBatexit_cleanup\fP (\fBvoid\fP)"
.br
.in -1c

Static Public Member Functions inherited from \fBSoField\fP
.in +1c
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitClasses\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBcleanupClass\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)"
.br
.in -1c
.SS "Protected Attributes"

.in +1c
.ti -1c
.RI "\fBSbMatrix\fP \fBvalue\fP"
.br
.in -1c
.SS "Additional Inherited Members"


Public Types inherited from \fBSoField\fP
.in +1c
.ti -1c
.RI "enum \fBFieldType\fP { \fBNORMAL_FIELD\fP = 0, \fBEVENTIN_FIELD\fP, \fBEVENTOUT_FIELD\fP, \fBEXPOSED_FIELD\fP }"
.br
.in -1c

Protected Member Functions inherited from \fBSoSField\fP
.in +1c
.ti -1c
.RI "\fBSoSField\fP (\fBvoid\fP)"
.br
.in -1c

Protected Member Functions inherited from \fBSoField\fP
.in +1c
.ti -1c
.RI "\fBSoField\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBvalueChanged\fP (SbBool \fBresetdefault\fP=TRUE)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBevaluateConnection\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP SbBool \fBreadConnection\fP (\fBSoInput\fP *\fBin\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBwriteConnection\fP (\fBSoOutput\fP *\fBout\fP) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBisDestructing\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBSoNotRec\fP \fBcreateNotRec\fP (\fBSoBase\fP *\fBcont\fP)"
.br
.in -1c
.SH "Detailed Description"
.PP 
The \fBSoSFMatrix\fP class is a container for an \fBSbMatrix\fP\&. 

This field is used where nodes, engines or other field containers need to store a 4x4 matrix\&.
.PP
Fields of this type stores their value to file as a set of 16 floating point values, written from the matrix in row-major mode\&.
.PP
\fBSee also\fP
.RS 4
\fBSoMFMatrix\fP 
.RE
.PP

.SH "Member Function Documentation"
.PP 
.SS "\fBvoid\fP * SoSFMatrix::createInstance (\fBvoid\fP)\fC [static]\fP"
\fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP
.br

.br
 Creates a new instance of the class type corresponding to the \fBSoType\fP object\&. 
.br
 
.SS "\fBSoType\fP SoSFMatrix::getClassTypeId (\fBvoid\fP)\fC [static]\fP"
This static method returns the \fBSoType\fP object associated with objects of this class\&. 
.br
 
.SS "\fBSoType\fP SoSFMatrix::getTypeId (\fBvoid\fP) const\fC [virtual]\fP"
Returns the type identification of an object derived from a class inheriting \fBSoField\fP\&. This is used for runtime type checking and 'downward' casting\&. 
.br
 
.PP
Implements \fBSoField\fP\&.
.SS "\fBvoid\fP SoSFMatrix::copyFrom (\fBconst\fP \fBSoField\fP & f)\fC [virtual]\fP"
Copy value(s) from \fIf\fP into this field\&. \fIf\fP must be of the same type as this field\&. 
.PP
Implements \fBSoField\fP\&.
.SS "SbBool SoSFMatrix::isSame (\fBconst\fP \fBSoField\fP & f) const\fC [virtual]\fP"
Check for equal type and value(s)\&. 
.PP
Implements \fBSoField\fP\&.
.SS "\fBvoid\fP SoSFMatrix::initClass (\fBvoid\fP)\fC [static]\fP"
Internal method called upon initialization of the library (from \fBSoDB::init()\fP) to set up the type system\&.   
.SS "\fBvoid\fP SoSFMatrix::setValue (\fBconst\fP float a11, \fBconst\fP float a12, \fBconst\fP float a13, \fBconst\fP float a14, \fBconst\fP float a21, \fBconst\fP float a22, \fBconst\fP float a23, \fBconst\fP float a24, \fBconst\fP float a31, \fBconst\fP float a32, \fBconst\fP float a33, \fBconst\fP float a34, \fBconst\fP float a41, \fBconst\fP float a42, \fBconst\fP float a43, \fBconst\fP float a44)"
Set matrix elements\&. 

.SH "Author"
.PP 
Generated automatically by Doxygen for Coin from the source code\&.