SoGLRenderAction.h
#ifndef COIN_SOGLRENDERACTION_H
#define COIN_SOGLRENDERACTION_H
/**************************************************************************\
* Copyright (c) Kongsberg Oil & Gas Technologies AS
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* Neither the name of the copyright holder nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
\**************************************************************************/
#include <Inventor/actions/SoAction.h>
#include <Inventor/actions/SoSubAction.h>
#include <Inventor/SbBasic.h>
#include <Inventor/SbViewportRegion.h>
#include <Inventor/system/inttypes.h>
#include <Inventor/lists/SoPathList.h>
#include <Inventor/lists/SbList.h>
typedef void SoGLRenderPassCB(void * userdata);
typedef void SoGLPreRenderCB(void * userdata, class SoGLRenderAction * action);
typedef float SoGLSortedObjectOrderCB(void * userdata, SoGLRenderAction * action);
class SoGLRenderActionP;
class COIN_DLL_API SoGLRenderAction : public SoAction {
typedef SoAction inherited;
SO_ACTION_HEADER(SoGLRenderAction);
public:
static void initClass(void);
SoGLRenderAction(const SbViewportRegion & viewportregion);
virtual ~SoGLRenderAction(void);
enum TransparencyType {
SCREEN_DOOR,
ADD, DELAYED_ADD, SORTED_OBJECT_ADD,
BLEND, DELAYED_BLEND, SORTED_OBJECT_BLEND,
// The remaining are Coin extensions to the common Inventor API
SORTED_OBJECT_SORTED_TRIANGLE_ADD,
SORTED_OBJECT_SORTED_TRIANGLE_BLEND,
NONE, SORTED_LAYERS_BLEND
};
enum TransparentDelayedObjectRenderType {
ONE_PASS,
NONSOLID_SEPARATE_BACKFACE_PASS
};
enum AbortCode {
CONTINUE, ABORT, PRUNE, DELAY
};
enum SortedObjectOrderStrategy {
BBOX_CENTER,
BBOX_CLOSEST_CORNER,
BBOX_FARTHEST_CORNER,
CUSTOM_CALLBACK
};
typedef AbortCode SoGLRenderAbortCB(void * userdata);
void setViewportRegion(const SbViewportRegion & newregion);
const SbViewportRegion & getViewportRegion(void) const;
void setUpdateArea(const SbVec2f & origin, const SbVec2f & size);
void getUpdateArea(SbVec2f & origin, SbVec2f & size) const;
void setAbortCallback(SoGLRenderAbortCB * const func, void * const userdata);
void getAbortCallback(SoGLRenderAbortCB * & func_out, void * & userdata_out) const;
void setTransparencyType(const TransparencyType type);
TransparencyType getTransparencyType(void) const;
void setTransparentDelayedObjectRenderType(TransparentDelayedObjectRenderType type);
TransparentDelayedObjectRenderType getTransparentDelayedObjectRenderType(void) const;
void setSmoothing(const SbBool smooth);
SbBool isSmoothing(void) const;
void setNumPasses(const int num);
int getNumPasses(void) const;
void setPassUpdate(const SbBool flag);
SbBool isPassUpdate(void) const;
void setPassCallback(SoGLRenderPassCB * const func, void * const userdata);
void setCacheContext(const uint32_t context);
uint32_t getCacheContext(void) const;
void addDelayedPath(SoPath * path);
SbBool isRenderingDelayedPaths(void) const;
SbBool handleTransparency(SbBool istransparent = FALSE);
void setCurPass(const int passnum, const int numpasses);
int getCurPass(void) const;
SbBool abortNow(void);
void setRenderingIsRemote(SbBool isremote);
SbBool getRenderingIsRemote(void) const;
virtual void invalidateState(void);
void addPreRenderCallback(SoGLPreRenderCB * func, void * userdata);
void removePreRenderCallback(SoGLPreRenderCB * func, void * userdata);
void setSortedLayersNumPasses(int num);
int getSortedLayersNumPasses(void) const;
void setSortedObjectOrderStrategy(const SortedObjectOrderStrategy strategy,
SoGLSortedObjectOrderCB * cb = NULL,
void * closure = NULL);
void setDelayedObjDepthWrite(SbBool write);
SbBool getDelayedObjDepthWrite(void) const;
SbBool isRenderingTranspPaths(void) const;
SbBool isRenderingTranspBackfaces(void) const;
protected:
friend class SoGLRenderActionP; // calls beginTraversal
virtual void beginTraversal(SoNode * node);
virtual void endTraversal(SoNode * node);
private:
SbPimplPtr<SoGLRenderActionP> pimpl;
SoGLRenderAction(const SoGLRenderAction & rhs);
SoGLRenderAction & operator = (const SoGLRenderAction & rhs);
}; // SoGLRenderAction
#endif // !COIN_SOGLRENDERACTION_H
SbPimplPtr
Definition SbPimplPtr.h:55
SbVec2f
The SbVec2f class is a 2 dimensional vector with floating point coordinates.
Definition SbVec2f.h:49
SbViewportRegion
The SbViewportRegion class is a viewport within a full window.
Definition SbViewportRegion.h:40
SoAction::invalidateState
virtual void invalidateState(void)
Definition SoAction.cpp:821
SoAction::initClass
static void initClass(void)
Definition SoAction.cpp:370
SoAction::SoAction
SoAction(void)
Definition SoAction.cpp:337
SoAction::beginTraversal
virtual void beginTraversal(SoNode *node)
Definition SoAction.cpp:1269
SoAction::endTraversal
virtual void endTraversal(SoNode *node)
Definition SoAction.cpp:1279
SoGLRenderAction
The SoGLRenderAction class renders the scene graph with OpenGL calls.
Definition SoGLRenderAction.h:50
SoGLRenderAction::addDelayedPath
void addDelayedPath(SoPath *path)
Definition SoGLRenderAction.cpp:1444
SoGLRenderAction::AbortCode
AbortCode
Definition SoGLRenderAction.h:76
SoGLRenderAction::DELAY
@ DELAY
Definition SoGLRenderAction.h:77
SoGLRenderAction::ABORT
@ ABORT
Definition SoGLRenderAction.h:77
SoGLRenderAction::PRUNE
@ PRUNE
Definition SoGLRenderAction.h:77
SoGLRenderAction::CONTINUE
@ CONTINUE
Definition SoGLRenderAction.h:77
SoGLRenderAction::setPassCallback
void setPassCallback(SoGLRenderPassCB *const func, void *const userdata)
Definition SoGLRenderAction.cpp:962
SoGLRenderAction::setPassUpdate
void setPassUpdate(const SbBool flag)
Definition SoGLRenderAction.cpp:941
SoGLRenderAction::setCurPass
void setCurPass(const int passnum, const int numpasses)
Definition SoGLRenderAction.cpp:1327
SoGLRenderAction::SoGLRenderAbortCB
AbortCode SoGLRenderAbortCB(void *userdata)
Definition SoGLRenderAction.h:87
SoGLRenderAction::SoGLRenderAction
SoGLRenderAction(const SbViewportRegion &viewportregion)
Definition SoGLRenderAction.cpp:699
SoGLRenderAction::getDelayedObjDepthWrite
SbBool getDelayedObjDepthWrite(void) const
Definition SoGLRenderAction.cpp:1990
SoGLRenderAction::abortNow
SbBool abortNow(void)
Definition SoGLRenderAction.cpp:1351
SoGLRenderAction::isPassUpdate
SbBool isPassUpdate(void) const
Definition SoGLRenderAction.cpp:952
SoGLRenderAction::setSmoothing
void setSmoothing(const SbBool smooth)
Definition SoGLRenderAction.cpp:899
SoGLRenderAction::getViewportRegion
const SbViewportRegion & getViewportRegion(void) const
Definition SoGLRenderAction.cpp:767
SoGLRenderAction::setTransparentDelayedObjectRenderType
void setTransparentDelayedObjectRenderType(TransparentDelayedObjectRenderType type)
Definition SoGLRenderAction.cpp:2026
SoGLRenderAction::addPreRenderCallback
void addPreRenderCallback(SoGLPreRenderCB *func, void *userdata)
Definition SoGLRenderAction.cpp:1536
SoGLRenderAction::setTransparencyType
void setTransparencyType(const TransparencyType type)
Definition SoGLRenderAction.cpp:863
SoGLRenderAction::getSortedLayersNumPasses
int getSortedLayersNumPasses(void) const
Definition SoGLRenderAction.cpp:1018
SoGLRenderAction::isRenderingDelayedPaths
SbBool isRenderingDelayedPaths(void) const
Definition SoGLRenderAction.cpp:1457
SoGLRenderAction::setSortedLayersNumPasses
void setSortedLayersNumPasses(int num)
Definition SoGLRenderAction.cpp:1008
SoGLRenderAction::isSmoothing
SbBool isSmoothing(void) const
Definition SoGLRenderAction.cpp:911
SoGLRenderAction::getCacheContext
uint32_t getCacheContext(void) const
Definition SoGLRenderAction.cpp:996
SoGLRenderAction::removePreRenderCallback
void removePreRenderCallback(SoGLPreRenderCB *func, void *userdata)
Definition SoGLRenderAction.cpp:1549
SoGLRenderAction::getTransparencyType
TransparencyType getTransparencyType(void) const
Definition SoGLRenderAction.cpp:875
SoGLRenderAction::getNumPasses
int getNumPasses(void) const
Definition SoGLRenderAction.cpp:932
SoGLRenderAction::getRenderingIsRemote
SbBool getRenderingIsRemote(void) const
Definition SoGLRenderAction.cpp:1428
SoGLRenderAction::isRenderingTranspBackfaces
SbBool isRenderingTranspBackfaces(void) const
Definition SoGLRenderAction.cpp:2015
SoGLRenderAction::getTransparentDelayedObjectRenderType
TransparentDelayedObjectRenderType getTransparentDelayedObjectRenderType(void) const
Definition SoGLRenderAction.cpp:2037
SoGLRenderAction::isRenderingTranspPaths
SbBool isRenderingTranspPaths(void) const
Definition SoGLRenderAction.cpp:2003
SoGLRenderAction::setSortedObjectOrderStrategy
void setSortedObjectOrderStrategy(const SortedObjectOrderStrategy strategy, SoGLSortedObjectOrderCB *cb=NULL, void *closure=NULL)
Definition SoGLRenderAction.cpp:1574
SoGLRenderAction::TransparencyType
TransparencyType
Definition SoGLRenderAction.h:61
SoGLRenderAction::ADD
@ ADD
Definition SoGLRenderAction.h:63
SoGLRenderAction::SORTED_OBJECT_SORTED_TRIANGLE_ADD
@ SORTED_OBJECT_SORTED_TRIANGLE_ADD
Definition SoGLRenderAction.h:66
SoGLRenderAction::SCREEN_DOOR
@ SCREEN_DOOR
Definition SoGLRenderAction.h:62
SoGLRenderAction::BLEND
@ BLEND
Definition SoGLRenderAction.h:64
SoGLRenderAction::SORTED_OBJECT_BLEND
@ SORTED_OBJECT_BLEND
Definition SoGLRenderAction.h:64
SoGLRenderAction::SORTED_LAYERS_BLEND
@ SORTED_LAYERS_BLEND
Definition SoGLRenderAction.h:68
SoGLRenderAction::SORTED_OBJECT_SORTED_TRIANGLE_BLEND
@ SORTED_OBJECT_SORTED_TRIANGLE_BLEND
Definition SoGLRenderAction.h:67
SoGLRenderAction::DELAYED_ADD
@ DELAYED_ADD
Definition SoGLRenderAction.h:63
SoGLRenderAction::SORTED_OBJECT_ADD
@ SORTED_OBJECT_ADD
Definition SoGLRenderAction.h:63
SoGLRenderAction::NONE
@ NONE
Definition SoGLRenderAction.h:68
SoGLRenderAction::DELAYED_BLEND
@ DELAYED_BLEND
Definition SoGLRenderAction.h:64
SoGLRenderAction::setAbortCallback
void setAbortCallback(SoGLRenderAbortCB *const func, void *const userdata)
Definition SoGLRenderAction.cpp:835
SoGLRenderAction::setNumPasses
void setNumPasses(const int num)
Definition SoGLRenderAction.cpp:922
SoGLRenderAction::TransparentDelayedObjectRenderType
TransparentDelayedObjectRenderType
Definition SoGLRenderAction.h:71
SoGLRenderAction::NONSOLID_SEPARATE_BACKFACE_PASS
@ NONSOLID_SEPARATE_BACKFACE_PASS
Definition SoGLRenderAction.h:73
SoGLRenderAction::ONE_PASS
@ ONE_PASS
Definition SoGLRenderAction.h:72
SoGLRenderAction::getCurPass
int getCurPass(void) const
Definition SoGLRenderAction.cpp:1339
SoGLRenderAction::handleTransparency
SbBool handleTransparency(SbBool istransparent=FALSE)
Definition SoGLRenderAction.cpp:1206
SoGLRenderAction::setRenderingIsRemote
void setRenderingIsRemote(SbBool isremote)
Definition SoGLRenderAction.cpp:1415
SoGLRenderAction::setViewportRegion
void setViewportRegion(const SbViewportRegion &newregion)
Definition SoGLRenderAction.cpp:755
SoGLRenderAction::getUpdateArea
void getUpdateArea(SbVec2f &origin, SbVec2f &size) const
Definition SoGLRenderAction.cpp:792
SoGLRenderAction::setDelayedObjDepthWrite
void setDelayedObjDepthWrite(SbBool write)
Definition SoGLRenderAction.cpp:1978
SoGLRenderAction::SortedObjectOrderStrategy
SortedObjectOrderStrategy
Definition SoGLRenderAction.h:80
SoGLRenderAction::BBOX_CENTER
@ BBOX_CENTER
Definition SoGLRenderAction.h:81
SoGLRenderAction::BBOX_CLOSEST_CORNER
@ BBOX_CLOSEST_CORNER
Definition SoGLRenderAction.h:82
SoGLRenderAction::BBOX_FARTHEST_CORNER
@ BBOX_FARTHEST_CORNER
Definition SoGLRenderAction.h:83
SoGLRenderAction::CUSTOM_CALLBACK
@ CUSTOM_CALLBACK
Definition SoGLRenderAction.h:84
SoGLRenderAction::setCacheContext
void setCacheContext(const uint32_t context)
Definition SoGLRenderAction.cpp:984
SoGLRenderAction::setUpdateArea
void setUpdateArea(const SbVec2f &origin, const SbVec2f &size)
Definition SoGLRenderAction.cpp:781
SoGLRenderAction::getAbortCallback
void getAbortCallback(SoGLRenderAbortCB *&func_out, void *&userdata_out) const
Definition SoGLRenderAction.cpp:849
SoNode
The SoNode class is the base class for nodes used in scene graphs.
Definition SoNode.h:56
SoPath
The SoPath class is a container class for traversal path descriptions.
Definition SoPath.h:52