SoNode.h
#ifndef COIN_SONODE_H
#define COIN_SONODE_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/fields/SoFieldContainer.h>
class SoAction;
class SoCallbackAction;
class SoChildList;
class SoGLRenderAction;
class SoGetBoundingBoxAction;
class SoGetMatrixAction;
class SoGetPrimitiveCountAction;
class SoHandleEventAction;
class SoNodeList;
class SoNotList;
class SoOutput;
class SoPickAction;
class SoRayPickAction;
class SoSearchAction;
class SoWriteAction;
class SoAudioRenderAction;
class SbDict;
class COIN_DLL_API SoNode : public SoFieldContainer {
typedef SoFieldContainer inherited;
public:
// Probably not interesting for the application programmer..?
#ifndef DOXYGEN_SKIP_THIS
enum Stage { FIRST_INSTANCE, PROTO_INSTANCE, OTHER_INSTANCE };
#endif // !DOXYGEN_SKIP_THIS
void setOverride(const SbBool state);
SbBool isOverride(void) const;
enum NodeType {
INVENTOR = 0x0000,
VRML1 = 0x0001,
VRML2 = 0x0002,
INVENTOR_1 = 0x0004,
INVENTOR_2_0 = 0x0008,
INVENTOR_2_1 = 0x0010,
INVENTOR_2_5 = 0x0020,
INVENTOR_2_6 = 0x0040,
COIN_1_0 = 0x0080,
COIN_2_0 = 0x0100,
EXTENSION = 0x0200,
COIN_2_2 = 0x0400,
COIN_2_3 = 0x0800,
COIN_2_4 = 0x1000,
INVENTOR_5_0 = 0x2000,
COIN_2_5 = 0x4000,
COIN_3_0 = 0x8000,
INVENTOR_6_0 = 0x10000,
COIN_4_0 = 0x20000
};
static uint32_t getCompatibilityTypes(const SoType & nodetype);
void setNodeType(const NodeType type);
NodeType getNodeType(void) const;
virtual SoNode * copy(SbBool copyconnections = FALSE) const;
virtual SbBool affectsState(void) const;
virtual void doAction(SoAction * action);
virtual void GLRender(SoGLRenderAction * action);
virtual void GLRenderBelowPath(SoGLRenderAction * action);
virtual void GLRenderInPath(SoGLRenderAction * action);
virtual void GLRenderOffPath(SoGLRenderAction * action);
virtual void callback(SoCallbackAction * action);
virtual void getBoundingBox(SoGetBoundingBoxAction * action);
virtual void getMatrix(SoGetMatrixAction * action);
virtual void handleEvent(SoHandleEventAction * action);
virtual void pick(SoPickAction * action);
virtual void rayPick(SoRayPickAction * action);
virtual void search(SoSearchAction * action);
virtual void write(SoWriteAction * action);
virtual void audioRender(SoAudioRenderAction * action);
virtual void getPrimitiveCount(SoGetPrimitiveCountAction * action);
virtual void grabEventsSetup(void);
virtual void grabEventsCleanup(void);
virtual void startNotify(void);
virtual void notify(SoNotList * l);
SbUniqueId getNodeId(void) const;
virtual SoChildList * getChildren(void) const;
virtual void writeInstance(SoOutput * out);
virtual SoNode * addToCopyDict(void) const;
virtual void copyContents(const SoFieldContainer * from,
SbBool copyconnections);
virtual SoFieldContainer * copyThroughConnection(void) const;
static SoType getClassTypeId(void);
static SoNode * getByName(const SbName & name);
static int getByName(const SbName & name, SoNodeList & l);
static void initClass(void);
static void initClasses(void);
static SbUniqueId getNextNodeId(void);
static int getActionMethodIndex(const SoType type);
static void getBoundingBoxS(SoAction * action, SoNode * node);
static void GLRenderS(SoAction * action, SoNode * node);
static void callbackS(SoAction * action, SoNode * node);
static void getMatrixS(SoAction * action, SoNode * node);
static void handleEventS(SoAction * action, SoNode * node);
static void pickS(SoAction * action, SoNode * node);
static void rayPickS(SoAction * action, SoNode * node);
static void searchS(SoAction * action, SoNode * node);
static void writeS(SoAction * action, SoNode * node);
static void audioRenderS(SoAction * action, SoNode * node);
static void getPrimitiveCountS(SoAction * action, SoNode * node);
protected:
SoNode(void);
virtual ~SoNode();
virtual SbBool readInstance(SoInput * in, unsigned short flags);
static const SoFieldData ** getFieldDataPtr(void);
// These are necessary to avoid problems with us not exporting the
// nextActionMethodIndex member into Win32 DLLs (we'll get
// unresolved symbol for extension node classes if the SoSubNode
// macros accesses the nextActionMethodIndex directly).
static void setNextActionMethodIndex(int index);
static int getNextActionMethodIndex(void);
static void incNextActionMethodIndex(void);
static void setCompatibilityTypes(const SoType & nodetype, const uint32_t bitmask);
SbUniqueId uniqueId;
static SbUniqueId nextUniqueId;
static int nextActionMethodIndex;
private:
static SoType classTypeId;
uint32_t stateflags;
void clearStateFlags(const unsigned int bits);
void setStateFlags(const unsigned int bits);
SbBool getState(const unsigned int bits) const;
static void cleanupClass(void);
};
#ifndef COIN_INTERNAL
// For SGI / TGS Open Inventor compile-time compatibility.
#include <Inventor/SoLists.h>
#endif // COIN_INTERNAL
#endif // !COIN_SONODE_H
SbDict
The SbDict class organizes a dictionary of keys and values.
Definition SbDict.h:63
SbName
The SbName class stores strings by reference.
Definition SbName.h:40
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
SoBase::startNotify
virtual void startNotify(void)
Definition SoBase.cpp:792
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
SoFieldContainer::writeInstance
virtual void writeInstance(SoOutput *out)
Definition SoFieldContainer.cpp:733
SoFieldContainer::SoFieldContainer
SoFieldContainer(void)
Definition SoFieldContainer.cpp:133
SoFieldContainer::getClassTypeId
static SoType getClassTypeId(void)
This static method returns the SoType object associated with objects of this class.
Definition SoFieldContainer.cpp:283
SoFieldContainer::notify
virtual void notify(SoNotList *l)
Definition SoFieldContainer.cpp:654
SoFieldContainer::initClass
static void initClass(void)
Sets up initialization for data common to all instances of this class, like submitting necessary info...
Definition SoFieldContainer.cpp:241
SoFieldContainer::copyThroughConnection
virtual SoFieldContainer * copyThroughConnection(void) const
Definition SoFieldContainer.cpp:822
SoFieldContainer::readInstance
virtual SbBool readInstance(SoInput *in, unsigned short flags)
Definition SoFieldContainer.cpp:1049
SoFieldContainer::copyContents
virtual void copyContents(const SoFieldContainer *from, SbBool copyconnections)
Definition SoFieldContainer.cpp:804
SoFieldContainer::cleanupClass
static void cleanupClass(void)
Definition SoFieldContainer.cpp:273
SoFieldData
The SoFieldData class is a container for a prototype set of fields.
Definition SoFieldData.h:48
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
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
SoNodeList
The SoNodeList class is a container for pointers to SoNode objects.
Definition SoNodeList.h:40
SoNode
The SoNode class is the base class for nodes used in scene graphs.
Definition SoNode.h:56
SoNode::SoNode
SoNode(void)
Definition SoNode.cpp:417
SoNode::setOverride
void setOverride(const SbBool state)
Definition SoNode.cpp:762
SoNode::isOverride
SbBool isOverride(void) const
Definition SoNode.cpp:780
SoNode::nextUniqueId
static SbUniqueId nextUniqueId
Definition SoNode.h:170
SoNode::nextActionMethodIndex
static int nextActionMethodIndex
Definition SoNode.h:171
SoNode::uniqueId
SbUniqueId uniqueId
Definition SoNode.h:169
SoNode::NodeType
NodeType
Definition SoNode.h:68
SoNode::COIN_2_0
@ COIN_2_0
Definition SoNode.h:78
SoNode::COIN_2_2
@ COIN_2_2
Definition SoNode.h:80
SoNode::INVENTOR_2_6
@ INVENTOR_2_6
Definition SoNode.h:76
SoNode::COIN_2_3
@ COIN_2_3
Definition SoNode.h:81
SoNode::INVENTOR_1
@ INVENTOR_1
Definition SoNode.h:72
SoNode::INVENTOR
@ INVENTOR
Definition SoNode.h:69
SoNode::COIN_2_5
@ COIN_2_5
Definition SoNode.h:84
SoNode::INVENTOR_5_0
@ INVENTOR_5_0
Definition SoNode.h:83
SoNode::COIN_2_4
@ COIN_2_4
Definition SoNode.h:82
SoNode::INVENTOR_2_1
@ INVENTOR_2_1
Definition SoNode.h:74
SoNode::VRML1
@ VRML1
Definition SoNode.h:70
SoNode::COIN_4_0
@ COIN_4_0
Definition SoNode.h:87
SoNode::VRML2
@ VRML2
Definition SoNode.h:71
SoNode::EXTENSION
@ EXTENSION
Definition SoNode.h:79
SoNode::INVENTOR_2_0
@ INVENTOR_2_0
Definition SoNode.h:73
SoNode::INVENTOR_2_5
@ INVENTOR_2_5
Definition SoNode.h:75
SoNode::COIN_3_0
@ COIN_3_0
Definition SoNode.h:85
SoNode::INVENTOR_6_0
@ INVENTOR_6_0
Definition SoNode.h:86
SoNode::COIN_1_0
@ COIN_1_0
Definition SoNode.h:77
SoNotList
The SoNotList class is a list of SoNotRec notification records.
Definition SoNotification.h:43
SoOutput
The SoOutput class is an abstraction of an output stream.
Definition SoOutput.h:51
SoPickAction
The SoPickAction class is the base class for picking actions.
Definition SoPickAction.h:43
SoRayPickAction
The SoRayPickAction class does ray intersection with scene graphs.
Definition SoRayPickAction.h:50
SoSearchAction
The SoSearchAction class provides methods for searching through scene graphs.
Definition SoSearchAction.h:44
SoType
The SoType class is the basis for the runtime type system in Coin.
Definition SoType.h:59
SoWriteAction
The SoWriteAction class writes a scene graph to file.
Definition SoWriteAction.h:42