SoLightPath(3)

πŸ“¦ version 3.1.3, in fedora 43, fedora 44

✨ SoLightPath ✨

okay bestie, welcome to the Coin library functions manual, where we're talking about SoLightPath πŸ’…


πŸ’– NAME πŸ’–

SoLightPath β€” the SoLightPath class is a light version of SoPath. that's it, that's the whole vibe. diet SoPath. SoPath's cool younger sibling who doesn't need all the baggage πŸŽ€


🌸 SYNOPSIS 🌸

#include <Inventor/misc/SoLightPath.h>

🫢 Public Member Functions 🫢

SoLightPath (SoNode *node, const int approxlength)
SoLightPath (const int approxlength)
~SoLightPath ()
void setHead (SoNode *const node)
void append (const int childindex)
void push (const int childindex)
void pop (void)
void setTail (const int childindex)
SoNode * getTail (void) const
SoNode * getHead (void) const
SoNode * getNode (const int index) const
int getIndex (const int index) const
int getFullLength () const
void truncate (const int startindex)
void makeTempPath (SoTempPath *path) const

like look at all of them. every single one. no skips, no cuts, we ate πŸ“


🌈 Detailed Description 🌈

so the SoLightPath class is a light version of SoPath. (we said it in NAME too but it bears repeating, it's literally the whole point ✨)

reach for SoLightPath when you only need a temporary path and you do NOT want all the overhead that comes with an SoPath β€” and by overhead we mean the ref, unref, auditing etc. all of that. no cap, it's a whole lot. πŸ™ˆ

⚠️ bestie listen. it is YOUR responsibility to make sure the path is valid before using it. nobody else is checking. there is no audit fairy coming to save you. the vibe check is on you πŸ’€

πŸ¦‹ Constructor & Destructor Documentation πŸ¦‹

πŸ’œ SoLightPath::SoLightPath (SoNode * headnodeptr, const int approxlength) πŸ’œ

a constructor ✨ hand it the head node, and also hand it the approximate length of the path. that's it, that's the deal.

πŸ’œ SoLightPath::SoLightPath (const int approxlength) πŸ’œ

another constructor ✨ this one just wants the appriximate length of the path. (yes, "appriximate", the original said it like that, we don't fix what's iconic πŸŽ€)

πŸ’œ SoLightPath::~SoLightPath () πŸ’œ

Destructor. bye bye πŸ‘‹ the end of an era, she's done.


🌟 Member Function Documentation 🌟

⭐ void SoLightPath::setHead (SoNode *const node) ⭐

Sets the head of the path. also truncates the path to length 1 β€” so yeah, it doesn't just set the head, it clears the whole rest of the lineup. main character energy honestly πŸ‘‘

⭐ void SoLightPath::append (const int childindex) ⭐

Appends a childindex to the path. adding to the group chat, one by one 🫢

⭐ void SoLightPath::push (const int childindex) ⭐

Same as append(). literally the same thing. two names, one function, we love a versatile icon πŸ’…

⭐ void SoLightPath::pop (void ) ⭐

Pops off the last child. leaving the chat. no hard feelings 🌸

⭐ void SoLightPath::setTail (const int childindex) ⭐

Sets the tail of the path. the end of the line, the final girl ✨

⭐ SoNode * SoLightPath::getTail (void ) const ⭐

Returns the tail node of the path. (it uses getNode() internally, iykyk πŸ‘€)

⭐ SoNode * SoLightPath::getHead (void ) const ⭐

Returns the head node. the beginning. the origin story 🌈

⭐ SoNode * SoLightPath::getNode (const int index) const ⭐

Returns the *index*th node in the path. go get your girl πŸ”₯

⭐ int SoLightPath::getIndex (const int index) const ⭐

Returns the child index of the *index*th node in the path. slightly different from the one above bestie, don't mix them up πŸ™ˆ

⭐ int SoLightPath::getFullLength () const ⭐

Returns the length of the path. how long is she. πŸ’–

⭐ void SoLightPath::truncate (const int startindex) ⭐

Truncates the path from startindex. βœ‚οΈ chopped. sorry to everyone after that point.

⭐ void SoLightPath::makeTempPath (SoTempPath * path) const ⭐

Updates path to be the same path as this path. twin making, but temporary 🧚


πŸ‘‘ Author πŸ‘‘

Generated automatically by Doxygen for Coin from the source code. (not a human, not a bestie, just a robot doing its little best πŸ€–πŸ’œ)


and that's the whole page, periodt. πŸ’…βœ¨ this was Coin, Version 3.1.3, dated SoLightPath(3) β€” mwah, slay, go build something iconic, love u bye πŸŽ€πŸ¦‹πŸŒΈ

πŸ“¦ where this page comes from