SbPList(3)

okay bestie, pull up a chair 🫶 you're reading SbPList(3), straight outta the Library Functions Manual, and honestly? she's a whole vibe. she holds your void pointers. that's it. that's the job. iconic behavior 💅

---

🌸 NAME 🌸

SbPList — the container class for void pointers ✨ (yes, the container class, main character energy only 👑)

---

💖 SYNOPSIS 💖

#include <Inventor/lists/SbPList.h>

🦋 Inherited by

• SbIntList
• SbStringList
• SbVec3fList
• SoActionMethodList
• SoAuditorList [private]
• SoBaseList
• SoDetailList
• SoEngineOutputList
• SoFieldList
• SoPickedPointList
• SoTypeList

(the whole friend group showed up, we love a nepo baby dynasty 💀)

✨ Public Member Functions ✨

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)

🎀 Protected Member Functions 🎀

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

---

📖 Detailed Description 📖

The SbPList class is a container class for void pointers. no cap, that's literally the entire lore. she stores void * and she does it beautifully 🦋

---

🍼 Constructor & Destructor Documentation 🍼

SbPList::SbPList (const int sizehint = DEFAULTSIZE)

okay so this constructor sets the internal allocated size of the list to sizehint. but bestie, listen — the list is still gonna have zero items in it at first. allocating space ≠ having stuff in there, we're just manifesting room ✨

This is the default constructor.

Referenced by: SbIntList::append(), SbVec3fList::append(), copy(), SbIntList::find(), SbIntList::insert(), SbVec3fList::insert(), SoAuditorList::notify(), operator!=(), operator=(), operator==(), SbIntList::operator[](), SbStringList::operator[](), SbVec3fList::operator[](), SoDetailList::operator[](), SbIntList::SbIntList(), SbIntList::SbIntList(), SbPList(), SbStringList::SbStringList(), SoAuditorList::SoAuditorList(), SoBaseList::SoBaseList(), SoBaseList::SoBaseList(), SoBaseList::SoBaseList(), SoDetailList::SoDetailList(), SoDetailList::SoDetailList(), SoDetailList::SoDetailList(), SoEngineOutputList::SoEngineOutputList(), SoEngineOutputList::SoEngineOutputList(), SoEngineOutputList::SoEngineOutputList(), SoFieldList::SoFieldList(), SoFieldList::SoFieldList(), SoFieldList::SoFieldList(), SoPickedPointList::SoPickedPointList(), SoPickedPointList::SoPickedPointList(), SoPickedPointList::SoPickedPointList(), SoTypeList::SoTypeList(), SoTypeList::SoTypeList(), and SoTypeList::SoTypeList().

---

SbPList::SbPList (const SbPList & l)

the copy constructor 🫶 she makes a lil twin.

References: copy(), and SbPList().

---

SbPList::~SbPList ()

the destructor. bye queen, you served 💅

---

🔥 Member Function Documentation 🔥

void SbPList::copy (const SbPList & l)

makes this list a copy of l. twin swap, but legal.

References: expand(), and SbPList().

Referenced by: operator=(), SbPList(), and SoPickedPointList::SoPickedPointList().

---

SbPList & SbPList::operator= (const SbPList & l)

the assignment operator.

References: copy(), and SbPList().

---

void SbPList::fit (void )

fits the allocated array exactly around the length of the list, discarding all the memory spent on those unused pre-allocated array cells. she's on a budget cleanse 🧚

ngl bestie, you should normally not need this and you probably don't want it either. it only exists so you have the option to optimize memory usage in the extremely unlikely scenario where you're yeeting huge SbList objects around your app like confetti 🎀

Referenced by: truncate(), SoDetailList::truncate(), and SoPickedPointList::truncate().

---

void SbPList::append (void * item) [inline]

appends item to the end of the list 💖

and she's self-sufficient — automatically allocates more items internally if needed. no prep required, she just grows 🌱

Referenced by: SoBase::addName(), SoAuditorList::append(), SoBaseList::append(), SoFieldList::append(), SoTypeList::append(), SoOffscreenRenderer::getWriteFiletypeInfo(), and SoAuditorList::notify().

---

int SbPList::find (void * item) const

returns the index of the first occurrence of item in the list, or -1 if item isn't in there at all. ghosted, essentially 👻

Referenced by: SoPath::append(), SoBaseKit::createPathToAnyPart(), SoDB::createRoute(), SbStringList::find(), SoTypeList::find(), SoGroup::findChild(), SoPath::isRelevantNotification(), SoAuditorList::notify(), removeItem(), SoBaseList::removeItem(), SoBase::removeName(), SoBaseKit::setPart(), and SoChildList::traverse().

---

void SbPList::insert (void * item, const int insertbefore)

inserts item at index insertbefore. sneaky lil drop-in ✨

heads up: insertbefore should not be larger than the current number of items in the list. don't test her.

Referenced by: SbStringList::insert(), SoBaseList::insert(), SoChildList::insert(), SoFieldList::insert(), and SoTypeList::insert().

---

void SbPList::removeItem (void * item)

removes an item from the list. if there are several items with the same value, she removes the one with the lowest index. first come, first eliminated 💀

References: find(), and remove().

Referenced by: SoField::disconnect(), and SoField::disconnect().

---

void SbPList::remove (const int index)

removes the item at index, and then everybody after it slides down one place in the list. the whole squad shuffles forward 🚶‍♀️🚶‍♀️🚶‍♀️

Referenced by: SoAuditorList::remove(), SoBaseList::remove(), SoChildList::remove(), SoInput::removeDirectory(), removeItem(), and SoBase::removeName().

---

void SbPList::removeFast (const int index) [inline]

removes the item at index, but this time she yanks the last item into its place and truncates the list. chaotic? yes. fast? also yes. slay 🔥

---

int SbPList::getLength (void ) const [inline]

returns the number of items in the list. the headcount, the census, the attendance sheet 📋

Referenced by: SoBaseList::addReferences(), SoNode::addToCopyDict(), SoPath::append(), SoPath::append(), SoAction::apply(), SoBoxHighlightRenderAction::apply(), SoLineHighlightRenderAction::apply(), SoReorganizeAction::apply(), SoReorganizeAction::apply(), SoText3::computeBBox(), SoBaseList::copy(), SoChildList::copy(), SoDetailList::copy(), SoFile::copyChildren(), SoWWWInline::copyChildren(), SoField::copyConnection(), SoFile::copyContents(), SoWWWInline::copyContents(), SbString::findAll(), SbBSPTree::findClosest(), SoInput::findFile(), SoPathList::findPath(), SoFile::getBoundingBox(), SoVRMLInline::getBoundingBox(), SoWWWInline::getBoundingBox(), SoField::getConnections(), SoFieldConverter::getForwardConnections(), SoAuditorList::getLength(), SoBase::getNamedBase(), SoBase::getNamedBases(), SoGroup::getNumChildren(), SoRayPickAction::getPickedPointList(), SoGroup::GLRender(), SoVRMLAppearance::GLRender(), SoVRMLCollision::GLRender(), SoVRMLShape::GLRender(), SoVRMLBillboard::GLRenderBelowPath(), SoVRMLGroup::GLRenderBelowPath(), SoChildList::insert(), SoCallbackList::invokeCallbacks(), SoInteractionKit::isPathSurrogateInMySubgraph(), SoWWWInline::isURLDataHere(), operator[](), SoNodekitCatalog::printCheck(), SoBaseKit::printTable(), SoAction::pushCurPath(), SoBaseKit::rayPick(), SoInteractionKit::readInstance(), SoField::referencesCopy(), SoBaseList::remove(), SoChildList::remove(), SoInput::removeDirectory(), SbImage::searchForFile(), SoInput::searchForFile(), SoChildList::set(), SoDetailList::set(), SoPickedPointList::set(), SoNodeKitListPart::setContainerType(), SoActionMethodList::setUp(), SoShape::shouldGLRender(), SoBaseList::SoBaseList(), SoDetailList::SoDetailList(), SoPickedPoint::SoPickedPoint(), SoPickedPointList::SoPickedPointList(), SoPathList::sort(), SoState::SoState(), SoToVRML2Action::SoToVRML2Action(), SoChildList::traverse(), SoChildList::traverse(), SoChildList::traverse(), SoBaseList::truncate(), SoDetailList::truncate(), SoPickedPointList::truncate(), SoPathList::uniquify(), SoVRMLParent::updateChildList(), SoAction::usePathCode(), SbVec3fList::~SbVec3fList(), and SoInput::~SoInput().

---

void SbPList::truncate (const int length, const int fit = 0) [inline]

shortens the list so it contains length elements, yeeting items from index length and onwards. ✂️

if fit is non-zero, she'll also shrink the internal size of the allocated array. but beware bestie — that is much less efficient than not re-fitting the array size. convenience tax, lowkey 📉

References: fit().

Referenced by: SbString::findAll(), SoOffscreenRenderer::getWriteFiletypeInfo(), SoActionMethodList::setUp(), SoBaseList::truncate(), SoDetailList::truncate(), SoPickedPointList::truncate(), and SoInput::~SoInput().

---

void ** SbPList::getArrayPtr (const int start = 0) const [inline]

returns a pointer to a non-modifiable array of the list's elements. start says which index into the array you're pointing at. look, don't touch 🫣

and no, the caller is not responsible for freeing that array — it's just a pointer into the internal array the list is already using. you didn't adopt it, you're just visiting.

Referenced by: SbStringList::getArrayPtr(), SoGroup::getChild(), SoGroup::GLRender(), SoVRMLAppearance::GLRender(), SoVRMLCollision::GLRender(), SoVRMLShape::GLRender(), SoVRMLBillboard::GLRenderBelowPath(), SoVRMLGroup::GLRenderBelowPath(), SoVRMLBillboard::GLRenderInPath(), SoVRMLGroup::GLRenderInPath(), SoPathList::sort(), SoPathList::uniquify(), and SoVRMLParent::updateChildList().

---

void *& SbPList::operator[] (const int index) const [inline]

returns the element at index 💫

and the way that she will automatically expand the internal array if index is outside the list's current bounds?? the values of any additional pointers get set to NULL in that case. she makes room and leaves it empty, very demure 🎀

References: getLength().

Referenced by: SoAuditorList::getObject(), SoBaseList::operator[](), SoFieldList::operator[](), SoPickedPointList::operator[](), SoDetailList::set(), SoFieldList::set(), and SoPickedPointList::set().

---

int SbPList::operator== (const SbPList & l) const

the equality operator. returns TRUE if this list and l are identical — like, containing the exact same set of elements identical. soulmates fr fr 💞

References: SbPList().

---

int SbPList::operator!= (const SbPList & l) const [inline]

the inequality operator. returns TRUE if this list and l are not equal. it's giving irreconcilable differences 💔

References: SbPList().

---

void * SbPList::get (const int index) const [inline]

returns the element at index. but — and this is the important part — she does not expand the array bounds if index is outside the list. no growth, no grace, just vibes 🌵

Referenced by: SoFieldList::get(), SoVRMLLOD::GLRenderBelowPath(), and SoBase::removeName().

---

void SbPList::set (const int index, void * item) [inline]

index operator to set the element at index. same deal as get — she does not expand the array bounds if index is outside the list. boundaries are boundaries 💅

Referenced by: SoAuditorList::set(), SoBaseList::set(), and SoTypeList::set().

---

void SbPList::expand (const int size) [inline], [protected]

expands the list to contain size items. heads up: the new items added at the end have undefined value. they're not blank, they're mystery 🕵️‍♀️🔮

Referenced by: copy().

---

int SbPList::getArraySize (void ) const [inline], [protected]

returns the number of items there's actually allocated space for in the array. capacity, not headcount 🏠

See also: getLength()

---

✍️ Author ✍️

Generated automatically by Doxygen for Coin from the source code. (yes, a robot wrote this, and she still ate 🤖💖)

---

and that's the whole page bestie!! 🎀 this was SbPList(3) from Coin, Version 2.5.0 — go forth and store your void pointers responsibly, ily, mwah 🫶✨🌈💜