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 
32 class SoSelection;
33 class SoPath;
34 class SoPickedPoint;
35 class SoCallbackList;
36 
37 typedef void SoSelectionPathCB(void * data, SoPath * path);
38 typedef void SoSelectionClassCB(void * data, SoSelection * sel);
39 typedef SoPath * SoSelectionPickCB(void * data, const SoPickedPoint * pick);
40 
41 class COIN_DLL_API SoSelection : public SoSeparator {
42  typedef SoSeparator inherited;
43 
45 
46 public:
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 
89 protected:
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 
102 protected: // unfortunately only protected in OIV
103 
105 
110 
111  SoSelectionPickCB *pickCBFunc;
112  void *pickCBData;
114 
116 
118  SbBool pickMatching;
119 
120 private:
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 SoBase class is the top-level superclass for a number of class-hierarchies.SoBase provides the ba...
Definition: SoBase.h:36
SoPathList selectionList
Definition: SoSelection.h:104
#define SO_NODE_HEADER(classname)
SbBool callPickCBOnlyIfSelectable
Definition: SoSelection.h:113
SoCallbackList * finishCBList
Definition: SoSelection.h:109
SoCallbackList * selCBList
Definition: SoSelection.h:106
SbBool pickMatching
Definition: SoSelection.h:118
SoSelectionPickCB * pickCBFunc
Definition: SoSelection.h:111
The SoPathList class is a container for pointers to SoPath objects.As this class inherits SoBaseList...
Definition: SoPathList.h:31
SoCallbackList * changeCBList
Definition: SoSelection.h:115
SoPath * mouseDownPickPath
Definition: SoSelection.h:117
The SoNode class is the base class for nodes used in scene graphs.Coin is a retained mode 3D visualiz...
Definition: SoNode.h:47
The SoSFEnum class is a container for an enum value.This field is used where nodes, engines or other field containers needs to store one particular value out of an enumerated set.
Definition: SoSFEnum.h:31
virtual void handleEvent(SoHandleEventAction *action)
Definition: SoSeparator.cpp:804
The SoCallbackList is a container for callback function pointers.This list stores callback function p...
Definition: SoCallbackList.h:35
SoCallbackList * deselCBList
Definition: SoSelection.h:107
Policy
Definition: SoSelection.h:50
The SoPath class is a container class for traversal path descriptions.SoPath objects contain a list o...
Definition: SoPath.h:43
SoSFEnum policy
Definition: SoSelection.h:54
void * pickCBData
Definition: SoSelection.h:112
SoCallbackList * startCBList
Definition: SoSelection.h:108
The SoHandleEventAction class distributes user events to the scene.This is the action used by the GUI...
Definition: SoHandleEventAction.h:37
Definition: SoSelection.h:51
The SoPickedPoint class is used for specifying picked points.It holds miscellaneous information about...
Definition: SoPickedPoint.h:39
The SoSelection class manages a list of selected nodes.Inserting an SoSelection node in your scene gr...
Definition: SoSelection.h:41
The SoSeparator class is a state-preserving group node.Subgraphs parented by SoSeparator nodes will n...
Definition: SoSeparator.h:35

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

Generated on Wed Feb 7 2018 for Coin by Doxygen 1.8.14.