Coin3D is Free Software,
published under the
BSD 3-clause license
.
https://bitbucket.org/Coin3D/
http://www.kongsberg.com/kogt/
SoScriptEngine.h
1
#ifndef COIN_SOSCRIPTENGINE_H
2
#define COIN_SOSCRIPTENGINE_H
3
4
/**************************************************************************\
5
* Copyright (c) Kongsberg Oil & Gas Technologies AS
6
* All rights reserved.
7
*
8
* Redistribution and use in source and binary forms, with or without
9
* modification, are permitted provided that the following conditions are
10
* met:
11
*
12
* Redistributions of source code must retain the above copyright notice,
13
* this list of conditions and the following disclaimer.
14
*
15
* Redistributions in binary form must reproduce the above copyright
16
* notice, this list of conditions and the following disclaimer in the
17
* documentation and/or other materials provided with the distribution.
18
*
19
* Neither the name of the copyright holder nor the names of its
20
* contributors may be used to endorse or promote products derived from
21
* this software without specific prior written permission.
22
*
23
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27
* HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
29
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
30
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
31
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34
\**************************************************************************/
35
36
#include <Inventor/SbBasic.h>
37
#include <Inventor/SbName.h>
38
#include <Inventor/fields/SoField.h>
39
40
class
COIN_DLL_API
SoScriptEngine
{
41
42
public
:
43
// FIXME: should all these functions be const? 20050719 erikgors.
44
// FIXME: what about the return value from executing a script?
45
// 20050719 erikgors.
46
SoScriptEngine
() { }
47
virtual
~
SoScriptEngine
() { }
48
virtual
SbBool executeScript(
const
SbName
& name,
49
const
SbString
& script)
const
= 0;
50
virtual
SbBool executeFile(
const
SbName
& filename)
const
= 0;
51
virtual
SbBool executeFunction(
const
SbName
& name,
int
argc,
52
const
SoField
* argv,
53
SoField
* rval = NULL)
const
= 0;
54
55
virtual
SbBool setScriptField(
const
SbName
& name,
56
const
SoField
* f)
const
= 0;
57
virtual
SbBool getScriptField(
const
SbName
& name,
SoField
* f)
const
= 0;
58
virtual
SbBool unsetScriptField(
const
SbName
& name)
const
= 0;
59
virtual
SbBool hasScriptField(
const
SbName
& name)
const
= 0;
60
};
61
62
#endif // !COIN_SOSCRIPTENGINE_H
SbName
The SbName class stores strings by reference.
Definition:
SbName.h:40
SbString
The SbString class is a string class with convenience functions for string operations.
Definition:
SbString.h:52
SoField
The SoField class is the top-level abstract base class for fields.
Definition:
SoField.h:47
SoScriptEngine
Definition:
SoScriptEngine.h:40
include
Inventor
misc
SoScriptEngine.h
Generated on Tue Sep 17 2019 00:00:00 for Coin by
doxygen
1.8.16