Coin Logo http://www.sim.no/
http://www.coin3d.org/

SoSelection.h
1#ifndef COIN_SOSELECTION_H
2#define COIN_SOSELECTION_H
3
4/**************************************************************************\
5 *
6 * This file is part of the Coin 3D visualization library.
7 * Copyright (C) by Kongsberg Oil & Gas Technologies.
8 *
9 * This library is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License
11 * ("GPL") version 2 as published by the Free Software Foundation.
12 * See the file LICENSE.GPL at the root directory of this source
13 * distribution for additional information about the GNU GPL.
14 *
15 * For using Coin with software that can not be combined with the GNU
16 * GPL, and for taking advantage of the additional benefits of our
17 * support services, please contact Kongsberg Oil & Gas Technologies
18 * about acquiring a Coin Professional Edition License.
19 *
20 * See http://www.coin3d.org/ for more information.
21 *
22 * Kongsberg Oil & Gas Technologies, Bygdoy Alle 5, 0257 Oslo, NORWAY.
23 * http://www.sim.no/ sales@sim.no coin-support@coin3d.org
24 *
25\**************************************************************************/
26
27#include <Inventor/nodes/SoSubNode.h>
28#include <Inventor/nodes/SoSeparator.h>
29#include <Inventor/fields/SoSFEnum.h>
30#include <Inventor/lists/SoPathList.h>
31
32class SoSelection;
33class SoPath;
34class SoPickedPoint;
35class SoCallbackList;
36
37typedef void SoSelectionPathCB(void * data, SoPath * path);
38typedef void SoSelectionClassCB(void * data, SoSelection * sel);
39typedef SoPath * SoSelectionPickCB(void * data, const SoPickedPoint * pick);
40
41class COIN_DLL_API SoSelection : public SoSeparator {
42 typedef SoSeparator inherited;
43
45
46public:
47 static void initClass(void);
48 SoSelection(void);
49
50 enum Policy {
51 SINGLE, TOGGLE, SHIFT
52 };
53
55
56 SoSelection(const int nChildren);
57
58 void select(const SoPath * path);
59 void select(SoNode *node);
60 void deselect(const SoPath * path);
61 void deselect(const int which);
62 void deselect(SoNode * node);
63 void toggle(const SoPath * path);
64 void toggle(SoNode * node);
65 SbBool isSelected(const SoPath * path) const;
66 SbBool isSelected(SoNode * node) const;
67 void deselectAll(void);
68 int getNumSelected(void) const;
69 const SoPathList * getList(void) const;
70 SoPath * getPath(const int index) const;
71 SoPath * operator[](const int i) const;
72 void addSelectionCallback(SoSelectionPathCB * f, void * userData = NULL);
73 void removeSelectionCallback(SoSelectionPathCB * f, void * userData = NULL);
74 void addDeselectionCallback(SoSelectionPathCB * f, void * userData = NULL);
75 void removeDeselectionCallback(SoSelectionPathCB * f,
76 void * userData = NULL);
77 void addStartCallback(SoSelectionClassCB * f, void * userData = NULL);
78 void removeStartCallback(SoSelectionClassCB * f, void * userData = NULL);
79 void addFinishCallback(SoSelectionClassCB * f, void * userData = NULL);
80 void removeFinishCallback(SoSelectionClassCB * f, void * userData = NULL);
81 void setPickFilterCallback(SoSelectionPickCB * f, void * userData = NULL,
82 const SbBool callOnlyIfSelectable = TRUE);
83 void setPickMatching(const SbBool pickMatching);
84 SbBool isPickMatching(void) const;
85 SbBool getPickMatching(void) const;
86 void addChangeCallback(SoSelectionClassCB * f, void * userData = NULL);
87 void removeChangeCallback(SoSelectionClassCB * f, void * userData = NULL);
88
89protected:
90 virtual ~SoSelection();
91
92 void invokeSelectionPolicy(SoPath *path, SbBool shiftDown);
93 void performSingleSelection(SoPath *path);
94 void performToggleSelection(SoPath *path);
95 SoPath * copyFromThis(const SoPath * path) const;
96 void addPath(SoPath *path);
97 void removePath(const int which);
98 int findPath(const SoPath *path) const;
99
100 virtual void handleEvent(SoHandleEventAction * action);
101
102protected: // unfortunately only protected in OIV
103
105
110
111 SoSelectionPickCB *pickCBFunc;
114
116
119
120private:
121 void init();
122 SoPath *searchNode(SoNode * node) const;
123 SoPath *getSelectionPath(SoHandleEventAction *action,
124 SbBool &ignorepick, SbBool &haltaction);
125};
126
127#endif // !COIN_SOSELECTION_H
The SoCallbackList is a container for callback function pointers.
Definition SoCallbackList.h:35
The SoHandleEventAction class distributes user events to the scene.
Definition SoHandleEventAction.h:37
The SoNode class is the base class for nodes used in scene graphs.
Definition SoNode.h:47
The SoPathList class is a container for pointers to SoPath objects.
Definition SoPathList.h:31
The SoPath class is a container class for traversal path descriptions.
Definition SoPath.h:43
The SoPickedPoint class is used for specifying picked points.
Definition SoPickedPoint.h:39
The SoSFEnum class is a container for an enum value.
Definition SoSFEnum.h:31
The SoSelection class manages a list of selected nodes.
Definition SoSelection.h:41
SbBool pickMatching
Definition SoSelection.h:118
SoCallbackList * selCBList
Definition SoSelection.h:106
SoCallbackList * finishCBList
Definition SoSelection.h:109
SoPathList selectionList
Definition SoSelection.h:104
SoPath * mouseDownPickPath
Definition SoSelection.h:117
SoCallbackList * startCBList
Definition SoSelection.h:108
SbBool callPickCBOnlyIfSelectable
Definition SoSelection.h:113
SoCallbackList * changeCBList
Definition SoSelection.h:115
SoSFEnum policy
Definition SoSelection.h:54
void * pickCBData
Definition SoSelection.h:112
SoSelectionPickCB * pickCBFunc
Definition SoSelection.h:111
Policy
Definition SoSelection.h:50
@ SINGLE
Definition SoSelection.h:51
SoCallbackList * deselCBList
Definition SoSelection.h:107
The SoSeparator class is a state-preserving group node.
Definition SoSeparator.h:35
virtual void handleEvent(SoHandleEventAction *action)
Definition SoSeparator.cpp:804
#define SO_NODE_HEADER(classname)
Definition macros.dox:43

Copyright © 1998-2010 by Kongsberg Oil & Gas Technologies. All rights reserved.

Generated on Wed Jul 17 2024 for Coin by Doxygen 1.12.0.