elementInput.hh 5.31 KB
Newer Older
Jan Möbius's avatar
Jan Möbius committed
1 2 3
/*===========================================================================*\
*                                                                            *
*                              OpenFlipper                                   *
Martin Schultz's avatar
Martin Schultz committed
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38
 *           Copyright (c) 2001-2015, RWTH-Aachen University                 *
 *           Department of Computer Graphics and Multimedia                  *
 *                          All rights reserved.                             *
 *                            www.openflipper.org                            *
 *                                                                           *
 *---------------------------------------------------------------------------*
 * This file is part of OpenFlipper.                                         *
 *---------------------------------------------------------------------------*
 *                                                                           *
 * Redistribution and use in source and binary forms, with or without        *
 * modification, are permitted provided that the following conditions        *
 * are met:                                                                  *
 *                                                                           *
 * 1. Redistributions of source code must retain the above copyright notice, *
 *    this list of conditions and the following disclaimer.                  *
 *                                                                           *
 * 2. Redistributions in binary form must reproduce the above copyright      *
 *    notice, this list of conditions and the following disclaimer in the    *
 *    documentation and/or other materials provided with the distribution.   *
 *                                                                           *
 * 3. Neither the name of the copyright holder nor the names of its          *
 *    contributors may be used to endorse or promote products derived from   *
 *    this software without specific prior written permission.               *
 *                                                                           *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS       *
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A           *
 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,  *
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,       *
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR        *
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF    *
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING      *
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS        *
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.              *
Jan Möbius's avatar
Jan Möbius committed
39 40 41
*                                                                            *
\*===========================================================================*/

Jan Möbius's avatar
Jan Möbius committed
42

Jan Möbius's avatar
 
Jan Möbius committed
43 44 45 46 47 48 49 50 51 52 53 54

#ifndef VSI_ELEMENTINPUT_HH
#define VSI_ELEMENTINPUT_HH

//== INCLUDES =================================================================
#include <QString>

#include <QDomDocument>
#include <QDomElement>
#include <QXmlQuery>

#include "elementInOut.hh"
Jan Möbius's avatar
Jan Möbius committed
55
#include "../parser/input.hh"
Jan Möbius's avatar
 
Jan Möbius committed
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77

//== NAMESPACES ===============================================================
namespace VSI {

//== CLASS DEFINITION =========================================================

/** Class for inputs of a scene element.
  * It handles all the different ways of input (connection to an output,
  * user configured during script creation, asking user during script execution,
  * optional)
  */
class ElementInput : public ElementInOut {

  public:

    /// Constructor
    ElementInput (Input *_in, SceneElement *_parent);

    /// Destructor
    ~ElementInput ();

    /// Type (=Input)
Jan Möbius's avatar
Jan Möbius committed
78
    Type type () const  override { return TypeInput; };
Jan Möbius's avatar
 
Jan Möbius committed
79 80 81 82 83 84 85 86 87 88 89

    /// Sets the valid flag (needed during code generation)
    void setValid (bool _value) { valid_ = _value; };

    /// Returns state of valid flag (needed during code generation)
    bool valid ();

    /// Set to a user value
    void setValue (QString _value);

    /// Returns value set by user
Jan Möbius's avatar
Jan Möbius committed
90
    QString value () const { return value_; };
Jan Möbius's avatar
 
Jan Möbius committed
91 92

    /// Add connection
Jan Möbius's avatar
Jan Möbius committed
93
    void addConnection (Connection *_conn) override;
Jan Möbius's avatar
 
Jan Möbius committed
94 95

    /// Remove connection
Jan Möbius's avatar
Jan Möbius committed
96
    void removeConnection (Connection *_conn) override;
Jan Möbius's avatar
 
Jan Möbius committed
97 98 99 100 101 102 103 104 105 106 107

    /// "Set" flag to mark input as set by user
    void set (bool _set);

    /// Return "set" flag
    bool isSet ();

    /// "ForceAsk" flag to mark an optional input for asking during script execution
    void setForceAsk (bool _set) { forceAsk_ = _set; };

    /// Return "ForceAsk" flag
Jan Möbius's avatar
Jan Möbius committed
108
    bool isForceAskSet () const { return forceAsk_; };
Jan Möbius's avatar
 
Jan Möbius committed
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135

    /// VSI::Input state passthrough
    unsigned int state ();

    /// Save to xml
    void saveToXml (QDomDocument &_doc, QDomElement &_root);

    /// Load from xml
    void loadFromXml (QXmlQuery &_xml);

  private:
    Input *in_;


    bool valid_;

    bool isSet_;
    QString value_;

    bool forceAsk_;
};

//=============================================================================
}
//=============================================================================

#endif