Open Inventor Release 2024.1.0
 
Loading...
Searching...
No Matches
SoEngineList Class Reference

Maintains a list of pointers to engines. More...

#include <Inventor/lists/SoEngineList.h>

+ Inheritance diagram for SoEngineList:

Public Member Functions

 SoEngineList ()
 Constructor.
 
 SoEngineList (int size)
 Constructor that pre-allocates storage for size pointers.
 
 SoEngineList (const SoEngineList &l)
 Constructor that copies the contents of another list.
 
virtual ~SoEngineList ()
 Destructor.
 
void append (SoEngine *ptr)
 Adds an engine to the end of the list.
 
SoEngineoperator[] (int i) const
 Returns pointer with given index.
 
SoEngineListoperator= (const SoEngineList &l)
 Copies a list, keeping all reference counts correct.
 
- Public Member Functions inherited from SoBaseList
 SoBaseList ()
 Constructor.
 
 SoBaseList (int size)
 Constructor that pre-allocates storage for size pointers.
 
 SoBaseList (const SoBaseList &l)
 Constructor that copies the contents of another list.
 
virtual ~SoBaseList ()
 Destructor.
 
void append (SoBase *ptr)
 Adds a pointer to the end of the list.
 
void insert (SoBase *ptr, int addBefore)
 Inserts given pointer in list before pointer with given index.
 
virtual void remove (int which)
 Removes pointer with given index.
 
virtual void truncate (int start)
 Removes all pointers after one with given index, inclusive.
 
void copy (const SoBaseList &l)
 Copies a list, keeping all reference counts correct.
 
SoBaseListoperator= (const SoBaseList &l)
 Copies a list, keeping all reference counts correct.
 
SoBaseoperator[] (int i) const
 Returns pointer with given index.
 
void set (int i, SoBase *ptr)
 Sets an element of a list.
 
void addReferences (SbBool flag)
 Indicates whether to call ref() and unref() for bases in the list when adding/removing them.
 
void touch (int index=-1)
 Forces each attached SoListSensor to be notified.
 
void addAuditor (void *auditor, SoNotRec::Type type)
 Add an auditor to the list.
 
void removeAuditor (void *auditor, SoNotRec::Type type)
 Remove an auditor to the list.
 
const SoAuditorListgetAuditors () const
 Get current auditor list.
 
int getChangedIndex () const
 Get last changed index element of the list.
 
SoListSensor::ChangeType getChangedType () const
 Get last changed type of the list.
 
void setNotificationInfo (const int changedIndex, const SoListSensor::ChangeType changedType)
 setup notification info for auditor mechanism.
 
- Public Member Functions inherited from SbPList
 SbPList ()
 Default constructor.
 
 SbPList (int initSize)
 Constructor.
 
 SbPList (const SbPList &pl)
 Constructor.
 
virtual ~SbPList ()
 Destructor.
 
void append (void *ptr)
 Adds given pointer to end of list.
 
int find (const void *ptr) const
 Returns index of given pointer in list, or -1 if not found.
 
void insert (void *ptr, int addBefore)
 Inserts given pointer in list before pointer with given index.
 
int getLength () const
 Returns number of pointers in list.
 
void copy (const SbPList &pl)
 Copies a list.
 
SbPListoperator= (const SbPList &pl)
 Assignment operator: copies list into this list.
 
void *& operator[] (const int index) const
 Returns pointer with given index.
 
int operator== (const SbPList &pl) const
 Equality operator.
 
int operator!= (const SbPList &pl) const
 Inequality operator.
 
void swap (int index1, int index2)
 Swaps element having index1 with the one having index2.
 

Detailed Description

Maintains a list of pointers to engines.

This subclass of SoBaseList holds lists of pointers to SoEngines. It updates reference counts to engines in the list whenever adding or removing pointers.

SEE ALSO

SoEngine

Definition at line 73 of file SoEngineList.h.

Constructor & Destructor Documentation

◆ SoEngineList() [1/3]

SoEngineList::SoEngineList ( )
inline

Constructor.

Definition at line 79 of file SoEngineList.h.

◆ SoEngineList() [2/3]

SoEngineList::SoEngineList ( int  size)
inline

Constructor that pre-allocates storage for size pointers.

Definition at line 84 of file SoEngineList.h.

◆ SoEngineList() [3/3]

SoEngineList::SoEngineList ( const SoEngineList l)
inline

Constructor that copies the contents of another list.

Definition at line 89 of file SoEngineList.h.

◆ ~SoEngineList()

virtual SoEngineList::~SoEngineList ( )
inlinevirtual

Destructor.

Definition at line 94 of file SoEngineList.h.

Member Function Documentation

◆ append()

void SoEngineList::append ( SoEngine ptr)
inline

Adds an engine to the end of the list.

Definition at line 99 of file SoEngineList.h.

◆ operator=()

SoEngineList & SoEngineList::operator= ( const SoEngineList l)
inline

Copies a list, keeping all reference counts correct.

Definition at line 109 of file SoEngineList.h.

◆ operator[]()

SoEngine * SoEngineList::operator[] ( int  i) const
inline

Returns pointer with given index.

If requested index does not exists, list is grown to return a valid pointer.

Definition at line 103 of file SoEngineList.h.


The documentation for this class was generated from the following file: