elementInOut.hh 5.3 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
*                                                                            *
\*===========================================================================*/
Jan Möbius's avatar
 
Jan Möbius committed
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 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 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
#ifndef VSI_ELEMENTINOUT_HH
#define VSI_ELEMENTINOUT_HH

//== INCLUDES =================================================================

#include <QList>

//== FORWARDDECLARATIONS ======================================================
class QGraphicsItem;

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

//== FORWARDDECLARATIONS ======================================================
class Text;
class ConnectionPoint;
class Connection;
class InOut;
class GraphicsScene;
class SceneElement;

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

/** Base class for inputs and outputs of scene elements.
  * It provides the visible widgets and handles connections
  */
class ElementInOut {

  public:

    /// Type
    enum Type {
      TypeInput,
      TypeOutput
    };

    /// Constructor
    ElementInOut (InOut *_io, SceneElement *_parent);

    /// Destructor
    virtual ~ElementInOut ();

    /// Type
    virtual Type type () const = 0;

    /// Connection point widget
    ConnectionPoint *connectionPointItem () const { return conn_; }

    /// Type text widget
    Text *typeTextItem () const { return typeText_; }

    /// Short description widget
    Text *descriptionTextItem () const { return descText_; }

    /// Connections
    QList<Connection *> connections () const { return connections_; };

    /// Add the connection
    virtual void addConnection (Connection *_conn);

    /// Remove the Connection
    virtual void removeConnection (Connection *_conn);

    /// Can this input/output be connected to _e
    bool validConnection (ElementInOut *_e);

    /// InOut context object
110
    InOut* inOut () const { return io_; };
Jan Möbius's avatar
 
Jan Möbius committed
111 112

    /// Scene element
113
    SceneElement* element() { return element_; };
Jan Möbius's avatar
 
Jan Möbius committed
114 115

  private:
116 117 118 119

    /// Private copy constructor to avoid accidental copy
    ElementInOut( const ElementInOut& _orig );

Jan Möbius's avatar
 
Jan Möbius committed
120 121 122 123 124 125 126 127 128 129 130 131 132 133
    InOut *io_;
    SceneElement *element_;

    ConnectionPoint *conn_;
    Text            *typeText_;
    Text            *descText_;

    QList<Connection *> connections_;
};

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

134
#endif