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