SoVRMLInline(3)

📦 version 2.5.0, in fedora 43, fedora 44

💖 SoVRMLInline 💖

okay bestie, buckle up — this is the manual page for SoVRMLInline (that's the 3 in SoVRMLInline(3), iykyk), and it is literally the class you reach for when you wanna insert VRML files into a scene. That's the whole vibe. Gorgeous. Iconic. Let's go. ✨

🌸 SYNOPSIS 🌸

#include <Inventor/VRMLnodes/SoVRMLInline.h>

So this one inherits SoNode, bestie. Everything below is the full drip report — what it declares itself, and every single thing it borrows from its ancestors. No skipping, we're doing all of it. 💅

✨ Public Types ✨

  • enum BboxVisibility { NEVER, UNTIL_LOADED, ALWAYS } — the three moods for showing the bounding box, fr: NEVER, UNTIL_LOADED, or ALWAYS. Pick your fighter.

🦋 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 } — the big menu of node types, each with its own little hex snack. Don't touch the numbers, they're precious. 👑

💖 Public Member Functions 💖

okay so here's everything SoVRMLInline does with its own two hands:

  • virtual SoType getTypeId (void) const — hands you back the SoType for this thing.
  • SoVRMLInline (void) — the constructor. Hi. Hello. Welcome. 🎀
  • void setFullURLName (const SbString &url) — sets the full URL name.
  • const SbString & getFullURLName (void) — gives you back that full URL name.
  • SoGroup * copyChildren (void) const — copies the children, returns an SoGroup *.
  • void requestURLData (void) — asks for the URL data, pls.
  • SbBool isURLDataRequested (void) const — has the URL data been requested? Yes or no, bestie.
  • SbBool isURLDataHere (void) const — is the URL data actually here tho?
  • void cancelURLDataRequest (void) — nvm, cancel that request. 🙈
  • void setChildData (SoNode *urlData) — hands it the child data as an SoNode *.
  • SoNode * getChildData (void) const — gives back the child data.
  • virtual void doAction (SoAction *action) — runs the whole action thing.
  • virtual void callback (SoCallbackAction *action) — the callback hook.
  • virtual void GLRender (SoGLRenderAction *action) — the render hook. This is where the magic happens, lowkey. 🔥
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action) — bounding box go fetch.
  • virtual void getMatrix (SoGetMatrixAction *action) — matrix go fetch.
  • virtual void handleEvent (SoHandleEventAction *action) — event handling, very main character.
  • virtual void search (SoSearchAction *action) — the search hook.
  • virtual void pick (SoPickAction *action) — the pick hook.
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action) — counts those primitives for you.
  • virtual SoChildList * getChildren (void) const — returns the child list, as an SoChildList *.

💜 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=0) 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 audioRender (SoAudioRenderAction *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=0)
  • 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 *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) 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 ⭐

these ones you can call without making an object first, slay:

  • static SoType getClassTypeId (void) — the class's own SoType.
  • static void initClass (void) — sets the class up. Call it, bestie.
  • static void setFetchURLCallBack (SoVRMLInlineFetchURLCB *f, void *closure) — installs the fetch-URL callback plus its closure.
  • static void setBoundingBoxVisibility (BboxVisibility b) — sets how the bounding box shows up.
  • static BboxVisibility getBoundingBoxVisibility (void) — reads back that bounding box visibility.
  • static void setBoundingBoxColor (SbColor &color) — paints the bounding box.
  • static SbColor & getBoundingBoxColor (void) — reads back that bounding box color.
  • static void setReadAsSoFile (SbBool enable) — toggles read-as-So-file.
  • static SbBool getReadAsSoFile (void) — reads back that toggle.

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

the actual fields, the ones that show up in your scene files:

  • SoSFVec3f bboxCenter — center of the bounding box.
  • SoSFVec3f bboxSize — size of the bounding box.
  • SoMFString url — the URL field. Multi-string, so it can hold a whole list of 'em.

🦋 Protected Member Functions 🦋

for the class's own internal use, not your business bestie (affectionate):

  • virtual const SoFieldData * getFieldData (void) const — the field data.
  • virtual ~SoVRMLInline () — the destructor.

🌸 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) 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 👑

the deep-lore section, the stuff that trickles down through the family tree:

🎀 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 = 0
  • static int nextActionMethodIndex = 0

and that's it for part one, bestie — don't scroll away, there's literally more 💅

✨ Detailed Description ✨

The SoVRMLInline class is used to insert VRML files into a scene. iconic behavior honestly 💖

The detailed class documentation is taken verbatim from the VRML97 standard (ISO/IEC 14772-1:1997). It is copyright The Web3D Consortium, and is used by permission of the Consortium:

Inline {
  exposedField MFString url        []
  field        SFVec3f  bboxCenter 0 0 0     # (-,)
  field        SFVec3f  bboxSize   -1 -1 -1  # (0,) or -1,-1,-1
}

The Inline node is a grouping node that reads its children data from a location in the World Wide Web. Exactly when its children are read and displayed is not defined (e.g. reading the children may be delayed until the Inline node's bounding box is visible to the viewer). The url field specifies the URL containing the children. An Inline node with an empty URL does nothing.

Each specified URL shall refer to a valid VRML file that contains a list of children nodes, prototypes, and routes at the top level as described in 4.6.5, Grouping and children nodes.

The results are undefined if the URL refers to a file that is not VRML or if the VRML file contains non-children nodes at the top level. 🚨

If multiple URLs are specified, the browser may display a URL of a lower preference VRML file while it is obtaining, or if it is unable to obtain, the higher preference VRML file. Details on the url field and preference order can be found in 4.5, VRML and the World Wide Web (http://www.web3d.org/x3d/specifications/vrml/ISO-IEC-14772-VRML97/part1/concepts.html#4.5).

The results are undefined if the contents of the URL change after it has been loaded. 💀

The bboxCenter and bboxSize fields specify a bounding box that encloses the Inline node's children. This is a hint that may be used for optimization purposes. The results are undefined if the specified bounding box is smaller than the actual bounding box of the children at any time. A default bboxSize value, (-1, -1, -1), implies that the bounding box is not specified and if needed shall be calculated by the browser. A description of the bboxCenter and bboxSize fields is in 4.6.4, Bounding boxes (http://www.web3d.org/x3d/specifications/vrml/ISO-IEC-14772-VRML97/part1/concepts.html#4.6.4).

🔮 Member Enumeration Documentation 🔮

enum SoVRMLInline::BboxVisibility

Enumerator vibes, bestie:

  • NEVER SoSFVec3f SoVRMLInline::bboxCenter — Center of bounding box.
  • SoSFVec3f SoVRMLInline::bboxSize — Size of bounding box.
  • SoMFString SoVRMLInline::url — The VRML file URL.

enum SoVRMLInline::BboxVisibility — Used to enumerate bounding box visibility settings.

  • NEVER — Never display bounding box.
  • UNTIL_LOADED — Display bounding box until file is loaded.
  • ALWAYS — Always display bounding box.

🧸 Constructor & Destructor Documentation 🧸

SoVRMLInline::SoVRMLInline (void )

Constructor.

References SoVRMLInline().

Referenced by getFieldData(), and SoVRMLInline().

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

Destructor.

💅 Member Function Documentation 💅

SoType SoVRMLInline::getTypeId (void ) const [virtual]

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

Usage example:

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

For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. This is typically done as part of setting up the full type system for extension classes, which is usually 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.

For more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups.

Implements SoBase.

const SoFieldData * SoVRMLInline::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 SoFieldContainer.

References SoVRMLInline().

void SoVRMLInline::setFullURLName (const SbString & urlref)

Sets the full (non-relative) URL name.

const SbString & SoVRMLInline::getFullURLName (void )

Returns the full URL name.

SoGroup * SoVRMLInline::copyChildren (void ) const

Returns a copy of the children.

References SoNode::copy(), SoBase::isOfType(), and SoNode::SoNode().

void SoVRMLInline::requestURLData (void )

Request URL data.

SbBool SoVRMLInline::isURLDataRequested (void ) const

Returns TRUE if the URL data has been requested.

SbBool SoVRMLInline::isURLDataHere (void ) const

Returns TRUE if the data has been loaded.

References getChildData().

void SoVRMLInline::cancelURLDataRequest (void )

Cancel the URL data request.

void SoVRMLInline::setChildData (SoNode * urldata)

Sets the child data. Can be used by the URL fetch callback.

References SoNode::SoNode().

SoNode * SoVRMLInline::getChildData (void ) const

Returns the child data (the scene loaded from the url).

Referenced by GLRender(), and isURLDataHere().

void SoVRMLInline::setFetchURLCallBack (SoVRMLInlineFetchURLCB * f, void * closure) [static]

Sets the callback used to handle URL loading.

void SoVRMLInline::setBoundingBoxVisibility (BboxVisibility b) [static]

Sets the bounding box visibility strategy.

SoVRMLInline::BboxVisibility SoVRMLInline::getBoundingBoxVisibility (void ) [static]

Returns the bounding box visibility strategy.

void SoVRMLInline::setBoundingBoxColor (SbColor & color) [static]

Sets the color of the bounding box.

SbColor & SoVRMLInline::getBoundingBoxColor (void ) [static]

Returns the color of the bounding box.

void SoVRMLInline::setReadAsSoFile (SbBool enable) [static]

Sets whether Inline nodes should be treated as a normal Inventor SoFile node.

SbBool SoVRMLInline::getReadAsSoFile (void ) [static]

Returns whether Inline nodes is read as SoFile nodes.

void SoVRMLInline::doAction (SoAction * action) [virtual]

This function performs the typical operation of a node for any action.

Reimplemented from SoNode.

References SoAction::getPathCode().

Referenced by callback(), getMatrix(), getPrimitiveCount(), GLRender(), handleEvent(), pick(), and search().

void SoVRMLInline::callback (SoCallbackAction * action) [virtual]

Action method for SoCallbackAction.

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.

References doAction().

void SoVRMLInline::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 wants to throw geometry primitives at OpenGL overrides this method.

Reimplemented from SoNode.

References ALWAYS, doAction(), getChildData(), SoAction::getState(), SbVec3f::getValue(), SoState::pop(), SoState::push(), SoNode::SoNode(), and UNTIL_LOADED.

void SoVRMLInline::getBoundingBox (SoGetBoundingBoxAction * action) [virtual]

Action method for the SoGetBoundingBoxAction.

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 SoGetBoundingBoxAction::extendBy(), SoGetBoundingBoxAction::getCenter(), getChildren(), SbPList::getLength(), SoAction::getPathCode(), SbVec3f::getValue(), SoGetBoundingBoxAction::isCenterSet(), SbBox3f::isEmpty(), SoGetBoundingBoxAction::resetCenter(), SoGetBoundingBoxAction::setCenter(), and SoChildList::traverse().

void SoVRMLInline::getMatrix (SoGetMatrixAction * action) [virtual]

Action method for SoGetMatrixAction.

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

Reimplemented from SoNode.

References doAction().

void SoVRMLInline::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 overrides this method.

Reimplemented from SoNode.

References doAction().

void SoVRMLInline::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.

References doAction(), SoSearchAction::isFound(), and SoNode::search().

void SoVRMLInline::pick (SoPickAction * action) [virtual]

Action method for SoPickAction.

Does common processing for SoPickAction action instances.

Reimplemented from SoNode.

References doAction().

void SoVRMLInline::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 calculates their primitive count also overrides this method to change the relevant state variables.

Reimplemented from SoNode.

References doAction().

SoChildList * SoVRMLInline::getChildren (void ) const [virtual]

Returns list of children for this node.

Reimplemented from SoNode.

Referenced by getBoundingBox().

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code.

This page is from Coin, Version 2.5.0, for SoVRMLInline(3). No date on this one, just pure source-code energy. Byeee bestie 💖✨

📦 where this page comes from