SoNodeKitPath(3)

📦 version 2.5.0, in fedora 43, fedora 44

💖 SoNodeKitPath(3) 💖

okay bestie, welcome to the Library Functions Manual page for SoNodeKitPath — the path class that is literally only nodekits. buckle up, she's specific 🎀

✨ NAME ✨

SoNodeKitPath — the SoNodeKitPath class is a path that contains only nodekit nodes.

🌸 SYNOPSIS 🌸

#include <Inventor/SoNodeKitPath.h>

Inherits SoPath.

💅 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=0)
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

🌈 Friends

int operator== (const SoNodeKitPath &p1, const SoNodeKitPath &p2)

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

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, not visible, gone, bye 🙈

🧚 Constructor & Destructor Documentation 🧚

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

A constructor. ✨

References SoBase::isOfType(), SoDebugError::postInfo(), and SoPath::SoPath().

Referenced by append(), findFork(), and operator==.

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

The destructor. she's done, she's leaving, periodt 💅

👑 Member Function Documentation 👑

int SoNodeKitPath::getLength (void ) const

Returns the length of the path (the number of nodekit nodes). 🍓

References SoBase::isOfType().

Referenced by append(), append(), findFork(), and operator==.

SoNode * SoNodeKitPath::getTail (void ) const

Returns the tail of the path (the last nodekit in the path). the final girl, literally 😭

References SoBase::isOfType(), and SoDebugError::postInfo().

Referenced by append().

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

Returns nodekit number idx in path. 🎯

References SoBase::isOfType(), and SoDebugError::postInfo().

Referenced by append(), findFork(), and operator==.

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

Returns nodekit number idx in the path, from the tail. counting backwards, main character energy 🔥

References SoBase::isOfType(), and SoDebugError::postInfo().

void SoNodeKitPath::truncate (const int length)

Truncates the path at nodekit number length. ✂️

References SoBase::isOfType(), SoDebugError::postInfo(), and SoPath::truncate().

void SoNodeKitPath::pop (void )

Pops off the last nodekit (truncates at last tail). 🫰

References SoBase::isOfType(), SoDebugError::postInfo(), and SoPath::truncate().

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. 🦋

ngl "occurrance" is spelled exactly like that in the original, so I'm keeping it, no cap 💀

References SoPath::append(), SoAction::apply(), getLength(), SoSearchAction::getPath(), getTail(), SoBaseKit::isSearchingChildren(), SoDebugError::postInfo(), SoPath::setHead(), SoSearchAction::setNode(), SoBaseKit::setSearchingChildren(), and SoPath::SoPath().

Referenced by append().

void SoNodeKitPath::append (const SoNodeKitPath * fromPath)

Appends the nodekit path to this path. Head of fromPath must be a part in the current tail. like, mandatory bestie 🫶

References append(), getLength(), getNode(), and SoNodeKitPath().

SbBool SoNodeKitPath::containsNode (SoBaseKit * node) const

Returns TRUE if node is in this path. 💯

References SoPath::containsNode().

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

Returns the index of last common nodekit, or -1 if head node differs. 🌸

References getLength(), getNode(), and SoNodeKitPath().

int operator== (const SoNodeKitPath & p1, const SoNodeKitPath & p2) [friend]

Returns TRUE if paths are equal, FALSE otherwise. twin check ✨

References getLength(), getNode(), operator==, and SoNodeKitPath().

Referenced by operator==.

🌟 Author 🌟

Generated automatically by Doxygen for Coin from the source code.

and that's the whole page bestie, you ate 💅 — this was Coin, Version 2.5.0, signing off, SoNodeKitPath(3) forever, no cap 🎀💖✨

📦 where this page comes from