Coin: SoDataSensor.h Source File

| Coin3D is Free Software, published under the BSD 3-clause license. | https://coin3d.github.io https://www.kongsberg.com/en/kogt/

SoDataSensor.h
1#ifndef COIN_SODATASENSOR_H
2#define COIN_SODATASENSOR_H
3
4/**************************************************************************\
5 * Copyright (c) Kongsberg Oil & Gas Technologies AS
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are
10 * met:
11 *
12 * Redistributions of source code must retain the above copyright notice,
13 * this list of conditions and the following disclaimer.
14 *
15 * Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 *
19 * Neither the name of the copyright holder nor the names of its
20 * contributors may be used to endorse or promote products derived from
21 * this software without specific prior written permission.
22 *
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
29 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
30 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
31 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34\**************************************************************************/
35
36#include <Inventor/sensors/SoDelayQueueSensor.h>
37#include <Inventor/misc/SoNotRec.h>
38#include <stdlib.h> // for NULL definition
39
40class SoNode;
41class SoField;
42class SoPath;
43class SoNotList;
44
45 class COIN_DLL_API SoDataSensor : public SoDelayQueueSensor {
46 typedef SoDelayQueueSensor inherited;
47
48public:
49 SoDataSensor(void);
50 SoDataSensor(SoSensorCB * func, void * data);
51 virtual ~SoDataSensor(void);
52
53 void setDeleteCallback(SoSensorCB * function, void * data = NULL);
54 SoNode * getTriggerNode(void) const;
55 SoField * getTriggerField(void) const;
56 SoPath * getTriggerPath(void) const;
57 void setTriggerPathFlag(SbBool flag);
58 SbBool getTriggerPathFlag(void) const;
59 SoNotRec::OperationType getTriggerOperationType(void) const;
60 int getTriggerIndex(void) const;
61 int getTriggerFieldNumIndices(void) const;
62 SoNode * getTriggerGroupChild(void) const;
63 SoNode * getTriggerReplacedGroupChild(void) const;
64
65 virtual void trigger(void);
66 virtual void notify(SoNotList * l);
67 virtual void dyingReference(void) = 0;
68
69protected:
70 void invokeDeleteCallback(void);
71
72private:
73 SoSensorCB * cbfunc;
74 void * cbdata;
75 SbBool findpath;
76 SoField * triggerfield;
77 SoNode * triggernode;
78 SoPath * triggerpath;
79 SoNotRec::OperationType triggeroperationtype;
80 int triggerindex, triggerfieldnumindices;
81 SoNode * triggergroupchild;
82 SoNode * triggergroupprevchild;
83};
84
85#endif // !COIN_SODATASENSOR_H
SoDataSensor::setDeleteCallback
void setDeleteCallback(SoSensorCB *function, void *data=NULL)
Definition SoDataSensor.cpp:119
SoDataSensor::getTriggerPath
SoPath * getTriggerPath(void) const
Definition SoDataSensor.cpp:178
SoDataSensor::getTriggerReplacedGroupChild
SoNode * getTriggerReplacedGroupChild(void) const
Definition SoDataSensor.cpp:279
SoDataSensor::getTriggerNode
SoNode * getTriggerNode(void) const
Definition SoDataSensor.cpp:142
SoDataSensor::setTriggerPathFlag
void setTriggerPathFlag(SbBool flag)
Definition SoDataSensor.cpp:193
SoDataSensor::getTriggerGroupChild
SoNode * getTriggerGroupChild(void) const
Definition SoDataSensor.cpp:262
SoDataSensor::getTriggerOperationType
SoNotRec::OperationType getTriggerOperationType(void) const
Definition SoDataSensor.cpp:217
SoDataSensor::getTriggerPathFlag
SbBool getTriggerPathFlag(void) const
Definition SoDataSensor.cpp:205
SoDataSensor::dyingReference
virtual void dyingReference(void)=0
SoDataSensor::invokeDeleteCallback
void invokeDeleteCallback(void)
Definition SoDataSensor.cpp:358
SoDataSensor::SoDataSensor
SoDataSensor(void)
Definition SoDataSensor.cpp:66
SoDataSensor::getTriggerFieldNumIndices
int getTriggerFieldNumIndices(void) const
Definition SoDataSensor.cpp:247
SoDataSensor::getTriggerIndex
int getTriggerIndex(void) const
Definition SoDataSensor.cpp:232
SoDataSensor::getTriggerField
SoField * getTriggerField(void) const
Definition SoDataSensor.cpp:159
SoDataSensor::notify
virtual void notify(SoNotList *l)
Definition SoDataSensor.cpp:312
SoDelayQueueSensor::trigger
virtual void trigger(void)
Definition SoDelayQueueSensor.cpp:157
SoDelayQueueSensor::SoDelayQueueSensor
SoDelayQueueSensor(void)
Definition SoDelayQueueSensor.cpp:71
SoField
The SoField class is the top-level abstract base class for fields.
Definition SoField.h:47
SoNode
The SoNode class is the base class for nodes used in scene graphs.
Definition SoNode.h:56
SoNotList
The SoNotList class is a list of SoNotRec notification records.
Definition SoNotification.h:43
SoNotRec::OperationType
OperationType
Definition SoNotRec.h:52
SoPath
The SoPath class is a container class for traversal path descriptions.
Definition SoPath.h:52
SoSensor::func
SoSensorCB * func
Definition SoSensor.h:67