kicad/pcbnew/dialogs/dialog_move_exact.h

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2014 John Beard, john.j.beard@gmail.com
 * Copyright (C) 1992-2014 KiCad Developers, see AUTHORS.txt for contributors.
 * Copyright (C) 2017 KiCad Developers, see CHANGELOG.TXT for contributors.
 *
 * 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 __DIALOG_MOVE_EXACT__
#define __DIALOG_MOVE_EXACT__

// Include the wxFormBuider header base:
#include <vector>
#include <dialog_move_exact_base.h>

enum MOVE_EXACT_ORIGIN
{
    RELATIVE_TO_CURRENT_POSITION,
    RELATIVE_TO_USER_ORIGIN,
    RELATIVE_TO_GRID_ORIGIN,
    RELATIVE_TO_DRILL_PLACE_ORIGIN,
    RELATIVE_TO_SHEET_ORIGIN
};


enum MOVE_EXACT_ANCHOR
{
    ANCHOR_TOP_LEFT_PAD,
    ANCHOR_CENTER_FOOTPRINT,
    ANCHOR_FROM_LIBRARY
};


struct MOVE_PARAMETERS
{
    wxPoint             translation     = wxPoint( 0,0 );
    double              rotation        = 0;
    MOVE_EXACT_ORIGIN   origin          = RELATIVE_TO_CURRENT_POSITION;
    MOVE_EXACT_ANCHOR   anchor          = ANCHOR_FROM_LIBRARY;
    bool                allowOverride   = true;
    bool                editingFootprint = false;
};


class DIALOG_MOVE_EXACT : public DIALOG_MOVE_EXACT_BASE
{
private:

    PCB_BASE_FRAME*     m_parent;
    wxPoint&            m_translation;
    double&             m_rotation;
    MOVE_EXACT_ORIGIN&  m_origin;
    MOVE_EXACT_ANCHOR&  m_anchor;
    bool&               m_allowOverride;
    bool&               m_editingFootprint;

public:
    // Constructor and destructor
    DIALOG_MOVE_EXACT(PCB_BASE_FRAME *aParent, MOVE_PARAMETERS &aParams );
    ~DIALOG_MOVE_EXACT();

private:

    /*!
     * Reset a text field to be 0 if it was exited while blank
     */
    void OnTextFocusLost( wxFocusEvent& event ) override;

    void OnPolarChanged( wxCommandEvent& event ) override;
    void OnClear( wxCommandEvent& event ) override;

    void OnOriginChanged( wxCommandEvent& event ) override;
    void OnOverrideChanged( wxCommandEvent& event ) override;

    void OnOkClick( wxCommandEvent& event ) override;

    /**
     * Convert a given Cartesian point into a polar representation.
     *
     * Linear units are not considered, the answer is in the same units as given
     * Angle is returned in degrees
     */
    void ToPolarDeg( double x, double y, double& r, double& q );

    /**
     * Get the (Cartesian) translation described by the text entries
     * @param val output translation vector
     * @param polar interpret as polar coords
     * @return false if error (though the text conversion functions don't report errors)
     */
    bool GetTranslationInIU ( wxPoint& val, bool polar );

    // Update texts (comments) after changing the coordinates type (polar/cartesian)
    void updateDlgTexts( bool aPolar );

    /**
     * Persistent dialog options
     */
    struct MOVE_EXACT_OPTIONS
    {
        bool                polarCoords;
        double              entry1;
        double              entry2;
        double              entryRotation;
        MOVE_EXACT_ORIGIN   origin;
        MOVE_EXACT_ANCHOR   anchor;
        bool                overrideAnchor;

        MOVE_EXACT_OPTIONS():
            polarCoords( false ),
            entry1( 0 ),
            entry2( 0 ),
            entryRotation( 0 ),
            origin( RELATIVE_TO_CURRENT_POSITION ),
            anchor( ANCHOR_FROM_LIBRARY ),
            overrideAnchor( false )
        {
        }
    };

    // persistent settings
    static MOVE_EXACT_OPTIONS m_options;
};

#endif      //  __DIALOG_MOVE_EXACT__