Open Inventor Reference
SoPathSensor.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  | Data sensor that is attached to a path in a scene graph. The
48  | sensor is scheduled when a change is made to any node in the graph
49  | defined by the path.
50  |
51  | Author(s) : Paul Strauss
52  |
53  ______________ S I L I C O N G R A P H I C S I N C . ____________
54  _______________________________________________________________________
55  */
56 
57 #ifndef _SO_PATH_SENSOR_
58 #define _SO_PATH_SENSOR_
59 
60 #include <Inventor/SoPath.h>
62 
65 
80 
82 
83  public:
84 
90  SoPathSensor(SoSensorCB *func, void *data);
91 
94  virtual ~SoPathSensor();
95 
98  void attach(SoPath *path);
99 
102  void detach();
103 
106  SoPath * getAttachedPath() const { return path; }
107 
108  protected:
109  void notify(SoNotList *list);
110 
111  private:
112  SoFullPath * path;
113  SoNode * head;
114 
116  virtual void dyingReference();
117 };
118 
119 #endif /* _SO_PATH_SENSOR_ */
#define INVENTOR_API
Disable some annoying warnings on MSVC 6.
Definition: SbSystem.h:81
void SoSensorCB(void *data, SoSensor *sensor)
This typedef defines the calling sequence for all callbacks from sensors.
Definition: SoSensor.h:89
Abstract base class for sensors attached to parts of a scene.
Definition: SoDataSensor.h:93
virtual void dyingReference()=0
This is called when the base (path, field, node, whatever) is deleted.
This SoEXTENDER class allows expert users to examine "hidden" children in paths.
Definition: SoPath.h:299
Abstract base class for all database nodes.
Definition: SoNode.h:103
Holds a list of SoNotRec notification records.
Sensor class that can be attached to Inventor paths.
Definition: SoPathSensor.h:81
SoPath * getAttachedPath() const
Returns the path that this sensor is sensing, or NULL if it is not attached to any path.
Definition: SoPathSensor.h:106
SoPathSensor()
Creation methods.
SoPathSensor(SoSensorCB *func, void *data)
Creation methods.
void detach()
Unschedules this sensor (if it is scheduled) and makes it ignore changes to the scene graph.
void notify(SoNotList *list)
Propagates modification notification through an instance.
virtual ~SoPathSensor()
Destroys the sensor, freeing up any memory associated with it after unscheduling it.
void attach(SoPath *path)
Makes this sensor detect changes to the given path.
Path that points to a list of hierarchical nodes.
Definition: SoPath.h:109