Coin: ScXML.h Source File

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

ScXML.h
1#ifndef COIN_SCXML_H
2#define COIN_SCXML_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/SoType.h>
38#include <Inventor/SbName.h>
39
40class ScXMLStateMachine;
41class ScXMLEvaluator;
42class SbByteBuffer;
43
44 class COIN_DLL_API ScXML {
45public:
46 static void initClasses(void);
47 static void cleanClasses(void);
48
49 static ScXMLStateMachine * readFile(const char * filename);
50 static ScXMLStateMachine * readBuffer(const SbByteBuffer & buffer);
51
52 static SbBool registerEvaluatorType(SbName profilename, SoType evaluatortype);
53 static SbBool unregisterEvaluatorType(SbName profilename, SoType evaluatortype);
54 static SoType getEvaluatorTypeForProfile(SbName profilename);
55
56}; // ScXML
57
58#endif // !COIN_SCXML_H
SbByteBuffer
Definition SbByteBuffer.h:33
SbName
The SbName class stores strings by reference.
Definition SbName.h:40
ScXMLEvaluator
defines an interface for profile-dependent evaluators.
Definition ScXMLEvaluator.h:44
ScXMLStateMachine
Manager for processing events and setting states in SCXML structures.
Definition ScXMLStateMachine.h:61
ScXML
namespace for static ScXML-related functions.
Definition ScXML.h:44
ScXML::readFile
static ScXMLStateMachine * readFile(const char *filename)
Definition ScXML.cpp:345
ScXML::initClasses
static void initClasses(void)
Definition ScXML.cpp:163
ScXML::readBuffer
static ScXMLStateMachine * readBuffer(const SbByteBuffer &buffer)
Definition ScXML.cpp:365
SoType
The SoType class is the basis for the runtime type system in Coin.
Definition SoType.h:59