SoFullPath(3)

📦 version 3.1.3, in fedora 43, fedora 44

💖 SoFullPath 💖

okay bestie, welcome to SoFullPath(3) from the Library Functions Manual — yes it's a C++ class page, yes it's from Coin, and yes it's lowkey iconic. it's giving "i know where the hidden children are and you don't" energy. 🕵️♀️✨

✨ NAME ✨

SoFullPath — the class that lets you examine hidden children in paths. no cap, that's literally the whole job. 💅

🌸 SYNOPSIS 🌸

#include <Inventor/SoFullPath.h>

Inherits SoPath.

Inherited by SoTempPath.

🎀 Public Member Functions 🎀

  • void pop (void)
  • SoNode * getTail (void) const
  • SoNode * getNodeFromTail (const int index) const
  • int getIndexFromTail (const int index) const
  • int getLength (void) const

💜 Public Member Functions inherited from SoPath 💜

  • SoPath (const int approxlength=4)
  • SoPath (SoNode *const head)
  • SoPath (const SoPath &rhs)
  • SoPath & operator= (const SoPath &rhs)
  • virtual SoType getTypeId (void) const
  • void setHead (SoNode *const head)
  • SoNode * getHead (void) const
  • void append (const int childindex)
  • void append (SoNode *const node)
  • void append (const SoPath *const frompath)
  • void push (const int childindex)
  • void pop (void)
  • SoNode * getTail (void) const
  • SoNode * getNode (const int index) const
  • SoNode * getNodeFromTail (const int index) const
  • int getIndex (const int index) const
  • int getIndexFromTail (const int index) const
  • int getLength (void) const
  • void truncate (const int length)
  • int findFork (const SoPath *const path) const
  • int findNode (const SoNode *const node) const
  • SbBool containsNode (const SoNode *const node) const
  • SbBool containsPath (const SoPath *const path) const
  • SoPath * copy (const int startfromnodeindex=0, int numnodes=0) const
  • void insertIndex (SoNode *const parent, const int newindex)
  • void removeIndex (SoNode *const parent, const int oldindex)
  • void replaceIndex (SoNode *const parent, const int index, SoNode *const newchild)
  • SbBool isRelevantNotification (SoNotList *const l) const
  • virtual void write (SoWriteAction *action)

🦋 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)
  • virtual void startNotify (void)
  • virtual void notify (SoNotList *l)
  • void addAuditor (void *const auditor, const SoNotRec::Type type)
  • void removeAuditor (void *const auditor, const SoNotRec::Type type)
  • const SoAuditorList & getAuditors (void) const
  • virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)
  • SbBool shouldWrite (void)
  • void assertAlive (void) const

🌈 Additional Inherited Members 🌈

⭐ Static Public Member Functions inherited from SoPath ⭐

  • static void initClass (void)
  • static SoType getClassTypeId (void)
  • static SoPath * getByName (const SbName name)
  • static int getByName (const SbName name, SoPathList &l)

⭐ 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)

🔒 Protected Types inherited from SoBase 🔒

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

🔒 Protected Member Functions inherited from SoPath 🔒

  • virtual ~SoPath ()
  • void auditPath (const SbBool flag)

🔒 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 inherited from SoBase 🔒

  • static uint32_t getCurrentWriteCounter (void)
  • static void staticDataLock (void)
  • static void staticDataUnlock (void)

📖 Detailed Description 📖

ok so, the SoFullPath class allows examination of hidden children in paths. that's the whole vibe check right there. 💫

SoPath allows only access from the head node to the first node with hidden children, but not any further. rude, honestly. 😤

Since the SoFullPath is derived from SoPath and contains no private data, you can cast SoPath instances to the SoFullPath type. This will allow you to examine hidden children. main character casting energy fr fr. 🎬✨

🙈 (Actually, you are not supposed to allocate instances of this class at all. It is only available as an "extended interface" into the superclass SoPath.)

not me telling you "don't instantiate this" — it's giving backstage pass, not a build-your-own situation. it's literally just an extended interface into the superclass SoPath. periodt. 💅

🛠️ Member Function Documentation 🛠️

🌟 void SoFullPath::pop (void ) [inline]

This method overrides SoPath::pop() to allow clients to get at all the nodes in the path. every last one. no gatekeeping. 🫶

🌟 SoNode * SoFullPath::getTail (void ) const

This method overrides SoPath::getTail() to allow clients to get the tail node, counting internal path nodes. yes, the internal ones too, bestie. 🎀

🌟 SoNode * SoFullPath::getNodeFromTail (const int index) const

This method overrides SoPath::getNodeFromTail() to allow clients to get the node positioned index nodes from the tail, counting internal path nodes. math girlies rise. ✨

🌟 int SoFullPath::getIndexFromTail (const int index) const

This method overrides SoPath::getIndexFromTail() to allow clients to get the child index number for nodes based on their position from the tail, counting hidden nodes. the hidden ones are included, that's the whole point. 🔥

🌟 int SoFullPath::getLength (void ) const

This method returns the length of the path, counting hidden nodes also. yes, the hidden ones count. they're part of the story. 👑

🖋️ Author 🖋️

Generated automatically by Doxygen for Coin from the source code. it literally wrote itself (well, Doxygen did). 💀✨

ok that's the whole page bestie, hope this was helpful, mwah 💋

this lil doc came from Coin — Version 3.1.3 — and it's the SoFullPath(3) page, slay 🎀🦋💖**

📦 where this page comes from