RailwayRouteOptimization/scripts/Projection/Projection.js

/**
 * Copyright (c) 2011-2018 by Andrew Mustun. All rights reserved.
 * 
 * This file is part of the QCAD project.
 *
 * QCAD 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.
 *
 * QCAD 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 QCAD.
 */

/**
 * \defgroup ecma_projection Projection Tools
 * \ingroup ecma_modify
 *
 * \brief This module contains ECMAScript implementations of various projection (isometric, orthographic) tools.
 */

include("scripts/Modify/Explode/Explode.js");
include("scripts/Modify/Transform.js");
include("scripts/ShapeAlgorithms.js");

/**
 * \class Projection
 * \brief Base class for all projection tools.
 * \ingroup ecma_projection
 */
function Projection(guiAction) {
    Transform.call(this, guiAction);

    this.rotation = 0.0;
    this.copies = 1;
    this.referencePoint = undefined;
    this.targetPoint = undefined;

    // inheriting classes set this to true if projected entities have to be
    // segmented into line segments:
    this.segmentation = false;
    this.segmentLength = 1.0;
    this.retainTexts = false;

    // force flat projection (for aux constructions):
    this.flat = false;
}

Projection.prototype = new Transform();
Projection.includeBasePath = includeBasePath;

Projection.State = {
    SettingReferencePoint : 0,
    SettingTargetPoint : 1
};

Projection.getMenu = function() {
    // var menu = EAction.getSubMenu(
    //     Modify.getMenu(),
    //     14800, 100,
    //     Projection.getTitle(),
    //     "ModifyProjectionMenu",
    //     Projection.includeBasePath + "/Projection.svg"
    // );
    // menu.setProperty("scriptFile", Projection.includeBasePath + "/Projection.js");
    // return menu;
};

Projection.getToolBar = function() {
    var tb = EAction.getToolBar(Projection.getTitle(), "ProjectionToolBar");
    tb.visible = false;
    return tb;
};

Projection.getCadToolBarPanel = function() {
    var mtb = Draw.getCadToolBarPanel();
    var actionName = "ProjectionToolsPanelAction";
    if (!isNull(mtb) && isNull(mtb.findChild(actionName))) {
        var action = new RGuiAction(qsTr("Projection Tools"), mtb);
        action.setScriptFile(Projection.includeBasePath + "/Projection.js");
        action.objectName = actionName;
        action.setRequiresDocument(true);
        action.setIcon(Projection.includeBasePath + "/Projection.svg");
        //action.setStatusTip(qsTr("Show projection tools"));
        action.setDefaultShortcut(new QKeySequence("w,j"));
        action.setNoState();
        action.setDefaultCommands(["projectmenu"]);
        action.setGroupSortOrder(50);
        action.setSortOrder(100);
        action.setWidgetNames(["MainToolsPanel"]);
    }

    var tb = EAction.getCadToolBarPanel(Projection.getTitle(), "ProjectionToolsPanel", true);
    return tb;
};

Projection.getToolMatrixPanel = function() {
    return EAction.getToolMatrixPanel(Projection.getTitle(), "ProjectionMatrixPanel", 3500);
};

Projection.getTitle = function() {
    return qsTr("&Projection");
};

Projection.prototype.getTitle = function() {
    return Projection.getTitle();
};

Projection.prototype.beginEvent = function() {
    Transform.prototype.beginEvent.call(this);

    // show projection tools panel:
    if (!isNull(this.getGuiAction()) && this.getGuiAction().objectName==="ProjectionToolsPanelAction") {
        EAction.showCadToolBarPanel("ProjectionToolsPanel");
        this.terminate();
        return;
    }

    // start tool:
    if (!this.verifySelection()) {
        this.terminate();
        return;
    }

    this.setState(Projection.State.SettingReferencePoint);
};

Projection.prototype.setState = function(state) {
    Transform.prototype.setState.call(this, state);

    this.getDocumentInterface().setClickMode(RAction.PickCoordinate);
    this.setCrosshairCursor();

    var appWin = RMainWindowQt.getMainWindow();
    switch (this.state) {
    case Projection.State.SettingReferencePoint:
        this.referencePoint = undefined;
        this.targetPoint = undefined;
        var trReferencePoint = qsTr("Reference point");
        this.setCommandPrompt(trReferencePoint);
        this.setLeftMouseTip(trReferencePoint);
        this.setRightMouseTip(EAction.trCancel);
        break;

    case Projection.State.SettingTargetPoint:
        this.targetPoint = undefined;
        var trTargetPoint = qsTr("Target point");
        this.setCommandPrompt(trTargetPoint);
        this.setLeftMouseTip(trTargetPoint);
        this.setRightMouseTip(EAction.trBack);
        break;
    }

    EAction.showSnapTools();
};

Projection.prototype.escapeEvent = function() {
    switch (this.state) {
    case Projection.State.SettingReferencePoint:
        Transform.prototype.escapeEvent.call(this);
        break;

    case Projection.State.SettingTargetPoint:
        this.setState(Projection.State.SettingReferencePoint);
        break;
    }
};

Projection.prototype.pickCoordinate = function(event, preview) {
    var di = this.getDocumentInterface();

    switch (this.state) {
    case Projection.State.SettingReferencePoint:
        this.referencePoint = event.getModelPosition();
        this.clearCache();
        if (preview) {
            this.updatePreview();
        }
        else {
            di.setRelativeZero(this.referencePoint);
            this.setState(Projection.State.SettingTargetPoint);
        }
        break;

    case Projection.State.SettingTargetPoint:
        this.targetPoint = event.getModelPosition();

        if (preview) {
            this.updatePreview();
        }
        else {
            var op = this.getOperation(false);
            if (!isNull(op)) {
                di.applyOperation(op);
            }
            di.setRelativeZero(this.targetPoint);
        }
        break;
    }
};

Projection.prototype.getOperation = function(preview) {
    if (this.state===Projection.State.SettingReferencePoint) {
        return undefined;
    }

    if (isNull(this.referencePoint) || isNull(this.targetPoint)) {
        return undefined;
    }

    return Transform.prototype.getOperation.call(this, preview, false, true);
};

Projection.prototype.preTransform = function(entity) {
    // move original entity to neutral position:
    entity.move(this.referencePoint.getNegated());

    // rotate entity:
    entity.rotate(RMath.deg2rad(this.rotation));
};

Projection.prototype.postTransform = function(entity) {
};

/**
 * Callback function for Transform.getOperation. Generic for all projections.
 * \param k Ignored
 * \param rec Recursive call (don't call preTransform to move / rotate)
 */
Projection.prototype.transform = function(entity, k, op, preview, flags, rec) {
    if (isNull(rec)) {
        rec = false;
    }

    var i, shapes;

    if (rec!==true) {
        this.preTransform(entity);
    }

    var explode = false;

    if (this.retainTexts && isTextBasedEntity(entity)) {
        if (isAttributeEntity(entity)) {
            explode = true;
        }
        else {
            // don't explode text, only project position:
            var e = entity.clone();
            e.setSelected(false);
            var p = e.getAlignmentPoint();
            var ph = p.operator_add(new RVector(0,e.getTextHeight()));
            //qDebug("p before:", p);
            //qDebug("ph before:", ph);
            //qDebug("ap:", e.getAlignmentPoint());
            this.project(p);
            this.project(ph);

            // project height:
            //qDebug("p after:", p);
            //qDebug("ph after:", ph);
            //e.setPosition(p);

            e.setAlignmentPoint(p);
            e.setTextHeight(p.getDistanceTo(ph));

            flags = flags | RAddObjectsOperation.UseAttributes;
            op.addObject(e, flags);
            return;
        }
    }

    // explode block reference to keep attributes (colors, etc.):
    if (isBlockReferenceEntity(entity)) {
        explode = true;
    }

    if (explode) {
        // explode attributes to texts
        // explode block reference
        var explodedEntities = Explode.explodeEntity(entity);
        if (!isNull(explodedEntities)) {
            for (i=0; i<explodedEntities.length; i++) {
                var explodedEntity = explodedEntities[i];

                if (isEntity(explodedEntity)) {
                    this.transform(explodedEntity, k, op, preview, flags, true);
                }
                else {
                    qWarning("shape in exploded block");
                }
            }
        }
        return;
    }

    shapes = entity.getShapes();
    this.addTransformedShapes(entity, shapes, op, preview, flags);

    // text data that is part of this entity (dimension label):
    if (isDimensionEntity(entity) && isFunction(entity.getTextData)) {
        var textData = entity.getTextData();
        var painterPaths = textData.getPainterPaths(false);
        for (i=0; i<painterPaths.length; i++) {
            if (painterPaths[i].getFeatureSize()<0.0) {
                continue;
            }
            shapes = painterPaths[i].getShapes();
            this.addTransformedShapes(entity, shapes, op, preview, flags);
        }
    }
};

/**
 * Adds the projected shapes of the given entity to the given operation.
 *
 * \param entity REntity Original (unprojected) entity (used to copy attributes
 *      to new shapes).
 * \param shapes Array The transformed shapes
 * \param op RAddObjectsOperation Operation
 */
Projection.prototype.addTransformedShapes = function(entity, shapes, op, preview, flags) {
    var i, s, n;

    if (isHatchEntity(entity) && entity.isSolid()) {
        var hd = entity.getData();
        hd.clearBoundary();
        hd.newLoop();

        for (i=0; i<shapes.length; i++) {
            s = this.projectShape(getPtr(shapes[i]), preview);
            for (n=0; n<s.length; n++) {
                if (isNull(s[n])) {
                    debugger;
                }

                if (isPolylineShape(s[n])) {
                    s[n].simplify(0.001);
                }

                if (RSettings.getQtVersion() >= 0x060000) {
                    hd.addBoundary(s[n].clone(), true);
                }
                else {
                    hd.addBoundary(s[n], true);
                }
            }
        }

        var e = entity.clone();
        e.setData(hd);
        e.setSelected(false);

//        for (i=0; i<hd.getLoopCount(); i++) {
//            s = hd.getLoopBoundary(i);
//            qDebug("hatch boundary:", s);
//        }

        //e.getData().getDocument().getStorage().setObjectId(e, RObject.INVALID_ID);
        flags = flags | RAddObjectsOperation.UseAttributes | RAddObjectsOperation.ForceNew;
        //flags = flags | RAddObjectsOperation.UseAttributes;
        op.addObject(e, flags);
        return;
    }

    for (i=0; i<shapes.length; i++) {
        if (isNull(shapes[i])) {
            continue;
        }

        s = this.projectShape(getPtr(shapes[i]), preview);
        for (n=0; n<s.length; n++) {
            if (isNull(s[n])) {
                debugger;
            }

            var e = shapeToEntity(entity.getDocument(), s[n]);
            if (isNull(e)) {
                continue;
            }

            e.copyAttributesFrom(entity);
            //e.move(this.targetPoint);
            flags = flags | RAddObjectsOperation.UseAttributes;
            op.addObject(e, flags);
        }
    }
};

/**
 * Reimplemented by inheriting classes to trim the given unprojected shape
 * to the projectable area.
 *
 * Default implementation returns the original shape (no trimming).
 *
 * \param shape RShape Shape to trim (normalized).
 */
Projection.prototype.trimShape = function(shape) {
    return [shape];
};

/**
 * Reimplemented by inheriting classes.
 *
 * Default implementation does nothing (no projection).
 *
 * \param p Vector to transform in normalized coordinates, relative to the
 * chosen reference point.
 */
Projection.prototype.project = function(p) {
    return;
}

/**
 * Can be reimplemented to return true if the transformation flips
 * entities (mirroring). This means that arcs have to be reversed.
 */
Projection.prototype.isFlip = function() {
    return false;
}

/**
 * Projection of the given shape. The shape uses coordinates relative to
 * the chosen reference point.
 *
 * \return Array of new projected shapes.
 */
Projection.prototype.projectShape = function(shape, preview, trim, rec) {
    var p, p2, i, k, s, ret;

    if (isNull(trim)) {
        trim = true;
    }
    if (isNull(rec)) {
        rec = false;
    }

    // trim shape and project resulting segments:
    if (trim===true && (isPointShape(shape) || isLineShape(shape) || isArcShape(shape))) {
        var trimmedShapes = this.trimShape(shape);

        ret = [];
        for (k=0; k<trimmedShapes.length; k++) {
            shape = trimmedShapes[k];
            s = this.projectShape(shape, preview, false);
            ret = ret.concat(s);
        }
        return ret;
    }

    if (this.segmentation && !this.flat) {
        // If segmentation is on, split up lines and arcs into polylines
        // with the given segment length. All other shapes are split up into
        // lines and arcs.
        if (isLineShape(shape) || isArcShape(shape)) {
            ret = [];

            // switch off segmentation for polyline segments:
            this.segmentation = false;

            var l = shape.getLength();
            var numSegments = 16;
            if (!preview && this.segmentLength>RS.PointTolerance) {
                numSegments = Math.ceil(l/this.segmentLength);
            }
            if (numSegments>1000) {
                // avoid huge number of segments / crash:
                numSegments = 1000;
            }

            var polyline = ShapeAlgorithms.lineOrArcToPolyline(shape, numSegments);
            var projectedPls = this.projectShape(polyline, preview, trim, true);
            if (projectedPls.length>0) {
                var projectedPl = projectedPls[0];
                if (!isNull(projectedPl)) {
                    projectedPl.simplify(0.01);
                    ret.push(projectedPl);
                }
            }
            this.segmentation = true;

            return ret;
        }
        if (isXLineShape(shape) || isRayShape(shape)) {
            return [];
        }
    }

    if (isPointShape(shape)) {
        p = shape.getPosition();
        this.project(p);
        shape.setPosition(p);
        return [ shape ];
    }

    if (isLineShape(shape)) {
        p = shape.getStartPoint();
        this.project(p);
        shape.setStartPoint(p);

        p = shape.getEndPoint();
        this.project(p);
        shape.setEndPoint(p);
        return [ shape ];
    }

    if (isXLineShape(shape) || isRayShape(shape)) {
        p = shape.getBasePoint();
        this.project(p);

        p2 = shape.getSecondPoint();
        this.project(p2);

        shape.setBasePoint(p);
        shape.setSecondPoint(p2);
        return [ shape ];
    }

    if (isArcShape(shape)) {
        var self=this;
        // TODO: use RShape::transformArc
        // make RShapeTransformation scriptable
        // override RShapeTransformation::transform
        var ellipse = ShapeAlgorithms.transformArc(shape,
            function(p) {
                self.project(p);
            }
        );
        if (ellipse.isValid()) {
            return [ ellipse ];
        }
        else {
            return [];
        }
    }

    if (isCircleShape(shape)) {
        var arc = new RArc(shape.getCenter(), shape.getRadius(), 0.0, Math.PI*2);
        return this.projectShape(arc, preview, trim);
    }

    if (isEllipseShape(shape)) {
        if (shape.isCircular()) {
            // ellipse is a full circle:
            if (shape.isFullEllipse()) {
                var circle = new RCircle(shape.getCenter(), shape.getMajorRadius());
                return this.projectShape(circle, preview, trim);
            }
            // ellipse is a circular arc:
            else {
                var arc = new RArc(shape.getCenter(),
                                     shape.getMajorRadius(),
                                     shape.getStartAngle(),
                                     shape.getEndAngle(),
                                     shape.isReversed());
                return this.projectShape(arc, preview, trim);
            }
        }

        // create polyline from ellipse:
        var ple = ShapeAlgorithms.approximateEllipse(shape, 16);
        return this.projectShape(ple, preview, trim);
    }

    if (isTriangleShape(shape)) {
        for (i=0; i<3; ++i) {
            p = shape.getCorner(i);
            this.project(p);
            shape.setCorner(i, p);
        }

        return [ shape ];
    }

    if (isSplineShape(shape)) {
        shape = ShapeAlgorithms.splineToLineOrArc(shape, 0.01);
        if (!isSplineShape(shape)) {
            return this.projectShape(shape, preview, trim);
        }

        var segmentation = this.segmentation;
        this.segmentation = false;
        var segments = preview ? 4 : -1;
        var pls = shape.toPolyline(segments);
//        var shapes = shape.getExploded(segments);
//        var pls = new RPolyline();
//        for (i=0; i<shapes.length; i++) {
//            s = getPtr(shapes[i]);
//            pls.appendShape(s);
//        }
        ret = this.projectShape(pls, preview, trim);
        this.segmentation = segmentation;
        return ret;
    }

    if (isPolylineShape(shape)) {
        if (!rec) {
            // remove duplicate vertices (zero length segments):
            shape.normalize(RS.PointTolerance);
        }

        // add polyline, split up at arcs that are projected into ellipses and
        // at gaps caused by trimming:
        ret = [];
        var pl = new RPolyline();
        var segmentCount = shape.countSegments();
        var addPl = false;

        // project each segment individually:
        for (i=0; i<segmentCount; i++) {
            s = getPtr(shape.getSegmentAt(i));

            s = this.projectShape(s, preview, trim, true);

            // iterate through projected shapes (trimming might lead to gaps):
            for (k=0; k<s.length; k++) {
                var seg = s[k];
                if (isFunction(seg.data)) {
                    seg = getPtr(seg);
                }

                var gotGap = pl.countVertices()>0 &&
                    !pl.getEndPoint().equalsFuzzy(seg.getStartPoint());

                // s is a line or polyline that connets to the polyline we have:
                if (!gotGap && (isLineShape(seg) || isPolylineShape(seg))) {
                    if (seg.getLength()>RS.PointTolerance) {
                        pl.appendShape(seg);
                    }
                }

                // s is an ellipse:
                var gotEllipse = isEllipseShape(seg);

                // reached last segment of current polyline:
                if (i===segmentCount-1 || gotEllipse || gotGap) {
                    if (pl.countVertices()===1) {
                        // don't add polyline for one single shape:
                        ret.push(pl.getSegmentAt(0));
                    }
                    else if (pl.countVertices()>0) {
                        ret.push(pl);
                        addPl = false;
                    }

                    if (gotEllipse) {
                        if (seg.isValid()) {
                            ret.push(seg);
                        }

                        pl = new RPolyline();
                    }
                    else if (gotGap){
                        pl = new RPolyline();
                        //qDebug("seg:", seg);
                        pl.appendShape(seg);
                        addPl = true;
                    }
                }
            }
        }

        if (addPl && pl.countVertices()>0) {
            ret.push(pl);
        }

        // set global width if polyline has uniform global semgent width:
        var gotGlobalWidth = false;
        var startWidths = shape.getStartWidths();
        var endWidths = shape.getEndWidths();
        if (startWidths.length>0 && endWidths.length>0) {
            if (startWidths[0]>RS.PointTolerance) {
                startWidths.sortNumerical();
                endWidths.sortNumerical();
                if (RMath.fuzzyCompare(startWidths[0], startWidths[startWidths.length-1]) &&
                    RMath.fuzzyCompare(endWidths[0], endWidths[endWidths.length-1]) &&
                    RMath.fuzzyCompare(startWidths[0], endWidths[0])) {

                    // got global polyline width:
                    gotGlobalWidth = true;
                    for (i=0; i<ret.length; i++) {
                        if (isPolylineShape(ret[i])) {
                            ret[i].setGlobalWidth(startWidths[0]);
                        }
                    }
                }
            }
        }

        // set pl segment widths if there's no segmentation and the number of segments match:
        if (ret.length===1 && isPolylineShape(ret[0])) {
            if (!gotGlobalWidth && !this.segmentation && shape.countSegments()===ret[0].countSegments()) {
                for (i=0; i<shape.countVertices(); i++) {
                    ret[0].setStartWidthAt(i, shape.getStartWidthAt(i));
                    ret[0].setEndWidthAt(i, shape.getEndWidthAt(i));
                }
            }
        }


        return ret;
    }

    return [];
};

Projection.prototype.slotRotateCCW = function() {
    this.rotation += 90;
    this.clearCache();
    this.updatePreview(true);
};

Projection.prototype.slotRotateCW = function() {
    this.rotation -= 90;
    this.clearCache();
    this.updatePreview(true);
};

Projection.prototype.slotSegmentLengthChanged = function(l) {
    this.segmentLength = l;
    this.clearCache();
    this.updatePreview(true);
};

Projection.prototype.slotRetainTextsChanged = function(v) {
    this.retainTexts = v;
    this.clearCache();
    this.updatePreview(true);
};

Projection.init = function() {
    Projection.getMenu();
    Projection.getToolBar();
    Projection.getCadToolBarPanel();
    Projection.getToolMatrixPanel();
};