OpenSceneGraph 3.6.5
ScriptEngine
Go to the documentation of this file.
1/* -*-c++-*- OpenSceneGraph - Copyright (C) 1998-2013 Robert Osfield
2 *
3 * This library is open source and may be redistributed and/or modified under
4 * the terms of the OpenSceneGraph Public License (OSGPL) version 0.0 or
5 * (at your option) any later version. The full license is in LICENSE file
6 * included with this distribution, and on the openscenegraph.org website.
7 *
8 * This library is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * OpenSceneGraph Public License for more details.
12*/
13
14#ifndef OSG_SCRIPTENGINE
15#define OSG_SCRIPTENGINE 1
16
17#include <osg/Object>
18#include <osg/Callback>
19#include <osg/NodeVisitor>
20#include <osg/UserDataContainer>
21
22namespace osg
23{
24
25// forward declare
26class ScriptEngine;
27
28/* Script class for wrapping a script and the language used in the script.*/
29class Script : public osg::Object
30{
31 public:
33 Script(const std::string& language, const std::string& str): _language(language), _script(str), _modifiedCount(0) {}
34 Script(const Script& rhs, const osg::CopyOp& copyop=osg::CopyOp::SHALLOW_COPY): osg::Object(rhs,copyop), _language(rhs._language), _script(rhs._script), _modifiedCount(0) {}
35
37
38 void setLanguage(const std::string& language) { _language = language; dirty(); }
39 const std::string& getLanguage() const{ return _language; }
40
41 void setScript(const std::string& str) { _script = str; dirty(); }
42 const std::string& getScript() const { return _script; }
43
44 void dirty() { ++_modifiedCount; }
45 unsigned int getModifiedCount() const { return _modifiedCount; }
46
47 protected:
48
49 virtual ~Script() {}
50
51 std::string _language;
52 std::string _script;
53 unsigned int _modifiedCount;
54};
55
56
59{
60 public:
61 ScriptNodeCallback(Script* script=0, const std::string& entryPoint="") : _script(script), _entryPoint(entryPoint) {}
63 osg::Object(rhs,copyop),
64 osg::Callback(rhs,copyop),
65 osg::NodeCallback(rhs,copyop), _script(rhs._script) {}
66
68
69
70 void setScript(osg::Script* script) { _script = script; }
71
73 osg::Script* getScript() { return _script.get(); }
74
76 const osg::Script* getScript() const { return _script.get(); }
77
79 void setEntryPoint(const std::string& script) { _entryPoint = script; }
80
82 const std::string& getEntryPoint() const { return _entryPoint; }
83
86
88 virtual void operator()(osg::Node* node, osg::NodeVisitor* nv);
89
90 protected:
91
93
95 std::string _entryPoint;
96};
97
101{
102 public:
103
105 inline const std::string& getLanguage() const { return _language; }
106
108 bool run(osg::Script* script)
109 {
110 // assumpt empty input and output parameters lists
111 Parameters inputParameters, outputParameters;
112 return run(script, "", inputParameters, outputParameters);
113 }
114
116 virtual bool run(osg::Script* script, const std::string& entryPoint, Parameters& inputParameters, Parameters& outputParameters) = 0;
117
118 protected:
119
120 ScriptEngine(const std::string& language):_language(language) { setName(language); }
121 virtual ~ScriptEngine() {}
122
123 std::string _language;
124};
125
126}
127
128#endif
The core osg library provides the basic scene graph classes such as Nodes, State and Drawables,...
Definition AlphaFunc:19
std::vector< osg::ref_ptr< osg::Object > > Parameters
Definition Callback:130
std::vector< Node * > NodePath
A vector of Nodes pointers which is used to describe the path from a root node to a descendant.
Definition Node:47
Definition Callback:34
Deprecated.
Definition Callback:215
NodeCallback()
Definition Callback:219
Copy Op(erator) used to control whether shallow or deep copy is used during copy construction and clo...
Definition CopyOp:41
@ SHALLOW_COPY
Definition CopyOp:47
Base class for all internal nodes in the scene graph.
Definition Node:72
Visitor for type safe operations on osg::Nodes.
Definition NodeVisitor:82
Base class/standard interface for objects which require IO support, cloning and reference counting.
Definition Object:61
virtual void setName(const std::string &name)
Set the name of object using C++ style string.
Definition Object:203
Object()
Construct an object.
Definition Object:69
Smart pointer for handling referenced counted objects.
Definition ref_ptr:32
Definition ScriptEngine:30
void dirty()
Definition ScriptEngine:44
std::string _script
Definition ScriptEngine:52
const std::string & getScript() const
Definition ScriptEngine:42
Script(const Script &rhs, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
Definition ScriptEngine:34
unsigned int getModifiedCount() const
Definition ScriptEngine:45
META_Object(osg, Script) void setLanguage(const std
Definition ScriptEngine:36
const std::string & getLanguage() const
Definition ScriptEngine:39
std::string _language
Definition ScriptEngine:51
Script()
Definition ScriptEngine:32
void setScript(const std::string &str)
Definition ScriptEngine:41
Script(const std::string &language, const std::string &str)
Definition ScriptEngine:33
unsigned int _modifiedCount
Definition ScriptEngine:53
virtual ~Script()
Definition ScriptEngine:49
const std::string & getEntryPoint() const
Get the script to call.
Definition ScriptEngine:82
std::string _entryPoint
Definition ScriptEngine:95
const osg::Script * getScript() const
Get the script to call.
Definition ScriptEngine:76
ScriptNodeCallback(const ScriptNodeCallback &rhs, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
Definition ScriptEngine:62
META_Object(osg, ScriptNodeCallback) void setScript(osg
Set the script to call.
Definition ScriptEngine:67
osg::ScriptEngine * getScriptEngine(osg::NodePath &nodePath)
find the ScriptEngine from looking at the UserDataContainers of nodes in scene graph above the Script...
void setEntryPoint(const std::string &script)
Set the entry point to call.
Definition ScriptEngine:79
osg::ref_ptr< Script > _script
Definition ScriptEngine:94
virtual void operator()(osg::Node *node, osg::NodeVisitor *nv)
NodeCallback method, calls the Script.
ScriptNodeCallback(Script *script=0, const std::string &entryPoint="")
Definition ScriptEngine:61
osg::Script * getScript()
Get the script to call.
Definition ScriptEngine:73
virtual ~ScriptNodeCallback()
Definition ScriptEngine:92
ScriptEngine base class for integrating different scripting languages.
Definition ScriptEngine:101
ScriptEngine(const std::string &language)
Definition ScriptEngine:120
std::string _language
Definition ScriptEngine:123
bool run(osg::Script *script)
run a Script.
Definition ScriptEngine:108
virtual bool run(osg::Script *script, const std::string &entryPoint, Parameters &inputParameters, Parameters &outputParameters)=0
run a Script.
virtual ~ScriptEngine()
Definition ScriptEngine:121
const std::string & getLanguage() const
get the scripting language supported by the ScriptEngine.
Definition ScriptEngine:105
#define OSG_EXPORT
Definition Export:39

osg logo
Generated at Wed Jul 23 2025 00:00:00 for the OpenSceneGraph by doxygen 1.14.0.