Developer Documentation

elementInput.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_ELEMENTINPUT_HH
45 #define VSI_ELEMENTINPUT_HH
46
47 //== INCLUDES =================================================================
48 #include <QString>
49
50 #include <QDomDocument>
51 #include <QDomElement>
52 #include <QXmlQuery>
53
54 #include "elementInOut.hh"
55 #include "../parser/input.hh"
56
57 //== NAMESPACES ===============================================================
58 namespace VSI {
59
60 //== CLASS DEFINITION =========================================================
61
67 class ElementInput : public ElementInOut {
68
69 public:
70
72 ElementInput (Input *_in, SceneElement *_parent);
73
75 ~ElementInput ();
76
78 Type type () const { return TypeInput; };
79
81 void setValid (bool _value) { valid_ = _value; };
82
84 bool valid ();
85
87 void setValue (QString _value);
88
90 QString value () const { return value_; };
91
93 void addConnection (Connection *_conn);
94
96 void removeConnection (Connection *_conn);
97
99 void set (bool _set);
100
102 bool isSet ();
103
105 void setForceAsk (bool _set) { forceAsk_ = _set; };
106
108 bool isForceAskSet () const { return forceAsk_; };
109
111 unsigned int state ();
112
114 void saveToXml (QDomDocument &_doc, QDomElement &_root);
115
117 void loadFromXml (QXmlQuery &_xml);
118
119 private:
120 Input *in_;
121
122
123 bool valid_;
124
125 bool isSet_;
126 QString value_;
127
128 bool forceAsk_;
129 };
130
131 //=============================================================================
132 }
133 //=============================================================================
134
135 #endif
VSI::ElementInput::setValid
void setValid(bool _value)
Sets the valid flag (needed during code generation)
Definition: elementInput.hh:81
VSI::ElementInput::valid
bool valid()
Returns state of valid flag (needed during code generation)
Definition: elementInput.cc:114
VSI::ElementInOut::Type
Type
Type.
Definition: elementInOut.hh:74
VSI::ElementInput::removeConnection
void removeConnection(Connection *_conn)
Remove connection.
Definition: elementInput.cc:147
VSI::ElementInput::setValue
void setValue(QString _value)
Set to a user value.
Definition: elementInput.cc:290
VSI::ElementInput::state
unsigned int state()
VSI::Input state passthrough.
Definition: elementInput.cc:128
VSI::Input
Definition: input.hh:60
VSI::ElementInput::setForceAsk
void setForceAsk(bool _set)
"ForceAsk" flag to mark an optional input for asking during script execution
Definition: elementInput.hh:105
VSI::ElementInput::value
QString value() const
Returns value set by user.
Definition: elementInput.hh:90
VSI::ElementInput::~ElementInput
~ElementInput()
Destructor.
Definition: elementInput.cc:107
VSI::ElementInOut
Definition: elementInOut.hh:69
VSI::SceneElement
Definition: sceneElement.hh:73
VSI::ElementInput::saveToXml
void saveToXml(QDomDocument &_doc, QDomElement &_root)
Save to xml.
Definition: elementInput.cc:210
VSI::ElementInput::isSet
bool isSet()
Return "set" flag.
Definition: elementInput.cc:199
VSI::ElementInput::type
Type type() const
Type (=Input)
Definition: elementInput.hh:78
VSI::ElementInput::ElementInput
ElementInput(Input *_in, SceneElement *_parent)
Constructor.
Definition: elementInput.cc:67
VSI
Definition: baseWidget.cc:72
VSI::ElementInput::addConnection
void addConnection(Connection *_conn)
Add connection.
Definition: elementInput.cc:136
VSI::Connection
Definition: connection.hh:66
VSI::ElementInput::isForceAskSet
bool isForceAskSet() const
Return "ForceAsk" flag.
Definition: elementInput.hh:108
VSI::ElementInput::loadFromXml
void loadFromXml(QXmlQuery &_xml)
Load from xml.
Definition: elementInput.cc:255
VSI::ElementInput
Definition: elementInput.hh:67