Coin: SoSelection.h Source File

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

SoSelection.h
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
41class SoSelection;
42class SoPath;
43class SoPickedPoint;
44class SoCallbackList;
45
46typedef void SoSelectionPathCB(void * data, SoPath * path);
47typedef void SoSelectionClassCB(void * data, SoSelection * sel);
48typedef SoPath * SoSelectionPickCB(void * data, const SoPickedPoint * pick);
49
50 class COIN_DLL_API SoSelection : public SoSeparator {
51 typedef SoSeparator inherited;
52
53 SO_NODE_HEADER(SoSelection);
54
55public:
56 static void initClass(void);
57 SoSelection(void);
58
59 enum Policy {
60 SINGLE, TOGGLE, SHIFT, DISABLE
61 };
62
63 SoSFEnum policy;
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
98protected:
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
111protected: // unfortunately only protected in OIV
112
113 SoPathList selectionList;
114
115 SoCallbackList *selCBList;
116 SoCallbackList *deselCBList;
117 SoCallbackList *startCBList;
118 SoCallbackList *finishCBList;
119
120 SoSelectionPickCB *pickCBFunc;
121 void *pickCBData;
122 SbBool callPickCBOnlyIfSelectable;
123
124 SoCallbackList *changeCBList;
125
126 SoPath *mouseDownPickPath;
127 SbBool pickMatching;
128
129private:
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
SoCallbackList
The SoCallbackList is a container for callback function pointers.
Definition lists/SoCallbackList.h:44
SoHandleEventAction
The SoHandleEventAction class distributes user events to the scene.
Definition SoHandleEventAction.h:46
SoNode::SoNode
SoNode(void)
Definition SoNode.cpp:417
SoPathList
The SoPathList class is a container for pointers to SoPath objects.
Definition SoPathList.h:40
SoPath
The SoPath class is a container class for traversal path descriptions.
Definition SoPath.h:52
SoPickedPoint
The SoPickedPoint class is used for specifying picked points.
Definition SoPickedPoint.h:48
SoSFEnum
The SoSFEnum class is a container for an enum value.
Definition SoSFEnum.h:40
SoSelection
The SoSelection class manages a list of selected nodes.
Definition SoSelection.h:50
SoSelection::setPickMatching
void setPickMatching(const SbBool pickMatching)
Definition SoSelection.cpp:674
SoSelection::pickMatching
SbBool pickMatching
Definition SoSelection.h:127
SoSelection::removeSelectionCallback
void removeSelectionCallback(SoSelectionPathCB *f, void *userData=NULL)
Definition SoSelection.cpp:550
SoSelection::addPath
void addPath(SoPath *path)
Definition SoSelection.cpp:811
SoSelection::isSelected
SbBool isSelected(const SoPath *path) const
Definition SoSelection.cpp:465
SoSelection::selCBList
SoCallbackList * selCBList
Definition SoSelection.h:115
SoSelection::finishCBList
SoCallbackList * finishCBList
Definition SoSelection.h:118
SoSelection::deselect
void deselect(const SoPath *path)
Definition SoSelection.cpp:402
SoSelection::selectionList
SoPathList selectionList
Definition SoSelection.h:113
SoSelection::mouseDownPickPath
SoPath * mouseDownPickPath
Definition SoSelection.h:126
SoSelection::getList
const SoPathList * getList(void) const
Definition SoSelection.cpp:509
SoSelection::toggle
void toggle(const SoPath *path)
Definition SoSelection.cpp:438
SoSelection::getNumSelected
int getNumSelected(void) const
Definition SoSelection.cpp:500
SoSelection::startCBList
SoCallbackList * startCBList
Definition SoSelection.h:117
SoSelection::callPickCBOnlyIfSelectable
SbBool callPickCBOnlyIfSelectable
Definition SoSelection.h:122
SoSelection::removePath
void removePath(const int which)
Definition SoSelection.cpp:822
SoSelection::invokeSelectionPolicy
void invokeSelectionPolicy(SoPath *path, SbBool shiftDown)
Definition SoSelection.cpp:725
SoSelection::deselectAll
void deselectAll(void)
Definition SoSelection.cpp:490
SoSelection::findPath
int findPath(const SoPath *path) const
Definition SoSelection.cpp:836
SoSelection::performToggleSelection
void performToggleSelection(SoPath *path)
Definition SoSelection.cpp:778
SoSelection::copyFromThis
SoPath * copyFromThis(const SoPath *path) const
Definition SoSelection.cpp:795
SoSelection::removeStartCallback
void removeStartCallback(SoSelectionClassCB *f, void *userData=NULL)
Definition SoSelection.cpp:599
SoSelection::getPath
SoPath * getPath(const int index) const
Definition SoSelection.cpp:518
SoSelection::changeCBList
SoCallbackList * changeCBList
Definition SoSelection.h:124
SoSelection::addDeselectionCallback
void addDeselectionCallback(SoSelectionPathCB *f, void *userData=NULL)
Definition SoSelection.cpp:562
SoSelection::policy
SoSFEnum policy
Definition SoSelection.h:63
SoSelection::addFinishCallback
void addFinishCallback(SoSelectionClassCB *f, void *userData=NULL)
Definition SoSelection.cpp:612
SoSelection::pickCBData
void * pickCBData
Definition SoSelection.h:121
SoSelection::pickCBFunc
SoSelectionPickCB * pickCBFunc
Definition SoSelection.h:120
SoSelection::removeChangeCallback
void removeChangeCallback(SoSelectionClassCB *f, void *userData=NULL)
Definition SoSelection.cpp:716
SoSelection::addSelectionCallback
void addSelectionCallback(SoSelectionPathCB *f, void *userData=NULL)
Definition SoSelection.cpp:539
SoSelection::isPickMatching
SbBool isPickMatching(void) const
Definition SoSelection.cpp:685
SoSelection::setPickFilterCallback
void setPickFilterCallback(SoSelectionPickCB *f, void *userData=NULL, const SbBool callOnlyIfSelectable=TRUE)
Definition SoSelection.cpp:656
SoSelection::removeDeselectionCallback
void removeDeselectionCallback(SoSelectionPathCB *f, void *userData=NULL)
Definition SoSelection.cpp:573
SoSelection::Policy
Policy
Definition SoSelection.h:59
SoSelection::SHIFT
@ SHIFT
Definition SoSelection.h:60
SoSelection::DISABLE
@ DISABLE
Definition SoSelection.h:60
SoSelection::SINGLE
@ SINGLE
Definition SoSelection.h:60
SoSelection::TOGGLE
@ TOGGLE
Definition SoSelection.h:60
SoSelection::getPickMatching
SbBool getPickMatching(void) const
Definition SoSelection.cpp:696
SoSelection::removeFinishCallback
void removeFinishCallback(SoSelectionClassCB *f, void *userData=NULL)
Definition SoSelection.cpp:623
SoSelection::operator[]
SoPath * operator[](const int i) const
Definition SoSelection.cpp:527
SoSelection::SoSelection
SoSelection(void)
Definition SoSelection.cpp:294
SoSelection::addChangeCallback
void addChangeCallback(SoSelectionClassCB *f, void *userData=NULL)
Definition SoSelection.cpp:706
SoSelection::performSingleSelection
void performSingleSelection(SoPath *path)
Definition SoSelection.cpp:744
SoSelection::select
void select(const SoPath *path)
Definition SoSelection.cpp:371
SoSelection::addStartCallback
void addStartCallback(SoSelectionClassCB *f, void *userData=NULL)
Definition SoSelection.cpp:588
SoSelection::deselCBList
SoCallbackList * deselCBList
Definition SoSelection.h:116
SoSeparator::initClass
static void initClass(void)
Sets up initialization for data common to all instances of this class, like submitting necessary info...
Definition SoSeparator.cpp:475
SoSeparator::handleEvent
virtual void handleEvent(SoHandleEventAction *action)
Definition SoSeparator.cpp:816
SoSeparator::SoSeparator
SoSeparator(void)
Definition SoSeparator.cpp:383
SO_NODE_HEADER
#define SO_NODE_HEADER(classname)
Definition Coin_macros.dox:50