panel_snapping.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright The KiCad Developers, see AUTHORS.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 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 <https://www.gnu.org/licenses/>.
 */
 
#ifndef PANEL_SNAPPING_H
#define PANEL_SNAPPING_H
 
#include <functional>
#include <vector>
 
#include <frame_type.h>
#include <gal/gal_display_options.h>
#include <panel_snapping_base.h>
#include <settings/snap_settings.h>

class PANEL_SNAPPING : public PANEL_SNAPPING_BASE
{
public:
    struct VALUES
    {
        KIGFX::GRID_SNAPPING    gridSnap = KIGFX::GRID_SNAPPING::ALWAYS;
        MAGNETIC_SETTINGS       magnetics;
        SNAP_INFERENCE_SETTINGS inference;
    };

    PANEL_SNAPPING( wxWindow* aParent, FRAME_T aFrameType, KIGFX::GRID_SNAPPING* aGridSnap,
                    SNAP_INFERENCE_SETTINGS* aInference, MAGNETIC_SETTINGS* aMagnetics,
                    std::function<VALUES()> aDefaults );
 
    bool TransferDataToWindow() override;
    bool TransferDataFromWindow() override;
 
    void ResetPanel() override;
 
private:
    void load( const VALUES& aValues );
 
    bool                     m_routing;
 
    KIGFX::GRID_SNAPPING*    m_gridSnap;
    SNAP_INFERENCE_SETTINGS* m_inference;
    MAGNETIC_SETTINGS*       m_magnetics;
    std::function<VALUES()>  m_defaults;
 
    std::vector<MAGNETIC_OPTIONS> m_padOptions;
    std::vector<MAGNETIC_OPTIONS> m_trackOptions;
    std::vector<MAGNETIC_OPTIONS> m_graphicsOptions;
};
 

std::vector<MAGNETIC_OPTIONS> MagneticSnapOptions( bool aRouting );

int MagneticSnapIndex( const std::vector<MAGNETIC_OPTIONS>& aOptions, MAGNETIC_OPTIONS aValue );

MAGNETIC_OPTIONS MagneticSnapValue( const std::vector<MAGNETIC_OPTIONS>& aOptions, int aIndex );
 

template <typename SETTINGS_T>
PANEL_SNAPPING* CreateSnappingPanel( wxWindow* aParent, SETTINGS_T* aCfg, FRAME_T aFrameType,
                                     SNAP_INFERENCE_SETTINGS SETTINGS_T::* aInference = nullptr,
                                     MAGNETIC_SETTINGS SETTINGS_T::* aMagnetics = nullptr )
{
    auto valuesOf =
            [aInference, aMagnetics]( const SETTINGS_T& aSettings )
            {
                PANEL_SNAPPING::VALUES values;
                values.gridSnap = aSettings.m_Window.grid.snap;
 
                if( aInference )
                    values.inference = aSettings.*aInference;
 
                if( aMagnetics )
                    values.magnetics = aSettings.*aMagnetics;
 
                return values;
            };
 
    return new PANEL_SNAPPING( aParent, aFrameType, &aCfg->m_Window.grid.snap,
                               aInference ? &( aCfg->*aInference ) : nullptr,
                               aMagnetics ? &( aCfg->*aMagnetics ) : nullptr,
                               [valuesOf]()
                               {
                                   SETTINGS_T defaults;
                                   defaults.Load();     // Loading without a file gives the defaults
                                   return valuesOf( defaults );
                               } );
}
 
#endif