SoFieldList(3)

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

πŸ’– SoFieldList β€” the Coin man page, but make it cute πŸ’–

okay bestie, so this is a page from the Coin library manual β€” section 3, library functions, and the whole thing is about a lil class called SoFieldList. no cap, it's exactly what it sounds like: a container for pointers to SoField objects. iconic behavior honestly.


✨ NAME ✨

SoFieldList β€” the SoFieldList class is a container for pointers to SoField objects. that's the whole vibe. a list. of field pointers. slay.


🌸 SYNOPSIS 🌸

#include <Inventor/lists/SoFieldList.h>

it inherits from SbPList, so it's picking up all the parent energy, bestie. πŸ’…

Public Member Functions

SoFieldList (void)
SoFieldList (const int sizehint)
SoFieldList (const SoFieldList &l)
void append (SoField *field)
void insert (SoField *field, const int insertbefore)
SoField * operator[] (const int idx) const
void set (const int idx, SoField *field)
SoField * get (const int idx) const

Public Member Functions inherited from SbPList

these are the ones it got from its parent, and yes, they're all still there, we do not gatekeep:

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

the secret menu, iykyk:

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

πŸ¦‹ Detailed Description πŸ¦‹

the SoFieldList class is a container for pointers to SoField objects. periodt. πŸ’–

See also: SbList


πŸŽ€ Constructor & Destructor Documentation πŸŽ€

SoFieldList::SoFieldList (void ) [inline]

default constructor. does exactly what it says on the tin, no notes. ✨

References SbPList::SbPList().

Referenced by SoFieldList().

SoFieldList::SoFieldList (const int sizehint) [inline]

this constructor initializes the internal allocated size for the list to sizehint. but heads up bestie β€” the list will still initially contain zero items. so like, it's got room but nobody's home yet. 🫢

See also: SbList::SbList(const int)

References SbPList::SbPList().

SoFieldList::SoFieldList (const SoFieldList & l) [inline]

copy constructor. clone the whole thing, main character duplicated energy. πŸ‘‘

See also: SbList::SbList(const SbList<Type> & l)

References SbPList::SbPList(), and SoFieldList().


πŸ”₯ Member Function Documentation πŸ”₯

void SoFieldList::append (SoField * field) [inline]

overridden from the parent so it can accept an SoField pointer argument. glow-up from void * to the real thing. πŸ’…

References SbPList::append().

Referenced by SoField::connectFrom(), SoFieldContainer::getAllFields(), SoFieldContainer::getFields(), SoEngineOutput::getForwardConnections(), and SoField::getForwardConnections().

void SoFieldList::insert (SoField * field, const int insertbefore) [inline]

overridden from the parent so it can accept an SoField pointer argument. sliding in at exactly the spot you said. 🌈

References SbPList::insert().

SoField * SoFieldList::operator[] (const int idx) const [inline]

overridden from the parent to return an SoField pointer. yes, it gives you back a real typed pointer, not just a random void *. we love type safety. πŸ’–

References SbPList::operator[]().

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

overridden from the parent so it can accept an SoField pointer argument. drop it in, replace what was there, done. ✨

References SbPList::operator[]().

SoField * SoFieldList::get (const int idx) const [inline]

overridden from the parent to return an SoField pointer. same deal, but it's get not []. πŸŽ€

References SbPList::get().


πŸ’œ Author πŸ’œ

generated automatically by Doxygen for Coin from the source code. not a human, just vibes and a parser. 😭


okay that's the whole page bestie, you're so welcome. this was SoFieldList(3) from Coin, Version 2.5.0 β€” go forth and build your lists, you've got this. πŸ¦‹πŸŒΈπŸ’–

πŸ“¦ where this page comes from