placement_tool.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2014 CERN
 * Copyright (C) 2020 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * @author Maciej Suminski <maciej.suminski@cern.ch>
 *
 * 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 2
 * 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, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 */

#ifndef ALIGN_DISTRIBUTE_TOOL_H_
#define ALIGN_DISTRIBUTE_TOOL_H_

#include <tool/tool_interactive.h>
#include <tools/pcb_selection.h>
#include <board_item.h>
#include <pcb_base_frame.h>

using ALIGNMENT_RECT = std::pair<BOARD_ITEM*, EDA_RECT>;
using ALIGNMENT_RECTS = std::vector<ALIGNMENT_RECT>;

class PCB_SELECTION_TOOL;

class ALIGN_DISTRIBUTE_TOOL : public TOOL_INTERACTIVE
{
public:
    ALIGN_DISTRIBUTE_TOOL();
    virtual ~ALIGN_DISTRIBUTE_TOOL();

    void Reset( RESET_REASON aReason ) override {}

    bool Init() override;

    int AlignTop( const TOOL_EVENT& aEvent );

    int AlignBottom( const TOOL_EVENT& aEvent );

    int AlignLeft( const TOOL_EVENT& aEvent );

    int AlignRight( const TOOL_EVENT& aEvent );

    int AlignCenterX( const TOOL_EVENT& aEvent );

    int AlignCenterY( const TOOL_EVENT& aEvent );

    int DistributeHorizontally( const TOOL_EVENT& aEvent );

    int DistributeVertically( const TOOL_EVENT& aEvent );

    void setTransitions() override;

private:
    template< typename T >
    size_t GetSelections( ALIGNMENT_RECTS& aItemsToAlign, ALIGNMENT_RECTS& aLockedItems,
                          T aCompare );

    template< typename T >
    int selectTarget( ALIGNMENT_RECTS& aItems, ALIGNMENT_RECTS& aLocked, T aGetValue );

    int doAlignLeft();

    int doAlignRight();

    void doDistributeCentersHorizontally( ALIGNMENT_RECTS& itemsToDistribute,
                                          BOARD_COMMIT& aCommit ) const;

    void doDistributeCentersVertically( ALIGNMENT_RECTS& itemsToDistribute,
                                        BOARD_COMMIT& aCommit ) const;

    void doDistributeGapsHorizontally( ALIGNMENT_RECTS& itemsToDistribute, BOARD_COMMIT& aCommit,
                                       const BOARD_ITEM* lastItem, int totalGap ) const;

    void doDistributeGapsVertically( ALIGNMENT_RECTS& itemsToDistribute, BOARD_COMMIT& aCommit,
                                     const BOARD_ITEM* lastItem, int totalGap ) const;

private:
    PCB_SELECTION_TOOL*  m_selectionTool;
    ACTION_MENU*         m_placementMenu;
    PCB_BASE_FRAME*      m_frame;
};

#endif /* ALIGN_DISTRIBUTE_TOOL_H_ */