SoTempPath(3)

📦 version 3.1.3, in fedora 43, fedora 44

💖 SoTempPath(3) 💖

okay so bestie, welcome to the Library Functions Manual, section 3. we're talking about SoTempPath today and honestly? she's niche but she's serving. 🎀

✨ NAME ✨

SoTempPath — the class that stores temporary paths. that's the whole job description, and she does it. 💅

🌸 SYNOPSIS 🌸

#include <Inventor/misc/SoTempPath.h>

Inherits SoFullPath.

🫶 Public Member Functions

  • SoTempPath (const int approxlength)
  • void simpleAppend (SoNode *const node, const int index)
  • void replaceTail (SoNode *const node, const int index)

🌈 Public Member Functions inherited from SoFullPath

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

okay so here's the tea: the SoTempPath class is used to store temporary paths. periodt. 💅

and the way it works? the path simply turns off auditing in the constructor, and then leaves you — yes you, bestie — with the responsibility of keeping the path valid. no cap. that's the deal. 🙈

⚠️ real talk: auditing is OFF, so keeping this path valid is 100% on you. it's giving "you break it, you bought it." 😭

🎀 Constructor & Destructor Documentation 🎀

SoTempPath::SoTempPath (const int approxlength)

Constructor. iconic. that's it, that's the whole vibe. ✨

🔥 Member Function Documentation 🔥

void SoTempPath::simpleAppend (SoNode *const node, const int index)

Append a node to the path — and yeah, the node is specified by node and its parent child index. this method is only available in SoTempPath, because it will not consider auditing or hidden children. so like, it's fast and unfiltered, bestie. 🦋

void SoTempPath::replaceTail (SoNode *const node, const int index)

Replace the tail of this path. the node is specified by node and parent child index. and same energy as above: this method is only available in SoTempPath, since it will not consider auditing or hidden children. 💜

🌸 Author 🌸

Generated automatically by Doxygen for Coin from the source code. (not a human, just vibes and a parser ✨)

and that's a wrap, gorgeous 🫶 this lil page came to you from Coin, Version 3.1.3, SoTempPath(3), and it's been an absolute pleasure. mwah 💋🎀

📦 where this page comes from