1SoPathSensor(3IV)()                                        SoPathSensor(3IV)()
2
3
4

NAME

6       SoPathSensor — sensor class that can be attached to Inventor paths
7

INHERITS FROM

9       SoSensor > SoDelayQueueSensor > SoDataSensor > SoPathSensor
10

SYNOPSIS

12       #include <Inventor/sensors/SoPathSensor.h>
13
14          Methods from class SoPathSensor:
15
16                         SoPathSensor()
17                         SoPathSensor(SoSensorCB *func, void *data)
18                         ~SoPathSensor()
19     void                attach(SoPath *path)
20     void                detach()
21     SoPath *            getAttachedPath() const
22
23          Methods from class SoDataSensor:
24
25     void                setDeleteCallback(SoSensorCB *function, void *data)
26     SoNode *            getTriggerNode() const
27     SoField *           getTriggerField() const
28     SoPath *            getTriggerPath() const
29     void                setTriggerPathFlag(SbBool flag)
30     SbBool              getTriggerPathFlag() const
31
32          Methods from class SoDelayQueueSensor:
33
34     void                setPriority(uint32_t pri)
35     uint32_t            getPriority()
36     static uint32_t     getDefaultPriority()
37     virtual void        schedule()
38     virtual void        unschedule()
39     virtual SbBool      isScheduled()
40
41          Methods from class SoSensor:
42
43     void                setFunction(SoSensorCB *callbackFunction)
44     SoSensorCB *        getFunction() const
45     void                setData(void *callbackData)
46     void *              getData() const
47
48

DESCRIPTION

50       Path sensors detect changes to paths, calling a callback function when‐
51       ever the path or any node in the path changes. The  definition  of  "in
52       the path" is the same as the definition used when applying an action to
53       the path — any node that can possibly affect the node at the end of the
54       path  chain  is  considered in the path. See the SoPath manual page for
55       more information on paths.
56

METHODS

58                         SoPathSensor()
59                         SoPathSensor(SoSensorCB *func, void *data)
60          Creation methods. The second method takes the callback function  and
61          data to be called when the sensor is triggered.
62
63                         ~SoPathSensor()
64          Destroys  the sensor, freeing up any memory associated with it after
65          unscheduling it.
66
67     void                attach(SoPath *path)
68     void                detach()
69     SoPath *            getAttachedPath() const
70          The attach() method makes this sensor detect changes  to  the  given
71          path.  The  detach() method unschedules this sensor (if it is sched‐
72          uled) and makes it ignore changes to the  scene  graph.  The  getAt‐
73          tachedPath() method returns the path that this sensor is sensing, or
74          NULL if it is not attached to any path.
75
76

SEE ALSO

78       SoNodeSensor, SoPathSensor, SoDataSensor
79
80
81
82
83                                                           SoPathSensor(3IV)()
Impressum