Coin: SoVRMLScript.h Source File

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

SoVRMLScript.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_SOVRMLSCRIPT_H
34#define COIN_SOVRMLSCRIPT_H
35
36#include <Inventor/nodes/SoSubNode.h>
37#include <Inventor/fields/SoSFBool.h>
38#include <Inventor/fields/SoMFString.h>
39
40class SoVRMLScript;
41class SoVRMLScriptP;
42class SoSensor;
43
44typedef void SoVRMLScriptEvaluateCB(void * closure, SoVRMLScript * node);
45
46 class COIN_DLL_API SoVRMLScript : public SoNode
47{
48 typedef SoNode inherited;
49
50public:
51 static void initClass(void);
52 SoVRMLScript(void);
53
54 static SoType getClassTypeId(void);
55 virtual SoType getTypeId(void) const;
56
57 SoMFString url;
58 SoSFBool directOutput;
59 SoSFBool mustEvaluate;
60
61 virtual void doAction(SoAction * action);
62 virtual void callback(SoCallbackAction * action);
63 virtual void GLRender(SoGLRenderAction * action);
64 virtual void getBoundingBox(SoGetBoundingBoxAction * action);
65 virtual void pick(SoPickAction * action);
66 virtual void handleEvent(SoHandleEventAction * action);
67 virtual void write(SoWriteAction * action);
68
69 static void setScriptEvaluateCB(SoVRMLScriptEvaluateCB * cb,
70 void * closure);
71
72protected:
73 virtual ~SoVRMLScript();
74 virtual void copyContents(const SoFieldContainer * from, SbBool copyconn);
75 virtual void notify(SoNotList * list);
76private:
77 static SoType classTypeId;
78 static void * createInstance(void);
79 SoFieldData * fielddata;
80 virtual const SoFieldData * getFieldData(void) const;
81
82private:
83 virtual SbBool readInstance(SoInput * in, unsigned short flags);
84
85 static void eval_cb(void * data, SoSensor *);
86 void initFieldData(void);
87 SoVRMLScriptP * pimpl;
88 friend class SoVRMLScriptP;
89}; // class SoVRMLScript
90
91#endif // ! COIN_SOVRMLSCRIPT_H
SoAction
The SoAction class is the base class for all traversal actions.
Definition SoAction.h:77
SoBase::getTypeId
virtual SoType getTypeId(void) const =0
Returns the type identification of an object derived from a class inheriting SoBase....
SoCallbackAction
The SoCallbackAction class invokes callbacks at specific nodes.
Definition SoCallbackAction.h:80
SoFieldContainer
The SoFieldContainer class is a base class for all classes that contain fields.
Definition SoFieldContainer.h:43
SoFieldContainer::getFieldData
virtual const SoFieldData * getFieldData(void) const
Definition SoFieldContainer.cpp:756
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
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
SoMFString
The SoMFString class is a container for SbString values.
Definition SoMFString.h:40
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::handleEvent
virtual void handleEvent(SoHandleEventAction *action)
Definition SoNode.cpp:1132
SoNode::getClassTypeId
static SoType getClassTypeId(void)
Definition SoNode.cpp:361
SoNode::getBoundingBox
virtual void getBoundingBox(SoGetBoundingBoxAction *action)
Definition SoNode.cpp:914
SoNode::doAction
virtual void doAction(SoAction *action)
Definition SoNode.cpp:858
SoNode::callback
virtual void callback(SoCallbackAction *action)
Definition SoNode.cpp:1075
SoNode::readInstance
virtual SbBool readInstance(SoInput *in, unsigned short flags)
Definition SoNode.cpp:1542
SoNode::copyContents
virtual void copyContents(const SoFieldContainer *from, SbBool copyconnections)
Definition SoNode.cpp:1483
SoNode::pick
virtual void pick(SoPickAction *action)
Definition SoNode.cpp:1158
SoNode::write
virtual void write(SoWriteAction *action)
Definition SoNode.cpp:1290
SoNode::initClass
static void initClass(void)
Sets up initialization for data common to all instances of this class, like submitting necessary info...
Definition SoNode.cpp:573
SoNode::GLRender
virtual void GLRender(SoGLRenderAction *action)
Definition SoNode.cpp:1003
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
SoSFBool
The SoSFBool class is a container for an SbBool value.
Definition SoSFBool.h:39
SoSensor
The SoSensor class is the abstract base class for all sensors.
Definition SoSensor.h:43
SoType
The SoType class is the basis for the runtime type system in Coin.
Definition SoType.h:59
SoVRMLScript
The SoVRMLScript class is used to control the scene using scripts.
Definition SoVRMLScript.h:47
SoWriteAction
The SoWriteAction class writes a scene graph to file.
Definition SoWriteAction.h:42