SoBase(3)

📦
version 4.0.10 · 4 versions
, in fedora 43, fedora 44

SoBase(3) — Coin manual, but make it cute ✨

okay so this is the SoBase(3) page from the Coin manual. It's a whole vibe. Let's get into it 💖

🎀 NAME 🎀

SoBase — the top-level superclass for a bunch of class hierarchies. It's giving "founder of the family tree" energy 👑

🦋 SYNOPSIS 🦋

#include <Inventor/misc/SoBase.h>

Inherited by SoFieldContainer, and SoPath.

✨ Public Member Functions ✨

  • void ref (void) const
  • void unref (void) const
  • void unrefNoDelete (void) const
  • int32_t getRefCount (void) const
  • void touch (void)
  • virtual SoType getTypeId (void) const =0 — Returns the type identification of an object derived from a class inheriting SoBase. This is used for runtime type checking and "downward" casting.
  • SbBool isOfType (SoType type) const — Returns TRUE if the type of this object is either of the same type or inherited from type.
  • virtual SbName getName (void) const
  • virtual void setName (const SbName &newname)
  • virtual void startNotify (void)
  • virtual void notify (SoNotList *l)
  • void addAuditor (void *const auditor, const SoNotRec::Type type)
  • void removeAuditor (void *const auditor, const SoNotRec::Type type)
  • const SoAuditorList & getAuditors (void) const
  • virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)
  • SbBool shouldWrite (void)
  • void assertAlive (void) const

🌈 Static Public Member Functions 🌈

  • static void initClass (void) — Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
  • static SoType getClassTypeId (void) — This static method returns the SoType object associated with objects of this class.
  • static void addName (SoBase *const base, const char *const name)
  • static void removeName (SoBase *const base, const char *const name)
  • static void incrementCurrentWriteCounter (void)
  • static void decrementCurrentWriteCounter (void)
  • static SoBase * getNamedBase (const SbName &name, SoType type)
  • static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type)
  • static SbBool read (SoInput *input, SoBase *&base, SoType expectedtype)
  • static void setInstancePrefix (const SbString &c)
  • static void setTraceRefs (SbBool trace)
  • static SbBool getTraceRefs (void)
  • static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)
  • static SbBool readRoute (SoInput *input)

💅 Protected Types 💅

  • enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 }

🧚 Protected Member Functions 🧚

  • SoBase (void)
  • virtual ~SoBase ()
  • virtual void destroy (void)
  • SbBool hasMultipleWriteRefs (void) const
  • SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const
  • void writeFooter (SoOutput *out) const
  • virtual const char * getFileFormatName (void) const
  • virtual SbBool readInstance (SoInput *input, unsigned short flags)=0
  • virtual SoNotRec createNotRec (void)

⭐ Static Protected Member Functions ⭐

  • static uint32_t getCurrentWriteCounter (void)
  • static void staticDataLock (void)
  • static void staticDataUnlock (void)

🔥 Detailed Description 🔥

The SoBase class is the top-level superclass for a number of class-hierarchies. No cap, it's the blueprint, the moment, the origin story 💖

SoBase provides the basic interfaces and methods for doing reference counting, type identification and import/export. All classes in Coin which uses these mechanisms are descendent from this class.

One important issue with SoBase-derived classes is that they should not be statically allocated, neither in static module memory nor on function's stack frames. SoBase-derived classes must always be allocated dynamically from the memory heap with the new operator.

This is so because SoBase-derived instances are reference counted, and will self destruct on the appropriate time. For this to work, they must be explicitly allocated in heap memory. See the class documentation of SoNode for more information.

🌸 Member Enumeration Documentation 🌸

enum SoBase::BaseFlags [protected]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. So like, don't worry about it unless you're deep in the sauce 🫣

💖 Constructor & Destructor Documentation 💖

SoBase::SoBase (void ) [protected]

Constructor. The initial reference count will be set to zero.

SoBase::~SoBase () [protected], [virtual]

Destructor. There should not be any normal circumstance where you need to explicitly delete an object derived from the SoBase class, as the reference counting should take care of deallocating unused objects.

See also unref(), unrefNoDelete()

👑 Member Function Documentation 👑

void SoBase::ref (void ) const

Increase the reference count of the object. This might be necessary to do explicitly from user code for certain situations (mainly to avoid premature deletion), but is usually called from other instances within the Coin library when objects are made dependent on each other.

See the class documentation of SoNode for more extensive information about reference counting.

See also unref(), unrefNoDelete()

void SoBase::unref (void ) const

Decrease the reference count of an object. If the reference count reaches zero, the object will delete itself. Be careful when explicitly calling this method, beware that you usually need to match user level calls to ref() with calls to either unref() or unrefNoDelete() to avoid memory leaks.

See also ref(), unrefNoDelete()

void SoBase::unrefNoDelete (void ) const

Decrease reference count, but do not delete ourself if the count reaches zero.

See also unref()

int32_t SoBase::getRefCount (void ) const

Returns number of objects referring to this object.

void SoBase::touch (void )

Force an update, in the sense that all objects connected to this object as an auditor will have to re-check the values of their inter-dependent data.

This is often used as an effective way of manually triggering a redraw by application programmers.

virtual SoType SoBase::getTypeId (void ) const [pure virtual]

Returns the type identification of an object derived from a class inheriting SoBase. This is used for runtime type checking and "downward" casting. Usage example:

void foo(SoNode * node)
{
  if (node->getTypeId() == SoFile::getClassTypeId()) {
    SoFile * filenode = (SoFile *)node;  // safe downward cast, knows the type
  }
}

For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. This is typically done as part of setting up the full type system for extension classes, which is usually accomplished by using the predefined macros available through for instance Inventor/nodes/SoSubNode.h (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on.

For more information on writing Coin extensions, see the class documentation of the top level superclasses for the various class groups.

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

SbBool SoBase::isOfType (SoType type) const

Returns TRUE if the type of this object is either of the same type or inherited from type. This is used for runtime type checking and "downward" casting. Basically it's the "do I know you?" check for your scene graph besties. ✨

Usage example:

void foo(SoNode * node)
{
  if (node->isOfType(SoGroup::getClassTypeId())) {
    SoGroup * group = (SoGroup *)node;  // safe downward cast, knows the type
  }
}

SbName SoBase::getName (void ) const [virtual]

Returns name of object. If no name has been given to this object, the returned SbName will contain the empty string. So like, no name, no drama, just an empty vibe. 🫶

void SoBase::setName (const SbName & newname) [virtual]

Set the name of this object.

Some characters are invalid to use as parts of names for SoBase derived objects, as object names needs to be consistent with the syntax of Inventor and VRML files upon file export / import operations (so one must for instance avoid using special token characters). Yeah bestie, the file format is picky. 😭

Invalid characters will be automatically replaced by underscore characters. If the name starts with an invalid character, the new name will be preceded by an underscore character.

For the exact definitions of what constitutes legal and illegal characters for SoBase names, see the SbName functions listed below.

See also: getName(), SbName::isBaseNameStartChar(), SbName::isBaseNameChar()

void SoBase::addName (SoBase *const b, const char *const name) [static]

Adds a name<->object mapping to the global dictionary. It's giving matchmaker energy. 💅

void SoBase::removeName (SoBase *const base, const char *const name) [static]

Removes a name<->object mapping from the global dictionary. Unmatched and unbothered. 🙈

void SoBase::startNotify (void ) [virtual]

This is the method which starts the notification sequence after changes.

At the end of a notification sequence, all "immediate" sensors (i.e. sensors set up with a zero priority) are triggered.

Reimplemented in SoNode.

void SoBase::notify (SoNotList * l) [virtual]

Notifies all auditors for this instance when changes are made. It's the group chat blast for "hey, something changed!" 📣

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

void SoBase::addAuditor (void *const auditor, const SoNotRec::Type type)

Add an auditor to notify whenever the object changes in any significant way. It's like adding a sub to your channel. 👑

See also: removeAuditor()

void SoBase::removeAuditor (void *const auditor, const SoNotRec::Type type)

Remove an auditor from the list. auditor will then no longer be notified whenever any updates are made to this object. Unsubscribed, periodt.

See also: addAuditor()

const SoAuditorList & SoBase::getAuditors (void ) const

Returns list of objects auditing this object. The whole audience, front row. 🌈

See also: addAuditor(), removeAuditor()

void SoBase::addWriteReference (SoOutput * out, SbBool isfromfield = 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. Counting receipts, bestie. 🧾

Reimplemented in SoBaseKit, SoFieldContainer, and SoGroup.

SbBool SoBase::shouldWrite (void )

Returns TRUE if this object should be written out during a write action. Will return FALSE if no references to this object have been made in the scene graph.

Note that connections from the fields of field container objects is not alone a valid reason for writing out the object -- there must also be at least one reference directly from another SoBase (like a parent/child relationship, for instance).

This method will return a valid result only during the second pass of write actions.

void SoBase::incrementCurrentWriteCounter (void ) [static]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. Lowkey just library business. 🤫

void SoBase::decrementCurrentWriteCounter (void ) [static]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. Also lowkey library business. 💀

SoBase * SoBase::getNamedBase (const SbName & name, SoType type) [static]

Returns the object of type, or derived from type, registered under name. If several objects have been registered under the same name with the same type, returns the last one which was registered.

If no object of a valid type or subtype has been registered with the given name, returns NULL. No match, no vibe. 🍓

int SoBase::getNamedBases (const SbName & name, SoBaseList & baselist, SoType type) [static]

Returns the number of objects of type type, or derived from type, registered under name. Like a headcount for your named besties. 🎀

All matches will also be appended to baselist. 💖

SbBool SoBase::read (SoInput * in, SoBase *& base, SoType expectedtype) — static

Bestie, this is the ✨main character✨ of file reading. It grabs the next SoBase-derived instance out of the in stream, checks that it's actually derived from expectedtype, and drops a pointer to the freshly allocated instance into base.

You get FALSE back when: there are read errors, the type doesn't match expectedtype, or somebody tried to reference (via the USE keyword) an instance that doesn't exist. Rude, but okay.

Now here's the tea: if it returns TRUE and base is NULL, three different things could have happened, and you gotta figure out which:

  1. End-of-file. Call SoInput::eof() after this method to catch that one.
  2. in didn't have a valid identifier name sitting at the stream for us to read. That happens either when there are errors, or when all the child nodes of a group have already been read. To detect that second case, peek at the next character in the stream — if it's a '}', that's your answer. 🕵️
  3. A child was given as the NULL keyword. This can happen while reading the contents of SoSFNode fields (heads up: NULL is not allowed for SoMFNode, okay?).

And if TRUE comes back with base not NULL? Then the instance was allocated and initialized according to whatever was read from the in stream. Slay. 👑

void SoBase::setInstancePrefix (const SbString & c) — static

Referenced instances of SoBase get written as "DEF NamePrefixNumber" when exported. Break it down:

  • "Name" = the name of the base instance, from setName()
  • "Prefix" = common to all objects, and you set it with this method (default is "+")
  • "Number" = a unique id, which is necessary when multiple objects share the same name

So if you want that prefix to be literally anything other than "+", this method is your girl. 💅

void SoBase::setTraceRefs (SbBool trace) — static

Set it to TRUE to turn on reference counting debugging — super useful for hunting down those cursed problems with accesses to freed memory or memory leaks. 🔍

Heads up though: this will absolutely flood any "normal" running system with debug info, so use it sensibly, bestie. Don't come crying to me when your terminal is a wall of text.

Also, fyi: the reference tracing functionality is disabled in "releaseversions" of the Coin library. So it's giving debug-build-only energy. 🫶

SbBool SoBase::getTraceRefs (void ) — static

Returns the status of the reference tracing flag. Simple as that. ✨

See also: setTraceRefs()

SbBool SoBase::connectRoute (SoInput * in, const SbName & fromnodename, const SbName & fromfieldname, const SbName & tonodename, const SbName & tofieldname) — static

Connect a route from the node named fromnodename's field fromfieldname over to the node named tonodename's field tofieldname. And the cute part? This method actually considers the field types (event in, event out, etc.) when it's connecting. Thoughtful. 🎀

This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

Since: Coin 2.0

void SoBase::assertAlive (void ) const

Okay so real talk — this API member is considered internal to the library, and it's not likely to be of interest to the application programmer. 🙈 But the lore is kinda fascinating so here we go:

There are 4 bits allocated for each SoBase-object for a bitpattern that indicates the object is still "alive". That pattern gets changed when the object is destructed. So if this method gets called after destruction, an assert will hit. 💀

This is used internally in Coin (in for instance SoBase::ref()) to try to detect when an instance has been prematurely destructed. And bestie, that is a very common mistake made by application programmers — letting the refcount drop to zero before it should. So this extra piece of assistance, via the accompanying assert() in this method, helps detect dangling references to the object before you get subsequent memory corruption and mysterious crashes. Which is, objectively, a Good Thing. 💖

This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

Since: Coin 2.0

SbBool SoBase::readRoute (SoInput * in) — static

Another internal-to-the-library one, not likely to be of interest to the application programmer. 🙈

It reads a (VRML97) ROUTE. And the backstory? We decided to also add support for routes in Coin, as a generic feature, since we think it's nicer than setting up field connections inside the nodes. Taste! 👑

void SoBase::destroy (void ) — protected, virtual

Cleans up all the hanging references to and from this instance, and then... commits suicide. 😭💀 Dramatic, but that's literally what the docs say.

It's called automatically when the reference count goes to zero.

Reimplemented in: SoProto.

SbBool SoBase::hasMultipleWriteRefs (void ) const — protected

Returns TRUE if this object is gonna be written more than once upon export.

Careful bestie: the result from this method is only valid during the second pass of a write action (and partially during the COUNT_REFS pass). So don't go trusting it any other time. 🚨

SbBool SoBase::writeHeader (SoOutput * out, SbBool isgroup, SbBool isengine) const — protected

Writes out the header of any SoBase-derived object. And what's in that header, you ask? The DEF keyword and the object name (if the object has a name — otherwise these get skipped), the class name, and a left bracket. ✨

Alternatively, the object representation may be made up of just the USE keyword plus the object name, if this is the second or subsequent reference written to the file.

If the object has been completed just by writing the header — which will be the case if we're writing multiple references of an object — we return TRUE. Otherwise, FALSE.

And if we return FALSE (i.e. there's more to write), we will increment the indentation level. Cute, right? 🎀

See also: writeFooter(), SoOutput::indent()

void SoBase::writeFooter (SoOutput * out) const — protected

This method will terminate the block representing an SoBase-derived object. That's it, that's the whole vibe. Closing the loop. 🌸

const char * SoBase::getFileFormatName (void ) const — protected, virtual

Returns the class name this object should be written under. The default string returned is the name of the class from the type system.

User extensions nodes and engines override this method to return the name of the extension — instead of "UnknownNode" or "UnknownEngine", which is what you'd otherwise be stuck with. Much better. 💅

Reimplemented in: SoProtoInstance.

virtual SbBool SoBase::readInstance (SoInput * in, unsigned short flags) — protected, pure virtual

This one 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 / persistent representation of an instance of this class type.

TRUE or FALSE gets returned, depending on whether the instantiation and configuration of the new object of this class type went OK or not. And important: the import process should be robust and handle corrupted input streams by returning FALSE. Don't just crash on us. 😭

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

Implemented in: SoBaseKit, SoBumpMap, SoEngine, SoFieldContainer, SoFile, SoGroup, SoImage, SoInteractionKit, SoNode, SoNodeEngine, SoNodeKitListPart, SoNormalBinding, SoProto, SoProtoInstance, SoSeparator, SoShaderObject, SoTexture2, SoTexture3, SoTextureCoordinateBinding, SoTextureCubeMap, SoVertexAttribute, SoVRMLBackground, SoVRMLImageTexture, SoVRMLLOD, SoVRMLParent, SoVRMLPixelTexture, SoVRMLSwitch, and SoWWWInline. Whew. 😮‍💨

uint32_t SoBase::getCurrentWriteCounter (void ) — static, protected

Internal to the library, not likely to be of interest to the application programmer. That's the whole thing, bestie. 🙈

void SoBase::staticDataLock (void ) — static, protected

Lock access to static data. 🔒

void SoBase::staticDataUnlock (void ) — static, protected

Unlock access to static data. 🔓 (Yeah, it's the sequel.)

SoNotRec SoBase::createNotRec (void ) — protected, virtual

Create a record entry for notification lists. 📝

Reimplemented in: SoGroup.

🌈 Author 🌈

Generated automatically by Doxygen for Coin from the source code. Not me, not you, not anyone's fave — a robot. 🤖✨

And that's a wrap on this whole page, bestie!! 🎀💖 Version 4.0.10, stamped Thu Jun 25 2026 00:00:00, filed under SoBase(3). Go forth and not leak memory, okay? You've got this. 🦋💅

📦 where this page comes from