Coin Logo Coin3D is Free Software,
published under the BSD 3-clause license.
https://coin3d.github.io
https://www.kongsberg.com/en/kogt/
SoSelection.h
Go to the documentation of this file.
1 #ifndef COIN_SOSELECTION_H
2 #define COIN_SOSELECTION_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/nodes/SoSubNode.h>
37 #include <Inventor/nodes/SoSeparator.h>
38 #include <Inventor/fields/SoSFEnum.h>
39 #include <Inventor/lists/SoPathList.h>
40 
41 class SoSelection;
42 class SoPath;
43 class SoPickedPoint;
44 class SoCallbackList;
45 
46 typedef void SoSelectionPathCB(void * data, SoPath * path);
47 typedef void SoSelectionClassCB(void * data, SoSelection * sel);
48 typedef SoPath * SoSelectionPickCB(void * data, const SoPickedPoint * pick);
49 
50 class COIN_DLL_API SoSelection : public SoSeparator {
51  typedef SoSeparator inherited;
52 
54 
55 public:
56  static void initClass(void);
57  SoSelection(void);
58 
59  enum Policy {
60  SINGLE, TOGGLE, SHIFT, DISABLE
61  };
62 
64 
65  SoSelection(const int nChildren);
66 
67  void select(const SoPath * path);
68  void select(SoNode *node);
69  void deselect(const SoPath * path);
70  void deselect(const int which);
71  void deselect(SoNode * node);
72  void toggle(const SoPath * path);
73  void toggle(SoNode * node);
74  SbBool isSelected(const SoPath * path) const;
75  SbBool isSelected(SoNode * node) const;
76  void deselectAll(void);
77  int getNumSelected(void) const;
78  const SoPathList * getList(void) const;
79  SoPath * getPath(const int index) const;
80  SoPath * operator[](const int i) const;
81  void addSelectionCallback(SoSelectionPathCB * f, void * userData = NULL);
82  void removeSelectionCallback(SoSelectionPathCB * f, void * userData = NULL);
83  void addDeselectionCallback(SoSelectionPathCB * f, void * userData = NULL);
84  void removeDeselectionCallback(SoSelectionPathCB * f,
85  void * userData = NULL);
86  void addStartCallback(SoSelectionClassCB * f, void * userData = NULL);
87  void removeStartCallback(SoSelectionClassCB * f, void * userData = NULL);
88  void addFinishCallback(SoSelectionClassCB * f, void * userData = NULL);
89  void removeFinishCallback(SoSelectionClassCB * f, void * userData = NULL);
90  void setPickFilterCallback(SoSelectionPickCB * f, void * userData = NULL,
91  const SbBool callOnlyIfSelectable = TRUE);
92  void setPickMatching(const SbBool pickMatching);
93  SbBool isPickMatching(void) const;
94  SbBool getPickMatching(void) const;
95  void addChangeCallback(SoSelectionClassCB * f, void * userData = NULL);
96  void removeChangeCallback(SoSelectionClassCB * f, void * userData = NULL);
97 
98 protected:
99  virtual ~SoSelection();
100 
101  void invokeSelectionPolicy(SoPath *path, SbBool shiftDown);
102  void performSingleSelection(SoPath *path);
103  void performToggleSelection(SoPath *path);
104  SoPath * copyFromThis(const SoPath * path) const;
105  void addPath(SoPath *path);
106  void removePath(const int which);
107  int findPath(const SoPath *path) const;
108 
109  virtual void handleEvent(SoHandleEventAction * action);
110 
111 protected: // unfortunately only protected in OIV
112 
114 
119 
121  void *pickCBData;
123 
125 
127  SbBool pickMatching;
128 
129 private:
130  void init();
131  SoPath *searchNode(SoNode * node) const;
132  SoPath *getSelectionPath(SoHandleEventAction *action,
133  SbBool &ignorepick, SbBool &haltaction);
134 };
135 
136 #endif // !COIN_SOSELECTION_H
The SoBase class is the top-level superclass for a number of class-hierarchies.
Definition: SoBase.h:45
SoPathList selectionList
Definition: SoSelection.h:113
#define SO_NODE_HEADER(classname)
SbBool callPickCBOnlyIfSelectable
Definition: SoSelection.h:122
SoCallbackList * finishCBList
Definition: SoSelection.h:118
SoCallbackList * selCBList
Definition: SoSelection.h:115
SoPath * SoSelectionPickCB(void *data, const SoPickedPoint *pick)
Definition: SoSelection.h:48
SbBool pickMatching
Definition: SoSelection.h:127
SoSelectionPickCB * pickCBFunc
Definition: SoSelection.h:120
The SoPathList class is a container for pointers to SoPath objects.
Definition: SoPathList.h:40
SoCallbackList * changeCBList
Definition: SoSelection.h:124
SoPath * mouseDownPickPath
Definition: SoSelection.h:126
The SoNode class is the base class for nodes used in scene graphs.
Definition: SoNode.h:56
The SoSFEnum class is a container for an enum value.
Definition: SoSFEnum.h:40
virtual void handleEvent(SoHandleEventAction *action)
Definition: SoSeparator.cpp:814
The SoCallbackList is a container for callback function pointers.
Definition: lists/SoCallbackList.h:44
SoCallbackList * deselCBList
Definition: SoSelection.h:116
Policy
Definition: SoSelection.h:59
The SoPath class is a container class for traversal path descriptions.
Definition: SoPath.h:52
SoSFEnum policy
Definition: SoSelection.h:63
void * pickCBData
Definition: SoSelection.h:121
SoCallbackList * startCBList
Definition: SoSelection.h:117
The SoHandleEventAction class distributes user events to the scene.
Definition: SoHandleEventAction.h:46
Definition: SoSelection.h:60
The SoPickedPoint class is used for specifying picked points.
Definition: SoPickedPoint.h:48
The SoSelection class manages a list of selected nodes.
Definition: SoSelection.h:50
The SoSeparator class is a state-preserving group node.
Definition: SoSeparator.h:44