SoSelection.h
#ifndef COIN_SOSELECTION_H
#define COIN_SOSELECTION_H
/**************************************************************************\
* Copyright (c) Kongsberg Oil & Gas Technologies AS
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* Neither the name of the copyright holder nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
\**************************************************************************/
#include <Inventor/nodes/SoSubNode.h>
#include <Inventor/nodes/SoSeparator.h>
#include <Inventor/fields/SoSFEnum.h>
#include <Inventor/lists/SoPathList.h>
class SoSelection;
class SoPath;
class SoPickedPoint;
class SoCallbackList;
typedef void SoSelectionPathCB(void * data, SoPath * path);
typedef void SoSelectionClassCB(void * data, SoSelection * sel);
typedef SoPath * SoSelectionPickCB(void * data, const SoPickedPoint * pick);
class COIN_DLL_API SoSelection : public SoSeparator {
typedef SoSeparator inherited;
SO_NODE_HEADER(SoSelection);
public:
static void initClass(void);
SoSelection(void);
enum Policy {
SINGLE, TOGGLE, SHIFT, DISABLE
};
SoSFEnum policy;
SoSelection(const int nChildren);
void select(const SoPath * path);
void select(SoNode *node);
void deselect(const SoPath * path);
void deselect(const int which);
void deselect(SoNode * node);
void toggle(const SoPath * path);
void toggle(SoNode * node);
SbBool isSelected(const SoPath * path) const;
SbBool isSelected(SoNode * node) const;
void deselectAll(void);
int getNumSelected(void) const;
const SoPathList * getList(void) const;
SoPath * getPath(const int index) const;
SoPath * operator[](const int i) const;
void addSelectionCallback(SoSelectionPathCB * f, void * userData = NULL);
void removeSelectionCallback(SoSelectionPathCB * f, void * userData = NULL);
void addDeselectionCallback(SoSelectionPathCB * f, void * userData = NULL);
void removeDeselectionCallback(SoSelectionPathCB * f,
void * userData = NULL);
void addStartCallback(SoSelectionClassCB * f, void * userData = NULL);
void removeStartCallback(SoSelectionClassCB * f, void * userData = NULL);
void addFinishCallback(SoSelectionClassCB * f, void * userData = NULL);
void removeFinishCallback(SoSelectionClassCB * f, void * userData = NULL);
void setPickFilterCallback(SoSelectionPickCB * f, void * userData = NULL,
const SbBool callOnlyIfSelectable = TRUE);
void setPickMatching(const SbBool pickMatching);
SbBool isPickMatching(void) const;
SbBool getPickMatching(void) const;
void addChangeCallback(SoSelectionClassCB * f, void * userData = NULL);
void removeChangeCallback(SoSelectionClassCB * f, void * userData = NULL);
protected:
virtual ~SoSelection();
void invokeSelectionPolicy(SoPath *path, SbBool shiftDown);
void performSingleSelection(SoPath *path);
void performToggleSelection(SoPath *path);
SoPath * copyFromThis(const SoPath * path) const;
void addPath(SoPath *path);
void removePath(const int which);
int findPath(const SoPath *path) const;
virtual void handleEvent(SoHandleEventAction * action);
protected: // unfortunately only protected in OIV
SoPathList selectionList;
SoCallbackList *selCBList;
SoCallbackList *deselCBList;
SoCallbackList *startCBList;
SoCallbackList *finishCBList;
SoSelectionPickCB *pickCBFunc;
void *pickCBData;
SbBool callPickCBOnlyIfSelectable;
SoCallbackList *changeCBList;
SoPath *mouseDownPickPath;
SbBool pickMatching;
private:
void init();
SoPath *searchNode(SoNode * node) const;
SoPath *getSelectionPath(SoHandleEventAction *action,
SbBool &ignorepick, SbBool &haltaction);
};
#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