Coin: SoPathSensor.h Source File

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

SoPathSensor.h
1#ifndef COIN_SOPATHSENSOR_H
2#define COIN_SOPATHSENSOR_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/SoDataSensor.h>
37
38class SoPathSensorP;
39
40 class COIN_DLL_API SoPathSensor : public SoDataSensor {
41 typedef SoDataSensor inherited;
42
43public:
44 SoPathSensor(void);
45 SoPathSensor(SoSensorCB * func, void * data);
46 virtual ~SoPathSensor(void);
47
48 enum TriggerFilter {
49 PATH = 0x1,
50 NODES = 0x2,
51 PATH_AND_NODES = 0x3
52 };
53
54 void setTriggerFilter(const TriggerFilter type);
55 TriggerFilter getTriggerFilter(void) const;
56
57 void attach(SoPath * path);
58 void detach(void);
59 SoPath * getAttachedPath(void) const;
60
61protected:
62 virtual void notify(SoNotList * l);
63
64private:
65 void commonConstructor(void);
66 virtual void dyingReference(void);
67
68 SoPathSensorP * pimpl;
69};
70
71#endif // !COIN_SOPATHSENSOR_H
SoDataSensor::dyingReference
virtual void dyingReference(void)=0
SoDataSensor::SoDataSensor
SoDataSensor(void)
Definition SoDataSensor.cpp:66
SoDataSensor::notify
virtual void notify(SoNotList *l)
Definition SoDataSensor.cpp:312
SoNotList
The SoNotList class is a list of SoNotRec notification records.
Definition SoNotification.h:43
SoPathSensor::SoPathSensor
SoPathSensor(void)
Definition SoPathSensor.cpp:97
SoPathSensor::TriggerFilter
TriggerFilter
Definition SoPathSensor.h:48
SoPathSensor::NODES
@ NODES
Definition SoPathSensor.h:50
SoPathSensor::PATH
@ PATH
Definition SoPathSensor.h:49
SoPathSensor::PATH_AND_NODES
@ PATH_AND_NODES
Definition SoPathSensor.h:51
SoPath
The SoPath class is a container class for traversal path descriptions.
Definition SoPath.h:52
SoSensor::func
SoSensorCB * func
Definition SoSensor.h:67