Open Inventor Release 2024.1.1
 
Loading...
Searching...
No Matches
SoPickAction.h
1/*=======================================================================
2 * Copyright 1991-1996, Silicon Graphics, Inc.
3 * ALL RIGHTS RESERVED
4 *
5 * UNPUBLISHED -- Rights reserved under the copyright laws of the United
6 * States. Use of a copyright notice is precautionary only and does not
7 * imply publication or disclosure.
8 *
9 * U.S. GOVERNMENT RESTRICTED RIGHTS LEGEND:
10 * Use, duplication or disclosure by the Government is subject to restrictions
11 * as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights
12 * in Technical Data and Computer Software clause at DFARS 252.227-7013 and/or
13 * in similar or successor clauses in the FAR, or the DOD or NASA FAR
14 * Supplement. Contractor/manufacturer is Silicon Graphics, Inc.,
15 * 2011 N. Shoreline Blvd. Mountain View, CA 94039-7311.
16 *
17 * THE CONTENT OF THIS WORK CONTAINS CONFIDENTIAL AND PROPRIETARY
18 * INFORMATION OF SILICON GRAPHICS, INC. ANY DUPLICATION, MODIFICATION,
19 * DISTRIBUTION, OR DISCLOSURE IN ANY FORM, IN WHOLE, OR IN PART, IS STRICTLY
20 * PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SILICON
21 * GRAPHICS, INC.
22**=======================================================================*/
23/*=======================================================================
24** Author : Paul S. Strauss (MMM yyyy)
25** Modified by : Nick Thompson (MMM yyyy)
26**=======================================================================*/
27/*=======================================================================
28 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.), ***
29 *** AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT. ***
30 *** ***
31 *** REPRODUCTION, DISCLOSURE, OR USE, IN WHOLE OR IN PART, OTHER THAN AS ***
32 *** SPECIFIED IN THE LICENSE ARE NOT TO BE UNDERTAKEN EXCEPT WITH PRIOR ***
33 *** WRITTEN AUTHORIZATION OF FEI S.A.S. ***
34 *** ***
35 *** RESTRICTED RIGHTS LEGEND ***
36 *** USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS ***
37 *** WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN ***
38 *** SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT ***
39 *** CLAUSE AT FAR 52.227-19 OR SUBPARAGRAPH (C)(1)(II) OF THE RIGHTS IN ***
40 *** TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013. ***
41 *** ***
42 *** COPYRIGHT (C) 1996-2014 BY FEI S.A.S, ***
43 *** BORDEAUX, FRANCE ***
44 *** ALL RIGHTS RESERVED ***
45**=======================================================================*/
46/*=======================================================================
47** Modified by : VSG (MMM YYYY)
48**=======================================================================*/
49
50
51#ifndef _SO_PICK_ACTION_
52#define _SO_PICK_ACTION_
53
54#include <Inventor/SbViewportRegion.h>
55#include <Inventor/actions/SoSubAction.h>
56
58//
59// Class: SoPickAction
60//
61// Base class for picking actions.
62//
64
79class SoPickAction : public SoAction {
80
81 SO_ACTION_HEADER(SoPickAction);
82
83 public:
89 void setViewportRegion(const SbViewportRegion &newRegion);
90
94 const SbViewportRegion &getViewportRegion() const { return vpRegion; }
95
96 SoEXTENDER_Documented public:
97 // Setting this flag to FALSE disables any pick culling that might
98 // take place (as in SoSeparators). This can be used for nodes
99 // (such as SoArray and SoMultipleCopy) that traverse their
100 // children multiple times in different locations, thereby
101 // avoiding computing bounding boxes each time. (This problem is
102 // very severe when each bounding box traversal also traverses the
103 // children N times.) The default setting is TRUE.
104 void enableCulling(SbBool flag) { culling = flag; }
105 SbBool isCullingEnabled() const { return culling; }
106
107 private:
108 static void initClass();
109 static void exitClass();
110
111 private:
112 SbViewportRegion vpRegion; // Current viewport region
113
114 // Constructor takes viewport region. See comments for the
115 // setViewportRegion() method.
116 SoPickAction(const SbViewportRegion &viewportRegion);
117
118 // Destructor
119 virtual ~SoPickAction();
120
121 // Initiates action on graph
122 virtual void beginTraversal(SoNode *node);
123
124 private:
125 SbBool culling; // Pick culling enabled?
126
127};
128
129#endif /* _SO_PICK_ACTION_ */
130
Class for representing a viewport.
Abstract base class for all actions.
Definition SoAction.h:132
Abstract base class for all database nodes.
Definition SoNode.h:145
Abstract base class for picking objects in a scene.
void setViewportRegion(const SbViewportRegion &newRegion)
Sets current viewport region to use for action.
void enableCulling(SbBool flag)
const SbViewportRegion & getViewportRegion() const
Returns current viewport region to use for action.
SbBool isCullingEnabled() const
int SbBool
Boolean type.
Definition SbBase.h:87