SoWWWInline(3)
๐ SoWWWInline โ the iconic URL-including node ๐
okay bestie, welcome to the SoWWWInline(3) page from the Library Functions Manual. this is part 1 and we're gonna go through the whole vibe: what it is, its synopsis, all the inherited stuff, the detailed description, the enum, and the constructor/destructor docs. no cap, every signature is staying exactly as written. periodt. ๐
โจ NAME โจ
SoWWWInlineโ TheSoWWWInlineclass is a node used to include data from an URL. ๐ฆ
๐ฆ 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 }
๐ Public Member Functions ๐
virtual SoType getTypeId (void) constSoWWWInline (void)void setFullURLName (const SbString &url)const SbString & getFullURLName (void)SoGroup * copyChildren (void) constvoid requestURLData (void)SbBool isURLDataRequested (void) constSbBool isURLDataHere (void) constvoid cancelURLDataRequest (void)void setChildData (SoNode *urldata)SoNode * getChildData (void) constvirtual SoChildList * getChildren (void) constvirtual 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) constvoid setNodeType (const NodeType type)NodeType getNodeType (void) constvirtual SoNode * copy (SbBool copyconnections=0) constvirtual SbBool affectsState (void) constvirtual 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) constvirtual void writeInstance (SoOutput *out)virtual SoNode * addToCopyDict (void) constvirtual SoFieldContainer * copyThroughConnection (void) const
๐ Public Member Functions inherited from SoFieldContainer ๐
void setToDefaults (void)SbBool hasDefaultValues (void) constSbBool fieldsAreEqual (const SoFieldContainer *container) constvoid copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=0)SbBool set (const char *const fielddata)void get (SbString &fielddata)virtual int getFields (SoFieldList &l) constvirtual int getAllFields (SoFieldList &l) constvirtual SoField * getField (const SbName &name) constvirtual SoField * getEventIn (const SbName &name) constvirtual SoField * getEventOut (const SbName &name) constSbBool getFieldName (const SoField *const field, SbName &name) constSbBool enableNotify (const SbBool flag)SbBool isNotifyEnabled (void) constSbBool set (const char *fielddata, SoInput *in)void get (SbString &fielddata, SoOutput *out)virtual SbBool validateNewFieldValue (SoField *field, void *newval)virtual void addWriteReference (SoOutput *out, SbBool isfromfield=0)SbBool getIsBuiltIn (void) constvoid setUserData (void *userdata) constvoid * getUserData (void) const
๐ง Public Member Functions inherited from SoBase ๐ง
void ref (void) constvoid unref (void) constvoid unrefNoDelete (void) constint32_t getRefCount (void) constvoid touch (void)SbBool isOfType (SoType type) constvirtual SbName getName (void) constvirtual 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) constSbBool 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 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 *in, SoBase *&base, SoType expectedtype)static void setInstancePrefix (const SbString &c)static void setTraceRefs (SbBool trace)static SbBool getTraceRefs (void)static SbBool connectRoute (SoInput *in, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)static SbBool readRoute (SoInput *in)
๐ Public Attributes ๐
SoSFString nameSoSFVec3f bboxCenterSoSFVec3f bboxSizeSoSFNode alternateRep
๐ก๏ธ Protected Member Functions ๐ก๏ธ
virtual const SoFieldData * getFieldData (void) constvirtual ~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)~SoFieldContainer ()
๐ Protected Member Functions inherited from SoBase ๐
SoBase (void)virtual ~SoBase ()virtual void destroy (void)SbBool hasMultipleWriteRefs (void) constSbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) constvoid writeFooter (SoOutput *out) constvirtual 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)
๐ซ Friends ๐ซ
class SoWWWInlineP
๐งฌ 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 = 0static int nextActionMethodIndex = 0
๐ Detailed Description ๐
okay so here's the tea, bestie: The SoWWWInline class is a node used to include data from an URL. ๐
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 pressure tho.
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. yes, you gotta tell it how big the vibe is. ๐
If FetchURLCallBack isn't set, the alternateRep will be rendered instead.
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.
References alternateRep, bboxCenter, bboxSize, name, and SoWWWInline().
Referenced by copyContents(), getFieldData(), and SoWWWInline().
SoWWWInline::~SoWWWInline () [protected], [virtual]
Destructor.
part 1 of 3, bestie โ part 2 is coming and we're not done yet ๐
โจ Member Function Documentation โจ
SoType SoWWWInline::getTypeId (void ) const [virtual]โ bestie, this one hands you the type ID of any object that inherits fromSoBase. It's literally the vibe check for run-time type checking and "downward" casting. ๐
Usage example, no cap:
void foo(SoNode * node)
{
if (node->getTypeId() == SoFile::getClassTypeId()) {
SoFile * filenode = (SoFile *)node; // safe downward cast, knows the type
}
else if (node->getTypeId().isOfType(SoGroup::getClassTypeId())) {
SoGroup * group = (SoGroup *)node; // safe downward cast, knows the type
}
}
If you're an application programmer wanting to extend the library with new nodes, engines, nodekits, draggers or whatever โ you gotta override this method in all subclasses. It's usually done as part of setting up the full type system for extension classes, and you'll typically use the pre-defined macros available through e.g. 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. For more info on writing Coin extensions, see 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, it returnsNULL. ๐ซถ- Reimplemented from:
SoFieldContainer - References:
SoWWWInline()
- Reimplemented from:
void SoWWWInline::setFullURLName (const SbString & url)โ if theSoWWWInline::namefield 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 theSoWWWInline::setFullURLName()method, return it. If not, it returns the value of theSoWWWInline::namefield. ๐- References:
SbString::getLength(), andname
- References:
SoGroup * SoWWWInline::copyChildren (void ) constโ returns a subgraph with a deep copy of the children of this node. Obsessed with how thorough this is. ๐- References:
getChildren(),SbPList::getLength(),SoBase::isOfType(), andSoNode::SoNode()
- References:
void SoWWWInline::requestURLData (void )โ start requesting URL data. This might trigger a callback to the callback set inSoWWWInline::setFetchURLCallBack(). ๐ฅSbBool SoWWWInline::isURLDataRequested (void ) constโ returnsTRUEifSoWWWInline::requestURLData()has been called without being canceled bySoWWWInline::cancelURLData(). ๐SbBool SoWWWInline::isURLDataHere (void ) constโ returnTRUEif the current child data has been read from file/URL and set usingsetChildData(). ๐ฆ- References:
getChildren(), andSbPList::getLength()
- References:
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. ๐void SoWWWInline::setChildData (SoNode * urldata)โ manually set up the subgraph for this node. This should be used by the application to set the data that was read from the file/URL. โจ- References:
SoNode::SoNode()
- References:
SoNode * SoWWWInline::getChildData (void ) constโ returns the child data for this node. This can be data read from a file, from an URL, from the contents ofSoWWWInline::alternateRepor that was manually set withSoWWWInline::setChildData(). ๐- Referenced by:
GLRender()
- Referenced by:
SoChildList * SoWWWInline::getChildren (void ) const [virtual]โ returns the child list with the child data for this node. Main character energy. ๐- Reimplemented from:
SoNode - Referenced by:
copyChildren(),copyContents(),doAction(),getBoundingBox(), andisURLDataHere()
- Reimplemented from:
void SoWWWInline::setFetchURLCallBack (SoWWWInlineFetchURLCB * f, void * userdata) [static]โ sets the URL fetch callback. This will be used inSoWWWInline::readInstance()or when the user callsSoWWWInline::requestURLData(). FIXME: Shouldn't called onreadInstance(), only when we need to render the node (or calculate the bbox if we don't have one). kintel 20060203. ๐ญvoid SoWWWInline::setBoundingBoxVisibility (BboxVisibility b) [static]โ sets the bounding box visibility strategy. The default isUNTIL_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 asSoFilechildren are read. If this is set toTRUE, the URL must point to a file on the local file system, as can be accessed by the standard C libraryfopen()call. โญSbBool SoWWWInline::getReadAsSoFile (void ) [static]โ returns if children should be read from local files.- See also:
setReadAsSoFile()
- See also:
void SoWWWInline::doAction (SoAction * action) [virtual]โ this function performs the typical operation of a node for any action. It's giving "do it all" energy. ๐ฅ- Reimplemented from:
SoNode - References:
getChildren(),SoAction::getPathCode(),SoChildList::traverse(), andSoChildList::traverseInPath() - Referenced by:
audioRender(),callback(),getMatrix(),getPrimitiveCount(),GLRender(),handleEvent(),pick(), andsearch()
- Reimplemented from:
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 forSoCallbackAction. Simply updates the state according to how the node behaves for the render action, so the application programmer can use theSoCallbackActionfor extracting information about the scene graph. ๐- Reimplemented from:
SoNode - References:
doAction()
- Reimplemented from:
void SoWWWInline::GLRender (SoGLRenderAction * action) [virtual]โ action method for theSoGLRenderAction. This is called during rendering traversals. Nodes influencing the rendering state in any way or who wants to throw geometry primitives at OpenGL overrides this method. ๐- Reimplemented from:
SoNode - References:
bboxCenter,bboxSize,doAction(),getChildData(),SoAction::getState(),NEVER,SoState::pop(),SoState::push(), andUNTIL_LOADED
- Reimplemented from:
void SoWWWInline::getBoundingBox (SoGetBoundingBoxAction * action) [virtual]โ action method for theSoGetBoundingBoxAction. Calculates bounding box and center coordinates for 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 calculates their bounding box also overrides this method to change the relevant state variables. โจ- Reimplemented from:
SoNode - References:
bboxCenter,bboxSize,SoGetBoundingBoxAction::extendBy(),SoGetBoundingBoxAction::getCenter(),getChildren(),SbPList::getLength(),SoAction::getPathCode(),SoGetBoundingBoxAction::isCenterSet(),SoGetBoundingBoxAction::resetCenter(),SoGetBoundingBoxAction::setCenter(), andSoChildList::traverse()
- Reimplemented from:
void SoWWWInline::getMatrix (SoGetMatrixAction * action) [virtual]โ action method forSoGetMatrixAction. Updates action by accumulating with the transformation matrix of this node (if any). ๐- Reimplemented from:
SoNode - References:
doAction()
- Reimplemented from:
void SoWWWInline::handleEvent (SoHandleEventAction * action) [virtual]โ action method forSoHandleEventAction. 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 overrides this method. ๐- Reimplemented from:
SoNode - References:
doAction()
- Reimplemented from:
void SoWWWInline::search (SoSearchAction * action) [virtual]โ action method forSoSearchAction. 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 theSoSearchAction-- if any of the requested criteria is a miss, the search is not deemed successful for the node. ๐- See also:
SoSearchAction - Reimplemented from:
SoNode - References:
doAction(),SoSearchAction::isFound(), andSoNode::search()
- See also:
void SoWWWInline::pick (SoPickAction * action) [virtual]โ action method forSoPickAction. Does common processing forSoPickActionaction instances. ๐ฆ- Reimplemented from:
SoNode - References:
doAction()
- Reimplemented from:
void SoWWWInline::getPrimitiveCount (SoGetPrimitiveCountAction * action) [virtual]โ action method for theSoGetPrimitiveCountAction. 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 calculates their primitive count also overrides this method to change the relevant state variables. ๐ข- Reimplemented from:
SoNode - References:
doAction()
- Reimplemented from:
void SoWWWInline::audioRender (SoAudioRenderAction * action) [virtual]โ action method forSoAudioRenderAction. Does common processing forSoAudioRenderActionaction instances. ๐- Reimplemented from:
SoNode - References:
doAction()
- Reimplemented from:
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. ๐- References:
bboxCenter,bboxSize,SbBox3f::extendBy(),SbBox3f::getCenter(), andSbBox3f::getSize()
- References:
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.TRUEorFALSEis 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 returningFALSE.flagsis used internally during binary import when reading user extension nodes, group nodes or engines. ๐ซถ- Reimplemented from:
SoNode - References:
SoNode::readInstance()
- Reimplemented from:
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 ifcopyconnectionsisFALSE. This is the protected method that should be overridden by extension node / engine / dragger / whatever subclasses which needs 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 theSoNode::copy()function:
SoNode * mynewnode = templatenode->copy();
The same also goes for engines. ๐
okay so the big one: when you override copyContents() in your extension class, you HAVE to call up to your parent superclass in the inheritance hierarchy. like, non-negotiable bestie. because copyContents() in stuff like SoNode and SoFieldContainer does important work and if you skip it you're just ghosting all that machinery. ๐
it should look 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.
References SoChildList::append(), SoNode::copyContents(), SoFieldContainer::findCopy(), getChildren(), SbPList::getLength(), SoFieldContainer::SoFieldContainer(), SoNode::SoNode(), and SoWWWInline().
๐ธ Member Data Documentation ๐ธ
the actual data members, the main characters of this section, let's go ๐
SoSFString SoWWWInline::nameโ the name of the file/URL where the children should be read from. this is literally the whole point of the node bestie โจ
Referenced by getFullURLName(), and SoWWWInline().
SoSFVec3f SoWWWInline::bboxCenterโ center of the bounding box. ๐
Referenced by addBoundingBoxChild(), getBoundingBox(), GLRender(), and SoWWWInline().
SoSFVec3f SoWWWInline::bboxSizeโ size of the bounding box. ๐ฆ
Referenced by addBoundingBoxChild(), getBoundingBox(), GLRender(), and SoWWWInline().
SoSFNode SoWWWInline::alternateRepโ the alternate representation. it's the fallback vibe โ used when the children can't be read fromname. ๐ฆ
Referenced by SoWWWInline().
๐ Author ๐
Generated automatically by Doxygen for Coin from the source code. (not me writing my own manpage, the robots did it, iconic honestly) ๐ค๐
and that's a wrap on SoWWWInline(3), bestie!! ๐โจ this lil page came from Coin, Version 2.5.0, and it lives in section 3 of the manual. go forth and inline those WWW children responsibly ๐ฆ๐ mwah, bye!! ๐โญ
๐ฆ where this page comes from
- fedora 43: Coin2-devel 2.5.0-52.fc43 ยท GPL-2.0-only
- fedora 43: Coin2-devel 2.5.0-52.fc43 ยท GPL-2.0-only
- fedora 44: Coin2-devel 2.5.0-54.fc44 ยท GPL-2.0-only
- fedora 44: Coin2-devel 2.5.0-54.fc44 ยท GPL-2.0-only
- ๐ girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms