Open Inventor Release 2024.1.3
 
Loading...
Searching...
No Matches
SoEnabledElementsList.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 : Gavin Bell (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#ifndef _SO_ENABLED_ELEMENTS_LIST_H_
51#define _SO_ENABLED_ELEMENTS_LIST_H_
52
54//
55// Class: SoEnabledElementsList
56//
57// Internal class. A list of elements enabled for a given action
58// class. Lists of elements can be merged, allowing an action class
59// to inherit enabled elements from its parent class.
60//
62
63#ifndef HIDDEN_FROM_DOC
64
65#include <Inventor/SoType.h>
66
67
68{
69
70 public:
71 // Constructor
72 SoEnabledElementsList(SoEnabledElementsList *parentList);
73
74 // Returns list of elements. This automatically merges the
75 // elements with elements enabled in the parentList.
76 const SoTypeList & getElements() const;
77
78 // Adds an element to the list if it's not already in it
79 void enable(SoType elementType, int stackIndex);
80
81 // Returns the current setting of the global counter used to
82 // determine when lists are out of date.
83 int getCounter() const
84 { return counter; }
85
86 // Reset the element counter to 0;
87 void resetCounter()
88 { counter = 0; }
89
90 private:
91 // This maintains a global counter used to determine when lists
92 // are out of date. It is incremented whenever a new element is
93 // added to a list.
94 mutable int counter;
95
96 // Used to protect access to the ststai counter variable.
97 mutable SbThreadMutex counterMtx;
98
99 // And a per-instance counter so we don't merge enabled elements
100 // with the parent list unnecessarily.
101 int setUpCounter;
102
103 // This list holds type id's of enabled elements, indexed by the
104 // stack index of the elements.
105 SoTypeList elements;
106
107 // Pointer to parent's list of enabled elements (NULL for
108 // SoAction).
109 SoEnabledElementsList *parent;
110};
111
112#endif
113
114#endif // _SO_ENABLED_ELEMENTS_LIST_H_
115
<a href="IconLegend.html"><img src="extTGS.gif" alt="VSG extension" border="0"></a> Portable mutex c...
Stores runtime type information.
Definition SoType.h:98
Maintains a list of SoTypes.
Definition SoTypeList.h:72