SoPathList(3)

🦋 SoPathList(3) 🦋

okay so bestie, welcome to the Library Functions Manual — yes we're doing a whole manual page today, and honestly? it's giving documentation excellence 💅

---

✨ NAME ✨

SoPathList — the container class for pointers to SoPath objects. she holds your SoPath pointers, she's organized, she's iconic 👑

---

🌸 SYNOPSIS 🌸

#include <Inventor/lists/SoPathList.h>

Inherits SoBaseList.

💖 Public Member Functions 💖

• SoPathList (void)
• SoPathList (const int size)
• SoPathList (const SoPathList &pl)
• ~SoPathList ()
• void append (SoPath *const path)
• SoPath * operator[] (const int i) const
• SoPathList & operator= (const SoPathList &pl)
• int findPath (const SoPath &path) const
• void sort (void)
• void uniquify (void)

💜 Public Member Functions inherited from SoBaseList 💜

• SoBaseList (void)
• SoBaseList (const int size)
• SoBaseList (const SoBaseList &l)
• ~SoBaseList ()
• void append (SoBase *ptr)
• void insert (SoBase *ptr, const int addbefore)
• void remove (const int index)
• void removeItem (SoBase *item)
• void truncate (const int length)
• void copy (const SoBaseList &l)
• SoBaseList & operator= (const SoBaseList &l)
• SoBase * operator[] (const int i) const
• void set (const int i, SoBase *const ptr)
• void addReferences (const SbBool flag)
• SbBool isReferencing (void) const

🎀 Public Member Functions inherited from SbPList 🎀

• SbPList (const int sizehint=DEFAULTSIZE)
• SbPList (const SbPList &l)
• ~SbPList ()
• void copy (const SbPList &l)
• SbPList & operator= (const SbPList &l)
• void fit (void)
• void append (void *item)
• int find (void *item) const
• void insert (void *item, const int insertbefore)
• void removeItem (void *item)
• void remove (const int index)
• void removeFast (const int index)
• int getLength (void) const
• void truncate (const int length, const int fit=0)
• void ** getArrayPtr (const int start=0) const
• void *& operator[] (const int index) const
• int operator== (const SbPList &l) const
• int operator!= (const SbPList &l) const
• void * get (const int index) const
• void set (const int index, void *item)

🌈 Additional Inherited Members 🌈

🧚 Protected Member Functions inherited from SbPList 🧚

• void expand (const int size)
• int getArraySize (void) const

---

👑 Detailed Description 👑

The SoPathList class is a container for pointers to SoPath objects. fr fr, that's her whole job and she does it flawlessly 💅

Since this class inherits SoBaseList, referencing and dereferencing will by default be done on the objects at append(), remove(), insert() etc. so like, the reference counting is handled for you, no cap 🫶

---

💖 Constructor & Destructor Documentation 💖

SoPathList::SoPathList (void )

The default constructor. the blueprint era ✨

References SoBaseList::SoBaseList().

Referenced by operator=(), and SoPathList().

SoPathList::SoPathList (const int size)

Constructor with a hint about the number of elements the list will hold. it's giving "manifesting capacity" 🌸

See also

• SoBaseList::SoBaseList(const int)

References SoBaseList::SoBaseList().

SoPathList::SoPathList (const SoPathList & pl)

Copy constructor. 📋

Does a shallow copy of the SoPath pointer values, but updates reference count. so the pointers get duplicated, the reference count gets bumped, and everybody stays safe 🫶

See also

• SoBaseList::SoBaseList(const SoBaseList &)

References SoBaseList::SoBaseList(), and SoPathList().

SoPathList::~SoPathList ()

Destructor. she's done, she's logging off, she ate and now she's leaving 💀

See also

• SoBaseList::~SoBaseList()

---

⭐ Member Function Documentation ⭐

void SoPathList::append (SoPath *const path)

Append ptr to the list. just add it to the end, bestie, it's that simple 💅

See also

• SoBaseList::append()

References SoBaseList::append().

Referenced by SoAction::apply(), and SoPath::getByName().

SoPath * SoPathList::operator[] (const int i) const

Return node pointer at index i. yes queen, give me index i 👑

See also

• SoBaseList::operator[]()

References SoBaseList::operator[]().

SoPathList & SoPathList::operator= (const SoPathList & pl)

Shallow copy of contents of list pl to this list. 📝

See also

• SoBaseList::operator=()

References SoBaseList::copy(), and SoPathList().

int SoPathList::findPath (const SoPath & path) const

Find and return index of first item equal to path. the search begins and she will find it 🔍

References SbPList::getLength().

void SoPathList::sort (void )

Sort paths in list according to how early they are run into when traversing the scene graph. it's a whole ordering situation, and honestly the scene graph traversal order is the moment 🌈

References SbPList::getArrayPtr(), and SbPList::getLength().

Referenced by SoAction::apply().

void SoPathList::uniquify (void )

Removes identical paths and paths that go through the tail of another path. bye bye duplicates, it's a purge and honestly she needed it ✨

⚠️ Note that this method assumes the list to be in a sorted order. like, she is NOT checking. sort first or perish, bestie 😭

See also

• sort()

References SoPath::findFork(), SbPList::getArrayPtr(), SbPList::getLength(), SoFullPath::getLength(), and SoBaseList::remove().

Referenced by SoAction::apply().

---

🌟 Author 🌟

Generated automatically by Doxygen for Coin from the source code. not me being auto-generated 💅 the source code did all the work and honestly? slay.

---

that's the whole page, you made it to the end, so proud of you bestie 🫶

and for the official sign-off: this gorgeous little manual page is from Coin, Version 2.5.0, and she answers to the name SoPathList(3). bye bye, go read sort() before you uniquify() 💖🎀🦋