NL_systemobject.h

/***************************************************************************
**                                                                        **
**  This file is part of SpineCreator, an easy to use GUI for             **
**  describing spiking neural network models.                             **
**  Copyright (C) 2013-2014 Alex Cope, Paul Richmond, Seb James           **
**                                                                        **
**  This program is free software: you can redistribute it and/or modify  **
**  it under the terms of the GNU General Public License as published by  **
**  the Free Software Foundation, either version 3 of the License, or     **
**  (at your option) any later version.                                   **
**                                                                        **
**  This program 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 General Public License for more details.                          **
**                                                                        **
**  You should have received a copy of the GNU General Public License     **
**  along with this program.  If not, see http://www.gnu.org/licenses/.   **
**                                                                        **
****************************************************************************
**           Author: Alex Cope                                            **
**  Website/Contact: http://bimpa.group.shef.ac.uk/                       **
****************************************************************************/

#ifndef SYSTEMOBJECT_H
#define SYSTEMOBJECT_H

#include "globalHeader.h"

/*!
 * Order matters here. Order these from "should be lowest in the
 * diagram" to "should be drawn on top of everything in a
 * diagram". See saveNetworkImageDialog::drawOrderLessThan for the
 * reason why this is.
 */
enum systemObjectType
{
    populationObject,
    projectionObject,
    synapseObject,
    inputObject,
    nullObject
};

class systemObject
{
public:

    virtual QString getName() { return "oops";}

    virtual void move(float, float) {}
    virtual void draw(QPainter *, float, float, float, int, int, QImage, drawStyle){}
    virtual bool is_clicked(float, float, float) {return true;}
    virtual void remove(nl_rootdata *) {/*delete this;*/}
    virtual void delAll(nl_rootdata *) {/*delete this;*/}
    /*!
     * \brief newFromExisting
     * Copy *this* and return as a new QSharedPointer
     * \return
     */
    virtual QSharedPointer<systemObject> newFromExisting(QMap <systemObject *, QSharedPointer <systemObject> > &) {return QSharedPointer<systemObject>(new systemObject);}

    /*!
     * \brief remapSharedPointers
     * Takes a map from old shared pointers to new ones - used
     * to update references when copy / pasting systemObjects
     */
    virtual void remapSharedPointers(QMap <systemObject *, QSharedPointer <systemObject> >) {return;}


    /*!
     * Set location offset for the object relative to the points x and
     * y (which is probably the mouse x,y), using the currentLocation
     * as a starting point.
     */
    virtual void setLocationOffsetRelTo(float x, float y)
    {
        this->locationOffset =  currentLocation() - QPointF(x,y);
    }

    /*!
     * Plain setter for the location offset.
     */
    virtual void setLocationOffset(float x, float y)
    {
        this->locationOffset = QPointF(x,y);
    }

    /*!
     * Plain setter for the location offset.
     */
    virtual void setLocationOffset(QPointF offset)
    {
        this->locationOffset = offset;
    }
    /*!
     * Plain getter for the location offset.
     */
    virtual QPointF getLocationOffset()
    {
        return this->locationOffset;
    }

    virtual QPointF currentLocation()
    {
        return QPointF(0,0);
    }

    systemObjectType type;
    int tag;
    bool connected;
    bool isDeleted;
    systemObject();
    virtual ~systemObject() {}

    /*!
     * The offset between (probably) the mouse which is
     * holding/dragging the object and the "real" currentLocation of
     * the object.
     */
    QPointF locationOffset;

    /*!
     * \brief annotation
     * QString to hold the annotation data for this object
     */
    QString annotation;

    // Maybe have QMap<QString,QString> annotationTexts here, plus
    // virtual methods for saving the data to the network.
};

#endif // SYSTEMOBJECT_H