SoAuditorList(3)

💖 NAME 💖

Hii bestie, welcome to the SoAuditorList(3) page from the Library Functions Manual ✨

SoAuditorList — the class that keeps track of auditors for certain object classes. That's it, that's the whole gig, and it does it flawlessly no cap 👑

---

🦋 SYNOPSIS 🦋

#include <Inventor/lists/SoAuditorList.h>

Inherits SbPList. Yes she's an heiress, the inheritance is real 💅

✨ Public Member Functions ✨

• SoAuditorList (void) — the default constructor, no args, no drama
• ~SoAuditorList () — the destructor, she's done here 🫶
• void append (void *const auditor, const SoNotRec::Type type) — tack an auditor of type onto the list
• void set (const int index, void *const auditor, const SoNotRec::Type type) — drop an auditor pointer + auditor type into the list at index
• void * getObject (const int index) const — hand back the auditor pointer sitting at index
• SoNotRec::Type getType (const int index) const — hand back the auditor type sitting at index
• int getLength (void) const — how many elements are in the list, the headcount fr
• int find (void *const auditor, const SoNotRec::Type type) const — go find an auditor of type in the list and give back its index; returns -1 if that auditor isn't in the list at all 😭
• void remove (const int index) — yeet the auditor at index
• void remove (void *const auditor, const SoNotRec::Type type) — yeet the auditor of type out of the list
• void notify (SoNotList *l) — send notification out to all our auditors, group chat blast 📣

---

🎀 Detailed Description 🎀

The SoAuditorList class is used to keep track of auditors for certain object classes.

Okay real talk: this class is mainly for internal use (it gets used from SoBase), and if you're doing "ordinary" Coin stuff you genuinely should not need to be familiar with it. She's backstage crew, not the main character — but she IS carrying the whole show, periodt 💜

---

🌸 Constructor & Destructor Documentation 🌸

SoAuditorList::SoAuditorList (void )

Default constructor. Nothing spicy, just vibes ✨

References SbPList::SbPList().

SoAuditorList::~SoAuditorList ()

Destructor. Cleanup time, goodbye bestie 👋

---

🧚 Member Function Documentation 🧚

void SoAuditorList::append (void *const auditor, const SoNotRec::Type type)

Append an auditor of type to the list. Slay 💅

References SbPList::append().

void SoAuditorList::set (const int index, void *const auditor, const SoNotRec::Type type)

Set auditor pointer and auditor type in list at index. So precise, so demure 🎀

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

void * SoAuditorList::getObject (const int index) const

Returns auditor pointer at index.

References SbPList::operator[]().

Referenced by find(), and notify().

SoNotRec::Type SoAuditorList::getType (const int index) const

Returns auditor type at index.

Referenced by find(), and notify().

int SoAuditorList::getLength (void ) const

Returns number of elements in list. The census, the roll call, the attendance sheet 📋

References SbPList::getLength().

Referenced by find(), SoBase::getAuditors(), notify(), remove(), and set().

int SoAuditorList::find (void *const auditor, const SoNotRec::Type type) const

Find auditor of type in list and return index. Returns -1 if auditor is not in the list. Ghosted, basically 👻

References getLength(), getObject(), and getType().

Referenced by remove().

void SoAuditorList::remove (const int index)

Remove auditor at index.

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

Referenced by SoBase::getAuditors(), remove(), and SoBase::~SoBase().

void SoAuditorList::remove (void *const auditor, const SoNotRec::Type type)

Remove auditor of type from list.

References find(), and remove().

void SoAuditorList::notify (SoNotList * l)

Send notification to all our auditors. It's giving "hey everyone, heads up" 📣✨

References SbPList::append(), SbPList::find(), getLength(), getObject(), getType(), and SbPList::SbPList().

---

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code. Not a human, just a very diligent robot 🫶

---

Okay that's the whole page bestie, every flag, every reference, nothing skipped, we ate and left zero crumbs 🍓

Coin — Version 2.5.0 — SoAuditorList(3), signing off like the icon she is 💖✨🎀