Developer Documentation

elementFunction.hh
1 /*===========================================================================*\
2 * *
3 * OpenFlipper *
4 * Copyright (c) 2001-2015, RWTH-Aachen University *
5 * Department of Computer Graphics and Multimedia *
6 * All rights reserved. *
7 * www.openflipper.org *
8 * *
9 *---------------------------------------------------------------------------*
10 * This file is part of OpenFlipper. *
11 *---------------------------------------------------------------------------*
12 * *
13 * Redistribution and use in source and binary forms, with or without *
14 * modification, are permitted provided that the following conditions *
15 * are met: *
16 * *
17 * 1. Redistributions of source code must retain the above copyright notice, *
18 * this list of conditions and the following disclaimer. *
19 * *
20 * 2. Redistributions in binary form must reproduce the above copyright *
21 * notice, this list of conditions and the following disclaimer in the *
22 * documentation and/or other materials provided with the distribution. *
23 * *
24 * 3. Neither the name of the copyright holder nor the names of its *
25 * contributors may be used to endorse or promote products derived from *
26 * this software without specific prior written permission. *
27 * *
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS *
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
30 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A *
31 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
32 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, *
33 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, *
34 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR *
35 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF *
36 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING *
37 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS *
38 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *
39 * *
40 \*===========================================================================*/
41
42
43
44 #ifndef VSI_ELEMENTFUNCTION_HH
45 #define VSI_ELEMENTFUNCTION_HH
46
47 //== INCLUDES =================================================================
48 #include <QString>
49
50 #include <QDomDocument>
51 #include <QDomElement>
52 #include <QXmlQuery>
53
54
55 //== NAMESPACES ===============================================================
56 namespace VSI {
57
58 //== FORWARDDECLARATIONS ======================================================
59 class Function;
60 class SceneElement;
61 class GraphicsScene;
62
66 class ElementFunction : public QObject{
67
68 Q_OBJECT
69
70 public:
71
73 ElementFunction (Function *_f, SceneElement *_element);
74
76 ~ElementFunction ();
77
79 SceneElement *element () { return element_; };
80
82 Function *function () { return function_; };
83
85 GraphicsScene *scene () { return scene_; };
86
88 void saveToXml (QDomDocument &_doc, QDomElement &_root);
89
91 void loadFromXml (QXmlQuery &_xml);
92
93 public slots:
94
95 // Initates editing of this function
96 void editFunction ();
97
98 private:
99
100 SceneElement *element_;
101 Function *function_;
102
103 GraphicsScene *scene_;
104 };
105
106 }
107
108 #endif
VSI::ElementFunction::element
SceneElement * element()
The scene element of this function element.
Definition: elementFunction.hh:79
VSI::Function
Definition: function.hh:67
VSI::ElementFunction::scene
GraphicsScene * scene()
Scene.
Definition: elementFunction.hh:85
VSI::ElementFunction::saveToXml
void saveToXml(QDomDocument &_doc, QDomElement &_root)
Save to xml.
Definition: elementFunction.cc:84
VSI::SceneElement
Definition: sceneElement.hh:73
VSI::ElementFunction::~ElementFunction
~ElementFunction()
Destructor.
Definition: elementFunction.cc:76
VSI
Definition: baseWidget.cc:72
VSI::ElementFunction::loadFromXml
void loadFromXml(QXmlQuery &_xml)
Load from xml.
Definition: elementFunction.cc:95
VSI::ElementFunction
Definition: elementFunction.hh:66
VSI::GraphicsScene
Definition: graphicsScene.hh:80
VSI::ElementFunction::ElementFunction
ElementFunction(Function *_f, SceneElement *_element)
Constructor.
Definition: elementFunction.cc:64