SoDetailList(3) Coin SoDetailList(3)NAME
SoDetailList -
The SoDetailList class is a container for pointers to SoDetail objects.
This list class will delete the details when destructed/truncated, or when a detail in the list is replaced by another detail. The caller
is responsible for allocating the details passed to the list, but should not deallocate them since this will be handled by the list.
SYNOPSIS
#include <Inventor/lists/SoDetailList.h>
Inherits SbPList.
Public Member Functions
SoDetailList (void)
SoDetailList (const int sizehint)
SoDetailList (const SoDetailList &l)
~SoDetailList ()
void append (SoDetail *detail)
void insert (SoDetail *detail, const int insertbefore)
void truncate (const int length, const int fit=0)
void copy (const SoDetailList &l)
SoDetailList & operator= (const SoDetailList &l)
SoDetail * operator[] (const int idx) const
void set (const int index, SoDetail *item)
Additional Inherited Members
Detailed Description
The SoDetailList class is a container for pointers to SoDetail objects.
This list class will delete the details when destructed/truncated, or when a detail in the list is replaced by another detail. The caller
is responsible for allocating the details passed to the list, but should not deallocate them since this will be handled by the list.
See also:
SbPList
Constructor &; Destructor Documentation
SoDetailList::SoDetailList (void) [inline]
Default constructor.
SoDetailList::SoDetailList (const intsizehint) [inline]
This constructor initializes the internal allocated size for the list to sizehint. Note that the list will still initially contain zero
items.
See also:
SbList::SbList(const int sizehint)
SoDetailList::SoDetailList (const SoDetailList &l)
Copy constructor.
SoDetailList::~SoDetailList ()
Destructor.
Member Function Documentation
void SoDetailList::truncate (const intlength, const intfit = 0)
Overridden to delete truncated items.
Reimplemented from SbPList.
void SoDetailList::copy (const SoDetailList &l)
Overridden to copy items, not just pointers.
SoDetail * SoDetailList::operator[] (const intidx) const [inline]
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.
void SoDetailList::set (const intidx, SoDetail *detail)
Overridden to delete old item.
Author
Generated automatically by Doxygen for Coin from the source code.
Version 3.1.3 Wed May 23 2012 SoDetailList(3)
Check Out this Related Man Page
SbPList(3) Coin SbPList(3)NAME
SbPList -
The SbPList class is a container class for void pointers.
SYNOPSIS
#include <Inventor/lists/SbPList.h>
Inherited by SbIntList, SbStringList, SbVec3fList, SoActionMethodList, SoAuditorList [private], SoBaseList, SoDetailList,
SoEngineOutputList, SoFieldList, SoPickedPointList, and SoTypeList.
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.
Constructor &; Destructor Documentation
SbPList::SbPList (const intsizehint = DEFAULTSIZE)
This constructor initializes the internal allocated size for the list to sizehint. Note that the list will still initially contain zero
items.
Default constructor.
SbPList::SbPList (const SbPList &l)
Copy constructor.
SbPList::~SbPList ()
Destructor.
Member Function Documentation
void SbPList::copy (const SbPList &l)
Make this list a copy of l.
SbPList & SbPList::operator= (const SbPList &l)
Assignment operator
void SbPList::fit (void)
Fit the allocated array exactly around the length of the list, descarding memory spent on unused pre-allocated array cells.
You should normally not need or want to call this method, and it is only available for the sake of having the option to optimize memory
usage for the unlikely event that you should throw around huge SbList objects within your application.
void SbPList::append (void *item) [inline]
Append item to the end of the list.
Automatically allocates more items internally if needed.
int SbPList::find (void *item) const
Return index of first occurrence of item in the list, or -1 if item is not present.
void SbPList::insert (void *item, const intinsertbefore)
Insert item at index insertbefore.
insertbefore should not be larger than the current number of items in the list.
void SbPList::removeItem (void *item)
Removes an item from the list. If there are several items with the same value, removes the item with the lowest index.
void SbPList::remove (const intindex)
Remove the item at index, moving all subsequent items downwards one place in the list.
Reimplemented in SoAuditorList, SoChildList, and SoBaseList.
void SbPList::removeFast (const intindex) [inline]
Remove the item at index, moving the last item into its place and truncating the list.
int SbPList::getLength (void) const [inline]
Returns number of items in the list.
Reimplemented in SoAuditorList.
void SbPList::truncate (const intlength, const intfit = 0) [inline]
Shorten the list to contain length elements, removing items from index length and onwards.
If fit is non-zero, will also shrink the internal size of the allocated array. Note that this is much less efficient than not re-fitting
the array size.
Reimplemented in SoPickedPointList, and SoDetailList.
void ** SbPList::getArrayPtr (const intstart = 0) const [inline]
Returns pointer to a non-modifiable array of the lists elements. start specifies an index into the array.
The caller is not responsible for freeing up the array, as it is just a pointer into the internal array used by the list.
void *& SbPList::operator[] (const intindex) const [inline]
Returns element at index.
Will automatically expand the size of the internal array if index is outside the current bounds of the list. The values of any additional
pointers are then set to NULL.
Reimplemented in SoDetailList, SbVec3fList, SoBaseList, SbIntList, SbStringList, SoFieldList, SoPickedPointList, SoEngineOutputList,
SoEngineList, SoNodeList, SoPathList, and SoTypeList.
int SbPList::operator== (const SbPList &l) const
Equality operator. Returns TRUE if this list and l are identical, containing the exact same ordered set of elements.
SbBool SbPList::operator!= (const SbPList &l) const [inline]
Inequality operator. Returns TRUE if this list and l are not equal.
void * SbPList::get (const intindex) const [inline]
Returns element at index. Does not expand array bounds if index is outside the list.
Reimplemented in SoFieldList.
void SbPList::set (const intindex, void *item) [inline]
Index operator to set element at index. Does not expand array bounds if index is outside the list.
void SbPList::expand (const intsize) [inline], [protected]
Expand the list to contain size items. The new items added at the end have undefined value.
int SbPList::getArraySize (void) const [inline], [protected]
Return number of items there's allocated space for in the array.
See also:
getLength()
Author
Generated automatically by Doxygen for Coin from the source code.
Version 3.1.3 Wed May 23 2012 SbPList(3)