Coin Logo Coin3D is Free Software,
published under the BSD 3-clause license.
https://coin3d.github.io
https://www.kongsberg.com/en/kogt/
SoGLRenderAction.h
1#ifndef COIN_SOGLRENDERACTION_H
2#define COIN_SOGLRENDERACTION_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/SbBasic.h>
39#include <Inventor/SbViewportRegion.h>
40#include <Inventor/system/inttypes.h>
41#include <Inventor/lists/SoPathList.h>
42#include <Inventor/lists/SbList.h>
43
44typedef void SoGLRenderPassCB(void * userdata);
45typedef void SoGLPreRenderCB(void * userdata, class SoGLRenderAction * action);
46typedef float SoGLSortedObjectOrderCB(void * userdata, SoGLRenderAction * action);
47
48class SoGLRenderActionP;
49
50class COIN_DLL_API SoGLRenderAction : public SoAction {
51 typedef SoAction inherited;
52
53 SO_ACTION_HEADER(SoGLRenderAction);
54
55public:
56 static void initClass(void);
57
58 SoGLRenderAction(const SbViewportRegion & viewportregion);
59 virtual ~SoGLRenderAction(void);
60
70
75
79
86
87 typedef AbortCode SoGLRenderAbortCB(void * userdata);
88
89 void setViewportRegion(const SbViewportRegion & newregion);
90 const SbViewportRegion & getViewportRegion(void) const;
91 void setUpdateArea(const SbVec2f & origin, const SbVec2f & size);
92 void getUpdateArea(SbVec2f & origin, SbVec2f & size) const;
93 void setAbortCallback(SoGLRenderAbortCB * const func, void * const userdata);
94 void getAbortCallback(SoGLRenderAbortCB * & func_out, void * & userdata_out) const;
99 void setSmoothing(const SbBool smooth);
100 SbBool isSmoothing(void) const;
101 void setNumPasses(const int num);
102 int getNumPasses(void) const;
103 void setPassUpdate(const SbBool flag);
104 SbBool isPassUpdate(void) const;
105 void setPassCallback(SoGLRenderPassCB * const func, void * const userdata);
106 void setCacheContext(const uint32_t context);
107 uint32_t getCacheContext(void) const;
108
109 void addDelayedPath(SoPath * path);
110 SbBool isRenderingDelayedPaths(void) const;
111
112 SbBool handleTransparency(SbBool istransparent = FALSE);
113 void setCurPass(const int passnum, const int numpasses);
114 int getCurPass(void) const;
115 SbBool abortNow(void);
116
117 void setRenderingIsRemote(SbBool isremote);
118 SbBool getRenderingIsRemote(void) const;
119
120 virtual void invalidateState(void);
121
122 void addPreRenderCallback(SoGLPreRenderCB * func, void * userdata);
123 void removePreRenderCallback(SoGLPreRenderCB * func, void * userdata);
124
125 void setSortedLayersNumPasses(int num);
126 int getSortedLayersNumPasses(void) const;
127
129 SoGLSortedObjectOrderCB * cb = NULL,
130 void * closure = NULL);
131
132 void setDelayedObjDepthWrite(SbBool write);
133 SbBool getDelayedObjDepthWrite(void) const;
134
135 SbBool isRenderingTranspPaths(void) const;
136 SbBool isRenderingTranspBackfaces(void) const;
137
138protected:
139 friend class SoGLRenderActionP; // calls beginTraversal
140 virtual void beginTraversal(SoNode * node);
141 virtual void endTraversal(SoNode * node);
142
143private:
145
147 SoGLRenderAction & operator = (const SoGLRenderAction & rhs);
148
149}; // SoGLRenderAction
150
151#endif // !COIN_SOGLRENDERACTION_H
Definition SbPimplPtr.h:55
The SbVec2f class is a 2 dimensional vector with floating point coordinates.
Definition SbVec2f.h:49
The SbViewportRegion class is a viewport within a full window.
Definition SbViewportRegion.h:40
virtual void invalidateState(void)
Definition SoAction.cpp:821
static void initClass(void)
Definition SoAction.cpp:370
SoAction(void)
Definition SoAction.cpp:337
virtual void beginTraversal(SoNode *node)
Definition SoAction.cpp:1269
virtual void endTraversal(SoNode *node)
Definition SoAction.cpp:1279
The SoGLRenderAction class renders the scene graph with OpenGL calls.
Definition SoGLRenderAction.h:50
void addDelayedPath(SoPath *path)
Definition SoGLRenderAction.cpp:1444
AbortCode
Definition SoGLRenderAction.h:76
@ DELAY
Definition SoGLRenderAction.h:77
@ ABORT
Definition SoGLRenderAction.h:77
@ PRUNE
Definition SoGLRenderAction.h:77
@ CONTINUE
Definition SoGLRenderAction.h:77
void setPassCallback(SoGLRenderPassCB *const func, void *const userdata)
Definition SoGLRenderAction.cpp:962
void setPassUpdate(const SbBool flag)
Definition SoGLRenderAction.cpp:941
void setCurPass(const int passnum, const int numpasses)
Definition SoGLRenderAction.cpp:1327
AbortCode SoGLRenderAbortCB(void *userdata)
Definition SoGLRenderAction.h:87
SoGLRenderAction(const SbViewportRegion &viewportregion)
Definition SoGLRenderAction.cpp:699
SbBool getDelayedObjDepthWrite(void) const
Definition SoGLRenderAction.cpp:1990
SbBool abortNow(void)
Definition SoGLRenderAction.cpp:1351
SbBool isPassUpdate(void) const
Definition SoGLRenderAction.cpp:952
void setSmoothing(const SbBool smooth)
Definition SoGLRenderAction.cpp:899
const SbViewportRegion & getViewportRegion(void) const
Definition SoGLRenderAction.cpp:767
void setTransparentDelayedObjectRenderType(TransparentDelayedObjectRenderType type)
Definition SoGLRenderAction.cpp:2026
void addPreRenderCallback(SoGLPreRenderCB *func, void *userdata)
Definition SoGLRenderAction.cpp:1536
void setTransparencyType(const TransparencyType type)
Definition SoGLRenderAction.cpp:863
int getSortedLayersNumPasses(void) const
Definition SoGLRenderAction.cpp:1018
SbBool isRenderingDelayedPaths(void) const
Definition SoGLRenderAction.cpp:1457
void setSortedLayersNumPasses(int num)
Definition SoGLRenderAction.cpp:1008
SbBool isSmoothing(void) const
Definition SoGLRenderAction.cpp:911
uint32_t getCacheContext(void) const
Definition SoGLRenderAction.cpp:996
void removePreRenderCallback(SoGLPreRenderCB *func, void *userdata)
Definition SoGLRenderAction.cpp:1549
TransparencyType getTransparencyType(void) const
Definition SoGLRenderAction.cpp:875
int getNumPasses(void) const
Definition SoGLRenderAction.cpp:932
SbBool getRenderingIsRemote(void) const
Definition SoGLRenderAction.cpp:1428
SbBool isRenderingTranspBackfaces(void) const
Definition SoGLRenderAction.cpp:2015
TransparentDelayedObjectRenderType getTransparentDelayedObjectRenderType(void) const
Definition SoGLRenderAction.cpp:2037
SbBool isRenderingTranspPaths(void) const
Definition SoGLRenderAction.cpp:2003
void setSortedObjectOrderStrategy(const SortedObjectOrderStrategy strategy, SoGLSortedObjectOrderCB *cb=NULL, void *closure=NULL)
Definition SoGLRenderAction.cpp:1574
TransparencyType
Definition SoGLRenderAction.h:61
@ ADD
Definition SoGLRenderAction.h:63
@ SORTED_OBJECT_SORTED_TRIANGLE_ADD
Definition SoGLRenderAction.h:66
@ SCREEN_DOOR
Definition SoGLRenderAction.h:62
@ BLEND
Definition SoGLRenderAction.h:64
@ SORTED_OBJECT_BLEND
Definition SoGLRenderAction.h:64
@ SORTED_LAYERS_BLEND
Definition SoGLRenderAction.h:68
@ SORTED_OBJECT_SORTED_TRIANGLE_BLEND
Definition SoGLRenderAction.h:67
@ DELAYED_ADD
Definition SoGLRenderAction.h:63
@ SORTED_OBJECT_ADD
Definition SoGLRenderAction.h:63
@ NONE
Definition SoGLRenderAction.h:68
@ DELAYED_BLEND
Definition SoGLRenderAction.h:64
void setAbortCallback(SoGLRenderAbortCB *const func, void *const userdata)
Definition SoGLRenderAction.cpp:835
void setNumPasses(const int num)
Definition SoGLRenderAction.cpp:922
TransparentDelayedObjectRenderType
Definition SoGLRenderAction.h:71
@ NONSOLID_SEPARATE_BACKFACE_PASS
Definition SoGLRenderAction.h:73
@ ONE_PASS
Definition SoGLRenderAction.h:72
int getCurPass(void) const
Definition SoGLRenderAction.cpp:1339
SbBool handleTransparency(SbBool istransparent=FALSE)
Definition SoGLRenderAction.cpp:1206
void setRenderingIsRemote(SbBool isremote)
Definition SoGLRenderAction.cpp:1415
void setViewportRegion(const SbViewportRegion &newregion)
Definition SoGLRenderAction.cpp:755
void getUpdateArea(SbVec2f &origin, SbVec2f &size) const
Definition SoGLRenderAction.cpp:792
void setDelayedObjDepthWrite(SbBool write)
Definition SoGLRenderAction.cpp:1978
SortedObjectOrderStrategy
Definition SoGLRenderAction.h:80
@ BBOX_CENTER
Definition SoGLRenderAction.h:81
@ BBOX_CLOSEST_CORNER
Definition SoGLRenderAction.h:82
@ BBOX_FARTHEST_CORNER
Definition SoGLRenderAction.h:83
@ CUSTOM_CALLBACK
Definition SoGLRenderAction.h:84
void setCacheContext(const uint32_t context)
Definition SoGLRenderAction.cpp:984
void setUpdateArea(const SbVec2f &origin, const SbVec2f &size)
Definition SoGLRenderAction.cpp:781
void getAbortCallback(SoGLRenderAbortCB *&func_out, void *&userdata_out) const
Definition SoGLRenderAction.cpp:849
The SoNode class is the base class for nodes used in scene graphs.
Definition SoNode.h:56
The SoPath class is a container class for traversal path descriptions.
Definition SoPath.h:52