NAME

       SoFieldContainer -

       The SoFieldContainer class is a base class for all classes that contain fields.

       The classes containing fields in Coin are the node and engine classes, so they are all
       subclasses of SoFieldContainer.

SYNOPSIS

       #include <Inventor/fields/SoFieldContainer.h>

       Inherits SoBase.

       Inherited by SoEngine, and SoNode.

   Public Member Functions
       void setToDefaults (void)
       SbBool hasDefaultValues (void) const
       SbBool fieldsAreEqual (const SoFieldContainer *container) const
       void copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=FALSE)
       SbBool set (const char *const fielddata)
       void get (SbString &fielddata)
       virtual int getFields (SoFieldList &l) const
       virtual int getAllFields (SoFieldList &l) const
       virtual SoField * getField (const SbName &name) const
       virtual SoField * getEventIn (const SbName &name) const
       virtual SoField * getEventOut (const SbName &name) const
       SbBool getFieldName (const SoField *const field, SbName &name) const
       SbBool enableNotify (const SbBool flag)
       SbBool isNotifyEnabled (void) const
       SbBool set (const char *fielddata, SoInput *input)
       void get (SbString &fielddata, SoOutput *out)
       virtual void notify (SoNotList *l)
       virtual SbBool validateNewFieldValue (SoField *field, void *newval)
       virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)
       virtual void writeInstance (SoOutput *out)
       SbBool getIsBuiltIn (void) const
       virtual const SoFieldData * getFieldData (void) const
       virtual void copyContents (const SoFieldContainer *from, SbBool copyconnections)
       virtual SoFieldContainer * copyThroughConnection (void) const
       virtual void getFieldsMemorySize (size_t &managed, size_t &unmanaged) const
       void setUserData (void *userdata) const
       void * getUserData (void) const

   Static Public Member Functions
       static void initClass (void)
       static SoType getClassTypeId (void)
       static void cleanupClass (void)
       static void initCopyDict (void)
       static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy)
       static SoFieldContainer * checkCopy (const SoFieldContainer *orig)
       static SoFieldContainer * findCopy (const SoFieldContainer *orig, const SbBool
           copyconnections)
       static void copyDone (void)

   Protected Member Functions
       SoFieldContainer (void)
       virtual ~SoFieldContainer ()
       virtual SbBool readInstance (SoInput *in, unsigned short flags)

   Protected Attributes
       SbBool isBuiltIn

   Additional Inherited Members

Detailed Description

       The SoFieldContainer class is a base class for all classes that contain fields.

       The classes containing fields in Coin are the node and engine classes, so they are all
       subclasses of SoFieldContainer.

       SoFieldContainer provides methods for reading, writing, comparing for equality, doing copy
       operations, etc on fields.

       See Also:
           SoField

Constructor & Destructor Documentation

   SoFieldContainer::SoFieldContainer (void) [protected]
       Constructor.

   SoFieldContainer::~SoFieldContainer () [protected],  [virtual]
       Destructor.

Member Function Documentation

   void SoFieldContainer::setToDefaults (void)
       This method sets all fields which we are parenting to their respective default values.

   SbBool SoFieldContainer::hasDefaultValues (void) const
       This method checks to see if the fields of this container have their default values, and
       returns TRUE if that is the case.

   SbBool SoFieldContainer::fieldsAreEqual (const SoFieldContainer *container) const
       This method returns TRUE if the values of the fields of this and container are equal.

   void SoFieldContainer::copyFieldValues (const SoFieldContainer *container,
       SbBoolcopyconnections = FALSE)
       This API member is considered internal to the library, as it is not likely to be of
       interest to the application programmer.

       This method copies the field values from container into this. The fields are assumed to be
       of the same type. The copyconnections flag decides whether the field connections are to be
       copied aswell.

   SbBool SoFieldContainer::set (const char *constfielddata)
       This method parses the values of one or more fields from the fielddata string.

       The fields must be in the same format as the Open Inventor file format. TRUE is returned
       upon success, and FALSE otherwise.

       See Also:
           get()

   void SoFieldContainer::get (SbString &fielddata)
       This methods stores the field data in the given fielddata string. The format of the
       returned string follows the Open Inventor file format.

       See Also:
           set()

   int SoFieldContainer::getFields (SoFieldList &fields) const [virtual]
       This method adds the fields in this container to the l argument, and returns the number of
       fields added.

       The virtual nature of this function means that it can be overridden to e.g. hide private
       fields.

   int SoFieldContainer::getAllFields (SoFieldList &fields) const [virtual]
       Returns VRML eventIn and eventOut fields in addition to the 'ordinary' fields.

       See Also:
           getFields()

   SoField * SoFieldContainer::getField (const SbName &name) const [virtual]
       This method returns a pointer to the field with name, or NULL if no such field exists.

   SoField * SoFieldContainer::getEventIn (const SbName &name) const [virtual]
       This method returns a pointer to the eventIn with name name, or NULL if no such eventIn
       exists.

   SoField * SoFieldContainer::getEventOut (const SbName &name) const [virtual]
       This method returns a pointer to the eventOut with name name, or NULL if no such eventOut
       exists.

   SbBool SoFieldContainer::getFieldName (const SoField *constfield, SbName &name) const
       Finds the name of the given field and returns the value in the name argument.

       TRUE is returned if the field is contained within this instance, and FALSE otherwise.

   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.

       Notification is default on. 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:

       SbBool autonotify = node->enableNotify(FALSE);
       // ...
       // Make modifications to fields of "node" here.
       // ...
       node->enableNotify(autonotify);
       node->touch();

       See Also:
           isNotifyEnabled()

   SbBool SoFieldContainer::isNotifyEnabled (void) const
       This method returns whether notification of changes to the field values in the container
       is propagated to its auditors.

       See Also:
           enableNotify()

   SbBool SoFieldContainer::set (const char *fielddata, SoInput *in)
       This method parses the values of one or more fields from the fielddata string.

       The fields must be in the same format as the Open Inventor file format. TRUE is returned
       upon success, and FALSE otherwise.

       We use the reference dictionary provided by in.

       See Also:
           get()

   void SoFieldContainer::get (SbString &fielddata, SoOutput *out)
       Put names and values of fields from this instance in the fielddata string. Fields will be
       separated in the returned string by end-of-line characters.

       We use the reference dictionary provided by out.

       See Also:
           set()

   void SoFieldContainer::notify (SoNotList *l) [virtual]
       Notifies all auditors for this instance when changes are made.

       Reimplemented from SoBase.

       Reimplemented in SoNode, SoSceneTexture2, SoVRMLSwitch, SoVRMLLOD, SoProfilerStats,
       SoSceneTextureCubeMap, SoTextureCubeMap, SoText3, SoTexture2, SoImage, SoTexture3,
       SoVRMLGroup, SoVertexProperty, SoVRMLParent, SoVRMLTransform, SoVRMLVertexShape,
       SoShadowGroup, SoVRMLElevationGrid, SoAsciiText, SoVRMLShape, SoSeparator, SoVRMLScript,
       SoBumpMap, SoVRMLProximitySensor, SoVRMLExtrusion, SoSwitch, SoVRMLBillboard, SoVRMLText,
       SoLOD, SoMaterial, SoShape, SoVertexAttribute, SoVRMLTouchSensor, SoLevelOfDetail,
       SoVRMLAppearance, SoVRMLIndexedLine, SoVRMLPixelTexture, SoEngine, SoVRMLIndexedLineSet,
       SoBlinker, SoIndexedLineSet, SoPackedColor, SoVertexShape, SoVRMLCollision,
       SoVRMLTimeSensor, SoVRMLVertexPoint, SoVRMLGeometry, SoVRMLVertexLine, SoNodeEngine,
       SoVRMLIndexedShape, and SoIndexedPointSet.

   SbBool SoFieldContainer::validateNewFieldValue (SoField *field, void *newval) [virtual]
       This API member is considered internal to the library, as it is not likely to be of
       interest to the application programmer. I can't make head or tails of this method, it
       seems to return TRUE no matter what the arguments are.

   void SoFieldContainer::addWriteReference (SoOutput *out, SbBoolisfromfield = FALSE) [virtual]
       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.

       Reimplemented from SoBase.

       Reimplemented in SoBaseKit.

   void SoFieldContainer::writeInstance (SoOutput *out) [virtual]
       Writes all the fields contained in this instance to the output stream within out.

       This method is solely called from the write methods of fields.

       Either from SoField if the write is done because of a field-to-field connection, or from
       one of the fields which may actually write SoFieldContainer instances, i.e. SoSFNode,
       SoMFNode, SoSFEngine, SoMFEngine, SoSFPath and SoMFPath.

       This method, in addition to the ordinary write() method of SoNode, needs to be present
       since the fields don't have a write action instance in their writeValue() method, and
       writeInstance() will create a new SoWriteAction and call continueToApply() on it.

       Reimplemented in SoNode, SoTimeCounter, SoEngine, SoElapsedTime, and SoNodeEngine.

   SbBool SoFieldContainer::getIsBuiltIn (void) const
       Returns TRUE if this object is instantiated from one of the native Coin classes, FALSE if
       the object's class is outside the standard Coin library.

   const SoFieldData * SoFieldContainer::getFieldData (void) const [virtual]
       Returns a pointer to the class-wide field data storage object for this instance. If no
       fields are present, returns NULL.

       Reimplemented in SoExtSelection, SoShaderParameter, SoBaseKit, SoDragger, SoCamera,
       SoWWWInline, SoVRMLInline, SoEventCallback, SoShape, SoVRMLSwitch, SoTrackballDragger,
       SoDirectionalLightManip, SoProtoInstance, SoSpotLightManip, SoInteractionKit, SoSelection,
       SoVertexShape, SoVRMLElevationGrid, SoVRMLFontStyle, SoSTLFileKit, SoComposeMatrix,
       SoClipPlaneManip, SoPointLightManip, SoTransformManip, SoShaderObject, SoShaderProgram,
       SoTexture2, SoWWWAnchor, SoComposeRotationFromTo, SoComposeRotation, SoComposeVec2f,
       SoComposeVec3f, SoComposeVec4f, SoTexture3, SoTextureCubeMap, SoVRMLAudioClip,
       SoVRMLImageTexture, SoVRMLVertexShape, SoProfilerStats, SoRotateSphericalDragger,
       SoSpotLightDragger, SoTransformerDragger, SoDecomposeMatrix, SoDecomposeVec2f,
       SoDecomposeVec3f, SoDecomposeVec4f, SoImage, SoSceneTexture2, SoSceneTextureCubeMap,
       SoText3, SoVRMLAnchor, SoVRMLIndexedFaceSet, SoVRMLMovieTexture, SoVRMLViewpoint,
       SoHandleBoxDragger, SoScale2UniformDragger, SoTabPlaneDragger, SoTranslate1Dragger,
       SoTranslate2Dragger, SoDecomposeRotation, SoBumpMap, SoGeoCoordinate, SoGeoSeparator,
       SoPendulum, SoRotor, SoShuttle, SoSwitch, SoVertexProperty, SoVRMLDragSensor, SoVRMLSound,
       SoForeignFileKit, SoShadowGroup, SoCenterballDragger, SoDirectionalLightDragger,
       SoJackDragger, SoRotateCylindricalDragger, SoRotateDiscDragger, SoScale1Dragger,
       SoScale2Dragger, SoScaleUniformDragger, SoTransformBoxDragger, SoCalculator,
       SoComputeBoundingBox, SoNodeKitListPart, SoCacheHint, SoFontStyle, SoGeoLocation,
       SoIndexedFaceSet, SoIndexedLineSet, SoIndexedTriangleStripSet, SoVRMLBackground,
       SoVRMLFog, SoVRMLIndexedLineSet, SoVRMLNavigationInfo, SoVRMLText, SoVRMLTimeSensor,
       SoDragPointDragger, SoPointLightDragger, SoTabBoxDragger, SoElapsedTime, SoGate,
       SoOneShot, SoTimeCounter, SoAsciiText, SoIndexedNurbsCurve, SoIndexedNurbsSurface,
       SoLocateHighlight, SoMaterial, SoProfile, SoRotationXYZ, SoSeparator, SoTexture3Transform,
       SoTextureCoordinatePlane, SoVRMLCollision, SoVRMLExtrusion, SoVRMLGroup, SoVRMLLOD,
       SoVRMLPositionInterpolator, SoSelectOne, SoBlinker, SoDrawStyle, SoEnvironment, SoFile,
       SoGeoOrigin, SoIndexedPointSet, SoListener, SoLOD, SoNurbsCurve, SoNurbsSurface,
       SoSurroundScale, SoTextureCombine, SoTextureCoordinateReflectionMap, SoTransform,
       SoVRMLBillboard, SoVRMLColorInterpolator, SoVRMLMaterial, SoVRMLOrientationInterpolator,
       SoVRMLParent, SoVRMLProximitySensor, SoVRMLSphereSensor, SoVRMLTextureTransform,
       SoShadowDirectionalLight, SoShadowSpotLight, SoBoolOperation, SoCounter, SoAntiSquish,
       SoArray, SoBumpMapTransform, SoCube, SoDepthBuffer, SoFaceSet, SoIndexedMarkerSet,
       SoIndexedShape, SoLevelOfDetail, SoNormal, SoPolygonOffset, SoShapeHints, SoText2,
       SoTexture2Transform, SoTextureCoordinateNormalMap, SoVRMLAppearance, SoVRMLColor,
       SoVRMLCoordinate, SoVRMLCoordinateInterpolator, SoVRMLInterpolator, SoVRMLLight,
       SoVRMLNormal, SoVRMLNormalInterpolator, SoVRMLPixelTexture, SoVRMLShape,
       SoVRMLTextureCoordinate, SoVRMLTouchSensor, SoVRMLVertexPoint, SoVRMLVisibilitySensor,
       SoConcatenate, SoHeightMapToNormalMap, SoOnOff, SoTransformVec3f, SoTriggerAny,
       SoCenterballManip, SoHandleBoxManip, SoJackManip, SoTabBoxManip, SoTrackballManip,
       SoTransformBoxManip, SoTransformerManip, SoBaseColor, SoComplexity, SoCone, SoCoordinate3,
       SoCoordinate4, SoCylinder, SoGeometryShader, SoLight, SoNonIndexedShape, SoNurbsProfile,
       SoPackedColor, SoSpotLight, SoTextureCoordinate3, SoVRMLCone, SoVRMLCylinder,
       SoVRMLCylinderSensor, SoVRMLGeometry, SoVRMLPlaneSensor, SoVRMLPointLight,
       SoVRMLScalarInterpolator, SoVRMLSpotLight, SoVRMLTransform, SoVRMLVertexLine,
       SoVRMLWorldInfo, SoShadowCulling, SoShadowStyle, SoFieldConverter, SoInterpolate,
       SoTexture2Convert, SoSeparatorKit, SoCallback, SoClipPlane, SoDirectionalLight, SoFont,
       SoFrustumCamera, SoGroup, SoLightModel, SoLineSet, SoMarkerSet, SoMaterialBinding,
       SoMatrixTransform, SoMultipleCopy, SoNormalBinding, SoPathSwitch, SoPickStyle,
       SoPointLight, SoPointSet, SoQuadMesh, SoResetTransform, SoRotation, SoScale, SoSphere,
       SoTextureCoordinate2, SoTextureCoordinateBinding, SoTextureCoordinateEnvironment,
       SoTextureCoordinateObject, SoTextureScalePolicy, SoTextureUnit, SoTranslation,
       SoTransparencyType, SoTriangleStripSet, SoUnits, SoVertexAttributeBinding, SoVRMLBox,
       SoVRMLDirectionalLight, SoVRMLIndexedLine, SoVRMLIndexedShape, SoVRMLPointSet,
       SoVRMLSphere, SoVRMLTexture, SoAppearanceKit, SoCameraKit, SoLightKit, SoSceneKit,
       SoAnnotation, SoBumpMapCoordinate, SoColorIndex, SoFragmentShader, SoInfo, SoLabel,
       SoLinearProfile, SoOrthographicCamera, SoPerspectiveCamera, SoProfileCoordinate2,
       SoProfileCoordinate3, SoTextureCoordinateDefault, SoTextureMatrixTransform,
       SoTransformSeparator, SoVRMLSensor, SoInterpolateFloat, SoInterpolateRotation,
       SoInterpolateVec2f, SoInterpolateVec3f, SoInterpolateVec4f, SoShapeKit, SoWrapperKit,
       SoTextureCoordinateCube, SoTextureCoordinateCylinder, SoTextureCoordinateFunction,
       SoTextureCoordinateSphere, SoTransformation, and SoVertexShader.

   void SoFieldContainer::copyContents (const SoFieldContainer *from, SbBoolcopyconnections)
       [virtual]
       Makes a deep copy of all data of from into this instance, except external scenegraph
       references if copyconnections is FALSE.

       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.

       For copying nodes from application code, you should not invoke this function directly, but
       rather call the SoNode::copy() function:

       SoNode * mynewnode = templatenode->copy();

       The same also goes for engines.

       Make sure that when you override the copyContents() method in your extension class that
       you also make it call upwards to it's parent superclass in the inheritance hierarchy, as
       copyContents() in for instance SoNode and SoFieldContainer does important work. It should
       go something like this:

       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..]
       }

       Reimplemented in SoNode, SoWWWInline, SoBaseKit, SoVRMLSwitch, SoVRMLLOD,
       SoInteractionKit, SoNodeKitListPart, SoVRMLParent, SoClipPlaneManip, SoGroup,
       SoDirectionalLightManip, SoSpotLightManip, SoVRMLShape, SoPointLightManip,
       SoTransformManip, SoVRMLScript, SoRotateSphericalDragger, SoRotateCylindricalDragger,
       SoFile, SoCallback, SoVertexAttribute, SoVRMLAppearance, and SoVRMLGeometry.

   SoFieldContainer * SoFieldContainer::copyThroughConnection (void) const [virtual]
       Return copy of this instance.

       Note: default implementation just returns this pointer, SoNode and SoEngine overrides this
       method to return the pointer to the actual copy.

       Reimplemented in SoNode, and SoEngine.

   void SoFieldContainer::initCopyDict (void) [static]
       This API member is considered internal to the library, as it is not likely to be of
       interest to the application programmer.

       Initialize a dictionary hash storing pointers for original fieldcontainer instances and
       their copies during scene graph copy operations.

       This method is called from the start of SoNode::copy().

   void SoFieldContainer::addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy)
       [static]
       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.

   SoFieldContainer * SoFieldContainer::checkCopy (const SoFieldContainer *orig) [static]
       Returns the copy of orig, if any. If no copy exists, we return a NULL pointer.

   SoFieldContainer * SoFieldContainer::findCopy (const SoFieldContainer *orig, const
       SbBoolcopyconnections) [static]
       Returns a copy of orig.

       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 copyconnections flag).

       This method will also run the copyContents() method on the copy, if it hasn't been run
       already. Note that if you call copyContents() on the copy outside of this method, this
       will go undetected and the guts of orig will be copied multiple times into its copy.

       If copyContents() 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.

       See Also:
           checkCopy()

   void SoFieldContainer::copyDone (void) [static]
       This API member is considered internal to the library, as it is not likely to be of
       interest to the application programmer.

       Clean up the dictionary hash.

       This method is called from the end of SoNode::copy().

   void SoFieldContainer::getFieldsMemorySize (size_t &managed, size_t &unmanaged) const
       [virtual]
       Returns the data array sizes of the SoFieldData-registered multi-fields. The managed
       argument returns the size of the fields that Coin manages the memory for, and the
       unmanaged argument returns the size of the data in the multi-fields controlled by the
       application through SoMField::setValuesPointer() which Coin will not delete.

       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.

       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.

       This method is used for memory profiling purposes.

       Since:
           Coin 3.0

   void SoFieldContainer::setUserData (void *userdata) const
       Set a generic user data pointer for this field container.

       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. getUserData() can later be used to retrieve the pointer.

       See Also:
           getUserData()

       Since:
           Coin 2.0

   void * SoFieldContainer::getUserData (void) const
       Return the generic user data pointer for this field container, or NULL if no user data has
       been set.

       See Also:
           setUserData()

       Since:
           Coin 2.0

   SbBool SoFieldContainer::readInstance (SoInput *in, unsigned shortflags) [protected],
       [virtual]
       This method is mainly intended for internal use during file import operations.

       It reads a definition of an instance from the input stream in. The input stream state
       points to the start of a serialized / persistant representation of an instance of this
       class type.

       TRUE or FALSE 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 FALSE.

       flags is used internally during binary import when reading user extension nodes, group
       nodes or engines.

       Implements SoBase.

       Reimplemented in SoNode, SoBaseKit, SoWWWInline, SoVRMLSwitch, SoVRMLLOD,
       SoInteractionKit, SoTextureCubeMap, SoNodeKitListPart, SoSeparator, SoTexture2, SoImage,
       SoVRMLParent, SoTexture3, SoShaderObject, SoProto, SoFile, SoGroup, SoVRMLImageTexture,
       SoEngine, SoProtoInstance, SoNormalBinding, SoBumpMap, SoVertexAttribute,
       SoTextureCoordinateBinding, SoVRMLBackground, SoNodeEngine, and SoVRMLPixelTexture.

Member Data Documentation

   SbBool SoFieldContainer::isBuiltIn [protected]
       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.

Author

       Generated automatically by Doxygen for Coin from the source code.