SoVRMLScript.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.
\**************************************************************************/
#ifndef COIN_SOVRMLSCRIPT_H
#define COIN_SOVRMLSCRIPT_H
#include <Inventor/nodes/SoSubNode.h>
#include <Inventor/fields/SoSFBool.h>
#include <Inventor/fields/SoMFString.h>
class SoVRMLScript;
class SoVRMLScriptP;
class SoSensor;
typedef void SoVRMLScriptEvaluateCB(void * closure, SoVRMLScript * node);
class COIN_DLL_API SoVRMLScript : public SoNode
{
typedef SoNode inherited;
public:
static void initClass(void);
SoVRMLScript(void);
static SoType getClassTypeId(void);
virtual SoType getTypeId(void) const;
SoMFString url;
SoSFBool directOutput;
SoSFBool mustEvaluate;
virtual void doAction(SoAction * action);
virtual void callback(SoCallbackAction * action);
virtual void GLRender(SoGLRenderAction * action);
virtual void getBoundingBox(SoGetBoundingBoxAction * action);
virtual void pick(SoPickAction * action);
virtual void handleEvent(SoHandleEventAction * action);
virtual void write(SoWriteAction * action);
static void setScriptEvaluateCB(SoVRMLScriptEvaluateCB * cb,
void * closure);
protected:
virtual ~SoVRMLScript();
virtual void copyContents(const SoFieldContainer * from, SbBool copyconn);
virtual void notify(SoNotList * list);
private:
static SoType classTypeId;
static void * createInstance(void);
SoFieldData * fielddata;
virtual const SoFieldData * getFieldData(void) const;
private:
virtual SbBool readInstance(SoInput * in, unsigned short flags);
static void eval_cb(void * data, SoSensor *);
void initFieldData(void);
SoVRMLScriptP * pimpl;
friend class SoVRMLScriptP;
}; // class SoVRMLScript
#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::getFieldData
virtual const SoFieldData * getFieldData(void) const
Definition SoFieldContainer.cpp:756
SoFieldContainer::SoFieldContainer
SoFieldContainer(void)
Definition SoFieldContainer.cpp:133
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::SoNode
SoNode(void)
Definition SoNode.cpp:417
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
SoVRMLScript::setScriptEvaluateCB
static void setScriptEvaluateCB(SoVRMLScriptEvaluateCB *cb, void *closure)
Definition Script.cpp:412
SoVRMLScript::SoVRMLScript
SoVRMLScript(void)
Definition Script.cpp:327
SoWriteAction
The SoWriteAction class writes a scene graph to file.
Definition SoWriteAction.h:42