1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
|
/*
*
* Copyright (C) 2000 Silicon Graphics, Inc. All Rights Reserved.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* Further, this software is distributed without any warranty that it is
* free of the rightful claim of any third person regarding infringement
* or the like. Any license provided herein, whether implied or
* otherwise, applies only to this software file. Patent licenses, if
* any, provided herein do not apply to combinations of this program with
* other software, or any other product whatsoever.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
* Mountain View, CA 94043, or:
*
* http://www.sgi.com
*
* For further information regarding this notice, see:
*
* http://oss.sgi.com/projects/GenInfo/NoticeExplan/
*
*/
// -*- C++ -*-
/*
* Copyright (C) 1990,91,92 Silicon Graphics, Inc.
*
_______________________________________________________________________
______________ S I L I C O N G R A P H I C S I N C . ____________
|
| $Revision: 1.1.1.1 $
|
| Description:
| Definition of (internal) SoNotRec and SoNotList classes, which
| handle notification propagation through instances of classes
| derived from SoBase.
|
| Author(s) : Paul S. Strauss, Nick Thompson
|
______________ S I L I C O N G R A P H I C S I N C . ____________
_______________________________________________________________________
*/
#ifndef _SO_NOTIFICATION_
#define _SO_NOTIFICATION_
#include <Inventor/SbBasic.h>
class SoBase;
class SoField;
//////////////////////////////////////////////////////////////////////////////
//
// Class: SoNotRec
//
// Records one step in the path taken by notification. Instances of
// this class are typically allocated on the stack as automatic
// variables.
//
// There is an SoBase pointer in the record that points to the base
// (node, path, or engine) from which the notification is being
// propagated. The contents of this pointer depend on the type of
// the notification. The type also indicates the nature of the
// notification. These are the possible types:
//
// CONTAINER: A field has changed value and is notifying its
// container node or engine. The base is the container.
//
// PARENT: A child of a group has changed and is notifying
// its parent. The base is the child.
//
// SENSOR: A node or path is notifying a sensor of a change.
// The base is the thing to which the sensor is attached.
//
// FIELD: A field in a node or engine is notifying the
// field to which it is connected. The base is the
// container of the source field.
//
// ENGINE: An engine is notifying a field to which it is
// connected. The base is the engine.
//
//////////////////////////////////////////////////////////////////////////////
SoINTERNAL class SoNotRec {
public:
// Notification types (what receives notification). Note that
// these are also used for maintaining lists of auditors in
// SoBase instances. Each auditor uses one of these types to
// indicate how it is auditing the instance. This is then
// propagated to the auditors in the notification records.
enum Type {
CONTAINER, // Field notifying container
PARENT, // Child node notifying parent
SENSOR, // Some base notifying sensor
FIELD, // Field notifying connected field
ENGINE // Engine notifying connected field
};
// Constructor - passed the base pointer
SoNotRec(SoBase *b) { base = b; }
// Sets notification type
void setType(SoNotRec::Type t) { type = t; }
// Returns base pointer, type, or previous record in list
SoBase * getBase() const { return base; }
SoNotRec::Type getType() const { return type; }
const SoNotRec * getPrevious() const { return previous; }
// Sets previous record pointer
void setPrevious(SoNotRec *prev) { previous = prev; }
// Prints a notification record for debugging
void print(FILE *fp) const;
private:
SoBase *base; // Base that changed
Type type; // Type of record
const SoNotRec *previous; // Pointer to previous record
};
//////////////////////////////////////////////////////////////////////////////
//
// Class: SoNotList
//
// Holds a list of SoNotRec notification records. Points to the first
// and last records in the list. The records are linked backwards by
// "previous" pointers.
//
// The list also points to the first notification record that
// involves a node. This info is used to determine which node
// actually notified sensors. There is also a pointer to the last
// field that changed, which is needed by field-specific sensors.
//
//////////////////////////////////////////////////////////////////////////////
SoINTERNAL class SoNotList {
public:
// Constructor
SoNotList();
// Copy constructor
SoNotList(const SoNotList *copyFrom) { *this = *copyFrom; }
// Appends given non-field record to end of list.
void append(SoNotRec *rec);
// Appends given (container) field record to end of list. We
// assume the base in the record is a node.
void append(SoNotRec *rec, SoField *field);
// Sets the type of the last (current) record in the list
void setLastType(SoNotRec::Type t)
{
last->setType(t);
// Reset firstAtNode pointer if we're going through
// field-to-field or engine-to-field connections.
if (t == SoNotRec::FIELD || t == SoNotRec::ENGINE)
firstAtNode = NULL;
}
// Returns first and last records in list
SoNotRec * getFirstRec() const { return first; }
SoNotRec * getLastRec() const { return last; }
// Returns first record in list that has a node base in the
// current chain of node-to-node notification. This information is
// passed to sensor callbacks to indicate which node initiated
// notification in the graph.
SoNotRec * getFirstRecAtNode() const { return firstAtNode; }
// Returns last field set by notification (or NULL if notification
// did not originate at or propagate through a field)
SoField * getLastField() const { return lastField; }
// Returns the time stamp so nodes can check if notification has
// already been handled
uint32_t getTimeStamp() const { return timeStamp; }
// Prints a notification list for debugging
void print(FILE *fp) const;
private:
SoNotRec *first, *last; // First and last records in list
SoNotRec *firstAtNode; // First record that has a node base
SoField *lastField; // Last field that changed
uint32_t timeStamp; // Time stamp of notification
};
#endif /* _SO_NOTIFICATION_ */
|
