SoWWWAnchor(3)

📦 version 3.1.3, in fedora 43, fedora 44

💖 SoWWWAnchor 💖 — the SoWWWAnchor(3) glow-up

okay so bestie, buckle UP, because this is the SoWWWAnchor(3) manual page and it is giving library-functions-manual realness. no cap. 💅

🌸 NAME 🌸

SoWWWAnchor — the SoWWWAnchor class adds URL callbacks to the highlighted geometry. like, you highlight a thing, and boom, URL callback energy. iconic behavior fr fr. ✨

🦋 SYNOPSIS 🦋

first things first, you gotta pull it in:

#include <Inventor/nodes/SoWWWAnchor.h>

and Inherits SoLocateHighlight. that's the family tree, periodt. 👑

💜 Public Types 💜

  • enum Mapping { NONE, POINT } — your mapping choices, two of them, no more no less.

✨ Public Types inherited from SoLocateHighlight ✨

  • enum Modes { AUTO, ON, OFF }
  • enum Styles { EMISSIVE, EMISSIVE_DIFFUSE }

✨ Public Types inherited from SoSeparator ✨

  • enum CacheEnabled { OFF, ON, AUTO }

✨ Public Types inherited from SoNode ✨

this one is a whole mood, look at all these:

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 🎀

the main character methods, right here:

  • virtual SoType getTypeId (void) const
  • SoWWWAnchor (void) — the constructor, hi bestie 👋
  • void setFullURLName (const SbString &url)
  • const SbString & getFullURLName (void)
  • virtual void handleEvent (SoHandleEventAction *action)

✨ Public Member Functions inherited from SoLocateHighlight ✨

  • SoLocateHighlight (void)
  • virtual void GLRenderBelowPath (SoGLRenderAction *action)
  • virtual void GLRenderInPath (SoGLRenderAction *action)

✨ Public Member Functions inherited from SoSeparator ✨

  • SoSeparator (void)
  • SoSeparator (const int nchildren)
  • virtual void doAction (SoAction *action)
  • virtual void GLRender (SoGLRenderAction *action)
  • virtual void GLRenderOffPath (SoGLRenderAction *action)
  • virtual void callback (SoCallbackAction *action)
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action)
  • virtual void getMatrix (SoGetMatrixAction *action)
  • virtual void rayPick (SoRayPickAction *action)
  • virtual void search (SoSearchAction *action)
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
  • virtual void audioRender (SoAudioRenderAction *action)
  • virtual void notify (SoNotList *nl)
  • virtual SbBool affectsState (void) const

✨ Public Member Functions inherited from SoGroup ✨

  • SoGroup (void)
  • SoGroup (int nchildren)
  • virtual void addChild (SoNode *node)
  • virtual void insertChild (SoNode *child, int newchildindex)
  • virtual SoNode * getChild (int index) const
  • virtual int findChild (const SoNode *node) const
  • virtual int getNumChildren (void) const
  • virtual void removeChild (int childindex)
  • virtual void removeChild (SoNode *child)
  • virtual void removeAllChildren (void)
  • virtual void replaceChild (int index, SoNode *newchild)
  • virtual void replaceChild (SoNode *oldchild, SoNode *newchild)
  • virtual void pick (SoPickAction *action)
  • virtual void write (SoWriteAction *action)
  • virtual SoChildList * getChildren (void) const

✨ 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 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=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 🌈

the ones you can call without even having an instance, so slay:

  • static SoType getClassTypeId (void)
  • static void initClass (void)
  • static void setFetchURLCallBack (SoWWWAnchorCB *f, void *userData)
  • static void setHighlightURLCallBack (SoWWWAnchorCB *f, void *userData)

✨ Static Public Member Functions inherited from SoLocateHighlight ✨

  • static SoType getClassTypeId (void)
  • static void initClass (void)
  • static void turnOffCurrentHighlight (SoGLRenderAction *action)

✨ Static Public Member Functions inherited from SoSeparator ✨

  • static SoType getClassTypeId (void)
  • static void initClass (void)
  • static void setNumRenderCaches (const int howmany)
  • static int getNumRenderCaches (void)

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

the actual fields, the ones you set and forget (jk don't forget them):

  • SoSFString name
  • SoSFString description
  • SoSFEnum map

✨ Public Attributes inherited from SoLocateHighlight ✨

  • SoSFColor color
  • SoSFEnum style
  • SoSFEnum mode

✨ Public Attributes inherited from SoSeparator ✨

  • SoSFEnum renderCaching
  • SoSFEnum boundingBoxCaching
  • SoSFEnum renderCulling
  • SoSFEnum pickCulling

🧚 Protected Member Functions 🧚

lowkey the internal ones, for the subclasses and the brave:

  • virtual const SoFieldData * getFieldData (void) const
  • virtual ~SoWWWAnchor ()
  • virtual void redrawHighlighted (SoAction *act, SbBool isNowHighlighting)

✨ Protected Member Functions inherited from SoLocateHighlight ✨

  • virtual ~SoLocateHighlight ()

✨ Protected Member Functions inherited from SoSeparator ✨

  • virtual ~SoSeparator ()
  • virtual SbBool cullTest (SoState *state)
  • virtual SbBool cullTest (SoGLRenderAction *action, int &cullresults)
  • virtual SbBool readInstance (SoInput *in, unsigned short flags)

✨ Protected Member Functions inherited from SoGroup ✨

  • virtual ~SoGroup ()
  • virtual SbBool readChildren (SoInput *in)
  • virtual void copyContents (const SoFieldContainer *from, 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 SoLocateHighlight ✨

  • static const SoFieldData ** getFieldDataPtr (void)

✨ Static Protected Member Functions inherited from SoSeparator ✨

  • static const SoFieldData ** getFieldDataPtr (void)

✨ Static Protected Member Functions inherited from SoGroup ✨

  • static const SoFieldData ** getFieldDataPtr (void)
bestie this is literally only part 1 💖 the rest of the page is still coming, don't go anywhere 🫶✨

🔧 Static Protected Member Functions inherited from SoNode

bestie these are the static helper goodies that come down the family tree from SoNode, and they're all protected so they're iykyk-only:

  • static const SoFieldData ** getFieldDataPtr (void) — hands you back the pointer-to-pointer for the field data, iconic.
  • static void setNextActionMethodIndex (int index) — sets the next action method index to index.
  • static int getNextActionMethodIndex (void) — returns that next action method index, no cap.
  • static void incNextActionMethodIndex (void) — bumps the next action method index up by one, slay.
  • static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask) — sets the compatibility types for nodetype using bitmask.

🔧 Static Protected Member Functions inherited from SoBase

and from SoBase, the ancestors really said "here, take these too":

  • static uint32_t getCurrentWriteCounter (void) — gives you the current write counter, periodt.
  • static void staticDataLock (void) — locks the static data.
  • static void staticDataUnlock (void) — unlocks it again, balance restored 💅.

🌸 Additional Inherited Members 🌸

not me listing literally every inherited thing because we don't skip a single one:

Protected Types inherited from SoBase

  • enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 } — the base flags enum, keeping the vibe classified.

Protected Attributes inherited from SoGroup

  • SoChildList * children — the child list pointer.

Protected Attributes inherited from SoNode

  • uint32_t uniqueId — the unique id, one of a kind 🦋.

Protected Attributes inherited from SoFieldContainer

  • SbBool isBuiltIn — whether it's built in or not.

Static Protected Attributes inherited from SoNode

  • static uint32_t nextUniqueId = 1 — the next unique id, starting at 1.
  • static int nextActionMethodIndex = 0 — the next action method index, starting at 0.

✨ Detailed Description ✨

okay so the whole point of SoWWWAnchor is that it adds URL callbacks to the highlighted geometry. it's giving hyperlink but make it 3D.

on top of highlighting whatever geometry is under the cursor, the application programmer can set callbacks. specifically you get one callback for picking (the fetch callback) and one callback for highlighting. two separate little guys, each doing their job 🫶.

here's the iconic example, copied exactly because we do not paraphrase code:

#Inventor V2.1 ascii

WWWAnchor {
   name "http://www.coin3d.org/Coin/egg.iv"
   description "Easter Egg"

   Separator {
      Transform { scaleFactor 0.8 1.2 0.8 }
      Sphere { }
   }
}

📄 FILE FORMAT/DEFAULTS:

the defaults, untouched, every single one of them:

WWWAnchor {
    renderCaching AUTO
    boundingBoxCaching AUTO
    renderCulling AUTO
    pickCulling AUTO
    color 0.3 0.3 0.3
    style EMISSIVE
    mode AUTO
    name "<Undefined URL>"
    description ""
    map NONE
}

Since

  • Inventor 2.1 — an oldie but a goodie, fr fr.

🧭 Member Enumeration Documentation

enum SoWWWAnchor::Mapping

this enum says how a picked node's position should be mapped to the URL. like, where do the coordinates go.

Enumerator

  • NONE — the position of the picked node is not mapped to the URL. simple, unbothered.
  • POINT — the position of the picked node is mapped to the URL as object space coordinates, adding a parameter string to the end of the URL. and the way that it works: to assure that the URL works with all browsers, the coordinates are divided by commas sent as the hex representation.

here's the example because it's honestly so satisfying: if a model by the name of sim.wrl resided at www.coin3d.org and the picked point had the coordinates [1.5, 10, 6.77], the resulting URL would be:

http://www.coin3d.org/sim.wrl?1.5%2c10%2c6.77

look at those %2cs doing their little hex comma thing 💅

🏗️ Constructor & Destructor Documentation

SoWWWAnchor::SoWWWAnchor (void )

Constructor. that's it, that's the whole description, she's born ✨

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

Destructor. protected and virtual, so she leaves the way she arrived, respectfully.

🛠️ Member Function Documentation

SoType SoWWWAnchor::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, verbatim:

void foo(SoNode * node)
{
  if (node->getTypeId() == SoFile::getClassTypeId()) {
    SoFile * filenode = (SoFile *)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 info on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups. go read it, it's giving homework but make it lore 📚.

Reimplemented from SoLocateHighlight.

const SoFieldData * SoWWWAnchor::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. so check it, bestie, don't dereference a whole nothing.

Reimplemented from SoLocateHighlight.

void SoWWWAnchor::setFullURLName (const SbString & url)

Sets the full URL to url. If this is set, this URL will be used in callbacks instead of the URL set in SoWWWAnchor::name. so it overrides, she's the main character now 👑

See also: SoWWWAnchor::getFullURLName()

const SbString & SoWWWAnchor::getFullURLName (void )

Returns the full URL if it's set by SoWWWAnchor::setFullURLName(). Otherwise the contents of SoWWWAnchor::name is returned. fallback queen.

See also: SoWWWAnchor::setFullURLName()

void SoWWWAnchor::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. so yeah, this is a whole ecosystem.

Reimplemented from SoLocateHighlight.

void SoWWWAnchor::setFetchURLCallBack (SoWWWAnchorCB * f, void * userData) [static]

Sets the callback function f that is called when a SoWWWAnchor node is clicked on. This callback can among other things be used to provide a browser with the URL of this node.

The callback will be called with the URL, userData and a pointer to this node as arguments. three args, no more no less 🫶.

void SoWWWAnchor::setHighlightURLCallBack (SoWWWAnchorCB * f, void * userData) [static]

Sets the callback function f that is called when a SoWWWAnchor node is highlighted. This callback can among other things be used to provide the user with a visual clue on which URL the node points to, for example by showing the URL as a string.

The callback will be called with the URL, userData and a pointer to this node as arguments. same trio as before, consistent king.

void SoWWWAnchor::redrawHighlighted (SoAction * act, SbBool isNowHighlighting) [protected], [virtual]

Calls the highlight callback set up with SoWWWAnchor::setHighlightURLCallBack(). it just... calls the callback. love a method that knows its purpose.

Reimplemented from SoLocateHighlight.

🗂️ Member Data Documentation

SoSFString SoWWWAnchor::name

The name of the URL which the anchor points to. the actual link, the whole point 💖

SoSFString SoWWWAnchor::description

The description of the URL.

SoSFEnum SoWWWAnchor::map

Enum describing how a node's position should be mapped to the URL. (yes, the Mapping enum from earlier, living here as a field.)

✍️ Author

Generated automatically by Doxygen for Coin from the source code. not a human, just a robot doing her little documentation slay 🤖💅

and that's a wrap on SoWWWAnchor(3), bestie!! this page came from Coin, Version 3.1.3, dated SoWWWAnchor(3) — you've officially read the whole thing, no skimming, we ate and left no crumbs 🎀✨ bye ily 🫶🌈
📦 where this page comes from