Coin Logo Coin3D is Free Software,
published under the BSD 3-clause license.
https://coin3d.github.io
https://www.kongsberg.com/en/kogt/
SoVRMLScript.h
Go to the documentation of this file.
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 
40 class SoVRMLScript;
41 class SoVRMLScriptP;
42 class SoSensor;
43 
44 typedef void SoVRMLScriptEvaluateCB(void * closure, SoVRMLScript * node);
45 
46 class COIN_DLL_API SoVRMLScript : public SoNode
47 {
48  typedef SoNode inherited;
49 
50 public:
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 
72 protected:
73  virtual ~SoVRMLScript();
74  virtual void copyContents(const SoFieldContainer * from, SbBool copyconn);
75  virtual void notify(SoNotList * list);
76 private:
77  static SoType classTypeId;
78  static void * createInstance(void);
79  SoFieldData * fielddata;
80  virtual const SoFieldData * getFieldData(void) const;
81 
82 private:
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
virtual void copyContents(const SoFieldContainer *from, SbBool copyconnections)
Definition: SoNode.cpp:1434
virtual void notify(SoNotList *l)
Definition: SoNode.cpp:461
The SoFieldContainer class is a base class for all classes that contain fields.
Definition: SoFieldContainer.h:43
virtual SoType getTypeId(void) const =0
Returns the type identification of an object derived from a class inheriting SoBase. This is used for runtime type checking and "downward" casting.
The SoPickAction class is the base class for picking actions.
Definition: SoPickAction.h:43
The SoNode class is the base class for nodes used in scene graphs.
Definition: SoNode.h:56
virtual const SoFieldData * getFieldData(void) const
Definition: SoFieldContainer.cpp:748
The SoSFBool class is a container for an SbBool value.
Definition: SoSFBool.h:39
The SoSensor class is the abstract base class for all sensors.
Definition: SoSensor.h:43
virtual SbBool readInstance(SoInput *in, unsigned short flags)
Definition: SoNode.cpp:1490
The SoAction class is the base class for all traversal actions.
Definition: SoAction.h:77
The SoMFString class is a container for SbString values.
Definition: SoMFString.h:40
virtual void pick(SoPickAction *action)
Definition: SoNode.cpp:1109
virtual void doAction(SoAction *action)
Definition: SoNode.cpp:809
The SoHandleEventAction class distributes user events to the scene.
Definition: SoHandleEventAction.h:46
The SoGetBoundingBoxAction class calculates bounding boxes for nodes and subgraphs.
Definition: SoGetBoundingBoxAction.h:45
The SoCallbackAction class invokes callbacks at specific nodes.
Definition: SoCallbackAction.h:80
The SoWriteAction class writes a scene graph to file.
Definition: SoWriteAction.h:42
The SoInput class is an abstraction of file import functionality.
Definition: SoInput.h:61
virtual void getBoundingBox(SoGetBoundingBoxAction *action)
Definition: SoNode.cpp:865
The SoFieldData class is a container for a prototype set of fields.
Definition: SoFieldData.h:48
virtual void GLRender(SoGLRenderAction *action)
Definition: SoNode.cpp:954
The SoNotList class is a list of SoNotRec notification records.
Definition: SoNotification.h:43
The SoType class is the basis for the runtime type system in Coin.
Definition: SoType.h:59
virtual void write(SoWriteAction *action)
Definition: SoNode.cpp:1241
virtual void callback(SoCallbackAction *action)
Definition: SoNode.cpp:1026
The SoVRMLScript class is used to control the scene using scripts.
Definition: SoVRMLScript.h:46
virtual void handleEvent(SoHandleEventAction *action)
Definition: SoNode.cpp:1083
The SoGLRenderAction class renders the scene graph with OpenGL calls.
Definition: SoGLRenderAction.h:50