SoAuditorList.3coin3 man page

SoAuditorList — 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.  

Synopsis

#include <Inventor/lists/SoAuditorList.h>

Inherits SbPList.

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::Type type)
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)

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.

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.

void SoAuditorList::set (const int index, void *const auditor, const SoNotRec::Type type)

Set auditor pointer and auditor type in list at index.

void * SoAuditorList::getObject (const int index) const

Returns auditor pointer at index.

SoNotRec::Type SoAuditorList::getType (const int index) const

Returns auditor type at index.

int SoAuditorList::getLength (void) const

Returns number of elements in list.

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.

void SoAuditorList::remove (const int index)

Remove auditor at index.

void SoAuditorList::remove (void *const auditor, const SoNotRec::Type type)

Remove auditor of type from list.

void SoAuditorList::notify (SoNotList * l)

Send notification to all our auditors.

Author

Generated automatically by Doxygen for Coin from the source code.

Referenced By

The man page SoAuditorList.3coin2(3) is an alias of SoAuditorList.3coin3(3).

Wed Aug 2 2017 Version 3.1.3 Coin