Coin: SoVRMLSwitch.h Source File

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

SoVRMLSwitch.h
1/**************************************************************************\
2 * Copyright (c) Kongsberg Oil & Gas Technologies AS
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met:
8 *
9 * Redistributions of source code must retain the above copyright notice,
10 * this list of conditions and the following disclaimer.
11 *
12 * Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 *
16 * Neither the name of the copyright holder nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31\**************************************************************************/
32
33#ifndef COIN_SOVRMLSWITCH_H
34#define COIN_SOVRMLSWITCH_H
35
36#include <Inventor/nodes/SoSubNode.h>
37#include <Inventor/nodes/SoGroup.h>
38#include <Inventor/fields/SoMFNode.h>
39#include <Inventor/fields/SoSFInt32.h>
40
41// undef in case Inventor/nodes/SoSwitch.h has been included first
42#undef SO_SWITCH_NONE
43#undef SO_SWITCH_INHERIT
44#undef SO_SWITCH_ALL
45
46#define SO_SWITCH_NONE (-1)
47#define SO_SWITCH_INHERIT (-2)
48#define SO_SWITCH_ALL (-3)
49
50class SoVRMLSwitchP;
51
52 class COIN_DLL_API SoVRMLSwitch : public SoGroup
53{
54 typedef SoGroup inherited;
55 SO_NODE_HEADER(SoVRMLSwitch);
56
57public:
58 static void initClass(void);
59 SoVRMLSwitch(void);
60 SoVRMLSwitch( int choices);
61
62 SoMFNode choice;
63 SoSFInt32 whichChoice;
64
65 virtual SbBool affectsState(void) const;
66
67 void addChoice(SoNode * choice);
68 void insertChoice(SoNode * choice, int idx);
69 SoNode * getChoice(int idx) const;
70 int findChoice(SoNode * choice) const;
71 int getNumChoices(void) const;
72 void removeChoice(int idx);
73 void removeChoice(SoNode * node);
74 void removeAllChoices(void);
75 void replaceChoice(int idx, SoNode * choice);
76 void replaceChoice(SoNode * old, SoNode * choice);
77
78 virtual void doAction(SoAction * action);
79 virtual void callback(SoCallbackAction * action);
80 virtual void GLRender(SoGLRenderAction * action);
81 virtual void pick(SoPickAction * action);
82 virtual void getBoundingBox(SoGetBoundingBoxAction * action);
83 virtual void handleEvent(SoHandleEventAction * action);
84 virtual void getMatrix(SoGetMatrixAction * action);
85 virtual void search(SoSearchAction * action);
86 virtual void write(SoWriteAction * action);
87 virtual void audioRender(SoAudioRenderAction * action);
88
89 void addChild(SoNode * child);
90 void insertChild(SoNode * child, int idx);
91 SoNode * getChild(int idx) const;
92 int findChild(const SoNode * child) const;
93 int getNumChildren(void) const;
94 void removeChild(int idx);
95 void removeChild(SoNode * child);
96 void removeAllChildren(void);
97 void replaceChild(int idx, SoNode * node);
98 void replaceChild(SoNode * old, SoNode * node);
99 virtual SoChildList * getChildren(void) const;
100
101protected:
102 virtual ~SoVRMLSwitch(void);
103
104 virtual void notify(SoNotList * list);
105 virtual SbBool readInstance(SoInput * in, unsigned short flags);
106 virtual void copyContents(const SoFieldContainer * from, SbBool copyConn);
107
108private:
109 void commonConstructor(void);
110 SoVRMLSwitchP * pimpl;
111 friend class SoVRMLSwitchP;
112}; // class SoVRMLSwitch
113
114#endif // ! COIN_SOVRMLSWITCH_H
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
SoChildList
The SoChildList class is a container for node children.
Definition SoChildList.h:42
SoFieldContainer
The SoFieldContainer class is a base class for all classes that contain fields.
Definition SoFieldContainer.h:43
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
SoGroup
The SoGroup class is a node which managed other node instances.
Definition SoGroup.h:40
SoGroup::removeChild
virtual void removeChild(int childindex)
Definition SoGroup.cpp:492
SoGroup::insertChild
virtual void insertChild(SoNode *child, int newchildindex)
Definition SoGroup.cpp:470
SoGroup::removeAllChildren
virtual void removeAllChildren(void)
Definition SoGroup.cpp:830
SoGroup::write
virtual void write(SoWriteAction *action)
Definition SoGroup.cpp:756
SoGroup::GLRender
virtual void GLRender(SoGLRenderAction *action)
Definition SoGroup.cpp:614
SoGroup::doAction
virtual void doAction(SoAction *action)
Definition SoGroup.cpp:542
SoGroup::addChild
virtual void addChild(SoNode *node)
Definition SoGroup.cpp:453
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::getChildren
virtual SoChildList * getChildren(void) const
Definition SoGroup.cpp:788
SoGroup::handleEvent
virtual void handleEvent(SoHandleEventAction *action)
Definition SoGroup.cpp:718
SoGroup::pick
virtual void pick(SoPickAction *action)
Definition SoGroup.cpp:711
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::copyContents
virtual void copyContents(const SoFieldContainer *from, SbBool copyconnections)
Definition SoGroup.cpp:403
SoGroup::getNumChildren
virtual int getNumChildren(void) const
Definition SoGroup.cpp:305
SoGroup::getBoundingBox
virtual void getBoundingBox(SoGetBoundingBoxAction *action)
Definition SoGroup.cpp:558
SoGroup::replaceChild
virtual void replaceChild(int index, SoNode *newchild)
Definition SoGroup.cpp:849
SoGroup::findChild
virtual int findChild(const SoNode *node) const
Definition SoGroup.cpp:517
SoGroup::getChild
virtual SoNode * getChild(int index) const
Definition SoGroup.cpp:291
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
SoMFNode
The SoMFNode class is a container for nodes.
Definition SoMFNode.h:41
SoNode
The SoNode class is the base class for nodes used in scene graphs.
Definition SoNode.h:56
SoNode::notify
virtual void notify(SoNotList *l)
Definition SoNode.cpp:506
SoNode::affectsState
virtual SbBool affectsState(void) const
Definition SoNode.cpp:880
SoNotList
The SoNotList class is a list of SoNotRec notification records.
Definition SoNotification.h:43
SoPickAction
The SoPickAction class is the base class for picking actions.
Definition SoPickAction.h:43
SoSFInt32
The SoSFInt32 class is a container for a 32-bit integer value.
Definition SoSFInt32.h:39
SoSearchAction
The SoSearchAction class provides methods for searching through scene graphs.
Definition SoSearchAction.h:44
SoVRMLSwitch
The SoVRMLSwitch class is a group node for traversing selected children.
Definition SoVRMLSwitch.h:53
SoVRMLSwitch::whichChoice
SoSFInt32 whichChoice
Definition SoVRMLSwitch.h:63
SoVRMLSwitch::choice
SoMFNode choice
Definition SoVRMLSwitch.h:62
SoWriteAction
The SoWriteAction class writes a scene graph to file.
Definition SoWriteAction.h:42