soauditorlist(3)
NAME
SoAuditorList
SYNOPSIS
#include <Inventor/lists/SoAuditorList.h> Inherits SbPList.
Detailed Description
The SoAuditorList class is used to keep track of auditors for certain
object classes.
- This class is mainly for internal use (from SoBase) and it should not
be necessary to be familiar with it for 'ordinary' Coin use.
- Public Member Functions
- SoAuditorList (void)
~SoAuditorList ()
void append (void *const auditor, const SoNotRec::Type type) void set (const int index, void *const auditor, const SoNotRec::Typetype) - void * getObject (const int index) const
SoNotRec::Type getType (const int index) const int getLength (void) const
int find (void *const auditor, const SoNotRec::Type type) const void remove (const int index)
void remove (void *const auditor, const SoNotRec::Type type) void notify (SoNotList *l)
Constructor & Destructor Documentation
- SoAuditorList::SoAuditorList (void)
- Default constructor.
- SoAuditorList::~SoAuditorList ()
- Destructor.
Member Function Documentation
- void SoAuditorList::append (void *const auditor, const SoNotRec::Type
- type)
Append an auditor of type to the list. - 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. - 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.
- Reimplemented from SbPList.
- 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. - References getLength(), getObject(), and getType().
- Referenced by remove().
- void SoAuditorList::remove (const int index)
- Remove auditor at index.
- Reimplemented from SbPList.
- References getLength(), and SbPList::remove().
- Referenced by SoBase::getAuditors(), and SoBase::~SoBase().
- void SoAuditorList::remove (void *const auditor, const SoNotRec::Type
- type)
Remove auditor of type from list. - References find().
- void SoAuditorList::notify (SoNotList * l)
- Send notification to all our auditors.
- References SbPList::append(), SbPList::find(), getLength(),
getObject(), and getType().
Author
- Generated automatically by Doxygen for Coin from the source code.