Open Inventor Reference
SoAuditorList.h
Go to the documentation of this file.
1 /*
2  *
3  * Copyright (C) 2000 Silicon Graphics, Inc. All Rights Reserved.
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2.1 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * Lesser General Public License for more details.
14  *
15  * Further, this software is distributed without any warranty that it is
16  * free of the rightful claim of any third person regarding infringement
17  * or the like. Any license provided herein, whether implied or
18  * otherwise, applies only to this software file. Patent licenses, if
19  * any, provided herein do not apply to combinations of this program with
20  * other software, or any other product whatsoever.
21  *
22  * You should have received a copy of the GNU Lesser General Public
23  * License along with this library; if not, write to the Free Software
24  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25  *
26  * Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
27  * Mountain View, CA 94043, or:
28  *
29  * http://www.sgi.com
30  *
31  * For further information regarding this notice, see:
32  *
33  * http://oss.sgi.com/projects/GenInfo/NoticeExplan/
34  *
35  */
36 
37 
38 /*
39  * Copyright (C) 1990,91,92 Silicon Graphics, Inc.
40  *
41  _______________________________________________________________________
42  ______________ S I L I C O N G R A P H I C S I N C . ____________
43  |
44  | $Revision: 1.1.1.1 $
45  |
46  | Description:
47  | This file contains the definition of the internal
48  | SoAuditorList class.
49  |
50  | Author(s) : Paul S. Strauss
51  |
52  ______________ S I L I C O N G R A P H I C S I N C . ____________
53  _______________________________________________________________________
54  */
55 
56 #ifndef _SO_AUDITOR_LIST_
57 #define _SO_AUDITOR_LIST_
58 
59 #include <Inventor/SbPList.h>
61 
86 
88  public:
89 
93 
95  void append(void *auditor, SoNotRec::Type type);
96 
98  void set(int index, void *auditor, SoNotRec::Type type);
99 
101  int find(void *auditor, SoNotRec::Type type) const;
102 
104  int findLast(void *auditor, SoNotRec::Type type) const;
105 
107  void * getObject(int index) const;
108  SoNotRec::Type getType(int index) const;
109 
111  void remove(int index);
112  void remove(void *auditor, SoNotRec::Type type)
113  { remove(find(auditor, type)); }
114 
116  int getLength() const;
117 
119  void notify(SoNotList *list);
120 
121  private:
123  void notify1(SoNotList *list, int index);
124 };
125 
126 #endif /* _SO_AUDITOR_LIST_ */
#define SoINTERNAL
Definition: SbBasic.h:155
#define INVENTOR_API
Disable some annoying warnings on MSVC 6.
Definition: SbSystem.h:81
List of generic (void *) pointers.
Definition: SbPList.h:78
void remove(int which)
Removes pointer with given index.
int find(const void *ptr) const
Returns index of given pointer in list, or -1 if not found.
SoAuditorList class.
Definition: SoAuditorList.h:87
int getLength() const
Returns number of auditors in list.
void append(void *auditor, SoNotRec::Type type)
Adds an auditor of the given type to the list.
void remove(int index)
Removes an auditor from the list.
void * getObject(int index) const
Returns object or type for given index.
SoNotRec::Type getType(int index) const
void set(int index, void *auditor, SoNotRec::Type type)
Sets auditor and type for given index.
SoAuditorList()
Constructor and destructor.
int find(void *auditor, SoNotRec::Type type) const
Finds an auditor in the list, returning the index or -1 if not found.
int findLast(void *auditor, SoNotRec::Type type) const
Finds an auditor in the list, starting from the end, returning the index or -1 if not found.
void remove(void *auditor, SoNotRec::Type type)
void notify(SoNotList *list)
Propagates notification to all auditors in list.
Holds a list of SoNotRec notification records.
Type
Notification types (what receives notification).