Developer Documentation
Loading...
Searching...
No Matches
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
53#include "elementInOut.hh"
54#include "../parser/input.hh"
55
56//== NAMESPACES ===============================================================
57namespace VSI {
58
59//== CLASS DEFINITION =========================================================
60
66class ElementInput : public ElementInOut {
67
68 public:
69
71 ElementInput (Input *_in, SceneElement *_parent);
72
75
77 Type type () const override { return TypeInput; };
78
80 void setValid (bool _value) { valid_ = _value; };
81
83 bool valid ();
84
86 void setValue (const QString& _value);
87
89 QString value () const { return value_; };
90
92 void addConnection (Connection *_conn) override;
93
95 void removeConnection (Connection *_conn) override;
96
98 void set (bool _set);
99
101 bool isSet ();
102
104 void setForceAsk (bool _set) { forceAsk_ = _set; };
105
107 bool isForceAskSet () const { return forceAsk_; };
108
110 unsigned int state ();
111
113 void saveToXml (QDomDocument &_doc, QDomElement &_root);
114
116 void loadElementInputFromXml (QDomElement& _domElement);
117
118 private:
119 Input *in_;
120
121
122 bool valid_;
123
124 bool isSet_;
125 QString value_;
126
127 bool forceAsk_;
128};
129
130//=============================================================================
131}
132//=============================================================================
133
134#endif
void setValid(bool _value)
Sets the valid flag (needed during code generation)
void saveToXml(QDomDocument &_doc, QDomElement &_root)
Save to xml.
QString value() const
Returns value set by user.
~ElementInput()
Destructor.
void setValue(const QString &_value)
Set to a user value.
void loadElementInputFromXml(QDomElement &_domElement)
Load from xml.
bool valid()
Returns state of valid flag (needed during code generation)
bool isSet()
Return "set" flag.
void removeConnection(Connection *_conn) override
Remove connection.
bool isForceAskSet() const
Return "ForceAsk" flag.
void addConnection(Connection *_conn) override
Add connection.
unsigned int state()
VSI::Input state passthrough.
Type type() const override
Type (=Input)
void set(bool _set)
"Set" flag to mark input as set by user
void setForceAsk(bool _set)
"ForceAsk" flag to mark an optional input for asking during script execution