SoFile(3)

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

🌸 NAME 🌸

SoFile — bestie, she's a node container for another model file. that's it, that's the gig. a whole entire other file, living inside a node. 💅

so like, quick intro before we get into it: this is the manual page for SoFile from the Coin library, and it's a long one so we're doing it in parts. buckle up. 🎀

🦋 SYNOPSIS 🦋

#include <Inventor/nodes/SoFile.h>

Inherits SoNode. (yes she's a nepo baby — everything a node can do, she can do, and more 💖)

✨ Public Member Functions

virtual SoType getTypeId (void) const
SoFile (void)
virtual void doAction (SoAction *action)
virtual void callback (SoCallbackAction *action)
virtual void GLRender (SoGLRenderAction *action)
virtual void getBoundingBox (SoGetBoundingBoxAction *action)
virtual void getMatrix (SoGetMatrixAction *action)
virtual void handleEvent (SoHandleEventAction *action)
virtual void pick (SoPickAction *action)
virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
virtual void audioRender (SoAudioRenderAction *action)
virtual void search (SoSearchAction *action)
SoGroup * copyChildren (void) const
virtual SoChildList * getChildren (void) const
virtual void copyContents (const SoFieldContainer *from, SbBool
    copyconnections)
const SbString & getFullName (void) const

🌈 Public Member Functions inherited from SoNode

void setOverride (const SbBool state)
SbBool isOverride (void) const
void setNodeType (const NodeType type)
NodeType getNodeType (void) const
virtual SoNode * copy (SbBool copyconnections=FALSE) const
virtual SbBool affectsState (void) const
virtual void GLRenderBelowPath (SoGLRenderAction *action)
virtual void GLRenderInPath (SoGLRenderAction *action)
virtual void GLRenderOffPath (SoGLRenderAction *action)
virtual void rayPick (SoRayPickAction *action)
virtual void write (SoWriteAction *action)
virtual void grabEventsSetup (void)
virtual void grabEventsCleanup (void)
virtual void startNotify (void)
virtual void notify (SoNotList *l)
SbUniqueId getNodeId (void) const
virtual void writeInstance (SoOutput *out)
virtual SoNode * addToCopyDict (void) const
virtual SoFieldContainer * copyThroughConnection (void) const

💜 Public Member Functions inherited from SoFieldContainer

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 SbBool validateNewFieldValue (SoField *field, void *newval)
virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)
SbBool getIsBuiltIn (void) const
virtual void getFieldsMemorySize (size_t &managed, size_t &unmanaged)
    const
void setUserData (void *userdata) const
void * getUserData (void) const

🫶 Public Member Functions inherited from SoBase

void ref (void) const
void unref (void) const
void unrefNoDelete (void) const
int32_t getRefCount (void) const
void touch (void)
SbBool isOfType (SoType type) const
virtual SbName getName (void) const
virtual void setName (const SbName &newname)
void addAuditor (void *const auditor, const SoNotRec::Type type)
void removeAuditor (void *const auditor, const SoNotRec::Type type)
const SoAuditorList & getAuditors (void) const
SbBool shouldWrite (void)
void assertAlive (void) const

and one little note on isOfType, straight from the source, no cap:

Returns TRUE if the type of this object is either of the same type or inherited from type.

💫 Static Public Member Functions 💫

static SoType getClassTypeId (void)
static void initClass (void)
static void setSearchOK (SbBool dosearch)
static SbBool getSearchOK ()

and about initClass, here's the deal: it sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. 🎀

⭐ Static Public Member Functions inherited from SoNode

static uint32_t getCompatibilityTypes (const SoType &nodetype)
static SoType getClassTypeId (void)
static SoNode * getByName (const SbName &name)
static int getByName (const SbName &name, SoNodeList &l)
static void initClass (void)
static void initClasses (void)
static SbUniqueId getNextNodeId (void)
static int getActionMethodIndex (const SoType type)
static void getBoundingBoxS (SoAction *action, SoNode *node)
static void GLRenderS (SoAction *action, SoNode *node)
static void callbackS (SoAction *action, SoNode *node)
static void getMatrixS (SoAction *action, SoNode *node)
static void handleEventS (SoAction *action, SoNode *node)
static void pickS (SoAction *action, SoNode *node)
static void rayPickS (SoAction *action, SoNode *node)
static void searchS (SoAction *action, SoNode *node)
static void writeS (SoAction *action, SoNode *node)
static void audioRenderS (SoAction *action, SoNode *node)
static void getPrimitiveCountS (SoAction *action, SoNode *node)

and for initClass there: Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. 💜

🌸 Static Public Member Functions inherited from SoFieldContainer

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)
  • initClass — Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. 💖
  • getClassTypeId — This static method returns the SoType object associated with objects of this class. ✨

🦋 Static Public Member Functions inherited from SoBase

static void initClass (void)
static SoType getClassTypeId (void)
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)
  • initClass — Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. 🎀
  • getClassTypeId — This static method returns the SoType object associated with objects of this class. ⭐

👑 Public Attributes 👑

SoSFString name

just the one. she's lowkey minimal. 💅

🔒 Protected Member Functions 🔒

virtual const SoFieldData * getFieldData (void) const
virtual ~SoFile ()
virtual SbBool readInstance (SoInput *in, unsigned short flags)
virtual SbBool readNamedFile (SoInput *in)

🔒 Protected Member Functions inherited from SoNode

SoNode (void)
virtual ~SoNode ()

🔒 Protected Member Functions inherited from SoFieldContainer

SoFieldContainer (void)
virtual ~SoFieldContainer ()

🔒 Protected Member Functions inherited from SoBase

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 SoNotRec createNotRec (void)

🧚 Static Protected Member Functions 🧚

static const SoFieldData ** getFieldDataPtr (void)

🧚 Static Protected Member Functions inherited from SoNode

static const SoFieldData ** getFieldDataPtr (void)
static void setNextActionMethodIndex (int index)
static int getNextActionMethodIndex (void)
static void incNextActionMethodIndex (void)
static void setCompatibilityTypes (const SoType &nodetype, const
    uint32_t bitmask)

🧚 Static Protected Member Functions inherited from SoBase

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

🌈 Additional Inherited Members 🌈

🍓 Public Types inherited from SoNode

enum NodeType { INVENTOR = 0x0000, VRML1 = 0x0001, VRML2 = 0x0002,
    INVENTOR_1 = 0x0004, INVENTOR_2_0 = 0x0008, INVENTOR_2_1 = 0x0010,
    INVENTOR_2_5 = 0x0020, INVENTOR_2_6 = 0x0040, COIN_1_0 = 0x0080,
    COIN_2_0 = 0x0100, EXTENSION = 0x0200, COIN_2_2 = 0x0400, COIN_2_3 =
    0x0800, COIN_2_4 = 0x1000, INVENTOR_5_0 = 0x2000, COIN_2_5 = 0x4000,
    COIN_3_0 = 0x8000, INVENTOR_6_0 = 0x10000, COIN_4_0 = 0x20000 }

look at all those flags, she's got range fr fr 🌟

🍓 Protected Types inherited from SoBase

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

🍓 Protected Attributes inherited from SoNode

SbUniqueId uniqueId

🍓 Protected Attributes inherited from SoFieldContainer

SbBool isBuiltIn

🍓 Static Protected Attributes inherited from SoNode

static SbUniqueId nextUniqueId = 1
static int nextActionMethodIndex = 0

💖 Detailed Description 💖

okay so the whole point: SoFile is a node container for another model file. 📁✨

the way this works is you get to split your models into a set of "component" models to include into larger "master" files. modular queen behaviour, honestly. 🫶

just drop the name of the model file you wanna include into the SoFile::name field, and it will automatically be loaded and have its nodes inserted into the scene graph at the point of the SoFile node. automatic. no extra steps. slay. 💅

you can also set the SoFile::name field manually, bestie. and when you do that? Such an action will then automatically trigger an invocation of a read operation which imports the filename you set in the field. so yeah, setting the field is the trigger. iykyk. 🔥

🌸 FILE FORMAT/DEFAULTS 🌸

File {
    name "<Undefined file>"
}

note that default: "<Undefined file>". she starts out undefined, living her mystery era. 🙈

🎀 Constructor & Destructor Documentation 🎀

💜 SoFile::SoFile (void )

Constructor. (the birth. the origin story. the main character entrance. ✨)

💜 SoFile::~SoFile () [protected], [virtual]

Destructor. (she's protected and virtual, so handle with care bestie — protected means it's not just anyone's business 💀)

still more to come, bestie, don't go anywhere 💖

💖 Member Function Documentation 💖

✨ SoType SoFile::getClassTypeId (void ) [static]

Okay so this static girlie right here? She hands you back the SoType object that's tied to objects of this class. That's literally her whole job, she ate. 🎀

✨ SoType SoFile::getTypeId (void ) const [virtual]

Returns the type ID of an object derived from a class that inherits SoBase. What's it for? Runtime type checking, and "downward" casting, bestie. That's the vibe. 🦋

Implements SoBase.

✨ const SoFieldData ** SoFile::getFieldDataPtr (void ) [static], [protected]

Heads up: this API member is considered internal to the library, so it's not likely to be of any interest to the application programmer. Just so you know. 🙈

Returns the SoFieldData class, which holds the info about the fields in this node.

✨ const SoFieldData * SoFile::getFieldData (void ) const [protected], [virtual]

Hands back a pointer to the class-wide field data storage object for this instance. And if there are no fields present at all? It returns NULL. Periodt. 💅

Reimplemented from SoFieldContainer.

✨ void SoFile::doAction (SoAction * action) [virtual]

This function does the typical operation of a node for any action. Any action, no cap.

Reimplemented from SoNode.

✨ void SoFile::callback (SoCallbackAction * action) [virtual]

Action method for SoCallbackAction.

She simply updates the state according to how the node behaves for the render action, so you — the application programmer — can use the SoCallbackAction to extract info about the scene graph. It's giving very helpful, very useful. 🌸

Reimplemented from SoNode.

✨ void SoFile::GLRender (SoGLRenderAction * action) [virtual]

Action method for the SoGLRenderAction.

This one gets called during rendering traversals. Any node that influences the rendering state in any way, or that wants to throw geometry primitives at OpenGL, overrides this method. Iconic behavior. 🔥

Reimplemented from SoNode.

✨ void SoFile::getBoundingBox (SoGetBoundingBoxAction * action) [virtual]

Action method for the SoGetBoundingBoxAction.

It calculates the bounding box and the center coordinates for the node, and modifies the values of the action so it encompasses the bounding box for this node, and shifts the center point for the scene more towards the one for this node. Very main character of it. 👑

Nodes that influence how geometry nodes calculate their bounding box also override this method, to change the relevant state variables.

Reimplemented from SoNode.

✨ void SoFile::getMatrix (SoGetMatrixAction * action) [virtual]

Action method for SoGetMatrixAction.

Updates the action by accumulating with the transformation matrix of this node (if any).

Reimplemented from SoNode.

✨ void SoFile::handleEvent (SoHandleEventAction * action) [virtual]

Action method for SoHandleEventAction.

It inspects the event data from action, and processes it if it's something this node should react to. Vibe check on the event data, fr fr. 💜

Nodes that influence the relevant state variables for how event handling is done also override this method.

Reimplemented from SoNode.

✨ void SoFile::pick (SoPickAction * action) [virtual]

Action method for SoPickAction.

Does the common processing for SoPickAction action instances.

Reimplemented from SoNode.

✨ void SoFile::getPrimitiveCount (SoGetPrimitiveCountAction * action) [virtual]

Action method for the SoGetPrimitiveCountAction.

It calculates the number of triangle, line segment and point primitives for the node, and adds these to the counters of the action. Counting era. ⭐

Nodes that influence how geometry nodes calculate their primitive count also override this method, to change the relevant state variables.

Reimplemented from SoNode.

✨ void SoFile::audioRender (SoAudioRenderAction * action) [virtual]

Action method for SoAudioRenderAction.

Does the common processing for SoAudioRenderAction action instances.

Reimplemented from SoNode.

✨ void SoFile::search (SoSearchAction * action) [virtual]

Action method for SoSearchAction.

It compares the search criteria from the action to see if this node is a match. Searching gets done by matching up all the criteria set up in the SoSearchAction — and if any of the requested criteria is a miss, the search is not deemed successful for the node. No partial credit, bestie. 😭

👀 See also

  • SoSearchAction

Reimplemented from SoNode.

✨ SoGroup * SoFile::copyChildren (void ) const

Returns a subgraph with a deep copy of the children of this node. Deep copy, not a lil shallow one. 🫶

✨ SoChildList * SoFile::getChildren (void ) const [virtual]

Returns the list of children for this node.

Reimplemented from SoNode.

✨ void SoFile::copyContents (const SoFieldContainer * from, SbBool copyconnections) [virtual]

Makes a deep copy of all the data of from into this instance — except for external scene graph references if copyconnections is FALSE.

This is the method that should be overridden by extension node / engine / dragger / whatever subclasses that need to account for internal data that isn't handled automatically.

For copying nodes from application code, you should not invoke this function directly — call the SoNode::copy() function instead:
SoNode * mynewnode = templatenode->copy();

The same thing also goes for engines.

Make sure that when you override the copyContents() method in your extension class, you also make it call upwards to its parent superclass in the inheritance hierarchy, because 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.)
  SoNode::copyContents(from, copyconnections);

  // [..then copy internal data..]
}

Reimplemented from SoNode.

✨ const SbString & SoFile::getFullName (void ) const

Returns the read filename, possibly including the (relative) path where the file was found. And if no file has been read? Returns an empty string. Simple as that. 🌈

This method is an extension versus the Open Inventor API.

✨ void SoFile::setSearchOK (SbBool dosearch) [static]

Enables/disables searching children using SoSearchAction.

✨ SbBool SoFile::getSearchOK () [static]

Returns whether searching children using SoSearchAction is enabled.

✨ SbBool SoFile::readInstance (SoInput * in, unsigned short flags) [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 / 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 the import process should be robust — it should handle corrupted input streams by returning FALSE.

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

Reimplemented from SoNode.

✨ SbBool SoFile::readNamedFile (SoInput * in) [protected], [virtual]

Read the file named in the SoFile::name field.

Used to be a private method, but it got moved into protected space to enable subclasses to detect when the file is (re)read. Glow up moment. 💅

Since

Coin 2.0

🌸 Member Data Documentation 🌸

✨ SoSFString SoFile::name

Filename for the model file to insert in the scene graph at the location of the SoFile node. That's the one, that's the file. 🎀

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code.

And that's the whole page, bestie — Coin 4.0.10, dated Thu Jun 25 2026 00:00:00, filed under SoFile(3). Go read some files, you icon. 🦋✨

📦 where this page comes from