SoForeignFileKit(3)

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

SoForeignFileKit(3) — the foreign file format bestie 💖

NAME

SoForeignFileKit — Abstract base class for foreign file format support in Coin.

abstract base class energy: this is the blueprint, not the build. 💅

SYNOPSIS

#include <ForeignFiles/SoForeignFileKit.h>

Inherits SoBaseKit.

Inherited by SoSTLFileKit.

Public Member Functions

Okay bestie, here's the main character energy of SoForeignFileKit itself. These are the functions you get when you're working with this class directly. ✨

  • virtual SoType getTypeId (void) const — type ID, as always.
  • virtual const SoNodekitCatalog * getNodekitCatalog (void) const — grab the nodekit catalog.
  • virtual SbBool canReadFile (const char *filename=NULL) const — can it read this file? filename defaults to NULL.
  • virtual SbBool readFile (const char *filename) — read the file, bestie.
  • virtual SbBool canWriteFile (const char *filename=NULL) const — can it write this file? filename defaults to NULL.
  • virtual SbBool writeFile (const char *filename) — write the file.
  • virtual class SoSeparator * convert ()=0 — pure virtual (=0), so subclasses must implement it. Abstract base class behavior, no cap.

Public Member Functions inherited from SoBaseKit

These are inherited from SoBaseKit, but they're still iconic and they still count:

  • SoBaseKit (void) — constructor.
  • virtual SoNode * getPart (const SbName &partname, SbBool makeifneeded) — get a part.
  • SbString getPartString (const SoBase *part) — get part string.
  • virtual SoNodeKitPath * createPathToPart (const SbName &partname, SbBool makeifneeded, const SoPath *pathtoextend=NULL) — create path to part.
  • virtual SbBool setPart (const SbName &partname, SoNode *from) — set part.
  • SbBool set (const char *namevaluepairliststring) — set from name-value pair list string.
  • SbBool set (const char *partnamestring, const char *parameterstring) — set from part name string and parameter string.
  • virtual void doAction (SoAction *action) — do action.
  • virtual void callback (SoCallbackAction *action) — callback.
  • virtual void GLRender (SoGLRenderAction *action) — GL render.
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action) — get bounding box.
  • virtual void getMatrix (SoGetMatrixAction *action) — get matrix.
  • virtual void handleEvent (SoHandleEventAction *action) — handle event.
  • virtual void rayPick (SoRayPickAction *action) — ray pick.
  • virtual void search (SoSearchAction *action) — search.
  • virtual void write (SoWriteAction *action) — write.
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action) — get primitive count.
  • virtual SoChildList * getChildren (void) const — get children.
  • void printDiagram (void) — print diagram.
  • void printSubDiagram (const SbName &rootname, int level) — print sub-diagram.
  • void printTable (void) — print table.
  • virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE) — add write reference.
  • SbBool forceChildDrivenWriteRefs (SoOutput *out) — force child-driven write refs.

Public Member Functions inherited from SoNode

More inherited goodies 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 pick (SoPickAction *action)
  • virtual void audioRender (SoAudioRenderAction *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 SoFieldContainer * copyThroughConnection (void) const

Public Member Functions inherited from SoFieldContainer

And 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)
  • 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

And 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 — 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)
  • 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

Static Public Member Functions

Now the static besties that belong to SoForeignFileKit:

  • static SoType getClassTypeId (void)
  • static const SoNodekitCatalog * getClassNodekitCatalog (void)
  • static void initClass (void)
  • static SbBool isFileSupported (SoInput *in, SbBool exhaust=FALSE)
  • static SbBool isFileSupported (const char *filename, SbBool exhaust=FALSE)
  • static SoForeignFileKit * createForeignFileKit (SoInput *in, SbBool exhaust=FALSE)
  • static SoForeignFileKit * createForeignFileKit (const char *filename, SbBool exhaust=FALSE)

Static Public Member Functions inherited from SoBaseKit

  • static SoType getClassTypeId (void)
  • static void initClass (void)
  • static const SoNodekitCatalog * getClassNodekitCatalog (void)
  • static SbBool isSearchingChildren (void)
  • static void setSearchingChildren (const SbBool newval)

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) — sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
  • 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)

Static Public Member Functions inherited from SoFieldContainer

  • 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 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)

Static Public Member Functions inherited from SoBase

  • 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 Member Functions

  • virtual const SoFieldData * getFieldData (void) const

Protected Member Functions inherited from SoBaseKit

  • virtual ~SoBaseKit ()
  • virtual SoNode * addToCopyDict (void) const
  • virtual void copyContents (const SoFieldContainer *fromfc, SbBool copyconnections)
  • SoGroup * getContainerNode (const SbName &listname, SbBool makeifneeded=TRUE)
  • virtual SoNode * getAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE)
  • virtual SoNodeKitPath * createPathToAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE, const SoPath *pathtoextend=NULL)
  • virtual SbBool setAnyPart (const SbName &partname, SoNode *from, SbBool anypart=TRUE)
  • void createNodekitPartsList (void)
  • void createFieldList (void)
  • virtual void createDefaultParts (void)
  • const SoNodekitParts * getNodekitPartsList (void) const
  • const SbList< SoSFNode * > & getCatalogInstances (void) const
  • void catalogError (void)
  • virtual SbBool setUpConnections (SbBool onoff, SbBool doitalways=FALSE)
  • virtual SbBool readInstance (SoInput *in, unsigned short flags)
  • virtual void setDefaultOnNonWritingFields (void)
  • void countMyFields (SoOutput *out)
  • virtual SbBool setPart (const int partNum, SoNode *node)

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 const SoNodekitCatalog ** getClassNodekitCatalogPtr (void)
  • static void initClasses (void)
  • static SbBool registerFileExtension (SoType handler, SbName extension, SoForeignFileIdentifyFunc *identify)

🛡️ Static Protected Member Functions inherited from SoBaseKit

  • static const SoFieldData ** getFieldDataPtr (void)
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (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)

🔒 Protected Attributes

  • SoSFNode topSeparator

🔒 Protected Attributes inherited from SoBaseKit

  • SoSFNode callbackList
  • SoChildList * children
  • SbBool connectionsSetUp

🔒 Protected Attributes inherited from SoNode

  • SbUniqueId uniqueId

🔒 Protected Attributes inherited from SoFieldContainer

  • SbBool isBuiltIn

🌈 Additional Inherited Members

🎀 Public Types inherited from SoNode

bestie look at this enum, it's giving options for days:

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 }

🎀 Protected Types inherited from SoBase

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

🎀 Static Protected Attributes inherited from SoNode

static SbUniqueId nextUniqueId = 1
static int nextActionMethodIndex = 0

💖 Detailed Description

Abstract base class for foreign file format support in Coin.

Abstract base class for foreign file format support in Coin. (yes bestie, they said it twice, it's that iconic ✨)

⚠️ Heads up: be aware that this class is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API. So if you're out here expecting it in O.G. Inventor, nope, it's a Coin exclusive 💅

Since: Coin 3.0 🎂

🧚 Member Function Documentation

⭐ SoType SoForeignFileKit::getClassTypeId (void ) [static]

This static method returns the SoType object associated with objects of this class.

⭐ SoType SoForeignFileKit::getTypeId (void ) const [virtual]

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

Reimplemented from SoBaseKit.

Reimplemented in SoSTLFileKit.

⭐ const SoFieldData ** SoForeignFileKit::getFieldDataPtr (void ) [static], [protected]

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

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

⭐ const SoFieldData * SoForeignFileKit::getFieldData (void ) const [protected], [virtual]

Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, returns NULL.

Reimplemented from SoBaseKit.

Reimplemented in SoSTLFileKit.

⭐ const SoNodekitCatalog * SoForeignFileKit::getClassNodekitCatalog (void ) [static]

Returns the nodekit catalog which defines the layout of this class' kit.

⭐ const SoNodekitCatalog * SoForeignFileKit::getNodekitCatalog (void ) const [virtual]

Returns the nodekit catalog which defines the layout of this class' kit.

Reimplemented from SoBaseKit.

Reimplemented in SoSTLFileKit.

⭐ const SoNodekitCatalog ** SoForeignFileKit::getClassNodekitCatalogPtr (void ) [static], [protected]

Returns the pointer to the pointer of the nodekit catalog for this class. (A double pointer, bestie. Pointer² 💅)

⭐ void SoForeignFileKit::initClass (void ) [static]

That's it, that's the entry. No extra lore given. 🫶

⭐ SbBool SoForeignFileKit::isFileSupported (SoInput * in, SbBool exhaust = FALSE) [static]

Convenience method. Will extract the filename from in and call the other ieFileSupported() method.

Will return false if file is not supported or /e in is not representing a normal file.

⭐ SbBool SoForeignFileKit::isFileSupported (const char * filename, SbBool exhaust = FALSE) [static]

Checks if the filename can be read by a registered SoForeignFileKit handler.

🚨 FIXME: exhaust is not implemented.

⭐ SoForeignFileKit * SoForeignFileKit::createForeignFileKit (SoInput * in, SbBool exhaust = FALSE) [static]

Convenience method. Will extract the filename from in and call the other ieFileSupported() method.

⭐ SoForeignFileKit * SoForeignFileKit::createForeignFileKit (const char * filename, SbBool exhaust = FALSE) [static]

Creates an instance of a suitable SoForeignFileKit subtype from the given file and reads its content. Returns NULL on failure or a kit with refcount of 0 on success. (Refcount 0, so like… you own it now. Handle with care bestie 🫶)

🚨 FIXME: exhaust is not implemented.

⭐ SbBool SoForeignFileKit::canReadFile (const char * filename = NULL) const [virtual]

Checks if this concrete class can read the given file.

Reimplemented in SoSTLFileKit.

⭐ SbBool SoForeignFileKit::readFile (const char * filename) [virtual]

Reads the given file into the internal representation. If successful, Coin should now be able to render the scene. If you need a pure Coin scene graph, call convert().

Reimplemented in SoSTLFileKit.

⭐ SbBool SoForeignFileKit::canWriteFile (const char * filename = NULL) const [virtual]

Checks if this concrete class can write to the given file.

Reimplemented in SoSTLFileKit.

⭐ SbBool SoForeignFileKit::writeFile (const char * filename) [virtual]

Writes the current contents to the given file.

See also: canWriteFile

Reimplemented in SoSTLFileKit.

⭐ virtual class SoSeparator * SoForeignFileKit::convert () [pure virtual]

Converts (if necessary) the internal representation of the foreign file to a pure Coin scenegraph. Returns the root node with a refcount of 0.

Implemented in SoSTLFileKit.

⭐ SbBool SoForeignFileKit::registerFileExtension (SoType handler, SbName extension, SoForeignFileIdentifyFunc * identify) [static], [protected]

Registers a concrete SoForeignFileKit subtype to be a handler for files with the given extension. One class can be a handler for multiple filename extensions. ✨ multitasking icon behavior ✨

🚨 FIXME: identify is not implemented

👑 Author

Generated automatically by Doxygen for Coin from the source code. (Not a human bestie, a whole robot wrote this 💀 but it ate, fr fr)

And that's a wrap on SoForeignFileKit(3), bestie! This was pulled straight from Coin version 4.0.10, dated Thu Jun 25 2026 00:00:00. Go forth and handle those foreign files, you absolute main character 🌸💖🦋

📦 where this page comes from