.TH "SoFieldContainer" 3 "Thu May 29 2014" "Version 4.0.0a" "Coin" \" -*- nroff -*- .ad l .nh .SH NAME SoFieldContainer \- .PP The \fBSoFieldContainer\fP class is a base class for all classes that contain fields\&. .PP The classes containing fields in Coin are the node and engine classes, so they are all subclasses of \fBSoFieldContainer\fP\&. .SH SYNOPSIS .br .PP .PP \fC#include \fP .PP Inherits \fBSoBase\fP\&. .PP Inherited by \fBSoEngine\fP, and \fBSoNode\fP\&. .SS "Public Member Functions" .in +1c .ti -1c .RI "void \fBsetToDefaults\fP (void)" .br .ti -1c .RI "SbBool \fBhasDefaultValues\fP (void) const " .br .ti -1c .RI "SbBool \fBfieldsAreEqual\fP (const \fBSoFieldContainer\fP *container) const " .br .ti -1c .RI "void \fBcopyFieldValues\fP (const \fBSoFieldContainer\fP *container, SbBool copyconnections=FALSE)" .br .ti -1c .RI "SbBool \fBset\fP (const char *const fielddata)" .br .ti -1c .RI "void \fBget\fP (\fBSbString\fP &fielddata)" .br .ti -1c .RI "virtual int \fBgetFields\fP (\fBSoFieldList\fP &l) const " .br .ti -1c .RI "virtual int \fBgetAllFields\fP (\fBSoFieldList\fP &l) const " .br .ti -1c .RI "virtual \fBSoField\fP * \fBgetField\fP (const \fBSbName\fP &name) const " .br .ti -1c .RI "virtual \fBSoField\fP * \fBgetEventIn\fP (const \fBSbName\fP &name) const " .br .ti -1c .RI "virtual \fBSoField\fP * \fBgetEventOut\fP (const \fBSbName\fP &name) const " .br .ti -1c .RI "SbBool \fBgetFieldName\fP (const \fBSoField\fP *const field, \fBSbName\fP &name) const " .br .ti -1c .RI "SbBool \fBenableNotify\fP (const SbBool flag)" .br .ti -1c .RI "SbBool \fBisNotifyEnabled\fP (void) const " .br .ti -1c .RI "SbBool \fBset\fP (const char *fielddata, \fBSoInput\fP *input)" .br .ti -1c .RI "void \fBget\fP (\fBSbString\fP &fielddata, \fBSoOutput\fP *out)" .br .ti -1c .RI "virtual void \fBnotify\fP (\fBSoNotList\fP *l)" .br .ti -1c .RI "virtual SbBool \fBvalidateNewFieldValue\fP (\fBSoField\fP *field, void *newval)" .br .ti -1c .RI "virtual void \fBaddWriteReference\fP (\fBSoOutput\fP *out, SbBool isfromfield=FALSE)" .br .ti -1c .RI "virtual void \fBwriteInstance\fP (\fBSoOutput\fP *out)" .br .ti -1c .RI "SbBool \fBgetIsBuiltIn\fP (void) const " .br .ti -1c .RI "virtual const \fBSoFieldData\fP * \fBgetFieldData\fP (void) const " .br .ti -1c .RI "virtual void \fBcopyContents\fP (const \fBSoFieldContainer\fP *from, SbBool copyconnections)" .br .ti -1c .RI "virtual \fBSoFieldContainer\fP * \fBcopyThroughConnection\fP (void) const " .br .ti -1c .RI "virtual void \fBgetFieldsMemorySize\fP (size_t &managed, size_t &unmanaged) const " .br .ti -1c .RI "void \fBsetUserData\fP (void *userdata) const " .br .ti -1c .RI "void * \fBgetUserData\fP (void) const " .br .in -1c .SS "Static Public Member Functions" .in +1c .ti -1c .RI "static void \fBinitClass\fP (void)" .br .ti -1c .RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)" .br .ti -1c .RI "static void \fBcleanupClass\fP (void)" .br .ti -1c .RI "static void \fBinitCopyDict\fP (void)" .br .ti -1c .RI "static void \fBaddCopy\fP (const \fBSoFieldContainer\fP *orig, const \fBSoFieldContainer\fP *copy)" .br .ti -1c .RI "static \fBSoFieldContainer\fP * \fBcheckCopy\fP (const \fBSoFieldContainer\fP *orig)" .br .ti -1c .RI "static \fBSoFieldContainer\fP * \fBfindCopy\fP (const \fBSoFieldContainer\fP *orig, const SbBool copyconnections)" .br .ti -1c .RI "static void \fBcopyDone\fP (void)" .br .in -1c .SS "Protected Member Functions" .in +1c .ti -1c .RI "\fBSoFieldContainer\fP (void)" .br .ti -1c .RI "virtual \fB~SoFieldContainer\fP ()" .br .ti -1c .RI "virtual SbBool \fBreadInstance\fP (\fBSoInput\fP *in, unsigned short flags)" .br .in -1c .SS "Protected Attributes" .in +1c .ti -1c .RI "SbBool \fBisBuiltIn\fP" .br .in -1c .SS "Additional Inherited Members" .SH "Detailed Description" .PP The \fBSoFieldContainer\fP class is a base class for all classes that contain fields\&. .PP The classes containing fields in Coin are the node and engine classes, so they are all subclasses of \fBSoFieldContainer\fP\&. \fBSoFieldContainer\fP provides methods for reading, writing, comparing for equality, doing copy operations, etc on fields\&. .PP \fBSee also:\fP .RS 4 \fBSoField\fP .RE .PP .SH "Constructor & Destructor Documentation" .PP .SS "SoFieldContainer::SoFieldContainer (void)\fC [protected]\fP" Constructor\&. .SS "SoFieldContainer::~SoFieldContainer ()\fC [protected]\fP, \fC [virtual]\fP" Destructor\&. .SH "Member Function Documentation" .PP .SS "void SoFieldContainer::setToDefaults (void)" This method sets all fields which we are parenting to their respective default values\&. .SS "SbBool SoFieldContainer::hasDefaultValues (void) const" This method checks to see if the fields of this container have their default values, and returns \fCTRUE\fP if that is the case\&. .SS "SbBool SoFieldContainer::fieldsAreEqual (const \fBSoFieldContainer\fP *container) const" This method returns \fCTRUE\fP if the values of the fields of this and \fIcontainer\fP are equal\&. .SS "void SoFieldContainer::copyFieldValues (const \fBSoFieldContainer\fP *container, SbBoolcopyconnections = \fCFALSE\fP)" \fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP .PP This method copies the field values from container into this\&. The fields are assumed to be of the same type\&. The \fIcopyconnections\fP flag decides whether the field connections are to be copied aswell\&. .SS "SbBool SoFieldContainer::set (const char *constfielddata)" This method parses the values of one or more fields from the \fIfielddata\fP string\&. .PP The fields must be in the same format as the Open Inventor file format\&. \fCTRUE\fP is returned upon success, and \fCFALSE\fP otherwise\&. .PP \fBSee also:\fP .RS 4 \fBget()\fP .RE .PP .SS "void SoFieldContainer::get (\fBSbString\fP &fielddata)" This methods stores the field data in the given \fIfielddata\fP string\&. The format of the returned string follows the Open Inventor file format\&. .PP \fBSee also:\fP .RS 4 \fBset()\fP .RE .PP .SS "int SoFieldContainer::getFields (\fBSoFieldList\fP &fields) const\fC [virtual]\fP" This method adds the fields in this container to the \fIl\fP argument, and returns the number of fields added\&. .PP The virtual nature of this function means that it can be overridden to e\&.g\&. hide private fields\&. .SS "int SoFieldContainer::getAllFields (\fBSoFieldList\fP &fields) const\fC [virtual]\fP" Returns VRML eventIn and eventOut fields in addition to the 'ordinary' fields\&. .PP \fBSee also:\fP .RS 4 \fBgetFields()\fP .RE .PP .SS "\fBSoField\fP * SoFieldContainer::getField (const \fBSbName\fP &name) const\fC [virtual]\fP" This method returns a pointer to the field with \fIname\fP, or \fCNULL\fP if no such field exists\&. .SS "\fBSoField\fP * SoFieldContainer::getEventIn (const \fBSbName\fP &name) const\fC [virtual]\fP" This method returns a pointer to the eventIn with name \fIname\fP, or \fCNULL\fP if no such eventIn exists\&. .SS "\fBSoField\fP * SoFieldContainer::getEventOut (const \fBSbName\fP &name) const\fC [virtual]\fP" This method returns a pointer to the eventOut with name \fIname\fP, or \fCNULL\fP if no such eventOut exists\&. .SS "SbBool SoFieldContainer::getFieldName (const \fBSoField\fP *constfield, \fBSbName\fP &name) const" Finds the name of the given \fIfield\fP and returns the value in the \fIname\fP argument\&. .PP \fCTRUE\fP is returned if the field is contained within this instance, and \fCFALSE\fP otherwise\&. .SS "SbBool SoFieldContainer::enableNotify (const SbBoolenable)" This method sets whether notification will be propagated on changing the values of the contained fields\&. The old value of the flag is returned\&. .PP Notification is default \fIon\fP\&. Turning off automatic notification can be useful for optimizing performance\&. During series of updates you may want to avoid the propagation of notifications upon every field value change if you make a lot of them\&. This is how you should handle those cases: .PP .PP .nf SbBool autonotify = node->enableNotify(FALSE); // \&.\&.\&. // Make modifications to fields of "node" here\&. // \&.\&.\&. node->enableNotify(autonotify); node->touch(); .fi .PP .PP \fBSee also:\fP .RS 4 \fBisNotifyEnabled()\fP .RE .PP .SS "SbBool SoFieldContainer::isNotifyEnabled (void) const" This method returns whether notification of changes to the field values in the container is propagated to its auditors\&. .PP \fBSee also:\fP .RS 4 \fBenableNotify()\fP .RE .PP .SS "SbBool SoFieldContainer::set (const char *fielddata, \fBSoInput\fP *in)" This method parses the values of one or more fields from the \fIfielddata\fP string\&. .PP The fields must be in the same format as the Open Inventor file format\&. \fCTRUE\fP is returned upon success, and \fCFALSE\fP otherwise\&. .PP We use the reference dictionary provided by \fIin\fP\&. .PP \fBSee also:\fP .RS 4 \fBget()\fP .RE .PP .SS "void SoFieldContainer::get (\fBSbString\fP &fielddata, \fBSoOutput\fP *out)" Put names and values of fields from this instance in the \fIfielddata\fP string\&. Fields will be separated in the returned string by end-of-line characters\&. .PP We use the reference dictionary provided by \fIout\fP\&. .PP \fBSee also:\fP .RS 4 \fBset()\fP .RE .PP .SS "void SoFieldContainer::notify (\fBSoNotList\fP *l)\fC [virtual]\fP" Notifies all auditors for this instance when changes are made\&. .PP Reimplemented from \fBSoBase\fP\&. .PP Reimplemented in \fBSoNode\fP, \fBSoSceneTexture2\fP, \fBSoVRMLSwitch\fP, \fBSoVRMLLOD\fP, \fBSoProfilerStats\fP, \fBSoSceneTextureCubeMap\fP, \fBSoTextureCubeMap\fP, \fBSoText3\fP, \fBSoTexture2\fP, \fBSoImage\fP, \fBSoTexture3\fP, \fBSoVRMLGroup\fP, \fBSoVertexProperty\fP, \fBSoVRMLParent\fP, \fBSoVRMLTransform\fP, \fBSoVRMLVertexShape\fP, \fBSoShadowGroup\fP, \fBSoVRMLElevationGrid\fP, \fBSoAsciiText\fP, \fBSoVRMLShape\fP, \fBSoSeparator\fP, \fBSoVRMLScript\fP, \fBSoBumpMap\fP, \fBSoVRMLProximitySensor\fP, \fBSoVRMLExtrusion\fP, \fBSoSwitch\fP, \fBSoVRMLBillboard\fP, \fBSoVRMLText\fP, \fBSoLOD\fP, \fBSoMaterial\fP, \fBSoShape\fP, \fBSoVertexAttribute\fP, \fBSoVRMLTouchSensor\fP, \fBSoLevelOfDetail\fP, \fBSoVRMLAppearance\fP, \fBSoVRMLIndexedLine\fP, \fBSoVRMLPixelTexture\fP, \fBSoEngine\fP, \fBSoVRMLIndexedLineSet\fP, \fBSoBlinker\fP, \fBSoIndexedLineSet\fP, \fBSoPackedColor\fP, \fBSoVertexShape\fP, \fBSoVRMLCollision\fP, \fBSoVRMLTimeSensor\fP, \fBSoVRMLVertexPoint\fP, \fBSoVRMLGeometry\fP, \fBSoVRMLVertexLine\fP, \fBSoNodeEngine\fP, \fBSoVRMLIndexedShape\fP, and \fBSoIndexedPointSet\fP\&. .SS "SbBool SoFieldContainer::validateNewFieldValue (\fBSoField\fP *field, void *newval)\fC [virtual]\fP" \fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP I can't make head or tails of this method, it seems to return TRUE no matter what the arguments are\&. .SS "void SoFieldContainer::addWriteReference (\fBSoOutput\fP *out, SbBoolisfromfield = \fCFALSE\fP)\fC [virtual]\fP" This method is used during the first write pass of a write action to count the number of references to this object in the scene graph\&. .PP Reimplemented from \fBSoBase\fP\&. .PP Reimplemented in \fBSoBaseKit\fP\&. .SS "void SoFieldContainer::writeInstance (\fBSoOutput\fP *out)\fC [virtual]\fP" Writes all the fields contained in this instance to the output stream within \fIout\fP\&. .PP This method is solely called from the write methods of fields\&. .PP Either from \fBSoField\fP if the write is done because of a field-to-field connection, or from one of the fields which may actually write \fBSoFieldContainer\fP instances, i\&.e\&. \fBSoSFNode\fP, \fBSoMFNode\fP, \fBSoSFEngine\fP, \fBSoMFEngine\fP, \fBSoSFPath\fP and \fBSoMFPath\fP\&. .PP This method, in addition to the ordinary write() method of \fBSoNode\fP, needs to be present since the fields don't have a write action instance in their writeValue() method, and \fBwriteInstance()\fP will create a new \fBSoWriteAction\fP and call continueToApply() on it\&. .PP Reimplemented in \fBSoNode\fP, \fBSoTimeCounter\fP, \fBSoEngine\fP, \fBSoElapsedTime\fP, and \fBSoNodeEngine\fP\&. .SS "SbBool SoFieldContainer::getIsBuiltIn (void) const" Returns \fCTRUE\fP if this object is instantiated from one of the native Coin classes, \fCFALSE\fP if the object's class is outside the standard Coin library\&. .SS "const \fBSoFieldData\fP * SoFieldContainer::getFieldData (void) const\fC [virtual]\fP" Returns a pointer to the class-wide field data storage object for this instance\&. If no fields are present, returns \fCNULL\fP\&. .PP Reimplemented in \fBSoExtSelection\fP, \fBSoShaderParameter\fP, \fBSoBaseKit\fP, \fBSoDragger\fP, \fBSoCamera\fP, \fBSoWWWInline\fP, \fBSoVRMLInline\fP, \fBSoEventCallback\fP, \fBSoShape\fP, \fBSoVRMLSwitch\fP, \fBSoTrackballDragger\fP, \fBSoDirectionalLightManip\fP, \fBSoProtoInstance\fP, \fBSoSpotLightManip\fP, \fBSoInteractionKit\fP, \fBSoSelection\fP, \fBSoVertexShape\fP, \fBSoVRMLElevationGrid\fP, \fBSoVRMLFontStyle\fP, \fBSoSTLFileKit\fP, \fBSoComposeMatrix\fP, \fBSoClipPlaneManip\fP, \fBSoPointLightManip\fP, \fBSoTransformManip\fP, \fBSoShaderObject\fP, \fBSoShaderProgram\fP, \fBSoTexture2\fP, \fBSoWWWAnchor\fP, \fBSoComposeRotationFromTo\fP, \fBSoComposeRotation\fP, \fBSoComposeVec2f\fP, \fBSoComposeVec3f\fP, \fBSoComposeVec4f\fP, \fBSoTexture3\fP, \fBSoTextureCubeMap\fP, \fBSoVRMLAudioClip\fP, \fBSoVRMLImageTexture\fP, \fBSoVRMLVertexShape\fP, \fBSoProfilerStats\fP, \fBSoRotateSphericalDragger\fP, \fBSoSpotLightDragger\fP, \fBSoTransformerDragger\fP, \fBSoDecomposeMatrix\fP, \fBSoDecomposeVec2f\fP, \fBSoDecomposeVec3f\fP, \fBSoDecomposeVec4f\fP, \fBSoImage\fP, \fBSoSceneTexture2\fP, \fBSoSceneTextureCubeMap\fP, \fBSoText3\fP, \fBSoVRMLAnchor\fP, \fBSoVRMLIndexedFaceSet\fP, \fBSoVRMLMovieTexture\fP, \fBSoVRMLViewpoint\fP, \fBSoHandleBoxDragger\fP, \fBSoScale2UniformDragger\fP, \fBSoTabPlaneDragger\fP, \fBSoTranslate1Dragger\fP, \fBSoTranslate2Dragger\fP, \fBSoDecomposeRotation\fP, \fBSoBumpMap\fP, \fBSoGeoCoordinate\fP, \fBSoGeoSeparator\fP, \fBSoPendulum\fP, \fBSoRotor\fP, \fBSoShuttle\fP, \fBSoSwitch\fP, \fBSoVertexProperty\fP, \fBSoVRMLDragSensor\fP, \fBSoVRMLSound\fP, \fBSoForeignFileKit\fP, \fBSoShadowGroup\fP, \fBSoCenterballDragger\fP, \fBSoDirectionalLightDragger\fP, \fBSoJackDragger\fP, \fBSoRotateCylindricalDragger\fP, \fBSoRotateDiscDragger\fP, \fBSoScale1Dragger\fP, \fBSoScale2Dragger\fP, \fBSoScaleUniformDragger\fP, \fBSoTransformBoxDragger\fP, \fBSoCalculator\fP, \fBSoComputeBoundingBox\fP, \fBSoNodeKitListPart\fP, \fBSoCacheHint\fP, \fBSoFontStyle\fP, \fBSoGeoLocation\fP, \fBSoIndexedFaceSet\fP, \fBSoIndexedLineSet\fP, \fBSoIndexedTriangleStripSet\fP, \fBSoVRMLBackground\fP, \fBSoVRMLFog\fP, \fBSoVRMLIndexedLineSet\fP, \fBSoVRMLNavigationInfo\fP, \fBSoVRMLText\fP, \fBSoVRMLTimeSensor\fP, \fBSoDragPointDragger\fP, \fBSoPointLightDragger\fP, \fBSoTabBoxDragger\fP, \fBSoElapsedTime\fP, \fBSoGate\fP, \fBSoOneShot\fP, \fBSoTimeCounter\fP, \fBSoAsciiText\fP, \fBSoIndexedNurbsCurve\fP, \fBSoIndexedNurbsSurface\fP, \fBSoLocateHighlight\fP, \fBSoMaterial\fP, \fBSoProfile\fP, \fBSoRotationXYZ\fP, \fBSoSeparator\fP, \fBSoTexture3Transform\fP, \fBSoTextureCoordinatePlane\fP, \fBSoVRMLCollision\fP, \fBSoVRMLExtrusion\fP, \fBSoVRMLGroup\fP, \fBSoVRMLLOD\fP, \fBSoVRMLPositionInterpolator\fP, \fBSoSelectOne\fP, \fBSoBlinker\fP, \fBSoDrawStyle\fP, \fBSoEnvironment\fP, \fBSoFile\fP, \fBSoGeoOrigin\fP, \fBSoIndexedPointSet\fP, \fBSoListener\fP, \fBSoLOD\fP, \fBSoNurbsCurve\fP, \fBSoNurbsSurface\fP, \fBSoSurroundScale\fP, \fBSoTextureCombine\fP, \fBSoTextureCoordinateReflectionMap\fP, \fBSoTransform\fP, \fBSoVRMLBillboard\fP, \fBSoVRMLColorInterpolator\fP, \fBSoVRMLMaterial\fP, \fBSoVRMLOrientationInterpolator\fP, \fBSoVRMLParent\fP, \fBSoVRMLProximitySensor\fP, \fBSoVRMLSphereSensor\fP, \fBSoVRMLTextureTransform\fP, \fBSoShadowDirectionalLight\fP, \fBSoShadowSpotLight\fP, \fBSoBoolOperation\fP, \fBSoCounter\fP, \fBSoAntiSquish\fP, \fBSoArray\fP, \fBSoBumpMapTransform\fP, \fBSoCube\fP, \fBSoDepthBuffer\fP, \fBSoFaceSet\fP, \fBSoIndexedMarkerSet\fP, \fBSoIndexedShape\fP, \fBSoLevelOfDetail\fP, \fBSoNormal\fP, \fBSoPolygonOffset\fP, \fBSoShapeHints\fP, \fBSoText2\fP, \fBSoTexture2Transform\fP, \fBSoTextureCoordinateNormalMap\fP, \fBSoVRMLAppearance\fP, \fBSoVRMLColor\fP, \fBSoVRMLCoordinate\fP, \fBSoVRMLCoordinateInterpolator\fP, \fBSoVRMLInterpolator\fP, \fBSoVRMLLight\fP, \fBSoVRMLNormal\fP, \fBSoVRMLNormalInterpolator\fP, \fBSoVRMLPixelTexture\fP, \fBSoVRMLShape\fP, \fBSoVRMLTextureCoordinate\fP, \fBSoVRMLTouchSensor\fP, \fBSoVRMLVertexPoint\fP, \fBSoVRMLVisibilitySensor\fP, \fBSoConcatenate\fP, \fBSoHeightMapToNormalMap\fP, \fBSoOnOff\fP, \fBSoTransformVec3f\fP, \fBSoTriggerAny\fP, \fBSoCenterballManip\fP, \fBSoHandleBoxManip\fP, \fBSoJackManip\fP, \fBSoTabBoxManip\fP, \fBSoTrackballManip\fP, \fBSoTransformBoxManip\fP, \fBSoTransformerManip\fP, \fBSoBaseColor\fP, \fBSoComplexity\fP, \fBSoCone\fP, \fBSoCoordinate3\fP, \fBSoCoordinate4\fP, \fBSoCylinder\fP, \fBSoGeometryShader\fP, \fBSoLight\fP, \fBSoNonIndexedShape\fP, \fBSoNurbsProfile\fP, \fBSoPackedColor\fP, \fBSoSpotLight\fP, \fBSoTextureCoordinate3\fP, \fBSoVRMLCone\fP, \fBSoVRMLCylinder\fP, \fBSoVRMLCylinderSensor\fP, \fBSoVRMLGeometry\fP, \fBSoVRMLPlaneSensor\fP, \fBSoVRMLPointLight\fP, \fBSoVRMLScalarInterpolator\fP, \fBSoVRMLSpotLight\fP, \fBSoVRMLTransform\fP, \fBSoVRMLVertexLine\fP, \fBSoVRMLWorldInfo\fP, \fBSoShadowCulling\fP, \fBSoShadowStyle\fP, \fBSoFieldConverter\fP, \fBSoInterpolate\fP, \fBSoTexture2Convert\fP, \fBSoSeparatorKit\fP, \fBSoCallback\fP, \fBSoClipPlane\fP, \fBSoDirectionalLight\fP, \fBSoFont\fP, \fBSoFrustumCamera\fP, \fBSoGroup\fP, \fBSoLightModel\fP, \fBSoLineSet\fP, \fBSoMarkerSet\fP, \fBSoMaterialBinding\fP, \fBSoMatrixTransform\fP, \fBSoMultipleCopy\fP, \fBSoNormalBinding\fP, \fBSoPathSwitch\fP, \fBSoPickStyle\fP, \fBSoPointLight\fP, \fBSoPointSet\fP, \fBSoQuadMesh\fP, \fBSoResetTransform\fP, \fBSoRotation\fP, \fBSoScale\fP, \fBSoSphere\fP, \fBSoTextureCoordinate2\fP, \fBSoTextureCoordinateBinding\fP, \fBSoTextureCoordinateEnvironment\fP, \fBSoTextureCoordinateObject\fP, \fBSoTextureScalePolicy\fP, \fBSoTextureUnit\fP, \fBSoTranslation\fP, \fBSoTransparencyType\fP, \fBSoTriangleStripSet\fP, \fBSoUnits\fP, \fBSoVertexAttributeBinding\fP, \fBSoVRMLBox\fP, \fBSoVRMLDirectionalLight\fP, \fBSoVRMLIndexedLine\fP, \fBSoVRMLIndexedShape\fP, \fBSoVRMLPointSet\fP, \fBSoVRMLSphere\fP, \fBSoVRMLTexture\fP, \fBSoAppearanceKit\fP, \fBSoCameraKit\fP, \fBSoLightKit\fP, \fBSoSceneKit\fP, \fBSoAnnotation\fP, \fBSoBumpMapCoordinate\fP, \fBSoColorIndex\fP, \fBSoFragmentShader\fP, \fBSoInfo\fP, \fBSoLabel\fP, \fBSoLinearProfile\fP, \fBSoOrthographicCamera\fP, \fBSoPerspectiveCamera\fP, \fBSoProfileCoordinate2\fP, \fBSoProfileCoordinate3\fP, \fBSoTextureCoordinateDefault\fP, \fBSoTextureMatrixTransform\fP, \fBSoTransformSeparator\fP, \fBSoVRMLSensor\fP, \fBSoInterpolateFloat\fP, \fBSoInterpolateRotation\fP, \fBSoInterpolateVec2f\fP, \fBSoInterpolateVec3f\fP, \fBSoInterpolateVec4f\fP, \fBSoShapeKit\fP, \fBSoWrapperKit\fP, \fBSoTextureCoordinateCube\fP, \fBSoTextureCoordinateCylinder\fP, \fBSoTextureCoordinateFunction\fP, \fBSoTextureCoordinateSphere\fP, \fBSoTransformation\fP, and \fBSoVertexShader\fP\&. .SS "void SoFieldContainer::copyContents (const \fBSoFieldContainer\fP *from, SbBoolcopyconnections)\fC [virtual]\fP" Makes a deep copy of all data of \fIfrom\fP into this instance, \fIexcept\fP external scenegraph references if \fIcopyconnections\fP is \fCFALSE\fP\&. .PP This is the method that should be overridden by extension node / engine / dragger / whatever subclasses which needs to account for internal data that are not handled automatically\&. .PP For copying nodes from application code, you should not invoke this function directly, but rather call the \fBSoNode::copy()\fP function: .PP .PP .nf SoNode * mynewnode = templatenode->copy(); .fi .PP .PP The same also goes for engines\&. .PP Make sure that when you override the \fBcopyContents()\fP method in your extension class that you also make it call upwards to it's parent superclass in the inheritance hierarchy, as \fBcopyContents()\fP in for instance \fBSoNode\fP and \fBSoFieldContainer\fP does important work\&. It should go something like this: .PP .PP .nf void MyCoinExtensionNode::copyContents(const SoFieldContainer * from, SbBool copyconnections) { // let parent superclasses do their thing (copy fields, copy // instance name, etc etc) SoNode::copyContents(from, copyconnections); // [\&.\&.then copy internal data\&.\&.] } .fi .PP .PP Reimplemented in \fBSoNode\fP, \fBSoWWWInline\fP, \fBSoBaseKit\fP, \fBSoVRMLSwitch\fP, \fBSoVRMLLOD\fP, \fBSoInteractionKit\fP, \fBSoNodeKitListPart\fP, \fBSoVRMLParent\fP, \fBSoClipPlaneManip\fP, \fBSoGroup\fP, \fBSoDirectionalLightManip\fP, \fBSoSpotLightManip\fP, \fBSoVRMLShape\fP, \fBSoPointLightManip\fP, \fBSoTransformManip\fP, \fBSoVRMLScript\fP, \fBSoRotateSphericalDragger\fP, \fBSoRotateCylindricalDragger\fP, \fBSoFile\fP, \fBSoCallback\fP, \fBSoVertexAttribute\fP, \fBSoVRMLAppearance\fP, and \fBSoVRMLGeometry\fP\&. .SS "\fBSoFieldContainer\fP * SoFieldContainer::copyThroughConnection (void) const\fC [virtual]\fP" Return copy of this instance\&. .PP Note: default implementation just returns \fCthis\fP pointer, \fBSoNode\fP and \fBSoEngine\fP overrides this method to return the pointer to the actual copy\&. .PP Reimplemented in \fBSoNode\fP, and \fBSoEngine\fP\&. .SS "void SoFieldContainer::initCopyDict (void)\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 .PP Initialize a dictionary hash storing pointers for original fieldcontainer instances and their copies during scene graph copy operations\&. .PP This method is called from the start of \fBSoNode::copy()\fP\&. .SS "void SoFieldContainer::addCopy (const \fBSoFieldContainer\fP *orig, const \fBSoFieldContainer\fP *copy)\fC [static]\fP" Add a pair of pointers to an original fieldcontainer and a copy of it to an internal pointer dictionary used during scene graph copy operations\&. .SS "\fBSoFieldContainer\fP * SoFieldContainer::checkCopy (const \fBSoFieldContainer\fP *orig)\fC [static]\fP" Returns the copy of \fIorig\fP, if any\&. If no copy exists, we return a \fCNULL\fP pointer\&. .SS "\fBSoFieldContainer\fP * SoFieldContainer::findCopy (const \fBSoFieldContainer\fP *orig, const SbBoolcopyconnections)\fC [static]\fP" Returns a copy of \fIorig\fP\&. .PP If no copy has been made earlier when the function is called, a copy is made on-the-fly (which is the reason we need to pass along the \fIcopyconnections\fP flag)\&. .PP This method will also run the \fBcopyContents()\fP method on the copy, if it hasn't been run already\&. Note that if you call \fBcopyContents()\fP on the copy outside of this method, this will go undetected and the guts of \fIorig\fP will be copied multiple times into its copy\&. .PP If \fBcopyContents()\fP is called directly (instead of using copy()), it's assumed that the user only wants to copy the field values, and we just return NULL here\&. This is done to match how it's done in SGI Inventor\&. .PP \fBSee also:\fP .RS 4 \fBcheckCopy()\fP .RE .PP .SS "void SoFieldContainer::copyDone (void)\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 .PP Clean up the dictionary hash\&. .PP This method is called from the end of \fBSoNode::copy()\fP\&. .SS "void SoFieldContainer::getFieldsMemorySize (size_t &managed, size_t &unmanaged) const\fC [virtual]\fP" Returns the data array sizes of the SoFieldData-registered multi-fields\&. The \fImanaged\fP argument returns the size of the fields that Coin manages the memory for, and the \fIunmanaged\fP argument returns the size of the data in the multi-fields controlled by the application through SoMField::setValuesPointer() which Coin will not delete\&. .PP Data that is kept in the object memory chunk (that is included when you do sizeof(object)) is not included in these values - only the memory that is managed in addtional memory chunks from the object chunk is returned\&. .PP Extension field types that are not known to the plain Coin library are not accounted for\&. This function is therefore virtual, so such extension field types can be added to the numbers for extension nodes\&. .PP This method is used for memory profiling purposes\&. .PP \fBSince:\fP .RS 4 Coin 3\&.0 .RE .PP .SS "void SoFieldContainer::setUserData (void *userdata) const" Set a generic user data pointer for this field container\&. .PP This function can be used by the application programmer to, for instance, store a pointer to an application specific data structure that is in some way related to the field container\&. \fBgetUserData()\fP can later be used to retrieve the pointer\&. .PP \fBSee also:\fP .RS 4 \fBgetUserData()\fP .RE .PP \fBSince:\fP .RS 4 Coin 2\&.0 .RE .PP .SS "void * SoFieldContainer::getUserData (void) const" Return the generic user data pointer for this field container, or NULL if no user data has been set\&. .PP \fBSee also:\fP .RS 4 \fBsetUserData()\fP .RE .PP \fBSince:\fP .RS 4 Coin 2\&.0 .RE .PP .SS "SbBool SoFieldContainer::readInstance (\fBSoInput\fP *in, unsigned shortflags)\fC [protected]\fP, \fC [virtual]\fP" This method is mainly intended for internal use during file import operations\&. .PP It reads a definition of an instance from the input stream \fIin\fP\&. The input stream state points to the start of a serialized / persistant representation of an instance of this class type\&. .PP \fCTRUE\fP or \fCFALSE\fP is returned, depending on if the instantiation and configuration of the new object of this class type went ok or not\&. The import process should be robust and handle corrupted input streams by returning \fCFALSE\fP\&. .PP \fIflags\fP is used internally during binary import when reading user extension nodes, group nodes or engines\&. .PP Implements \fBSoBase\fP\&. .PP Reimplemented in \fBSoNode\fP, \fBSoBaseKit\fP, \fBSoWWWInline\fP, \fBSoVRMLSwitch\fP, \fBSoVRMLLOD\fP, \fBSoInteractionKit\fP, \fBSoTextureCubeMap\fP, \fBSoNodeKitListPart\fP, \fBSoSeparator\fP, \fBSoTexture2\fP, \fBSoImage\fP, \fBSoVRMLParent\fP, \fBSoTexture3\fP, \fBSoShaderObject\fP, \fBSoProto\fP, \fBSoFile\fP, \fBSoGroup\fP, \fBSoVRMLImageTexture\fP, \fBSoEngine\fP, \fBSoProtoInstance\fP, \fBSoNormalBinding\fP, \fBSoBumpMap\fP, \fBSoVertexAttribute\fP, \fBSoTextureCoordinateBinding\fP, \fBSoVRMLBackground\fP, \fBSoNodeEngine\fP, and \fBSoVRMLPixelTexture\fP\&. .SH "Member Data Documentation" .PP .SS "SbBool SoFieldContainer::isBuiltIn\fC [protected]\fP" Flag for storing whether or not this class instance is a built-in class or not\&. By knowing the difference between a class which is native Coin or a user extension, it is possible to automatically store and read extension nodes and engines\&. .SH "Author" .PP Generated automatically by Doxygen for Coin from the source code\&.