Abstract base class for objects that contain fields. More...
#include <Inventor/fields/SoFieldContainer.h>
Public Member Functions | |
| void | setToDefaults () |
| Sets all fields in this object to their default values. | |
| SbBool | hasDefaultValues () const |
| Returns TRUE if all of the object's fields have their default values. | |
| SbBool | fieldsAreEqual (const SoFieldContainer *fc) const |
Returns TRUE if this object's fields are exactly equal to fc's fields. | |
| void | copyFieldValues (const SoFieldContainer *fc, SbBool copyConnections=FALSE) |
Copies the contents of fc's fields into this object's fields. | |
| SbBool | set (const char *fieldDataString) |
| Sets one or more fields in this object to the values specified in the given string, which should be a string in the Inventor file format. | |
| void | get (SbString &fieldDataString) |
| Returns the values of the fields of this object in the Inventor ASCII file format in the given string. | |
| virtual int | getFields (SoFieldList &list) const |
| Appends pointers to all of this object's fields to resultList, and returns the number of fields appended. | |
| virtual SoField * | getField (const SbName &fieldName) const |
| Returns a pointer to the field with the given name. | |
| SbBool | getFieldName (const SoField *field, SbName &fieldName) const |
Returns the name of the given field in the fieldName argument. | |
| SbBool | enableNotify (SbBool flag) |
| Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE). | |
| SbBool | isNotifyEnabled () const |
| Notification is the process of telling interested objects that this object has changed. | |
| SbBool | set (const char *fieldDataString, SoInput *dictIn) |
| Sets one or more fields in this object to the values specified in the given string, which should be a string in the Inventor file format. | |
| void | get (SbString &fieldDataString, SoOutput *dictOut) |
| Returns the values of the fields of this object in the Inventor ASCII file format in the given string. | |
| virtual void | notify (SoNotList *) |
| Propagates modification notification through an instance. | |
| virtual void | addWriteReference (SoOutput *out, SbBool isFromField=FALSE) |
| Adds a reference to the instance when writing. | |
| virtual void | writeInstance (SoOutput *out) |
| Writes instance to SoOutput. (Used only for last stage of writing) | |
| SbBool | getIsBuiltIn () const |
| Returns whether or not instance is considered 'built-in' to the library. | |
| virtual const SoFieldData * | getFieldData () const |
| Returns an SoFieldData structure for the node. | |
| virtual void | copyContents (const SoFieldContainer *fromFC, SbBool copyConnections) |
| ////////////////////////////////////////// | |
| virtual SoFieldContainer * | copyThroughConnection () const |
| During a copy operation, this copies an instance that is encountered through a field connection. | |
Static Public Member Functions | |
| static SoType | getClassTypeId () |
| Returns the type of this class. | |
| static void | initClass () |
| Setup type information. | |
| static void | initCopyDict () |
| During a copy operation, copies of nodes and engines are stored in a dictionary, keyed by the original node or engine pointer, so that copies can be re-used. | |
| static void | addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy) |
| Adds an instance to the dictionary. | |
| static SoFieldContainer * | checkCopy (const SoFieldContainer *orig) |
| If a copy of the given instance is in the dictionary, this returns it. | |
| static SoFieldContainer * | findCopy (const SoFieldContainer *orig, SbBool copyConnections) |
| If a copy of the given instance is not in the dictionary, this returns NULL. | |
| static void | copyDone () |
| Cleans up the dictionary when done. | |
Protected Member Functions | |
| SoFieldContainer () | |
| ~SoFieldContainer () | |
| virtual SbBool | readInstance (SoInput *in, unsigned short flags) |
| Reads stuff into instance. Returns FALSE on error. | |
Protected Attributes | |
| SbBool | isBuiltIn |
| Is the subclass a built-in Inventor subclass or an extender subclass? This is used to determine whether to read/write field type information. | |
Detailed Description
SoFieldContainer is the abstract base class for engines and nodes. It contains methods for finding out what fields an object has, controlling notification, and for dealing with all of the fields of an object at once.
The fields of an engine are its inputs. Note that even though an engine's output corresponds to a specific type of field, an engine output is not a field.
- See Also
Definition at line 91 of file SoFieldContainer.h.
Constructor & Destructor Documentation
| SoFieldContainer::SoFieldContainer | ( | ) | [protected] |
| SoFieldContainer::~SoFieldContainer | ( | ) | [protected] |
Member Function Documentation
| static void SoFieldContainer::addCopy | ( | const SoFieldContainer * | orig, |
| const SoFieldContainer * | copy | ||
| ) | [static] |
| static SoFieldContainer* SoFieldContainer::checkCopy | ( | const SoFieldContainer * | orig | ) | [static] |
Otherwise, it returns NULL. The copy is not changed in any way.
| virtual void SoFieldContainer::copyContents | ( | const SoFieldContainer * | fromFC, |
| SbBool | copyConnections | ||
| ) | [virtual] |
Copies the contents of the given node into this instance. The default implementation copies just field values and the name.
Reimplemented in SoCallback, SoFile, SoGroup, SoNode, SoWWWInline, SoUnknownEngine, SoUnknownNode, SoRotateCylindricalDragger, SoRotateSphericalDragger, SoDirectionalLightManip, SoPointLightManip, SoSpotLightManip, SoTransformManip, SoInteractionKit, SoBaseKit, and SoNodeKitListPart.
| static void SoFieldContainer::copyDone | ( | ) | [static] |
| void SoFieldContainer::copyFieldValues | ( | const SoFieldContainer * | fc, |
| SbBool | copyConnections = FALSE |
||
| ) |
fc must be the same type as this object. If copyConnections is TRUE, then if any of fc's fields are connected then this object's fields will also be connected to the same source.
| virtual SoFieldContainer* SoFieldContainer::copyThroughConnection | ( | ) | const [virtual] |
The default implementation just returns the original pointer - no copy is done. Subclasses such as nodes and engines handle this differently.
Reimplemented in SoConcatenate, SoEngine, SoGate, SoSelectOne, and SoNode.
The returned boolean value indicates whether notification was enabled immediately prior to applying this method.
Definition at line 162 of file SoFieldContainer.h.
| SbBool SoFieldContainer::fieldsAreEqual | ( | const SoFieldContainer * | fc | ) | const |
If fc is not exactly same type as this object, FALSE is returned.
| static SoFieldContainer* SoFieldContainer::findCopy | ( | const SoFieldContainer * | orig, |
| SbBool | copyConnections | ||
| ) | [static] |
Otherwise, this copies the contents of the original into the copy (if not already done) and returns a pointer to the copy.
| void SoFieldContainer::get | ( | SbString & | fieldDataString | ) | [inline] |
Fields whose isDefault() bit is set will not be part of the string. You can use the field->get() method to get a field's value as a string even if has its default value.
Definition at line 139 of file SoFieldContainer.h.
Fields whose isDefault() bit is set will not be part of the string. You can use the field->get() method to get a field's value as a string even if has its default value.
| static SoType SoFieldContainer::getClassTypeId | ( | ) | [inline, static] |
Reimplemented from SoBase.
Reimplemented in SoEngine, and SoNode.
Definition at line 96 of file SoFieldContainer.h.
If no such field exists, NULL is returned.
| virtual const SoFieldData* SoFieldContainer::getFieldData | ( | ) | const [virtual] |
Objects with no fields should return NULL, which is what the default method does.
Returns FALSE if field is not a member of this object.
| virtual int SoFieldContainer::getFields | ( | SoFieldList & | list | ) | const [virtual] |
The types of the fields can be determined using field->isOfType() and field->getTypeId(), and their names can be determined by passing the field pointers to the getFieldName() method (see below).
| SbBool SoFieldContainer::getIsBuiltIn | ( | ) | const [inline] |
Used during writing.
Definition at line 226 of file SoFieldContainer.h.
| SbBool SoFieldContainer::hasDefaultValues | ( | ) | const |
This will return TRUE even if a field's isDefault() method returns FALSE em for example, if a field's default value is 0.0 and you setValue(0.0) that field, the default flag will be set to FALSE (because it would be too slow to compare the field against its default value every time setValue is called). However, hasDefaultValues() would return TRUE in this case.
| static void SoFieldContainer::initClass | ( | ) | [static] |
Reimplemented from SoBase.
Reimplemented in SoBoolOperation, SoCalculator, SoComputeBoundingBox, SoConcatenate, SoCounter, SoElapsedTime, SoEngine, SoFieldConverter, SoGate, SoInterpolate, SoOneShot, SoOnOff, SoSelectOne, SoTimeCounter, SoTransformVec3f, SoTriggerAny, SoUpgrader, SoV1CustomNode, SoAnnotation, SoArray, SoAsciiText, SoBaseColor, SoBlinker, SoCallback, SoCamera, SoClipPlane, SoColorIndex, SoComplexity, SoCone, SoCoordinate3, SoCoordinate4, SoCube, SoCylinder, SoDirectionalLight, SoDrawStyle, SoEnvironment, SoEventCallback, SoFaceSet, SoFile, SoFont, SoFontStyle, SoGroup, SoIndexedFaceSet, SoIndexedLineSet, SoIndexedNurbsCurve, SoIndexedNurbsSurface, SoIndexedShape, SoIndexedTriangleSet, SoIndexedTriangleStripSet, SoInfo, SoLabel, SoLevelOfDetail, SoLight, SoLightModel, SoLinearProfile, SoLineSet, SoLocateHighlight, SoLOD, SoMaterial, SoMaterialBinding, SoMatrixTransform, SoMultipleCopy, SoNode, SoNonIndexedShape, SoNormal, SoNormalBinding, SoNurbsCurve, SoNurbsProfile, SoNurbsSurface, SoOrthographicCamera, SoPackedColor, SoPathSwitch, SoPendulum, SoPerspectiveCamera, SoPickStyle, SoPointLight, SoPointSet, SoProfile, SoProfileCoordinate2, SoProfileCoordinate3, SoQuadMesh, SoResetTransform, SoRotation, SoRotationXYZ, SoRotor, SoScale, SoSeparator, SoShape, SoShapeHints, SoShuttle, SoSphere, SoSpotLight, SoSwitch, SoText2, SoText3, SoTexture2, SoTexture2Transform, SoTextureCoordinate2, SoTextureCoordinateBinding, SoTextureCoordinateDefault, SoTextureCoordinateEnvironment, SoTextureCoordinateFunction, SoTextureCoordinatePlane, SoTransform, SoTransformation, SoTransformSeparator, SoTranslation, SoTriangleStripSet, SoUnits, SoVertexProperty, SoVertexShape, SoWWWAnchor, SoWWWInline, SoUnknownEngine, SoUnknownNode, SoCenterballDragger, SoDirectionalLightDragger, SoDragger, SoDragPointDragger, SoHandleBoxDragger, SoJackDragger, SoPointLightDragger, SoRotateCylindricalDragger, SoRotateDiscDragger, SoRotateSphericalDragger, SoScale1Dragger, SoScale2Dragger, SoScale2UniformDragger, SoScaleUniformDragger, SoSpotLightDragger, SoTabBoxDragger, SoTabPlaneDragger, SoTrackballDragger, SoTransformBoxDragger, SoTransformerDragger, SoTranslate1Dragger, SoTranslate2Dragger, SoCenterballManip, SoDirectionalLightManip, SoHandleBoxManip, SoJackManip, SoPointLightManip, SoSpotLightManip, SoTabBoxManip, SoTrackballManip, SoTransformBoxManip, SoTransformerManip, SoTransformManip, SoInteractionKit, SoAntiSquish, SoSelection, SoSurroundScale, SoPolygonOffset, SoAppearanceKit, SoBaseKit, SoCameraKit, SoLightKit, SoNodeKitListPart, SoSceneKit, SoSeparatorKit, SoShapeKit, and SoWrapperKit.
| static void SoFieldContainer::initCopyDict | ( | ) | [static] |
These methods operate on that dictionary. Initializes a new copy dictionary
| SbBool SoFieldContainer::isNotifyEnabled | ( | ) | const [inline] |
Notification is needed to make engines and sensors function, is used to keep SoPaths up to date when the scene graph's topology changes, and is also used to invalidate rendering or bounding box caches.
Notification is normally enabled, but can be disabled on a node by node (or engine by engine) basis. If you are making extensive changes to a large part of the scene graph then disabling notification can increase performance, at the expense of increased responsibility for making sure that any interested engines, sensors or paths are kept up to date.
For example, if you will be making a lot of changes to a small part of your scene graph and you know that there are no engines or sensors attached to nodes in that part of the scene graph, you might disable notification on the nodes you are changing, modify them, re-enable notification, and then touch() one of the nodes to cause a redraw.
However, you should profile your application and make sure that notification is taking a significant amount of time before going to the trouble of manually controlling notification.
Definition at line 189 of file SoFieldContainer.h.
| virtual void SoFieldContainer::notify | ( | SoNotList * | ) | [virtual] |
Reimplemented from SoBase.
Reimplemented in SoEngine, SoBlinker, SoIndexedShape, SoNode, SoSeparator, and SoVertexShape.
| virtual SbBool SoFieldContainer::readInstance | ( | SoInput * | in, |
| unsigned short | flags | ||
| ) | [protected, virtual] |
Implements SoBase.
Reimplemented in SoElapsedTime, SoEngine, SoOneShot, SoTimeCounter, SoFile, SoGroup, SoMaterialBinding, SoNormalBinding, SoSeparator, SoTexture2, SoTextureCoordinateBinding, SoWWWInline, SoUnknownNode, SoInteractionKit, SoBaseKit, and SoNodeKitListPart.
| SbBool SoFieldContainer::set | ( | const char * | fieldDataString | ) | [inline] |
TRUE is returned if the string was valid Inventor file format. For example, you could set the fields of an SoCube by doing:
Definition at line 130 of file SoFieldContainer.h.
| void SoFieldContainer::setToDefaults | ( | ) |
| virtual void SoFieldContainer::writeInstance | ( | SoOutput * | out | ) | [virtual] |
Reimplemented in SoElapsedTime, SoEngine, SoOneShot, SoTimeCounter, and SoNode.
Member Data Documentation
SbBool SoFieldContainer::isBuiltIn [protected] |
Definition at line 280 of file SoFieldContainer.h.
The documentation for this class was generated from the following file:
- MeVis/ThirdParty/Sources/Inventor/inventor/lib/database/include/Inventor/fields/SoFieldContainer.h
