Coin: SoSeparator.h Source File

| Coin3D is Free Software, published under the BSD 3-clause license. | https://coin3d.github.io https://www.kongsberg.com/en/kogt/

SoSeparator.h
1#ifndef COIN_SOSEPARATOR_H
2#define COIN_SOSEPARATOR_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/nodes/SoSubNode.h>
37#include <Inventor/fields/SoSFEnum.h>
38#include <Inventor/nodes/SoGroup.h>
39#include <Inventor/tools/SbPimplPtr.h>
40
41class SoState;
42class SoSeparatorP;
43
44 class COIN_DLL_API SoSeparator : public SoGroup {
45 typedef SoGroup inherited;
46
47 SO_NODE_HEADER(SoSeparator);
48
49public:
50 static void initClass(void);
51 SoSeparator(void);
52 SoSeparator(const int nchildren);
53
54 enum CacheEnabled {
55 OFF, ON, AUTO
56 };
57
58 SoSFEnum renderCaching;
59 SoSFEnum boundingBoxCaching;
60 SoSFEnum renderCulling;
61 SoSFEnum pickCulling;
62
63 virtual void doAction(SoAction * action);
64 virtual void GLRender(SoGLRenderAction * action);
65 virtual void GLRenderBelowPath(SoGLRenderAction * action);
66 virtual void GLRenderInPath(SoGLRenderAction * action);
67 virtual void GLRenderOffPath(SoGLRenderAction * action);
68 virtual void callback(SoCallbackAction * action);
69 virtual void getBoundingBox(SoGetBoundingBoxAction * action);
70 virtual void getMatrix(SoGetMatrixAction * action);
71 virtual void handleEvent(SoHandleEventAction * action);
72 virtual void rayPick(SoRayPickAction * action);
73 virtual void search(SoSearchAction * action);
74 virtual void getPrimitiveCount(SoGetPrimitiveCountAction * action);
75 virtual void audioRender(SoAudioRenderAction * action);
76
77 virtual void notify(SoNotList * nl);
78
79 static void setNumRenderCaches(const int howmany);
80 static int getNumRenderCaches(void);
81 virtual SbBool affectsState(void) const;
82
83protected:
84 virtual ~SoSeparator();
85
86 virtual SbBool cullTest(SoState * state);
87 virtual SbBool cullTest(SoGLRenderAction * action, int & cullresults);
88 virtual SbBool readInstance(SoInput * in, unsigned short flags);
89
90private:
91 void commonConstructor(void);
92 SbBool cullTestNoPush(SoState * state);
93
94 static int numrendercaches;
95
96 SbPimplPtr<SoSeparatorP> pimpl;
97
98 // NOT IMPLEMENTED
99 SoSeparator(const SoSeparator & rhs);
100 SoSeparator & operator = (const SoSeparator & rhs);
101
102};
103
104#endif // !COIN_SOSEPARATOR_H
SbPimplPtr
Definition SbPimplPtr.h:55
SoAction
The SoAction class is the base class for all traversal actions.
Definition SoAction.h:77
SoAudioRenderAction
The SoAudioRenderAction class renders the aural parts of the scene graph.
Definition SoAudioRenderAction.h:42
SoCallbackAction
The SoCallbackAction class invokes callbacks at specific nodes.
Definition SoCallbackAction.h:80
SoGLRenderAction
The SoGLRenderAction class renders the scene graph with OpenGL calls.
Definition SoGLRenderAction.h:50
SoGetBoundingBoxAction
The SoGetBoundingBoxAction class calculates bounding boxes for nodes and subgraphs.
Definition SoGetBoundingBoxAction.h:45
SoGetMatrixAction
The SoGetMatrixAction class is an action for accumulating the transformation matrix of a subgraph.
Definition SoGetMatrixAction.h:46
SoGetPrimitiveCountAction
The SoGetPrimitiveCountAction class counts the primitives in a scene.
Definition SoGetPrimitiveCountAction.h:44
SoGroup::GLRender
virtual void GLRender(SoGLRenderAction *action)
Definition SoGroup.cpp:614
SoGroup::doAction
virtual void doAction(SoAction *action)
Definition SoGroup.cpp:542
SoGroup::audioRender
virtual void audioRender(SoAudioRenderAction *action)
Definition SoGroup.cpp:725
SoGroup::getMatrix
virtual void getMatrix(SoGetMatrixAction *action)
Definition SoGroup.cpp:696
SoGroup::readInstance
virtual SbBool readInstance(SoInput *in, unsigned short flags)
Definition SoGroup.cpp:312
SoGroup::search
virtual void search(SoSearchAction *action)
Definition SoGroup.cpp:774
SoGroup::SoGroup
SoGroup(void)
Definition SoGroup.cpp:251
SoGroup::handleEvent
virtual void handleEvent(SoHandleEventAction *action)
Definition SoGroup.cpp:718
SoGroup::initClass
static void initClass(void)
Sets up initialization for data common to all instances of this class, like submitting necessary info...
Definition SoGroup.cpp:526
SoGroup::callback
virtual void callback(SoCallbackAction *action)
Definition SoGroup.cpp:689
SoGroup::getBoundingBox
virtual void getBoundingBox(SoGetBoundingBoxAction *action)
Definition SoGroup.cpp:558
SoGroup::getPrimitiveCount
virtual void getPrimitiveCount(SoGetPrimitiveCountAction *action)
Definition SoGroup.cpp:904
SoHandleEventAction
The SoHandleEventAction class distributes user events to the scene.
Definition SoHandleEventAction.h:46
SoInput
The SoInput class is an abstraction of file import functionality.
Definition SoInput.h:61
SoNode::notify
virtual void notify(SoNotList *l)
Definition SoNode.cpp:506
SoNode::GLRenderOffPath
virtual void GLRenderOffPath(SoGLRenderAction *action)
Definition SoNode.cpp:1038
SoNode::affectsState
virtual SbBool affectsState(void) const
Definition SoNode.cpp:880
SoNode::GLRenderInPath
virtual void GLRenderInPath(SoGLRenderAction *action)
Definition SoNode.cpp:1026
SoNode::GLRenderBelowPath
virtual void GLRenderBelowPath(SoGLRenderAction *action)
Definition SoNode.cpp:1014
SoNode::rayPick
virtual void rayPick(SoRayPickAction *action)
Definition SoNode.cpp:1188
SoNotList
The SoNotList class is a list of SoNotRec notification records.
Definition SoNotification.h:43
SoRayPickAction
The SoRayPickAction class does ray intersection with scene graphs.
Definition SoRayPickAction.h:50
SoSFEnum
The SoSFEnum class is a container for an enum value.
Definition SoSFEnum.h:40
SoSearchAction
The SoSearchAction class provides methods for searching through scene graphs.
Definition SoSearchAction.h:44
SoSeparator::boundingBoxCaching
SoSFEnum boundingBoxCaching
Definition SoSeparator.h:59
SoSeparator::getNumRenderCaches
static int getNumRenderCaches(void)
Definition SoSeparator.cpp:925
SoSeparator::cullTest
virtual SbBool cullTest(SoState *state)
Definition SoSeparator.cpp:1023
SoSeparator::CacheEnabled
CacheEnabled
Definition SoSeparator.h:54
SoSeparator::ON
@ ON
Definition SoSeparator.h:55
SoSeparator::OFF
@ OFF
Definition SoSeparator.h:55
SoSeparator::AUTO
@ AUTO
Definition SoSeparator.h:55
SoSeparator::renderCaching
SoSFEnum renderCaching
Definition SoSeparator.h:58
SoSeparator::renderCulling
SoSFEnum renderCulling
Definition SoSeparator.h:60
SoSeparator::pickCulling
SoSFEnum pickCulling
Definition SoSeparator.h:61
SoSeparator::SoSeparator
SoSeparator(void)
Definition SoSeparator.cpp:383
SoSeparator::setNumRenderCaches
static void setNumRenderCaches(const int howmany)
Definition SoSeparator.cpp:913
SoState
The SoState class manages the Coin scene graph traversal state data.
Definition SoState.h:44
SO_NODE_HEADER
#define SO_NODE_HEADER(classname)
Definition Coin_macros.dox:50