SoWWWInline(3)

📦 version 3.1.3, in fedora 43, fedora 44

okay so bestie, welcome to the SoWWWInline(3) page. this is part 1, and it's giving library functions manual but make it cute. 💅 no cap, we're keeping every single detail.

✨ NAME ✨

SoWWWInline — the class is literally a node used to include data from an URL. periodt. 🦋

🦋 SYNOPSIS 🦋

#include <Inventor/nodes/SoWWWInline.h>

Inherits SoNode.

🌸 Public Types 🌸

  • enum BboxVisibility { NEVER, UNTIL_LOADED, ALWAYS }

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

💖 Public Member Functions 💖

  • virtual SoType getTypeId (void) const
  • SoWWWInline (void)
  • void setFullURLName (const SbString &url)
  • const SbString & getFullURLName (void)
  • SoGroup * copyChildren (void) const
  • void requestURLData (void)
  • SbBool isURLDataRequested (void) const
  • SbBool isURLDataHere (void) const
  • void cancelURLDataRequest (void)
  • void setChildData (SoNode *urldata)
  • SoNode * getChildData (void) const
  • virtual SoChildList * getChildren (void) const
  • virtual void doAction (SoAction *action)
  • virtual void doActionOnKidsOrBox (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 search (SoSearchAction *action)
  • virtual void pick (SoPickAction *action)
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
  • virtual void audioRender (SoAudioRenderAction *action)

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

👑 Static Public Member Functions 👑

  • static SoType getClassTypeId (void)
  • static void initClass (void)
  • static void setFetchURLCallBack (SoWWWInlineFetchURLCB *f, void *userdata)
  • static void setBoundingBoxVisibility (BboxVisibility b)
  • static BboxVisibility getBoundingBoxVisibility (void)
  • static void setBoundingBoxColor (SbColor &c)
  • static const SbColor & getBoundingBoxColor (void)
  • static void setReadAsSoFile (SbBool onoff)
  • static SbBool getReadAsSoFile (void)

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

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

🎀 Public Attributes 🎀

  • SoSFString name
  • SoSFVec3f bboxCenter
  • SoSFVec3f bboxSize
  • SoSFNode alternateRep

🦋 Protected Member Functions 🦋

  • virtual const SoFieldData * getFieldData (void) const
  • virtual ~SoWWWInline ()
  • virtual void addBoundingBoxChild (SbVec3f center, SbVec3f size)
  • virtual SbBool readInstance (SoInput *in, unsigned short flags)
  • virtual void copyContents (const SoFieldContainer *fromfC, SbBool copyconnections)

🌸 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

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

🧚 Protected Types inherited from SoBase 🧚

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

🍓 Protected Attributes inherited from SoNode 🍓

  • uint32_t uniqueId

💜 Protected Attributes inherited from SoFieldContainer 💜

  • SbBool isBuiltIn

⭐ Static Protected Attributes inherited from SoNode ⭐

  • static uint32_t nextUniqueId = 1
  • static int nextActionMethodIndex = 0

📖 Detailed Description 📖

okay so the SoWWWInline class is literally a node used to include data from an URL. periodt. 💅

if the URL is not a local file, the application is responsible for supplying a callback to a function which will fetch the data of the URL. no cap.

as long as no data has been imported, the scenegraph representation of the node will be that of a bounding box enclosing the geometry we expect to fetch from the URL. the application is naturally also responsible for specifying the expected dimensions of the geometry. you got this. 🫶

if FetchURLCallBack isn't set, the alternateRep will be rendered instead. that's the vibe.

FILE FORMAT/DEFAULTS:

WWWInline {
    name "<Undefined file>"
    bboxCenter 0 0 0
    bboxSize 0 0 0
    alternateRep NULL
}

Since:

  • SGI Inventor 2.1
  • Coin 1.0

🔥 Member Enumeration Documentation 🔥

enum SoWWWInline::BboxVisibility

Used to enumerate bbox rendering strategies. 💅

Enumerator:

  • NEVER — Never render bounding box.
  • UNTIL_LOADED — Render bounding box until children are loaded.
  • ALWAYS — Always render bounding box, event when children are loaded.

💀 Constructor & Destructor Documentation 💀

SoWWWInline::SoWWWInline (void )

Constructor. ✨

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

Destructor. 💀

💖 MEMBER FUNCTION DOCUMENTATION 💖

bestie this is the big section, so grab a snack 🍓 — every single method this node hands you, in order, no skips, no shortcuts. periodt.

  • SoType SoWWWInline::getTypeId (void ) const [virtual] — hands you back the type identification of an object that derives from a class inheriting SoBase. this is the whole machinery behind run-time type checking and "downward" casting. iykyk.

usage example, literally copy-paste vibes:

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

now listen, for you application programmers who wanna extend the library with new nodes, engines, nodekits, draggers or whatever else — this method needs to be overridden in all subclasses. it's typically done as part of setting up the full type system for extension classes, which usually gets accomplished by using the pre-defined 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 and so forth.

for more info on writing Coin extensions, go read the class documentation of the toplevel superclasses for the various class groups. 🫶

Implements SoBase.

  • const SoFieldData * SoWWWInline::getFieldData (void ) const [protected], [virtual] — returns a pointer to the class-wide field data storage object for this instance. if there are no fields present, it returns NULL. that's it, that's the whole vibe.

Reimplemented from SoFieldContainer.

  • void SoWWWInline::setFullURLName (const SbString & url) — if the SoWWWInline::name field specifies a relative URL, use this method to name the complete URL. very "let me finish your sentence for you" of it 💅
  • const SbString & SoWWWInline::getFullURLName (void ) — if a full URL has been set with the SoWWWInline::setFullURLName() method, it returns that. if not, it returns the value of the SoWWWInline::name field. no drama either way.
  • SoGroup * SoWWWInline::copyChildren (void ) const — returns a subgraph with a deep copy of the children of this node. deep copy, not a little surface-level situationship copy. 🔥
  • void SoWWWInline::requestURLData (void ) — starts requesting URL data. heads up: this might trigger a callback to the callback set in SoWWWInline::setFetchURLCallBack().
  • SbBool SoWWWInline::isURLDataRequested (void ) const — returns TRUE if SoWWWInline::requestURLData() has been called and hasn't been canceled by SoWWWInline::cancelURLData(). basically "did we ask? are we still asking?"
  • SbBool SoWWWInline::isURLDataHere (void ) const — returns TRUE if the current child data has been read from file/URL and set using setChildData(). the data has arrived, bestie. 🦋
  • void SoWWWInline::cancelURLDataRequest (void ) — can be used to signal that URL loading has been canceled. you should use this method if you intend to request URL data more than once. don't be messy about it, cancel properly. 😭
  • void SoWWWInline::setChildData (SoNode * urldata) — manually sets up the subgraph for this node. this is the one your application should use to set the data that was read from the file/URL.
  • SoNode * SoWWWInline::getChildData (void ) const — returns the child data for this node. and that can be data read from a file, from an URL, from the contents of SoWWWInline::alternateRep, or data that was manually set with SoWWWInline::setChildData(). so many entrances to the same party. ✨
  • SoChildList * SoWWWInline::getChildren (void ) const [virtual] — returns the child list with the child data for this node.

Reimplemented from SoNode.

  • void SoWWWInline::setFetchURLCallBack (SoWWWInlineFetchURLCB * f, void * userdata) [static] — sets the URL fetch callback. this will be used in SoWWWInline::readInstance() or when the user calls SoWWWInline::requestURLData().
FIXME: Shouldn't called on readInstance(), only when we need to render the node (or calculate the bbox if we don't have one). kintel 20060203.

(yes we are keeping the FIXME verbatim, it's part of the lore 🫡)

  • void SoWWWInline::setBoundingBoxVisibility (BboxVisibility b) [static] — sets the bounding box visibility strategy. the default is UNTIL_LOADED.
  • SoWWWInline::BboxVisibility SoWWWInline::getBoundingBoxVisibility (void ) [static] — returns the bounding box visibility. that's the whole job. 👑
  • void SoWWWInline::setBoundingBoxColor (SbColor & c) [static] — sets the bounding box color. paint the box, bestie 🎀
  • const SbColor & SoWWWInline::getBoundingBoxColor (void ) [static] — returns the bounding box color.
  • void SoWWWInline::setReadAsSoFile (SbBool onoff) [static] — sets whether children should be read from a local file, in the same manner as SoFile children are read.

if this is set to TRUE, the URL must point to a file on the local file system, as can be accessed by the standard C library fopen() call. local only, no wandering off to the internet. 🌈

  • SbBool SoWWWInline::getReadAsSoFile (void ) [static] — returns if children should be read from local files.

See also

  • setReadAsSoFile()
  • void SoWWWInline::doAction (SoAction * action) [virtual] — this function performs the typical operation of a node for any action. any action. the generalist. 💅

Reimplemented from SoNode.

  • void SoWWWInline::doActionOnKidsOrBox (SoAction * action) [virtual] — this method should probably have been private in OIV. it is obsoleted in Coin. let us know if you need it. 👀
  • void SoWWWInline::callback (SoCallbackAction * action) [virtual] — action method for SoCallbackAction.

simply updates the state according to how the node behaves for the render action, so you the application programmer can use the SoCallbackAction for extracting information about the scene graph. cute little info extraction moment.

Reimplemented from SoNode.

  • void SoWWWInline::GLRender (SoGLRenderAction * action) [virtual] — action method for the SoGLRenderAction.

this is called during rendering traversals. nodes influencing the rendering state in any way, or who want to throw geometry primitives at OpenGL, override this method. go off, throw those primitives 🔥

Reimplemented from SoNode.

  • void SoWWWInline::getBoundingBox (SoGetBoundingBoxAction * action) [virtual] — action method for the SoGetBoundingBoxAction.

calculates bounding box and center coordinates for the node and modifies the values of the action to encompass the bounding box for this node and to shift the center point for the scene more towards the one for this node.

nodes influencing how geometry nodes calculate their bounding box also override this method to change the relevant state variables.

Reimplemented from SoNode.

  • void SoWWWInline::getMatrix (SoGetMatrixAction * action) [virtual] — action method for SoGetMatrixAction.

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

Reimplemented from SoNode.

  • void SoWWWInline::handleEvent (SoHandleEventAction * action) [virtual] — action method for SoHandleEventAction.

inspects the event data from action, and processes it if it is something which this node should react to.

nodes influencing relevant state variables for how event handling is done also override this method.

Reimplemented from SoNode.

  • void SoWWWInline::search (SoSearchAction * action) [virtual] — action method for SoSearchAction.

compares the search criteria from the action to see if this node is a match. searching is done by matching up all criteria set up in the SoSearchAction — if any of the requested criteria is a miss, the search is not deemed successful for the node. one miss and it's over, no partial credit. 💀

See also

  • SoSearchAction

Reimplemented from SoNode.

  • void SoWWWInline::pick (SoPickAction * action) [virtual] — action method for SoPickAction.

does common processing for SoPickAction action instances.

Reimplemented from SoNode.

  • void SoWWWInline::getPrimitiveCount (SoGetPrimitiveCountAction * action) [virtual] — action method for the SoGetPrimitiveCountAction.

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

nodes influencing how geometry nodes calculate their primitive count also override this method to change the relevant state variables.

Reimplemented from SoNode.

  • void SoWWWInline::audioRender (SoAudioRenderAction * action) [virtual] — action method for SoAudioRenderAction.

does common processing for SoAudioRenderAction action instances.

Reimplemented from SoNode.

  • void SoWWWInline::addBoundingBoxChild (SbVec3f center, SbVec3f size) [protected], [virtual] — convenience method that extends the current bounding box to include the box specified by center and size. convenience!! we love a method that does the extra work for us 🫶
  • SbBool SoWWWInline::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 / persistant representation of an instance of this class type.

TRUE or FALSE is returned, depending on if the instantiation and configuration of the new object of this class type went ok or not. the import process should be robust and 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.

  • void SoWWWInline::copyContents (const SoFieldContainer * from, SbBool copyconnections) [protected], [virtual] — makes a deep copy of all data of from into this instance, except external scenegraph references if copyconnections is FALSE.

this is the protected method that should be overridden by extension node / engine / dragger / whatever subclasses which need to account for internal data that are not handled automatically.

for copying nodes from application code, you should not invoke this function directly, but rather call the SoNode::copy() function:

SoNode * mynewnode = templatenode->copy();

the same also goes for engines.

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

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

Reimplemented from SoNode.

🌸 MEMBER DATA DOCUMENTATION 🌸

the fields. the actual data slots. the main characters of the data world 👑

  • SoSFString SoWWWInline::name — name of file/URL where children should be read. the address, bestie 📍
  • SoSFVec3f SoWWWInline::bboxCenter — center of bounding box.
  • SoSFVec3f SoWWWInline::bboxSize — size of bounding box.
  • SoSFNode SoWWWInline::alternateRep — alternate representation. used when children can't be read from name. the backup plan, the safety net, the "if all else fails" rep. 💜

🎀 AUTHOR 🎀

generated automatically by Doxygen for Coin from the source code. not me, not you, not a human — the robot did it. iconic behavior honestly. 🤖✨

and that's a wrap on SoWWWInline(3), bestie! this page lives in Coin Version 3.1.3, so if you ever need to cite it, that's the version and that's the page number. go forth and inline responsibly 💅💖🦋

📦 where this page comes from