SoAuditorList(3)

💖 SoAuditorList 💖

okay bestie, so this is the manual page for SoAuditorList(3) from the Library Functions Manual, and I need you to know it's lowkey a backend diva. she doesn't want the spotlight, but the whole show does NOT go on without her. let's get into it 🫶

---

✨ NAME ✨

SoAuditorList — the class that keeps track of auditors for certain object classes. yes, that's literally her whole job, and she ate 💅

---

🌸 SYNOPSIS 🌸

#include <Inventor/lists/SoAuditorList.h>

she Inherits SbPList, so all that list-girl energy is inherited, no cap 🧚

👑 Public Member Functions

SoAuditorList (void)
~SoAuditorList ()
void append (void *const auditor, const SoNotRec::Type type)
void set (const int index, void *const auditor, const SoNotRec::Type type)
void * getObject (const int index) const
SoNotRec::Type getType (const int index) const
int getLength (void) const
int find (void *const auditor, const SoNotRec::Type type) const
void remove (const int index)
void remove (void *const auditor, const SoNotRec::Type type)
void notify (SoNotList *l)

---

🦋 Detailed Description 🦋

so the SoAuditorList class is used to keep track of auditors for certain object classes. that's the mission statement, that's the vibe, that's the whole personality.

this class is mainly for internal use (from SoBase), and it should not be necessary to be familiar with it for "ordinary" Coin use. so like… if you're just a casual Coin user living your best life, you can skip this one fr fr. this is backstage-pass content only. 🙈

---

🎀 Constructor & Destructor Documentation 🎀

💖 SoAuditorList::SoAuditorList (void )

Default constructor. she's born, she's ready, iconic from day one ✨

💖 SoAuditorList::~SoAuditorList ()

Destructor. she's done, she's leaving the group chat, we love a clean exit 💅

---

🌈 Member Function Documentation 🌈

• void SoAuditorList::append (void *const auditor, const SoNotRec::Type type) — appends an auditor of type to the list. adding a new friend to the roster 🫶
• void SoAuditorList::set (const int index, void *const auditor, const SoNotRec::Type type) — sets the auditor pointer and the auditor type in the list at index. glow-up in place, no moving required 💖
• void * SoAuditorList::getObject (const int index) const — returns the auditor pointer at index. who's that at position index? it's her 👑
• SoNotRec::Type SoAuditorList::getType (const int index) const — returns the auditor type at index. and what's her vibe? here's the answer ✨
• int SoAuditorList::getLength (void ) const — returns the number of elements in the list. headcount check, bestie 🌸
• int SoAuditorList::find (void *const auditor, const SoNotRec::Type type) const — finds an auditor of type in the list and returns the index. returns -1 if the auditor is not in the list. so if you get a -1, she's just not there, don't take it personally 💀
• void SoAuditorList::remove (const int index) — removes the auditor at index. bye bestie, blocking you at that exact spot 🙈
• void SoAuditorList::remove (void *const auditor, const SoNotRec::Type type) — removes an auditor of type from the list. same energy, but you're finding her by type instead of by seat number 🦋
• void SoAuditorList::notify (SoNotList * l) — sends notification to all our auditors. group announcement, everyone needs to know, main character broadcast energy 🔥

---

💜 Author 💜

generated automatically by Doxygen for Coin from the source code. not a human, just a robot doing her little documentation ballet 🤖🎀

---

okay and for the cute sign-off: this whole page is from Coin, Version 3.1.3, and yeah that's the source/version and the date line energy wrapped up in one little bow. she's SoAuditorList(3) and she served 💅⭐