Provided by: libcoin60-doc_3.1.3-2_all bug

NAME

       SoBaseList -

       The SoBaseList class is a container for pointers to SoBase derived objects.

       The additional capability of the SoBaseList class over its parent class, SbPList, is to
       automatically handle referencing and dereferencing of items as they are added or removed
       from the lists.

SYNOPSIS

       #include <Inventor/lists/SoBaseList.h>

       Inherits SbPList.

       Inherited by SoEngineList, SoNodeList, and SoPathList.

   Public Member Functions
       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

Detailed Description

       The SoBaseList class is a container for pointers to SoBase derived objects.

       The additional capability of the SoBaseList class over its parent class, SbPList, is to
       automatically handle referencing and dereferencing of items as they are added or removed
       from the lists.

Constructor & Destructor Documentation

   SoBaseList::SoBaseList (void) Default constructor.
   SoBaseList::SoBaseList (const intsize) Constructor with a hint about the maximum number of
       pointers in the list.
       See also:
           SbPList::SbPList(const int)

   SoBaseList::SoBaseList (const SoBaseList &l) Copy constructor.
       Shallow copy the items of l into this list, adding to the item reference counts if the
       reference flag of l is TRUE.

       See also:
           SbPList::SbPList(const SbPList &)

   SoBaseList::~SoBaseList () Destructor. Dereferences items before freeing resources.

Member Function Documentation

   void SoBaseList::append (SoBase *ptr) Append ptr to list, adding to the reference count of the
       object (unless addReferences() has been set to FALSE).
       See also:
           SbPList::append()

   void SoBaseList::insert (SoBase *ptr, const intaddbefore) Insert ptr in the list at position
       addbefore, adding to the reference count of the object (unless addReferences() has been
       set to FALSE).
       See also:
           SbPList::insert()

   void SoBaseList::remove (const intindex) Removes item at index from the list, dereferencing
       the object (unless addReferences() has been set to FALSE).
       See also:
           SbPList::remove()

       Reimplemented from SbPList.

       Reimplemented in SoChildList.

   void SoBaseList::removeItem (SoBase *item) Removes item from the list, dereferencing the
       object (unless addReferences() has been set to FALSE).
       See also:
           SbPList::removeItem()

   void SoBaseList::truncate (const intlength) Makes the list contain only the length first
       items, removing all items from index length and onwards to the end of the list.
       Dereferences the objects to be removed (unless addReferences() has been set to FALSE).
       See also:
           SbPList::truncate()

       Reimplemented in SoChildList.

   void SoBaseList::copy (const SoBaseList &l) Shallow copy of the item pointers of l list into
       this one, first removing all items in this list.
   SoBaseList & SoBaseList::operator= (const SoBaseList &l) Shallow copy of the SoBase pointers
       from l into this one, returning a pointer to ourself.
       See also:
           copy()

   SoBase * SoBaseList::operator[] (const intidx) const Returns element at idx.
       Will automatically expand the size of the internal array if idx is outside the current
       bounds of the list. The values of any additional pointers are then set to NULL.

       Reimplemented from SbPList.

       Reimplemented in SoEngineList, SoNodeList, and SoPathList.

   void SoBaseList::set (const inti, SoBase *constptr) Index operator to set element at i. Does
       not expand array bounds if i is outside the list.
   void SoBaseList::addReferences (const SbBoolflag) Decide whether or not the SoBase items
       should be automatically referenced and dereferenced as they are added and removed from the
       list.
       Default setting is to do referencing.

   SbBool SoBaseList::isReferencing (void) const Return whether the SoBase instances are
       automatically referenced and dereferenced when they are added and removed from the list.
       This function is an extension for Coin, and it is not available in the original SGI Open
       Inventor v2.1 API.

       See also:
           addReferences()

       Since:
           Coin 2.0

Author

       Generated automatically by Doxygen for Coin from the source code.