librecad/src/lib/actions/rs_previewactioninterface.h

/****************************************************************************
**
** This file is part of the LibreCAD project, a 2D CAD program
**
** Copyright (C) 2010 R. van Twisk (librecad@rvt.dds.nl)
** Copyright (C) 2001-2003 RibbonSoft. All rights reserved.
**
**
** This file may be distributed and/or modified under the terms of the
** GNU General Public License version 2 as published by the Free Software
** Foundation and appearing in the file gpl-2.0.txt included in the
** packaging of this file.
**
** 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, write to the Free Software
** Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
**
** This copyright notice MUST APPEAR in all copies of the script!
**
**********************************************************************/

#ifndef RS_PREVIEWACTIONINTERFACE_H
#define RS_PREVIEWACTIONINTERFACE_H

#include <QPointF>

#include "dxf_format.h"
#include "rs_actioninterface.h"
#include "rs_entity.h"
#include "rs_vector.h"

class RS_Point;
class LC_OverlayDrawable;
class LC_ActionInfoMessageBuilder;
class LC_Highlight;
class LC_RefEllipse;

class RS_Arc;
class RS_Circle;
class RS_ConstructionLine;
class RS_Ellipse;
class RS_Line;
struct RS_ArcData;
struct RS_CircleData;
struct RS_EllipseData;
struct RS_LineData;

struct LC_MouseEvent{
    RS_Vector snapPoint;
    RS_Vector graphPoint;
    QPoint uiPosition;
    bool isControl = false;
    bool isShift = false;
    bool isAlt = false;
    QMouseEvent* originalEvent = nullptr;
};

/**
 * This is the interface that must be implemented for all
 * action classes which need a preview.
 *
 * @author Andrew Mustun
 */
class RS_PreviewActionInterface : public RS_ActionInterface {
public:
    RS_PreviewActionInterface(const char *name,LC_ActionContext *actionContext,RS2::ActionType actionType = RS2::ActionNone);
    ~RS_PreviewActionInterface() override;
    void init(int status) override;
    void finish(bool updateTB = true) override;
    void suspend() override;
    void resume() override;
    void trigger() override;
    void mouseMoveEvent(QMouseEvent *event) override;
    QStringList getAvailableCommands() override;
protected:
    std::unique_ptr<LC_ActionInfoMessageBuilder> m_msgBuilder;
    // fixme - sand - tmp -  move to overlay!!!
    int m_angleSnapMarkerSize = 20;
    /**
     * Preview that holds the entities to be previewed.
     */
    std::unique_ptr<RS_Preview> m_preview;
    bool m_hasPreview = true;//whether preview is in use

    std::unique_ptr<LC_Highlight> m_highlight;

    double m_refPointSize = 2.0;
    int m_refPointMode = DXF_FORMAT_PDMode_EncloseSquare(DXF_FORMAT_PDMode_CentreDot);
    bool m_showRefEntitiesOnPreview = false;
    bool m_highlightEntitiesOnHover = false;
    bool m_highlightEntitiesRefPointsOnHover = false;
    bool m_doNotAllowNonDecimalAnglesInput = false;

    virtual void doTrigger(){}

    void deletePreview();
    void deleteHighlights();
    void deletePreviewAndHighlights();
    void drawPreview();
    void drawHighlights();
    void drawPreviewAndHighlights();

    void addToHighlights(RS_Entity *e, bool enable = true);

    bool trySnapToRelZeroCoordinateEvent(const LC_MouseEvent *e);

    RS_Vector getRelZeroAwarePoint(const LC_MouseEvent *e, const RS_Vector &pos);
    RS_Vector getSnapAngleAwarePoint(const LC_MouseEvent *e, const RS_Vector &basepoint, const RS_Vector &pos, bool drawMark = false);
    RS_Vector getSnapAngleAwarePoint(const LC_MouseEvent *e, const RS_Vector &basepoint, const RS_Vector &pos, bool drawMark, bool force);
    RS_Vector getFreeSnapAwarePoint(const LC_MouseEvent *e, const RS_Vector &pos) const;

    void addOverlay(LC_OverlayDrawable* en, RS2::OverlayGraphics position);

    void previewEntity(RS_Entity *en);
    RS_Circle* previewCircle(const RS_CircleData& circleData);
    RS_Arc *previewArc(const RS_ArcData &arcData);
    RS_Ellipse *previewEllipse(const RS_EllipseData &ellipseData);
    RS_Point* previewPoint(const RS_Vector &coord);
    RS_Line* previewLine(const RS_Vector &start, const RS_Vector &end);
    RS_Line* previewLine(const RS_LineData &data);
    RS_Line* previewRefLine(const RS_Vector &start, const RS_Vector &end);
    RS_ConstructionLine* previewRefConstructionLine(const RS_Vector &start, const RS_Vector &end);
    void previewRefLines(const std::vector<RS_LineData>& points);
    void previewRefSelectableLine(const RS_Vector &start, const RS_Vector &end);
    void previewRefPoint(const RS_Vector &coord);
    void previewRefSelectablePoint(const RS_Vector &coord);
    void previewRefPoints(const std::vector<RS_Vector>& points);
    RS_Arc* previewRefArc(const RS_Vector &center, const RS_Vector &startPoint, const RS_Vector &mouse, bool determineReversal);
    RS_Arc* previewRefArc(bool reversed, const RS_Vector &center, const RS_Vector &startPoint, const RS_Vector &mouse);
    RS_Circle* previewRefCircle(const RS_Vector &center, const double radius);
    RS_Arc *previewRefArc(const RS_ArcData &arcData);
    LC_RefEllipse *previewRefEllipse(const RS_EllipseData &arcData);

    void initRefEntitiesMetrics();

    void highlightHover(RS_Entity *e);
    void highlightHoverWithRefPoints(RS_Entity* e, bool value);
    void highlightSelected(RS_Entity *e, bool enable=true);

    virtual void moveRelativeZero(const RS_Vector &zero);
    void markRelativeZero();

    bool is(RS_Entity* e, RS2::EntityType type) const;
    bool isLine(RS_Entity*  e) const{return is(e, RS2::EntityLine);}
    bool isPolyline(RS_Entity*  e) const{return is(e, RS2::EntityPolyline);}
    bool isCircle(RS_Entity*  e) const {return is(e, RS2::EntityCircle);}
    bool isArc(RS_Entity*  e) const {return is(e, RS2::EntityArc);}
    bool isEllipse(RS_Entity*  e) const {return is(e, RS2::EntityEllipse);}
    bool isAtomic(RS_Entity* e) const {return e != nullptr && e->isAtomic();}

    void previewSnapAngleMark(const RS_Vector &center, double angle);
    void previewSnapAngleMark(const RS_Vector &center, const RS_Vector &refPoint);

    RS_Entity *catchModifiableEntity(LC_MouseEvent *e, const EntityTypeList &enTypeList);
    RS_Entity *catchModifiableEntity(LC_MouseEvent *e, const RS2::EntityType &enType);

    RS_Entity *catchModifiableEntity(RS_Vector &coord, const RS2::EntityType &enType);

    RS_Entity *catchEntityByEvent(LC_MouseEvent *e, RS2::ResolveLevel level = RS2::ResolveNone);
    RS_Entity *catchEntityByEvent(LC_MouseEvent *e, RS2::EntityType enType, RS2::ResolveLevel level = RS2::ResolveNone);
    RS_Entity *catchEntityByEvent(LC_MouseEvent *e, const EntityTypeList &enTypeList, RS2::ResolveLevel level = RS2::ResolveNone);

    RS_Entity* catchAndDescribe(LC_MouseEvent *e, const EntityTypeList &enTypeList, RS2::ResolveLevel level);
    RS_Entity* catchAndDescribe(LC_MouseEvent* e, RS2::ResolveLevel level  = RS2::ResolveNone);
    RS_Entity* catchAndDescribe(LC_MouseEvent *e, RS2::EntityType enType, RS2::ResolveLevel level = RS2::ResolveNone);

    RS_Entity* catchAndDescribe(const RS_Vector &pos, RS2::ResolveLevel level = RS2::ResolveNone);

    RS_Entity* catchModifiableAndDescribe(LC_MouseEvent *e, const RS2::EntityType &enType);
    RS_Entity* catchModifiableAndDescribe(LC_MouseEvent *e, const EntityTypeList &enTypeList);

    LC_ActionInfoMessageBuilder& msg(const QString& name, const QString& value);
    LC_ActionInfoMessageBuilder& msg(const QString& name);
    LC_ActionInfoMessageBuilder& msgStart();

    QString obtainEntityDescriptionForInfoCursor(RS_Entity *e, RS2::EntityDescriptionLevel level);
    void prepareEntityDescription(RS_Entity *entity, RS2::EntityDescriptionLevel level);
    void appendInfoCursorZoneMessage(QString message, int zoneNumber, bool replaceContent);
    void appendInfoCursorEntityCreationMessage(QString message);

    RS_Circle *previewToCreateCircle(const RS_CircleData &circleData);
    RS_Arc *previewToCreateArc(const RS_ArcData &arcData);
    RS_Line *previewToCreateLine(const RS_LineData &lineData);
    RS_Line *previewToCreateLine(const RS_Vector &start, const RS_Vector &end);
    RS_Ellipse *previewToCreateEllipse(const RS_EllipseData &ellipseData);
    RS_Point *previewToCreatePoint(const RS_Vector &coord);
    void previewEntityToCreate(RS_Entity *en, bool addToPreview = true);

    void fireCoordinateEventForSnap(LC_MouseEvent *e);

    void onMouseLeftButtonRelease(int status, QMouseEvent *e) override;
    void onMouseRightButtonRelease(int status, QMouseEvent *e) override;
    void onMouseLeftButtonPress(int status, QMouseEvent *e) override;
    void onMouseRightButtonPress(int status, QMouseEvent *e) override;

    virtual void onMouseMoveEvent(int status, LC_MouseEvent* event);
    virtual void onMouseLeftButtonRelease(int status, LC_MouseEvent *e);
    virtual void onMouseRightButtonRelease(int status, LC_MouseEvent *e);
    virtual void onMouseLeftButtonPress(int status, LC_MouseEvent *e);
    virtual void onMouseRightButtonPress(int status, LC_MouseEvent *e);
    virtual QStringList doGetAvailableCommands(int status);

    bool parseToWCSAngle(const QString &c, double &wcsAngleRad);
    bool parseToUCSBasisAngle(const QString &c, double& ucsBasisAngleRad);
    bool parseToRelativeAngle(const QString&c, double &ucsBasisAngleRad);
    double evalAngleValue(const QString &c, bool *ok) const;
    void initFromSettings() override;
private:
    LC_MouseEvent toLCMouseMoveEvent(QMouseEvent *e);
    friend LC_ActionInfoMessageBuilder;
};
#endif