SoSTLFileKit(3)

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

👑 SoSTLFileKit(3) 👑 Coin manual page, bestie edition 💖

okay so this is the manual page for SoSTLFileKit, a class from Coin 🪙 (the 3D graphics toolkit, not the money — though honestly both are giving rich energy). This page is long, so it's split over 2 parts. This is part 1. More is coming, don't go anywhere. 🦋

✨ NAME ✨

SoSTLFileKit — bestie, it is literally a class for using STL files with Coin. that's the whole vibe. 🎀

🎀 SYNOPSIS 🎀

#include <ForeignFiles/SoSTLFileKit.h>

Inherits SoForeignFileKit. so it is a foreign file kit, and it handles STL. slay. 💅

💜 Public Types 💜

enum Colorization { GREY, MATERIALISE, TNO_VISICAM }

the colorization options. three of them. iconic trio. 🌈

🦋 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 }

🌸 Public Member Functions 🌸

the ones that belong to this class itself, no cap:

virtual SoType getTypeId (void) const
virtual const SoNodekitCatalog * getNodekitCatalog (void) const
SoSTLFileKit (void)
virtual SbBool canReadFile (const char *filename=NULL) const
virtual SbBool readFile (const char *filename)
virtual SbBool canWriteFile (const char *filename=NULL) const
virtual SbBool writeFile (const char *filename)
SbBool canReadScene (void) const
SbBool readScene (SoNode *scene)
virtual SoSeparator * convert ()

💅 Public Member Functions inherited from SoBaseKit 💅

SoBaseKit (void)
virtual SoNode * getPart (const SbName &partname, SbBool makeifneeded)
SbString getPartString (const SoBase *part)
virtual SoNodeKitPath * createPathToPart (const SbName &partname, SbBool
    makeifneeded, const SoPath *pathtoextend=NULL)
virtual SbBool setPart (const SbName &partname, SoNode *from)
SbBool set (const char *namevaluepairliststring)
SbBool set (const char *partnamestring, const char *parameterstring)
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 rayPick (SoRayPickAction *action)
virtual void search (SoSearchAction *action)
virtual void write (SoWriteAction *action)
virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
virtual SoChildList * getChildren (void) const
void printDiagram (void)
void printSubDiagram (const SbName &rootname, int level)
void printTable (void)
virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)
SbBool forceChildDrivenWriteRefs (SoOutput *out)

that's the whole nodekit toolkit situation. yes, there are two different set overloads. no, you can't merge them. 😭

🌟 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 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 🍓

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

fields AND events AND userdata, the whole friend group is here. 🫶

🧚 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

quick translation for isOfType: it hands you back TRUE if this object's type is either the same as type or inherited from type. both count. 💖

⭐ Static Public Member Functions ⭐

static SoType getClassTypeId (void)
static const SoNodekitCatalog * getClassNodekitCatalog (void)
static void initClass (void)
static SbBool identify (const char *filename)

🔥 Static Public Member Functions inherited from 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)
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 about that initClass up there — it sets up initialization for data common to all instances of this class, like submitting the necessary info to the Coin type system. it's the little prep routine before the party. ✨

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

two notes on those two:

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

same two as before, same meaning:

  • 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 info
SoSFBool binary
SoSFEnum colorization

three of them. info, binary, and colorization. remember them, they're main characters. 👑

🫶 Protected Member Functions 🫶

virtual const SoFieldData * getFieldData (void) const
virtual ~SoSTLFileKit (void)
void reset (void)
SbBool addFacet (const SbVec3f &v1, const SbVec3f &v2, const SbVec3f
    &v3, const SbVec3f &normal)
void organizeModel (void)

yes that's a destructor in there and yes addFacet takes four SbVec3f refs — three verts and a normal. bestie it's geometry, of course there's a normal. 🦋

part 2 is loading… hold that thought 💫

🫶 Protected Member Functions inherited from SoBaseKit

These are the lil' helpers SoBaseKit passes down to us like hand-me-downs that actually slay 💅

  • virtual ~SoBaseKit () — the destructor, inherited and virtual, doing its goodbye thing
  • virtual SoNode * addToCopyDict (void) const — adds this node into the copy dictionary, const-ly
  • virtual void copyContents (const SoFieldContainer *fromfc, SbBool copyconnections) — copies the contents over from fromfc, with a copyconnections flag deciding whether connections come along
  • SoGroup * getContainerNode (const SbName &listname, SbBool makeifneeded=TRUE) — grabs the container node for listname; makeifneeded defaults to TRUE
  • virtual SoNode * getAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE) — gets any part by partname; leafcheck and publiccheck both default to FALSE
  • virtual SoNodeKitPath * createPathToAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE, const SoPath *pathtoextend=NULL) — builds a whole path to any part; leafcheck=FALSE, publiccheck=FALSE, and pathtoextend=NULL
  • virtual SbBool setAnyPart (const SbName &partname, SoNode *from, SbBool anypart=TRUE) — sets any part; anypart defaults to TRUE
  • void createNodekitPartsList (void) — makes the nodekit parts list
  • void createFieldList (void) — makes the field list
  • virtual void createDefaultParts (void) — makes the default parts
  • const SoNodekitParts * getNodekitPartsList (void) const — returns the nodekit parts list, const
  • const SbList< SoSFNode * > & getCatalogInstances (void) const — returns a const reference to the catalog instances list of SoSFNode *
  • void catalogError (void) — throws up a catalog error
  • virtual SbBool setUpConnections (SbBool onoff, SbBool doitalways=FALSE) — wires up (or unwires) connections; doitalways defaults to FALSE
  • virtual SbBool readInstance (SoInput *in, unsigned short flags) — reads an instance from in with flags
  • virtual void setDefaultOnNonWritingFields (void) — sets defaults on the fields that aren't being written
  • void countMyFields (SoOutput *out) — counts my fields for out
  • virtual SbBool setPart (const int partNum, SoNode *node) — sets part number partNum to node

🌸 Protected Member Functions inherited from SoNode

  • SoNode (void) — constructor, protected style
  • virtual ~SoNode () — destructor, also protected, also virtual

🎀 Protected Member Functions inherited from SoFieldContainer

  • SoFieldContainer (void) — the constructor
  • virtual ~SoFieldContainer () — the destructor

🦋 Protected Member Functions inherited from SoBase

  • SoBase (void) — constructor
  • virtual ~SoBase () — destructor
  • virtual void destroy (void) — destroys the thing
  • SbBool hasMultipleWriteRefs (void) const — checks whether there are multiple write refs
  • SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const — writes the header to out; takes isgroup and isengine
  • void writeFooter (SoOutput *out) const — writes the footer to out
  • virtual const char * getFileFormatName (void) const — returns the file format name
  • virtual SoNotRec createNotRec (void) — creates a notification record

✨ Static Protected Member Functions

  • static const SoFieldData ** getFieldDataPtr (void) — returns the pointer-to-pointer of the field data
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — returns the pointer-to-pointer of the class nodekit catalog

💖 Static Protected Member Functions inherited from SoForeignFileKit

  • static const SoFieldData ** getFieldDataPtr (void) — same deal, pointer-to-pointer of field data
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — pointer-to-pointer of the class nodekit catalog
  • static void initClasses (void) — inits the classes
  • static SbBool registerFileExtension (SoType handler, SbName extension, SoForeignFileIdentifyFunc *identify) — registers a file extension with a handler, an extension, and an identify function pointer

🌈 Static Protected Member Functions inherited from SoBaseKit

  • static const SoFieldData ** getFieldDataPtr (void) — pointer-to-pointer of field data
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — pointer-to-pointer of the class nodekit catalog

⭐ Static Protected Member Functions inherited from SoNode

  • static const SoFieldData ** getFieldDataPtr (void) — pointer-to-pointer of field data
  • static void setNextActionMethodIndex (int index) — sets the next action method index to index
  • static int getNextActionMethodIndex (void) — gets the next action method index
  • static void incNextActionMethodIndex (void) — increments the next action method index
  • static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask) — sets compatibility types for nodetype with bitmask

💜 Static Protected Member Functions inherited from SoBase

  • static uint32_t getCurrentWriteCounter (void) — returns the current write counter
  • static void staticDataLock (void) — locks the static data
  • static void staticDataUnlock (void) — unlocks the static data

👑 Protected Attributes

  • SoSFNode shapehints
  • SoSFNode texture
  • SoSFNode normalbinding
  • SoSFNode normals
  • SoSFNode materialbinding
  • SoSFNode material
  • SoSFNode coordinates
  • SoSFNode facets

🌸 Protected Attributes inherited from SoForeignFileKit

  • 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

💅 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

okay so bestie, SoSTLFileKit is a class for using STL files with Coin. You can use it to read and write STL files, and convert back and forth between Open Inventor scene graphs and SoSTLFileKits. it's giving versatility, fr fr ✨

STL files are 3D models intended for 3D printers, and it's a format supported by a wide variety of computer-aided design programs. STL models are, because of their intended purpose, always representations of solid objects. STL is short for stereolithography — the process used for 3D printing. iconic honestly 🖨️

Ordinary STL models do not contain color information. There are, however, two extensions to the binary file format for specifying color. Currently neither extension is supported. This is caused by lack of sample models using the extensions, and will be added as soon as such models are found. We have the specs on the extensions, and it should be pretty straight-forwards to implement, but we want to get it right at once since we have write support (we don't want to inadvertently create a third color extension ;). no cap 💀

When writing STL files, certain STL model criteria are not enforced by SoSTLFileKit. These are:

  • STL models should represent complete solids — it is the user's responsibility to give models of solid data to readScene(), and not readScene()'s responsibility to check the incoming data.
  • STL models should have all triangles in counterclockwise order. This is not enforced either.
  • STL models should reside in the positive octant of the coordinate space. This is also the user's responsibility to ensure, although adding functionality for translating the model should be easy, so it might get implemented.

Since the color extensions are not supported yet, color information is not collected either when converting Open Inventor scene graphs to SoSTLFileKits.

Be aware that this class is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API. 🚨

🌟 Since

Coin 3.0

🛠️ Constructor & Destructor Documentation

SoSTLFileKit::SoSTLFileKit (void )

Constructor. 🎬

SoSTLFileKit::~SoSTLFileKit (void ) [protected], [virtual]

Destructor. 🫡

💖 Member Function Documentation

SoType SoSTLFileKit::getClassTypeId (void ) [static]

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

SoType SoSTLFileKit::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 SoForeignFileKit.

const SoFieldData ** SoSTLFileKit::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 * SoSTLFileKit::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 SoForeignFileKit.

const SoNodekitCatalog * SoSTLFileKit::getClassNodekitCatalog (void ) [static]

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

const SoNodekitCatalog * SoSTLFileKit::getNodekitCatalog (void ) const [virtual]

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

Reimplemented from SoForeignFileKit.

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

Returns the pointer to the pointer of the nodekit catalog for this class. 🪞

void SoSTLFileKit::initClass (void ) [static]

SbBool SoSTLFileKit::identify (const char * filename) [static]

Returns whether or not filename is identified as an STL file. 🔍

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

Checks if this concrete class can read the given file.

Reimplemented from SoForeignFileKit.

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

Reads in an STL file. Both ASCII and binary files are supported. For binary files, the color extensions are not implemented yet.

Returns FALSE if filename could not be opened or parsed correctly.

See also : canReadFile

Reimplemented from SoForeignFileKit.

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

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

Reimplemented from SoForeignFileKit.

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

Writes the STL model to an STL file. 💾

See also : binary, info, canWriteFile, canReadScene

Reimplemented from SoForeignFileKit.

SbBool SoSTLFileKit::readScene (SoNode * scene)

Converts a scene graph into an SoSTLFileKit. Useful for creating STL files. 🏗️

See also : canReadScene, canWriteFile, writeFile

SoSeparator * SoSTLFileKit::convert () [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. ⚠️

Implements SoForeignFileKit.

void SoSTLFileKit::reset (void ) [protected]

Resets the STL model so it contains nothing. 🧼

SbBool SoSTLFileKit::addFacet (const SbVec3f & v1, const SbVec3f & v2, const SbVec3f & v3, const SbVec3f & n) [protected]

Adds one triangle to the STL model. 🔺

See also : reset, organizeModel

void SoSTLFileKit::organizeModel (void ) [protected]

Should be called after the STL model is completely set up in the SoSTLFileKit through import from a file or from a scene graph. The model will then be optimized for fast rendering. ⚡

See also : addFacet, reset

✍️ Author

Generated automatically by Doxygen for Coin from the source code.

and that's a wrap bestie 💅 this page came from Coin version 4.0.10, dated Thu Jun 25 2026 00:00:00 — go forth and STL responsibly, mwah 🫶✨

📦 where this page comes from