treeplacement.h

/*
 * vim: ts=4 sw=4 et tw=0 wm=0
 *
 * libdialect - A library for computing DiAlEcT layouts:
 *                 D = Decompose/Distribute
 *                 A = Arrange
 *                 E = Expand/Emend
 *                 T = Transform
 *
 * Copyright (C) 2018  Monash University
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * See the file LICENSE.LGPL distributed with the library.
 *
 * This library 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.
 *
 * Author(s):   Steve Kieffer   <http://skieffer.info>
*/

#ifndef DIALECT_TREEPLACEMENT_H
#define DIALECT_TREEPLACEMENT_H

#include <string>
#include <memory>
#include <map>
#include <set>

#include "libvpsc/rectangle.h"

#include "libdialect/commontypes.h"
#include "libdialect/faces.h"
#include "libdialect/graphs.h"
#include "libdialect/trees.h"
#include "libdialect/ortho.h"
#include "libdialect/opts.h"
#include "libdialect/constraints.h"
#include "libdialect/logging.h"

namespace dialect {

FaceSet_SP reattachTrees(Graph_SP core, Trees trees, HolaOpts opts, Logger *logger=nullptr);

TreePlacement_SP chooseBestPlacement(TreePlacements tps, HolaOpts opts);

class TreePlacement
#ifndef SWIG
// We hide this from SWIG, lest it complain, "Nothing known about base class 'std::enable_shared_from_this..."
// http://swig.10945.n7.nabble.com/Nothing-known-about-base-class-std-enable-shared-from-this-tp14603p14604.html
        : public std::enable_shared_from_this<TreePlacement>
#endif
{
public:
    TreePlacement(Tree_SP tree, Face &face, Node_SP faceRoot,
                  CompassDir dp, CardinalDir dg, bool flip=false)
        : m_ID(nextID++),
          m_tree(tree),
          m_face(face),
          m_faceRoot(faceRoot),
          m_placementDir(dp),
          m_growthDir(dg),
          m_flip(flip),
          m_cost(0),
          m_boxNode(nullptr) {}

    CompassDir getPlacementDir(void) const { return m_placementDir; }

    CardinalDir getGrowthDir(void) const { return m_growthDir; }

    bool isExternal(void) const { return m_face.isExternal(); }

    id_type id(void) const { return m_ID; }

    size_t getNumPotentialNbrs(void);

    double estimateCost(void);

    Node_SP getRootNode(void) const { return m_faceRoot; }

    Face &getFace(void) { return m_face; }

    void insertTreeNode(double padding=0) { m_face.insertTreeNode(shared_from_this(), padding); }

    std::string toString(void) const;

    Node_SP buildTreeBox(double padding=0) const;

    void recordBoxNode(Node_SP &boxNode) { m_boxNode = boxNode; }

    bool hasBoxNode(void) { return m_boxNode != nullptr; }

    Node_SP getBoxNode(void) { return m_boxNode; }

    ProjSeq_SP buildBestProjSeq(double padding=0, bool doCostlierDimensionFirst=false,
                                ExpansionEstimateMethod expansionMethod=ExpansionEstimateMethod::CONSTRAINTS) {
        return m_face.buildBestProjSeq(shared_from_this(), padding, doCostlierDimensionFirst, expansionMethod);
    }

    bool somePointOppositeSegment(LineSegment &seg, Avoid::Point &pt, double padding=-1, bool openInterval=false);

    void applyGeometryToTree(void);

    void insertTreeIntoGraph(Graph &G, NodesById &treeNodes, NodesById &bufferNodes, EdgesById &treeEdges);

    size_t size(void) const { return m_tree->size(); }

    void setRootAligns(vpsc::Dim dim, std::set<id_type> &idSet) { m_rootAligns[dim] = idSet; }

    bool rootIsAlignedWith(vpsc::Dim dim, id_type id);

private:

    static id_type nextID;
    const id_type m_ID;

    Tree_SP m_tree;
    Face &m_face;
    Node_SP m_faceRoot;
    CompassDir m_placementDir;
    CardinalDir m_growthDir;
    bool m_flip;

    double m_cost;
    Node_SP m_boxNode = nullptr;

    std::map<vpsc::Dim, std::set<id_type>> m_rootAligns;

};


} // namespace dialect

#endif // DIALECT_TREEPLACEMENT_H