SoVRMLAnchor(3)

📦 version 2.5.0, in fedora 43, fedora 44

🎀 SoVRMLAnchor(3) — Library Functions Manual 🎀

okay bestie, grab a lil snack because we're about to get deep into SoVRMLAnchor. it's a whole manual page, it's long, it comes in two parts, and yes we're doing all of it. no skimming. we're eating today. 💅

✨ NAME ✨

SoVRMLAnchor — the class used for linking to other URL resources. it's giving "portal to somewhere else but make it VRML". 🌈

✨ SYNOPSIS ✨

#include <Inventor/VRMLnodes/SoVRMLAnchor.h>

Inherits SoVRMLParent.

💖 Public Member Functions 💖

  • virtual SoType getTypeId (void) const — the type-id getter, her own personal one.
  • SoVRMLAnchor (void) — the constructor. hi bestie, you're born. 🎀
  • virtual void handleEvent (SoHandleEventAction *action) — handles the event action. iconic behaviour tbh.

🦋 Public Member Functions inherited from SoVRMLParent 🦋

all of these come as a package deal from the parent, no cap:

  • virtual SbBool affectsState (void) const
  • virtual void addChild (SoNode *child)
  • virtual void insertChild (SoNode *child, int idx)
  • virtual SoNode * getChild (int idx) const
  • virtual int findChild (const SoNode *child) const
  • virtual int getNumChildren (void) const
  • virtual void removeChild (int idx)
  • virtual void removeChild (SoNode *child)
  • virtual void removeAllChildren (void)
  • virtual void replaceChild (int idx, SoNode *child)
  • virtual void replaceChild (SoNode *old, SoNode *child)
  • virtual SoChildList * getChildren (void) const
  • virtual void doAction (SoAction *action)
  • virtual void search (SoSearchAction *action)
  • virtual void write (SoWriteAction *action)
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)

🦋 Public Member Functions inherited from SoGroup 🦋

  • SoGroup (void)
  • SoGroup (int nchildren)
  • virtual void GLRender (SoGLRenderAction *action)
  • virtual void callback (SoCallbackAction *action)
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action)
  • virtual void getMatrix (SoGetMatrixAction *action)
  • virtual void pick (SoPickAction *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=0) const
  • virtual void GLRenderBelowPath (SoGLRenderAction *action)
  • virtual void GLRenderInPath (SoGLRenderAction *action)
  • virtual void GLRenderOffPath (SoGLRenderAction *action)
  • virtual void rayPick (SoRayPickAction *action)
  • virtual void grabEventsSetup (void)
  • virtual void grabEventsCleanup (void)
  • virtual void startNotify (void)
  • 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 💖

  • static SoType getClassTypeId (void) — class-level type-id, the group chat version.
  • static void initClass (void) — sets the class up. do not skip her.
  • static void setFetchURLCallBack (SoVRMLAnchorCB *, void *closure) — sets the fetch-URL callback. yes she takes a closure too. 🫶

🌸 Static Public Member Functions inherited from SoVRMLParent 🌸

  • static SoType getClassTypeId (void)
  • static void initClass (void)
  • static void updateChildList (const SoNode *const *nodes, const int numnodes, SoChildList &cl)
  • static void updateChildList (SoNode *nodewithsfnode, SoChildList &cl)

🌸 Static Public Member Functions inherited from SoGroup 🌸

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

the actual fields she's carrying around, periodt:

  • SoMFString url — the URL, multi-string energy.
  • SoSFString description — a lil description.
  • SoMFString parameter — parameters, also multi-string.
  • SoSFVec3f bboxCenter — bounding box center.
  • SoSFVec3f bboxSize — bounding box size.

🍓 Public Attributes inherited from SoVRMLParent 🍓

  • SoMFNode children

💖 Protected Member Functions 💖

  • virtual const SoFieldData * getFieldData (void) const — field data getter.
  • virtual ~SoVRMLAnchor () — the destructor. bye bestie, you were iconic. 😭

🧚 Protected Member Functions inherited from SoVRMLParent 🧚

  • SoVRMLParent (void)
  • SoVRMLParent (int approxchildren)
  • virtual ~SoVRMLParent ()
  • virtual void notify (SoNotList *list)
  • virtual SbBool readInstance (SoInput *in, unsigned short flags)
  • virtual void copyContents (const SoFieldContainer *from, SbBool copyConn)

🧚 Protected Member Functions inherited from SoGroup 🧚

  • virtual ~SoGroup ()
  • virtual SbBool readChildren (SoInput *in)

🧚 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) — pointer to the field-data pointer. very meta. ✨

💜 Static Protected Member Functions inherited from SoVRMLParent 💜

  • static const SoFieldData ** getFieldDataPtr (void)

💜 Static Protected Member Functions inherited from SoGroup 💜

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

🌟 Public Types inherited from SoNode 🌟

the whole enum, verbatim, no edits, no cap:

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
}

🌟 Protected Types inherited from SoBase 🌟

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

🌟 Protected Attributes inherited from SoVRMLParent 🌟

  • SoMFNode addChildren
  • SoMFNode removeChildren

🌟 Protected Attributes inherited from SoGroup 🌟

  • SoChildList * children

🌟 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
ok so that's the whole synopsis dump — every single inherited member, every attribute, every static, all of it. nothing got left on read. 💅

and that's where part 1 stops, bestie — part 2 is pulling up any second, don't go anywhere 🦋⏳

🦋 Detailed Description 🦋

okay so SoVRMLAnchor is the class you reach for when you wanna link out to other URL resources. it's giving "portal to another world" energy, fr fr.

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

Anchor {
  eventIn      MFNode   addChildren
  eventIn      MFNode   removeChildren
  exposedField MFNode   children        []
  exposedField SFString description     ""
  exposedField MFString parameter       []
  exposedField MFString url             []
  field        SFVec3f  bboxCenter      0 0 0     # (-inf, inf)
  field        SFVec3f  bboxSize        -1 -1 -1  # (0, inf) or -1,-1,-1
}

so the Anchor grouping node grabs the content of a URL when the user activates (like, clicks) some geometry contained inside the Anchor node's children. if that URL points to a valid VRML file, that world replaces the world the Anchor node is part of — except when the parameter field (explained down below) changes that behaviour. if it's non-VRML data getting retrieved, the browser decides how to handle it; typically it just gets passed to an appropriate non-VRML browser. exactly how a user activates geometry inside the Anchor node depends on the pointing device and is up to the VRML browser. typically, clicking with the pointing device means the new scene replaces the current scene. an Anchor node with an empty url does literally nothing when its children are chosen. the full tea on how multiple Anchors and pointing-device sensors get resolved on activation lives in 4.6.7, Sensor nodes (http://www.web3d.org/x3d/specifications/vrml/ISO-IEC-14772-VRML97/part1/concepts.html#4.6.7).

more deets on the children, addChildren, and removeChildren fields and eventIns can be found in 4.6.5, Grouping and children nodes (http://www.web3d.org/x3d/specifications/vrml/ISO-IEC-14772-VRML97/part1/concepts.html#4.6.5).

the description field in the Anchor node is a textual description of the Anchor node. browser-specific user interfaces might use it to show users more detailed info about the Anchor. the parameter exposed field can supply any additional info for the browser to interpret. every string has to be "keyword=value" pairs. for example, some browsers let you specify a 'target' for a link so it displays in another part of an HTML document. the parameter field then looks like:

Anchor {
  parameter [ "target=name_of_frame" ]
  ...
}

an Anchor node can also bind the initial Viewpoint node in a world, by specifying a URL ending with "#ViewpointName" where "ViewpointName" is the name of a viewpoint defined in the VRML file. like, for example:

Anchor {
  url "http://www.school.edu/vrml/someScene.wrl#OverView"
  children  Shape { geometry Box {} }
}

that specifies an anchor that loads the VRML file "someScene.wrl" and binds the initial user view to the Viewpoint node named "OverView" when the Anchor node's geometry (Box) is activated. if that named Viewpoint node isn't found in the VRML file, the VRML file loads using the default Viewpoint node binding stack rules (see VRMLViewpoint). and if the url field is given in the form "#ViewpointName" (i.e. no file name at all), then the Viewpoint node with that name ("ViewpointName") in the Anchor's run-time name scope(s) shall be bound (set_bind TRUE). ⚠️ the results are undefined if there are multiple Viewpoints with the same name in the Anchor's run-time name scope(s). also undefined if the Anchor node isn't part of any run-time name scope, or is part of more than one run-time name scope. see 4.4.6, Run-time name scope, for a description of run-time name scopes. and see VRMLViewpoint for the Viewpoint transition rules that spell out how browsers shall interpret the transition from the old Viewpoint node to the new one. e.g.:

Anchor {
  url "#Doorway"
  children Shape {
    geometry Sphere {}
  }
}

this binds the viewer to the viewpoint defined by the "Doorway" viewpoint in the current world when the sphere is activated. in this case, if the Viewpoint isn't found, no action occurs on activation. more details on the url field live 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). and the bboxCenter and bboxSize fields specify a bounding box enclosing the Anchor's children — it's just 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 point in time. the default bboxSize value, (-1, -1, -1), implies the bounding box isn't specified, and if it's needed the browser shall calculate it. more details on bboxCenter and bboxSize are in 4.6.4, Bounding boxes (http://www.web3d.org/x3d/specifications/vrml/ISO-IEC-14772-VRML97/part1/concepts.html#4.6.4).

🛠️ Constructor & Destructor Documentation 🛠️

SoVRMLAnchor::SoVRMLAnchor (void )

the default constructor, bestie. the standard one. 💅

it references bboxCenter, bboxSize, description, parameter, SoVRMLAnchor(), and url.

it's referenced by getFieldData(), and SoVRMLAnchor().

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

the destructor. protected, virtual, doing its quiet little cleanup moment. 🎀

✨ Member Function Documentation ✨

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

hands you the type identification of an object derived from a class that inherits SoBase. it's what powers run-time type checking and "downward" casting. iykyk.

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 who wanna extend the library with new nodes, engines, nodekits, draggers or whatever: this method needs to be overridden in all subclasses. typically that's done as part of setting up the full type system for extension classes, which is usually handled with 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 info on writing Coin extensions, check the class documentation of the toplevel superclasses for the various class groups.

Reimplemented from SoVRMLParent.

const SoFieldData * SoVRMLAnchor::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. simple as that. 💖

Reimplemented from SoVRMLParent.

References SoVRMLAnchor().

void SoVRMLAnchor::setFetchURLCallBack (SoVRMLAnchorCB * f, void * closure) [static]

sets the callback that gets called when the node is selected. so like, the moment the vibe check happens. ✨

void SoVRMLAnchor::handleEvent (SoHandleEventAction * action) [virtual]

the action method for SoHandleEventAction.

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

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

Reimplemented from SoGroup.

References SoMouseButtonEvent::BUTTON1, SoHandleEventAction::getEvent(), SbString::getLength(), SoAction::getState(), SoGroup::handleEvent(), SoMouseButtonEvent::isButtonPressEvent(), SoState::pop(), SoState::push(), and url.

🌈 Member Data Documentation 🌈

SoMFString SoVRMLAnchor::url

the URL string, bestie. the whole point. 👑

Referenced by handleEvent(), and SoVRMLAnchor().

SoSFString SoVRMLAnchor::description

the textual description of the URL. little caption energy. 🎀

Referenced by SoVRMLAnchor().

SoMFString SoVRMLAnchor::parameter

may be used to supply additional information to the browser.

each string should be pairs of keyword = value.

Referenced by SoVRMLAnchor().

SoSFVec3f SoVRMLAnchor::bboxCenter

children bounding box hint center. default value is (0, 0, 0). 🧚

Referenced by SoVRMLAnchor().

SoSFVec3f SoVRMLAnchor::bboxSize

children bounding box size hint. default value is (-1, -1, -1). 🧚

Referenced by SoVRMLAnchor().

👑 Author 👑

generated automatically by Doxygen for Coin, straight from the source code. no cap, the robots wrote this one. 🤖✨

and that's a wrap on part 2, bestie!! this whole glow-up came to you courtesy of Coin, Version 2.5.0, and it's serving SoVRMLAnchor(3) realness. go forth and anchor responsibly 💅💖🌸

📦 where this page comes from