SoNodeKitPath(3)

📦 version 3.1.3, in fedora 43, fedora 44

okay bestie, welcome to SoNodeKitPath(3) — yeah it lives in the Library Functions Manual, and yes we are absolutely going to get into it. Grab a boba, sit criss-cross, this is gonna be cute. 🍓✨

✨ NAME ✨

SoNodeKitPath — the class that is a path containing only nodekit nodes. That's it, that's the whole personality. 💅

🌸 SYNOPSIS 🌸

#include <Inventor/SoNodeKitPath.h>

Inherits SoPath. (a nepo baby, but a talented one 🫶)

💜 Public Member Functions 💜

  • int getLength (void) const
  • SoNode * getTail (void) const
  • SoNode * getNode (const int idx) const
  • SoNode * getNodeFromTail (const int idx) const
  • void truncate (const int length)
  • void pop (void)
  • void append (SoBaseKit *childKit)
  • void append (const SoNodeKitPath *fromPath)
  • SbBool containsNode (SoBaseKit *node) const
  • int findFork (const SoNodeKitPath *path) 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

🧚 Protected Member Functions 🧚

  • SoNodeKitPath (const int approxLength)
  • virtual ~SoNodeKitPath ()

🌟 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

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

🔮 Static Protected Member Functions inherited from SoBase 🔮

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

💖 Detailed Description 💖

The SoNodeKitPath class is a path that contains only nodekit nodes.

All other nodes are hidden from the user. Like, they're not even in the room. You don't see them, you don't speak to them, they don't exist to you. 👑✨

🎀 Constructor & Destructor Documentation 🎀

🫧 SoNodeKitPath::SoNodeKitPath (const int approxLength) [protected]

A constructor. That's the whole note. It constructs. Slay. 💅

🫧 SoNodeKitPath::~SoNodeKitPath () [protected], [virtual]

The destructor. It destructs. Bye bestie, mwah. 😭💖

🦋 Member Function Documentation 🦋

✨ int SoNodeKitPath::getLength (void) const

Returns the length of the path — a.k.a. the number of nodekit nodes. Just the kits, nothing else, no crumbs. 💅

✨ SoNode * SoNodeKitPath::getTail (void) const

Returns the tail of the path — the last nodekit in the path. The final girl. The main character of the end. 👑

✨ SoNode * SoNodeKitPath::getNode (const int idx) const

Returns nodekit number idx in path. (counting from the front, like a normal person 💖)

✨ SoNode * SoNodeKitPath::getNodeFromTail (const int idx) const

Returns nodekit number idx in the path, from the tail. Yes we're counting backwards, it's a vibe. 🌈

✨ void SoNodeKitPath::truncate (const int length)

Truncates the path at nodekit number length. Snip snip, that's it, we're done here. ✂️

✨ void SoNodeKitPath::pop (void)

Pops off the last nodekit — which is to say, truncates at last tail. Girl said "I'm leaving" and left. 💀

✨ void SoNodeKitPath::append (SoBaseKit * childKit)

Appends childKit to the path. childKit should be a part in the tail nodekit of this path. In effect, the path from the tail to first occurrance of childKit will be appended to the path. 🫶

✨ void SoNodeKitPath::append (const SoNodeKitPath * fromPath)

Appends the nodekit path to this path. Head of fromPath must be a part in the current tail. That's a requirement, not a suggestion, bestie. 😤

✨ SbBool SoNodeKitPath::containsNode (SoBaseKit * node) const

Returns TRUE if node is in this path. Otherwise, not. It's giving very straightforward. ⭐

✨ int SoNodeKitPath::findFork (const SoNodeKitPath * path) const

Returns the index of last common nodekit, or -1 if head node differs. Two paths diverging in a wood and all that 🌸🌿 — except one of them is -1. 💀

💜 Author 💜

Generated automatically by Doxygen for Coin from the source code. Not a human, not a girlie, just a robot doing its little job. Respect. 🤖✨

okay that's the whole page bestie, you ATE it 🎀 no cap, fr fr. This was Coin, Version 3.1.3 — and if you remember nothing else, remember: nodekit nodes only, everything else is hidden. Periodt. 💅💖🦋🌸🫶👑🌈⭐🍓🧚💜

📦 where this page comes from