.TH "coin_fields" 3 "Tue Dec 26 2023 17:59:22" "Version 4.0.2" "Coin" \" -*- nroff -*-
.ad l
.nh
.SH NAME
coin_fields \- Field Classes
.PP
 \- The fields are the data containers in the scene graph\&. Nodes and engines all use fields to store their public data\&.  

.SH SYNOPSIS
.br
.PP
.SS "Classes"

.in +1c
.ti -1c
.RI "class \fBSoField\fP"
.br
.RI "The \fBSoField\fP class is the top-level abstract base class for fields\&. "
.ti -1c
.RI "class \fBSoFieldData\fP"
.br
.RI "The \fBSoFieldData\fP class is a container for a prototype set of fields\&. "
.ti -1c
.RI "class \fBSoMFBitMask\fP"
.br
.RI "The \fBSoMFBitMask\fP class is a container for a set of bitmasks\&. "
.ti -1c
.RI "class \fBSoMFBool\fP"
.br
.RI "The \fBSoMFBool\fP class is a container for SbBool values\&. "
.ti -1c
.RI "class \fBSoMFColor\fP"
.br
.RI "The \fBSoMFColor\fP class is a container for \fBSbColor\fP values\&. "
.ti -1c
.RI "class \fBSoMFColorRGBA\fP"
.br
.RI "The \fBSoMFColorRGBA\fP class is a container for \fBSbColor4f\fP values\&. "
.ti -1c
.RI "class \fBSoMFDouble\fP"
.br
.RI "The \fBSoMFDouble\fP class is a container for double float precision point values\&. "
.ti -1c
.RI "class \fBSoMFEngine\fP"
.br
.RI "The \fBSoMFEngine\fP class is a container for engines\&. "
.ti -1c
.RI "class \fBSoMFEnum\fP"
.br
.RI "The \fBSoMFEnum\fP class is a container for a set of enumerated values\&. "
.ti -1c
.RI "class \fBSoMFFloat\fP"
.br
.RI "The \fBSoMFFloat\fP class is a container for floating point values\&. "
.ti -1c
.RI "class \fBSoMFInt32\fP"
.br
.RI "The \fBSoMFInt32\fP class is a container for 32-bit integer values\&. "
.ti -1c
.RI "class \fBSoMFMatrix\fP"
.br
.RI "The \fBSoMFMatrix\fP class is a container for \fBSbMatrix\fP values\&. "
.ti -1c
.RI "class \fBSoMFName\fP"
.br
.RI "The \fBSoMFName\fP class is a container for \fBSbName\fP values\&. "
.ti -1c
.RI "class \fBSoMFNode\fP"
.br
.RI "The \fBSoMFNode\fP class is a container for nodes\&. "
.ti -1c
.RI "class \fBSoMFPath\fP"
.br
.RI "The \fBSoMFPath\fP class is a container for paths\&. "
.ti -1c
.RI "class \fBSoMFPlane\fP"
.br
.RI "The \fBSoMFPlane\fP class is a container for \fBSbPlane\fP values\&. "
.ti -1c
.RI "class \fBSoMFRotation\fP"
.br
.RI "The \fBSoMFRotation\fP class is a container for \fBSbRotation\fP values\&. "
.ti -1c
.RI "class \fBSoMFShort\fP"
.br
.RI "The \fBSoMFShort\fP class is a container for short integer values\&. "
.ti -1c
.RI "class \fBSoMFString\fP"
.br
.RI "The \fBSoMFString\fP class is a container for \fBSbString\fP values\&. "
.ti -1c
.RI "class \fBSoMFTime\fP"
.br
.RI "The \fBSoMFTime\fP class is a container for \fBSbTime\fP values\&. "
.ti -1c
.RI "class \fBSoMFUInt32\fP"
.br
.RI "The \fBSoMFUInt32\fP class is a container for 32-bit unsigned integer values\&. "
.ti -1c
.RI "class \fBSoMFUShort\fP"
.br
.RI "The \fBSoMFUShort\fP class is a container for unsigned short integer values\&. "
.ti -1c
.RI "class \fBSoMFVec2b\fP"
.br
.RI "The \fBSoMFVec2b\fP class is a container for \fBSbVec2b\fP vectors\&. "
.ti -1c
.RI "class \fBSoMFVec2s\fP"
.br
.RI "The \fBSoMFVec2s\fP class is a container for \fBSbVec2s\fP vectors\&. "
.ti -1c
.RI "class \fBSoMFVec2i32\fP"
.br
.RI "The \fBSoMFVec2i32\fP class is a container for \fBSbVec2i32\fP vectors\&. "
.ti -1c
.RI "class \fBSoMFVec2f\fP"
.br
.RI "The \fBSoMFVec2f\fP class is a container for \fBSbVec2f\fP vectors\&. "
.ti -1c
.RI "class \fBSoMFVec2d\fP"
.br
.RI "The \fBSoMFVec2d\fP class is a container for \fBSbVec2d\fP vectors\&. "
.ti -1c
.RI "class \fBSoMFVec3b\fP"
.br
.RI "The \fBSoMFVec3b\fP class is a container for \fBSbVec3b\fP vectors\&. "
.ti -1c
.RI "class \fBSoMFVec3s\fP"
.br
.RI "The \fBSoMFVec3s\fP class is a container for \fBSbVec3s\fP vectors\&. "
.ti -1c
.RI "class \fBSoMFVec3i32\fP"
.br
.RI "The \fBSoMFVec3i32\fP class is a container for \fBSbVec3i32\fP vectors\&. "
.ti -1c
.RI "class \fBSoMFVec3f\fP"
.br
.RI "The \fBSoMFVec3f\fP class is a container for \fBSbVec3f\fP vectors\&. "
.ti -1c
.RI "class \fBSoMFVec3d\fP"
.br
.RI "The \fBSoMFVec3d\fP class is a container for \fBSbVec3d\fP vectors\&. "
.ti -1c
.RI "class \fBSoMFVec4b\fP"
.br
.RI "The \fBSoMFVec4b\fP class is a container for \fBSbVec4b\fP vectors\&. "
.ti -1c
.RI "class \fBSoMFVec4ub\fP"
.br
.RI "The \fBSoMFVec4ub\fP class is a container for \fBSbVec4ub\fP vectors\&. "
.ti -1c
.RI "class \fBSoMFVec4s\fP"
.br
.RI "The \fBSoMFVec4s\fP class is a container for \fBSbVec4s\fP vectors\&. "
.ti -1c
.RI "class \fBSoMFVec4us\fP"
.br
.RI "The \fBSoMFVec4us\fP class is a container for \fBSbVec4us\fP vectors\&. "
.ti -1c
.RI "class \fBSoMFVec4i32\fP"
.br
.RI "The \fBSoMFVec4i32\fP class is a container for \fBSbVec4i32\fP vectors\&. "
.ti -1c
.RI "class \fBSoMFVec4ui32\fP"
.br
.RI "The \fBSoMFVec4ui32\fP class is a container for \fBSbVec4ui32\fP vectors\&. "
.ti -1c
.RI "class \fBSoMFVec4f\fP"
.br
.RI "The \fBSoMFVec4f\fP class is a container for \fBSbVec4f\fP vectors\&. "
.ti -1c
.RI "class \fBSoMFVec4d\fP"
.br
.RI "The \fBSoMFVec4d\fP class is a container for \fBSbVec4d\fP vectors\&. "
.ti -1c
.RI "class \fBSoMField\fP"
.br
.RI "The \fBSoMField\fP class is the base class for fields which can contain multiple values\&. "
.ti -1c
.RI "class \fBSoSFBitMask\fP"
.br
.RI "The \fBSoSFBitMask\fP class is a container for a set of bit flags\&. "
.ti -1c
.RI "class \fBSoSFBool\fP"
.br
.RI "The \fBSoSFBool\fP class is a container for an SbBool value\&. "
.ti -1c
.RI "class \fBSoSFBox2s\fP"
.br
.RI "The \fBSoSFBox2s\fP class is a container for an \fBSbBox2s\fP vector\&. "
.ti -1c
.RI "class \fBSoSFBox2i32\fP"
.br
.RI "The \fBSoSFBox2i32\fP class is a container for an \fBSbBox2i32\fP vector\&. "
.ti -1c
.RI "class \fBSoSFBox2f\fP"
.br
.RI "The \fBSoSFBox2f\fP class is a container for an \fBSbBox2f\fP vector\&. "
.ti -1c
.RI "class \fBSoSFBox2d\fP"
.br
.RI "The \fBSoSFBox2d\fP class is a container for an \fBSbBox2d\fP vector\&. "
.ti -1c
.RI "class \fBSoSFBox3s\fP"
.br
.RI "The \fBSoSFBox3s\fP class is a container for an \fBSbBox3s\fP vector\&. "
.ti -1c
.RI "class \fBSoSFBox3i32\fP"
.br
.RI "The \fBSoSFBox3i32\fP class is a container for an \fBSbBox3i32\fP vector\&. "
.ti -1c
.RI "class \fBSoSFBox3f\fP"
.br
.RI "The \fBSoSFBox3f\fP class is a container for an \fBSbBox3f\fP vector\&. "
.ti -1c
.RI "class \fBSoSFBox3d\fP"
.br
.RI "The \fBSoSFBox3d\fP class is a container for an \fBSbBox3d\fP vector\&. "
.ti -1c
.RI "class \fBSoSFColor\fP"
.br
.RI "The \fBSoSFColor\fP class is a container for an \fBSbColor\fP value\&. "
.ti -1c
.RI "class \fBSoSFColorRGBA\fP"
.br
.RI "The \fBSoSFColorRGBA\fP class is a container for an \fBSbColor4f\fP value\&. "
.ti -1c
.RI "class \fBSoSFDouble\fP"
.br
.RI "The \fBSoSFDouble\fP class is a container for a double precision floating point value\&. "
.ti -1c
.RI "class \fBSoSFEngine\fP"
.br
.RI "The \fBSoSFEngine\fP class is a container for a single engine\&. "
.ti -1c
.RI "class \fBSoSFEnum\fP"
.br
.RI "The \fBSoSFEnum\fP class is a container for an enum value\&. "
.ti -1c
.RI "class \fBSoSFFloat\fP"
.br
.RI "The \fBSoSFFloat\fP class is a container for a floating point value\&. "
.ti -1c
.RI "class \fBSoSFImage\fP"
.br
.RI "The \fBSoSFImage\fP class is used to store pixel images\&. "
.ti -1c
.RI "class \fBSoSFImage3\fP"
.br
.RI "The \fBSoSFImage3\fP class is used to store 3D (volume) images\&. "
.ti -1c
.RI "class \fBSoSFInt32\fP"
.br
.RI "The \fBSoSFInt32\fP class is a container for a 32-bit integer value\&. "
.ti -1c
.RI "class \fBSoSFMatrix\fP"
.br
.RI "The \fBSoSFMatrix\fP class is a container for an \fBSbMatrix\fP\&. "
.ti -1c
.RI "class \fBSoSFName\fP"
.br
.RI "The \fBSoSFName\fP class is a container for an \fBSbName\fP\&. "
.ti -1c
.RI "class \fBSoSFNode\fP"
.br
.RI "The \fBSoSFNode\fP class is a container for a single node\&. "
.ti -1c
.RI "class \fBSoSFPath\fP"
.br
.RI "The \fBSoSFPath\fP class is a container for a single path\&. "
.ti -1c
.RI "class \fBSoSFPlane\fP"
.br
.RI "The \fBSoSFPlane\fP class is a container for an \fBSbPlane\fP value\&. "
.ti -1c
.RI "class \fBSoSFRotation\fP"
.br
.RI "The \fBSoSFRotation\fP class is a container for an \fBSbRotation\fP\&. "
.ti -1c
.RI "class \fBSoSFShort\fP"
.br
.RI "The \fBSoSFShort\fP class is a container for a short integer value\&. "
.ti -1c
.RI "class \fBSoSFString\fP"
.br
.RI "The \fBSoSFString\fP class is a container for an \fBSbString\fP\&. "
.ti -1c
.RI "class \fBSoSFTime\fP"
.br
.RI "The \fBSoSFTime\fP class is a container for an \fBSbTime\fP value\&. "
.ti -1c
.RI "class \fBSoSFTrigger\fP"
.br
.RI "The \fBSoSFTrigger\fP class is the 'void' class used for detecting field changes\&. "
.ti -1c
.RI "class \fBSoSFUInt32\fP"
.br
.RI "The \fBSoSFUInt32\fP class is a container for a 32-bit unsigned integer value\&. "
.ti -1c
.RI "class \fBSoSFUShort\fP"
.br
.RI "The \fBSoSFUShort\fP class is a container for a unsigned short integer value\&. "
.ti -1c
.RI "class \fBSoSFVec2b\fP"
.br
.RI "The \fBSoSFVec2b\fP class is a container for an \fBSbVec2b\fP vector\&. "
.ti -1c
.RI "class \fBSoSFVec2s\fP"
.br
.RI "The \fBSoSFVec2s\fP class is a container for an \fBSbVec2s\fP vector\&. "
.ti -1c
.RI "class \fBSoSFVec2i32\fP"
.br
.RI "The \fBSoSFVec2i32\fP class is a container for an \fBSbVec2i32\fP vector\&. "
.ti -1c
.RI "class \fBSoSFVec2f\fP"
.br
.RI "The \fBSoSFVec2f\fP class is a container for an \fBSbVec2f\fP vector\&. "
.ti -1c
.RI "class \fBSoSFVec2d\fP"
.br
.RI "The \fBSoSFVec2d\fP class is a container for an \fBSbVec2d\fP vector\&. "
.ti -1c
.RI "class \fBSoSFVec3b\fP"
.br
.RI "The \fBSoSFVec3b\fP class is a container for an \fBSbVec3b\fP vector\&. "
.ti -1c
.RI "class \fBSoSFVec3s\fP"
.br
.RI "The \fBSoSFVec3s\fP class is a container for an \fBSbVec3s\fP vector\&. "
.ti -1c
.RI "class \fBSoSFVec3i32\fP"
.br
.RI "The \fBSoSFVec3i32\fP class is a container for an \fBSbVec3i32\fP vector\&. "
.ti -1c
.RI "class \fBSoSFVec3f\fP"
.br
.RI "The \fBSoSFVec3f\fP class is a container for an \fBSbVec3f\fP vector\&. "
.ti -1c
.RI "class \fBSoSFVec3d\fP"
.br
.RI "The \fBSoSFVec3d\fP class is a container for an \fBSbVec3d\fP vector\&. "
.ti -1c
.RI "class \fBSoSFVec4b\fP"
.br
.RI "The \fBSoSFVec4b\fP class is a container for an \fBSbVec4b\fP vector\&. "
.ti -1c
.RI "class \fBSoSFVec4ub\fP"
.br
.RI "The \fBSoSFVec4ub\fP class is a container for an \fBSbVec4ub\fP vector\&. "
.ti -1c
.RI "class \fBSoSFVec4s\fP"
.br
.RI "The \fBSoSFVec4s\fP class is a container for an \fBSbVec4s\fP vector\&. "
.ti -1c
.RI "class \fBSoSFVec4us\fP"
.br
.RI "The \fBSoSFVec4us\fP class is a container for an \fBSbVec4us\fP vector\&. "
.ti -1c
.RI "class \fBSoSFVec4i32\fP"
.br
.RI "The \fBSoSFVec4i32\fP class is a container for an \fBSbVec4i32\fP vector\&. "
.ti -1c
.RI "class \fBSoSFVec4ui32\fP"
.br
.RI "The \fBSoSFVec4ui32\fP class is a container for an \fBSbVec4ui32\fP vector\&. "
.ti -1c
.RI "class \fBSoSFVec4f\fP"
.br
.RI "The \fBSoSFVec4f\fP class is a container for an \fBSbVec4f\fP vector\&. "
.ti -1c
.RI "class \fBSoSFVec4d\fP"
.br
.RI "The \fBSoSFVec4d\fP class is a container for an \fBSbVec4d\fP vector\&. "
.ti -1c
.RI "class \fBSoSField\fP"
.br
.RI "The \fBSoSField\fP class is the base class for fields which contains only a single value\&. "
.ti -1c
.RI "class \fBSoFieldList\fP"
.br
.RI "The \fBSoFieldList\fP class is a container for pointers to \fBSoField\fP objects\&. "
.in -1c
.SH "Detailed Description"
.PP 
The fields are the data containers in the scene graph\&. Nodes and engines all use fields to store their public data\&. 

Fields can be inter-connected, causing changes at one location in a scene graph to cause other parts of the scene graph to automatically also get updated\&. Direct field-to-field connections will cause values to get duplicated, while field connections together with engines can create complex networks for such updating that include mathematical computations and logical operations\&. Field connections are uni-directional, but setting up a connection in both directions will cause a bi-directional connection\&.
.PP
Fields are first divided into two groups; 'single fields' and 'multi
fields'\&. Single-fields contain just one value, while multi-fields can contain many values or even none at all\&.
.PP
Besides fields that are part of nodes, you also have 'global fields'\&. The 'realtime' field is one such field\&.
.PP
The fields in VRML97 nodes have additional semantics\&. Some are 'event_in' and some are 'event_out', listening for events or triggering events\&. 'event_in' events should not be read from, and 'event_out' fields should not be written to\&. 
.SH "Author"
.PP 
Generated automatically by Doxygen for Coin from the source code\&.