opts.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_OPTS_H
#define DIALECT_OPTS_H

#include "libdialect/ortho.h"

namespace dialect {

enum class AspectRatioClass {
    NONE, PORTRAIT, LANDSCAPE
};

enum class TreeRoutingType {
    STRICT,
    CORE_ATTACHMENT,
    MONOTONIC
};

enum class ExpansionEstimateMethod {
    SPACE,
    CONSTRAINTS
};

struct HolaOpts {


    CardinalDir defaultTreeGrowthDir = CardinalDir::SOUTH;
    double treeLayoutScalar_nodeSep = 0.25;
    double treeLayoutScalar_rankSep = 1.0;
    bool preferConvexTrees = true;
    TreeRoutingType peeledTreeRouting = TreeRoutingType::CORE_ATTACHMENT;
    TreeRoutingType wholeTreeRouting = TreeRoutingType::MONOTONIC;



    bool orthoHubAvoidFlatTriangles = true;


    bool useACAforLinks = true;


    double routingScalar_crossingPenalty = 2;
    double routingScalar_segmentPenalty = 0.5;



    bool treePlacement_favourCardinal = true;
    bool treePlacement_favourExternal = true;
    bool treePlacement_favourIsolation = true;



    bool expansion_doCostlierDimensionFirst = false;
    ExpansionEstimateMethod expansion_estimateMethod = ExpansionEstimateMethod::CONSTRAINTS;



    bool do_near_align = true;
    unsigned align_reps = 2;


    double nearAlignScalar_kinkWidth = 0.25;
    double nearAlignScalar_scope = 1.0;



    double nodePaddingScalar = 0.25;



    AspectRatioClass preferredAspectRatio = AspectRatioClass::LANDSCAPE;
    CardinalDir preferredTreeGrowthDir = CardinalDir::SOUTH;
    bool putUlcAtOrigin = true;

};


} // namespace dialect

#endif // DIALECT_OPTS_H