element.hh 5.49 KB
Newer Older
Jan Möbius's avatar
Jan Möbius committed
1 2 3
/*===========================================================================*\
*                                                                            *
*                              OpenFlipper                                   *
Jan Möbius's avatar
Jan Möbius committed
4
*      Copyright (C) 2001-2011 by Computer Graphics Group, RWTH Aachen       *
Jan Möbius's avatar
Jan Möbius committed
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 39 40 41
*                           www.openflipper.org                              *
*                                                                            *
*--------------------------------------------------------------------------- *
*  This file is part of OpenFlipper.                                         *
*                                                                            *
*  OpenFlipper is free software: you can redistribute it and/or modify       *
*  it under the terms of the GNU Lesser General Public License as            *
*  published by the Free Software Foundation, either version 3 of            *
*  the License, or (at your option) any later version with the               *
*  following exceptions:                                                     *
*                                                                            *
*  If other files instantiate templates or use macros                        *
*  or inline functions from this file, or you compile this file and          *
*  link it with other files to produce an executable, this file does         *
*  not by itself cause the resulting executable to be covered by the         *
*  GNU Lesser General Public License. This exception does not however        *
*  invalidate any other reasons why the executable file might be             *
*  covered by the GNU Lesser General Public License.                         *
*                                                                            *
*  OpenFlipper is distributed in the hope that it will be useful,            *
*  but WITHOUT ANY WARRANTY; without even the implied warranty of            *
*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the             *
*  GNU Lesser General Public License for more details.                       *
*                                                                            *
*  You should have received a copy of the GNU LesserGeneral Public           *
*  License along with OpenFlipper. If not,                                   *
*  see <http://www.gnu.org/licenses/>.                                       *
*                                                                            *
\*===========================================================================*/

/*===========================================================================*\
*                                                                            *
*   $Revision$                                                       *
*   $LastChangedBy$                                                *
*   $Date$                     *
*                                                                            *
\*===========================================================================*/
Jan Möbius's avatar
 
Jan Möbius committed
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83

#ifndef VSI_ELEMENT_HH_
#define VSI_ELEMENT_HH_

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

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

//== FORWARDDECLARATIONS ======================================================
class Input;
class Output;
class InOut;
class Context;
class Function;

#define ELEMENT_FLAG_NO_DELETE 0x1
#define ELEMENT_FLAG_SKIP_TOOLBOX 0x2

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

/** Class that represents an element of the visual scripting interface.
  */
class Element {

  public:

    /// Constructor
    Element (Context *_context, QString _name);

    /// Destructor
    ~Element ();

    /// Context of element
    Context *context () const { return context_; };

    /// Element name
    QString name () const { return name_; };

    /// Element category
Jan Möbius's avatar
Jan Möbius committed
84
    const QString &category () const { return category_; };
Jan Möbius's avatar
 
Jan Möbius committed
85 86

    /// Short description
Jan Möbius's avatar
Jan Möbius committed
87
    const QString &shortDescription () const { return shortDesc_; };
Jan Möbius's avatar
 
Jan Möbius committed
88 89

    /// Long description
Jan Möbius's avatar
Jan Möbius committed
90
    const QString &longDescription () const { return longDesc_; };
Jan Möbius's avatar
 
Jan Möbius committed
91 92

    /// Inputs
Jan Möbius's avatar
Jan Möbius committed
93
    const QVector<Input *> &inputs () const { return inputs_; };
Jan Möbius's avatar
 
Jan Möbius committed
94 95

    /// Outputs
Jan Möbius's avatar
Jan Möbius committed
96
    const QVector<Output *> &outputs () const { return outputs_; };
Jan Möbius's avatar
 
Jan Möbius committed
97 98

    /// Functions
Jan Möbius's avatar
Jan Möbius committed
99
    const QVector <Function*> &functions () const { return functions_; };
Jan Möbius's avatar
 
Jan Möbius committed
100 101 102 103 104 105 106 107 108 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 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150

    /// Scenegraph input
    Input *dataIn () { return dataIn_; };

    /// Scenegraph output
    Output *dataOut () { return dataOut_; };

    /// Flags
    unsigned int flags () const { return flags_; };

    /// Precode segment
    QString precode () const { return precode_; };

    /// Code segment
    QString code () const { return code_; };

    /// Returns an unused id number
    unsigned int getNewId ();

    /// sets the minimum for an unused id
    void setMinId (unsigned int _id);

    friend class Context;

  private:
    Context *context_;

    QString name_;
    QString category_;
    QString shortDesc_;
    QString longDesc_;

    QString precode_;
    QString code_;

    QVector <Input*> inputs_;
    QVector <Output*> outputs_;
    QVector <Function*> functions_;

    Input *dataIn_;
    Output *dataOut_;

    unsigned int flags_;

    unsigned int id_;
};

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

Jan Möbius's avatar
Jan Möbius committed
151
#endif