qelectrotech-source-mirror/sources/qetgraphicsitem/terminal.h

/*
	Copyright 2006-2019 The QElectroTech Team
	This file is part of QElectroTech.
	
	QElectroTech 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 2 of the License, or
	(at your option) any later version.
	
	QElectroTech 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 QElectroTech.  If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef TERMINAL_H
#define TERMINAL_H
#include <QtWidgets>
#include <QtXml>
#include "qet.h"
class Conductor;
class Diagram;
class Element;
class TerminalData;

/**
	This class represents a terminal of an electrical element, i.e. a possible
	plug point for conductors.
    This class handles all mouse events for connecting conductors
*/
class Terminal : public QGraphicsObject
{
		Q_OBJECT

	signals:
		void conductorWasAdded(Conductor *conductor);
		void conductorWasRemoved(Conductor *conductor);
	
		// constructors, destructor
	public:
		Terminal(QPointF,      Qet::Orientation, Element * = nullptr);
		Terminal(qreal, qreal, Qet::Orientation, Element * = nullptr);
        Terminal(TerminalData* data, Element *e = nullptr);
		Terminal(QPointF,      Qet::Orientation, QString number, QString name, bool hiddenName, Element * = nullptr);
		~Terminal() override;
	
	private:
		Terminal(const Terminal &);
	
		// methods
	public:
			//Enable the use of qgraphicsitem_cast to safely cast a QGraphicsItem into a Terminal
			//@return the QGraphicsItem type
		int type() const override { return Type; }
	
		void   paint        (QPainter *, const QStyleOptionGraphicsItem *, QWidget *) override;
		void   drawHelpLine (bool draw = true);
		QLineF HelpLine     () const;
		QRectF boundingRect () const override;
	
			// methods to manage conductors attached to the terminal
		Terminal* alignedWithTerminal () const;
		bool      addConductor        (Conductor *conductor);
		void      removeConductor     (Conductor *conductor);
		int       conductorsCount     () const;
		Diagram  *diagram             () const;
		Element  *parentElement       () const;
	
	QList<Conductor *> conductors() const;
	Qet::Orientation orientation() const;
	QPointF dockConductor() const;
	QString number() const;
	QString name() const;
	void setNumber(QString number);
	void setName(QString name, bool hiddenName);
	void updateConductor();
	bool isLinkedTo(Terminal *);
	bool canBeLinkedTo(Terminal *);
	
	// methods related to XML import/export
	static bool valideXml(QDomElement  &);
	bool fromXml (QDomElement &);
	QDomElement toXml (QDomDocument &) const;
	
	protected:
	// methods related to events management
	void hoverEnterEvent  (QGraphicsSceneHoverEvent *) override;
	void hoverMoveEvent   (QGraphicsSceneHoverEvent *) override;
	void hoverLeaveEvent  (QGraphicsSceneHoverEvent *) override;
	void mousePressEvent  (QGraphicsSceneMouseEvent *) override;
	void mouseMoveEvent   (QGraphicsSceneMouseEvent *) override;
	void mouseReleaseEvent(QGraphicsSceneMouseEvent *) override;
	
		// attributes
	public:
		enum { Type = UserType + 1002 };

		static const qreal terminalSize;
		static const qreal Z;
			// Various static colors used for hover effects
			/// default color
		static QColor neutralColor;
			/// color for legal actions
		static QColor allowedColor;
			/// color for allowed but fuzzy or not recommended  actions
		static QColor warningColor;
			/// color for forbidden actions
		static QColor forbiddenColor;
	
	private:
        bool               m_draw_help_line{false};
        QGraphicsLineItem *m_help_line{nullptr};
        QGraphicsLineItem *m_help_line_a{nullptr};


    TerminalData* d;

	/// Parent electrical element
    Element *parent_element_{nullptr};
	/// docking point for parent element
	QPointF dock_elmt_;
	/// List of conductors attached to the terminal
	QList<Conductor *> conductors_;
	/// Pointer to a rectangle representing the terminal bounding rect;
	/// used to calculate the bounding rect once only;
	/// used a pointer because boundingRect() is supposed to be const.
    QRectF *br_{nullptr};
	/// Last terminal seen through an attached conductor
	Terminal *previous_terminal_;
	/// Whether the mouse pointer is hovering the terminal
	bool hovered_;
	/// Color used for the hover effect
	QColor hovered_color_;
	/// Number of Terminal
	QString number_terminal_;
	/// Name of Terminal
	QString name_terminal_;
	bool name_terminal_hidden;

    /// Unique identifier of the terminal
    /// This uuid is different to the uuid of the part terminal it represents
    QUuid m_uuid;
	
	private:
    void init(QString number, QString name, bool hiddenName);
    void init(QPointF pf, Qet::Orientation o, QString number, QString name, bool hiddenName);
};

/**
	@return the number of conductors attached to the terminal.
*/
inline int Terminal::conductorsCount() const {
	return(conductors_.size());
}

/**
	@return the number of terminal.
*/
inline QString Terminal::number() const {
	return(number_terminal_);
}

/**
	@return the name of terminal.
*/
inline QString Terminal::name() const {
	return(name_terminal_);
}

QList<Terminal *> relatedPotentialTerminal (const Terminal *terminal, const bool all_diagram = true);

#endif