layout_tree.hpp

Go to the documentation of this file.

#ifndef GENESIS_TREE_DRAWING_LAYOUT_TREE_H_
#define GENESIS_TREE_DRAWING_LAYOUT_TREE_H_

/*
    Genesis - A toolkit for working with phylogenetic data.
    Copyright (C) 2014-2019 Lucas Czech and HITS gGmbH

    This program 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.

    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, see <http://www.gnu.org/licenses/>.

    Contact:
    Lucas Czech <lucas.czech@h-its.org>
    Exelixis Lab, Heidelberg Institute for Theoretical Studies
    Schloss-Wolfsbrunnenweg 35, D-69118 Heidelberg, Germany
*/

#include "genesis/tree/common_tree/tree.hpp"
#include "genesis/tree/tree.hpp"
#include "genesis/utils/formats/svg/svg.hpp"

#include <string>
#include <vector>

namespace genesis {
namespace tree {

// =================================================================================================
//     Typedefs
// =================================================================================================

using LayoutTree     = tree::Tree;

using LayoutTreeNode = tree::TreeNode;

using LayoutTreeEdge = tree::TreeEdge;

using LayoutTreeLink = tree::TreeLink;

// =================================================================================================
//     Layout Tree Node Data
// =================================================================================================

class LayoutNodeData : public tree::CommonNodeData
{
    // -------------------------------------------------------------------
    //     Constructor and Rule of Five
    // -------------------------------------------------------------------

public:

    virtual ~LayoutNodeData() override = default;

    // Move ctor and assignment.
    LayoutNodeData( LayoutNodeData&& )             = delete;
    LayoutNodeData& operator= ( LayoutNodeData&& ) = delete;

protected:

    LayoutNodeData() = default;

    // Copy ctor and assignment.
    LayoutNodeData( LayoutNodeData const& )             = default;
    LayoutNodeData& operator= ( LayoutNodeData const& ) = default;

public:

    static std::unique_ptr< LayoutNodeData > create()
    {
        return std::unique_ptr< LayoutNodeData >( new LayoutNodeData() );
    }

    virtual std::unique_ptr< BaseNodeData > recreate() const override
    {
        return std::unique_ptr< LayoutNodeData >( new LayoutNodeData() );
    }

    virtual std::unique_ptr< BaseNodeData > clone() const override
    {
        return std::unique_ptr< LayoutNodeData >( new LayoutNodeData( *this ));
    }

    // -----------------------------------------------------
    //     Data Members
    // -----------------------------------------------------

public:

    double distance = -1.0;

    double spreading = -1.0;

    long parent_index = -1;

    utils::SvgGroup shape;
    utils::SvgStroke spacer_stroke = utils::SvgStroke( utils::SvgStroke::Type::kNone );

};

// =================================================================================================
//     Layout Tree Edge Data
// =================================================================================================

class LayoutEdgeData : public tree::CommonEdgeData
{
    // -------------------------------------------------------------------
    //     Constructor and Rule of Five
    // -------------------------------------------------------------------

public:

    virtual ~LayoutEdgeData() override = default;

    // Move ctor and assignment.
    LayoutEdgeData( LayoutEdgeData&& )             = delete;
    LayoutEdgeData& operator= ( LayoutEdgeData&& ) = delete;

protected:

    LayoutEdgeData() = default;

    // Copy ctor and assignment.
    LayoutEdgeData( LayoutEdgeData const& )             = default;
    LayoutEdgeData& operator= ( LayoutEdgeData const& ) = default;

public:

    static std::unique_ptr< LayoutEdgeData > create()
    {
        return std::unique_ptr< LayoutEdgeData >( new LayoutEdgeData() );
    }

    virtual std::unique_ptr< BaseEdgeData > recreate() const override
    {
        return std::unique_ptr< LayoutEdgeData >( new LayoutEdgeData() );
    }

    virtual std::unique_ptr< BaseEdgeData > clone() const override
    {
        return std::unique_ptr< LayoutEdgeData >( new LayoutEdgeData( *this ));
    }

    // -----------------------------------------------------
    //     Data Members
    // -----------------------------------------------------

public:

    utils::SvgStroke spreading_stroke;
    utils::SvgStroke distance_stroke;

    utils::SvgGroup shape;

};

} // namespace tree
} // namespace genesis

#endif // include guard