Coin: SoPickAction.h Source File

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

SoPickAction.h
1#ifndef COIN_SOPICKACTION_H
2#define COIN_SOPICKACTION_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/actions/SoAction.h>
37#include <Inventor/actions/SoSubAction.h>
38#include <Inventor/tools/SbLazyPimplPtr.h>
39#include <Inventor/SbViewportRegion.h>
40
41class SoPickActionP;
42
43 class COIN_DLL_API SoPickAction : public SoAction {
44 typedef SoAction inherited;
45
46 SO_ACTION_HEADER(SoPickAction);
47
48public:
49 static void initClass(void);
50
51 void setViewportRegion(const SbViewportRegion & newregion);
52 const SbViewportRegion & getViewportRegion(void) const;
53
54 void enableCulling(const SbBool flag);
55 SbBool isCullingEnabled(void) const;
56
57protected:
58 SoPickAction(const SbViewportRegion & viewportregion);
59 virtual ~SoPickAction(void);
60
61 virtual void beginTraversal(SoNode * node);
62
63 SbViewportRegion vpRegion;
64
65private:
66 SbBool cullingenabled;
67
68private:
69 SbLazyPimplPtr<SoPickActionP> pimpl;
70
71 // NOT IMPLEMENTED:
72 SoPickAction(const SoPickAction & rhs);
73 SoPickAction & operator = (const SoPickAction & rhs);
74}; // SoPickAction
75
76#endif // !COIN_SOPICKACTION_H
SbLazyPimplPtr
Definition SbLazyPimplPtr.h:56
SbViewportRegion
The SbViewportRegion class is a viewport within a full window.
Definition SbViewportRegion.h:40
SoAction
The SoAction class is the base class for all traversal actions.
Definition SoAction.h:77
SoAction::initClass
static void initClass(void)
Definition SoAction.cpp:370
SoAction::beginTraversal
virtual void beginTraversal(SoNode *node)
Definition SoAction.cpp:1269
SoNode
The SoNode class is the base class for nodes used in scene graphs.
Definition SoNode.h:56
SoPickAction
The SoPickAction class is the base class for picking actions.
Definition SoPickAction.h:43
SoPickAction::vpRegion
SbViewportRegion vpRegion
Definition SoPickAction.h:63