Open Inventor Release 2024.2.0
 
Loading...
Searching...
No Matches
SoAnnotation.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**=======================================================================*/
26/*=======================================================================
27 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.), ***
28 *** AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT. ***
29 *** ***
30 *** REPRODUCTION, DISCLOSURE, OR USE, IN WHOLE OR IN PART, OTHER THAN AS ***
31 *** SPECIFIED IN THE LICENSE ARE NOT TO BE UNDERTAKEN EXCEPT WITH PRIOR ***
32 *** WRITTEN AUTHORIZATION OF FEI S.A.S. ***
33 *** ***
34 *** RESTRICTED RIGHTS LEGEND ***
35 *** USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS ***
36 *** WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN ***
37 *** SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT ***
38 *** CLAUSE AT FAR 52.227-19 OR SUBPARAGRAPH (C)(1)(II) OF THE RIGHTS IN ***
39 *** TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013. ***
40 *** ***
41 *** COPYRIGHT (C) 1996-2019 BY FEI S.A.S, ***
42 *** BORDEAUX, FRANCE ***
43 *** ALL RIGHTS RESERVED ***
44**=======================================================================*/
45/*=======================================================================
46** Modified by : VSG (MMM YYYY)
47**=======================================================================*/
48
49
50#ifndef _SO_ANNOTATION_
51#define _SO_ANNOTATION_
52
53#include <Inventor/nodes/SoSeparator.h>
54#include <Inventor/SoType.h>
55
56SO_PIMPL_PUBLIC_DECLARATION(SoAnnotation)
57
58
59//
60// Class: SoAnnotation
61//
62// Annotation group node: delays rendering its children until all
63// other nodes have been traversed, turning off depth buffer
64// comparisons first. The result is that the shapes under the
65// annotation node are rendered on top of the rest of the scene.
66//
67// Note that if more than one annotation node is present in a graph,
68// the order in which they are traversed determines the stacking
69// order - later nodes are rendered on top of earlier ones. Also note
70// that since depth buffer comparisons are disabled, complex 3D
71// objects may not be rendered correctly when used under annotation
72// nodes.
73//
74// All non-rendering actions are inherited as is from SoSeparator.
75//
77
130class SoAnnotation : public SoSeparator {
131
132 SO_NODE_HEADER(SoAnnotation);
133 SO_PIMPL_PUBLIC_HEADER(SoAnnotation)
134
135 public:
136
137 // No fields
138
143
144 private:
145 // Implement actions
146 virtual void GLRender(SoGLRenderAction *action);
147 virtual void GLRenderBelowPath(SoGLRenderAction *action);
148 virtual void GLRenderInPath(SoGLRenderAction *action);
149 virtual void GLRenderOffPath(SoGLRenderAction *action);
150 virtual int32_t getRenderUnitID() const;
151
152 private:
153 static void initClass();
154 static void exitClass();
155 static void setNoDelay(SbBool flag);
156 static SbBool getNoDelay();
157
158 private:
159 // Destructor
160 virtual ~SoAnnotation();
161
162 private:
163 void commonConstructor();
164};
165
166#endif /* _SO_ANNOTATION_ */
167
Annotation group node.
SoAnnotation()
Creates an annotation node with default settings.
Renders a scene graph using Open Inventor's Render Engine.
Group node that saves and restores traversal state.
int SbBool
Boolean type.
Definition SbBase.h:87