SoWWWInline(3)

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

💖 SoWWWInline 💖

okay so this is the SoWWWInline(3) page from the Coin manual, and bestie, it's a whole thing — it's long, so it comes in three parts. This is part one. Buckle up. 🎀

✨ NAME ✨

SoWWWInline — a node whose whole entire job is to include data from a URL. that's it. that's the vibe. 🦋

🌸 SYNOPSIS 🌸

#include <Inventor/nodes/SoWWWInline.h>

It inherits from SoNode. (iconic lineage, honestly 👑)

💅 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, COIN_4_0 = 0x20000 }

look at all those hex numbers, she's serving bitmask realness ✨

🫶 Public Member Functions

  • virtual SoType getTypeId (void) const — the type-id getter, overridden like a good main character.
  • SoWWWInline (void) — the constructor. hi bestie 🫶
  • void setFullURLName (const SbString &url) — set the full URL name.
  • const SbString & getFullURLName (void) — get that full URL name back.
  • SoGroup * copyChildren (void) const — copies the children.
  • void requestURLData (void) — ask for the URL data, please and thank you.
  • SbBool isURLDataRequested (void) const — has the URL data been requested? asking for a friend.
  • SbBool isURLDataHere (void) const — is the URL data actually here tho?
  • void cancelURLDataRequest (void) — nvm, cancel that request 💀
  • void setChildData (SoNode *urldata) — hand over the child data.
  • SoNode * getChildData (void) const — gimme the child data.
  • virtual SoChildList * getChildren (void) const — get the children list.
  • virtual void doAction (SoAction *action) — do the action.
  • virtual void doActionOnKidsOrBox (SoAction *action) — do the action on the kids or the box.
  • virtual void callback (SoCallbackAction *action) — the callback traversal.
  • virtual void GLRender (SoGLRenderAction *action) — the GL render traversal. make it pretty 🔥
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action) — grab the bounding box.
  • virtual void getMatrix (SoGetMatrixAction *action) — grab the matrix.
  • virtual void handleEvent (SoHandleEventAction *action) — handle that event.
  • virtual void search (SoSearchAction *action) — the search traversal.
  • virtual void pick (SoPickAction *action) — the pick traversal.
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action) — count those primitives.
  • virtual void audioRender (SoAudioRenderAction *action) — audio render traversal 🔊

🫶 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 — 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

  • static SoType getClassTypeId (void)
  • 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 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) — 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)

🎀 Public Attributes

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

four whole fields, she's lowkey stacked ngl 💅

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

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

and that's part one, bestie 🫶 no cap, there's more coming, don't go anywhere 💖

💖 Detailed Description 💖

okay so bestie, gather round 🌸 the SoWWWInline class is a node, and its entire personality is including data from an URL. that's the whole gig. 💅

so here's the tea: if that URL is not a local file, then you, the application, are responsible for handing over a callback to a function that'll go fetch the URL's data. no callback, no data, no vibes. 🫶

and as long as nothing has been imported yet, the scene graph representation of this node is just gonna be a bounding box hugging the geometry we expect to fetch from the URL. naturally, the application is also on the hook for telling it what those expected dimensions are. 📦✨

if FetchURLCallBack isn't set, then alternateRep gets rendered instead. periodt.

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

this one exists to enumerate bounding box rendering strategies, iykyk.

Enumerator:

  • NEVER — never render the bounding box. not once. not ever. 🙈
  • UNTIL_LOADED — render the bounding box until the children are loaded. then it's bye bye box. 🦋
  • ALWAYS — always render the bounding box, event when children are loaded. (typo's theirs, not mine 💀)

🌈 Constructor & Destructor Documentation 🌈

SoWWWInline::SoWWWInline(void)

Constructor. it's giving new node energy ✨

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

Destructor. it's giving closure 💜

👑 Member Function Documentation 👑

SoType SoWWWInline::getClassTypeId(void) — [static]

this static method hands you back the SoType object that's associated with objects of this class. 💫

SoType SoWWWInline::getTypeId(void) const — [virtual]

returns the type identification of an object derived from a class inheriting SoBase. this is the one used for runtime type checking and "downward" casting, bestie. 🔍

Implements SoBase.

const SoFieldData ** SoWWWInline::getFieldDataPtr(void) — [static], [protected]

okay so this API member is considered internal to the library, because it's not likely to be of interest to the application programmer. 🙈

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

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. (iconic empty-handed behavior 💅)

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. 🌐

const SbString & SoWWWInline::getFullURLName(void)

if a full URL has been set with the SoWWWInline::setFullURLName() method, return it. if not, it returns the value of the SoWWWInline::name field instead. 🎀

SoGroup * SoWWWInline::copyChildren(void) const

returns a subgraph with a deep copy of the children of this node. no shared vibes here, it's a whole copy. 🫶

void SoWWWInline::requestURLData(void)

start requesting URL data. heads up, this might trigger a callback to the callback you set in SoWWWInline::setFetchURLCallBack(). 🔥

SbBool SoWWWInline::isURLDataRequested(void) const

returns TRUE if SoWWWInline::requestURLData() has been called without being canceled by SoWWWInline::cancelURLData(). ✅

SbBool SoWWWInline::isURLDataHere(void) const

return TRUE if the current child data have been read from file/URL and set using setChildData(). 📥

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. (yeah, otherwise you're just out here requesting twice with no closure 😭)

void SoWWWInline::setChildData(SoNode * urldata)

manually set up the subgraph for this node. this is the one the 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(). all roads lead to child data, fr fr. 🌈

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 is gonna get 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.

that's straight from the source, bestie, don't shoot the messenger 💀

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. 👀

void SoWWWInline::setBoundingBoxColor(SbColor & c) — [static]

sets the bounding box color. 🎨

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. no remote shenanigans allowed in that mode. 🚫🌐

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. classic node behavior, no notes. 💅

Reimplemented from SoNode.

void SoWWWInline::doActionOnKidsOrBox(SoAction * action) — [virtual]

this method should probably have been private in the Open Inventor API. it is obsoleted in Coin. let us know if you need it. 📣

void SoWWWInline::callback(SoCallbackAction * action) — [virtual]

action method for SoCallbackAction.

it simply updates the state according to how the node behaves for the render action, so the application programmer can use the SoCallbackAction for extracting information about the scene graph. 🕵️‍♀️

Reimplemented from SoNode.

void SoWWWInline::GLRender(SoGLRenderAction * action) — [virtual]

action method for the SoGLRenderAction.

this gets called during rendering traversals. nodes that influence the rendering state in any way, or want to throw geometry primitives at OpenGL, override this method. 🔥

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's 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. 🎯

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. 🧚

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 / persistent 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 scene graph references if copyconnections is FALSE. 🫶

this is the 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 its 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.)
  SoNode::copyContents(from, copyconnections);

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

Reimplemented from SoNode.

✨ Member Data Documentation ✨

Okay bestie, these are the actual data members — the little fields living inside every SoWWWInline node, just vibing and holding your values. Four of them. All public. All iconic. Let's get into it 💅

  • SoSFString SoWWWInline::name — this is the name of the file or URL that the children get read from. Like, it's a SoSFString, so it's a single string field, and whatever you put in there is where the node goes looking for its kiddos. That's the whole personality. 🎀
  • SoSFVec3f SoWWWInline::bboxCenter — the center of the bounding box. Yep, a SoSFVec3f, so it's three floats (x, y, z) telling everything where the middle of the box sits. Lowkey crucial for the scene graph to know where you at. 📍
  • SoSFVec3f SoWWWInline::bboxSize — the size of the bounding box. Also a SoSFVec3f, also three floats, but this one says how big the box is in each direction. Center and size, they're a matching set, they go together fr fr. 📐
  • SoSFNode SoWWWInline::alternateRep — the alternate representation. This one's the understudy 🎭: it's used when the children can't be read from name. So if the file/URL situation doesn't work out, this node steps in and covers. Backup plan energy, and honestly? Slay. 💖
Not me being obsessed with how tidy this is — four fields, zero drama, each one doing exactly one job. Main character data members only. ✨

🫶 Author 🫶

Generated automatically by Doxygen for Coin from the source code.

Like, nobody hand-wrote this, bestie — Doxygen just did its thing and pulled it straight out of the Coin source. Automated queen. 🤖👑

And that's a wrap on SoWWWInline(3)!! 🌈 You made it all the way through all three parts and I'm so proud of you 🥹💜 This page is from Coin version 4.0.10, dated Thu Jun 25 2026 00:00:00, and it's filed under SoWWWInline(3). Go forth and inline your WWWs responsibly, angel 🦋🌸💖

📦 where this page comes from