kicad/share/zoom.cpp

/************/
/* zoom.cpp */
/************/

/*
 *  Fonctions de gestion du zoom, du pas de grille et du
 *  recadrage automatique
 */

#include "fctsys.h"
#include "gr_basic.h"

#include "common.h"
#include "macros.h"

#ifdef EESCHEMA
#include "program.h"
#include "libcmp.h"
#include "general.h"
#endif

#ifdef PCBNEW
#include "pcbnew.h"
#endif

#ifdef CVPCB
#include "cvpcb.h"
#endif

#include "bitmaps.h"

#include "protos.h"

#include "id.h"


/**************************************************/
void WinEDA_DrawFrame::Recadre_Trace( bool ToMouse )
/**************************************************/

/** Compute draw offset (scroll bars and draw parameters)
 *  in order to have the current graphic cursor position at the screen center
 *  @param ToMouse if TRUE, the mouse cursor is moved
 *  to the graphic cursor position (which is usually on grid)
 *
 *  Note: Mac OS ** does not ** allow moving mouse cursor by program.
 */
{
    PutOnGrid( &(GetBaseScreen()->m_Curseur) );

    AdjustScrollBars();

    ReDrawPanel();

    /* Move the mouse cursor to the on grid graphic cursor position */
    if( ToMouse == TRUE )
    {
        DrawPanel->MouseToCursorSchema();
    }
}


/************************************************/
void WinEDA_DrawFrame::PutOnGrid( wxPoint* coord )
/************************************************/
/** Adjust the coordinate to the nearest grid value
* @param coord = coordinate to adjust
*/
{
    double ftmp;

    if( !GetBaseScreen()->m_UserGridIsON )
    {
        wxSize grid_size = GetBaseScreen()->GetGrid();

        ftmp     = (double) coord->x / grid_size.x;
        coord->x = ( (int) round( ftmp ) ) * grid_size.x;

        ftmp     = (double) coord->y / grid_size.y;
        coord->y = ( (int) round( ftmp ) ) * grid_size.y;
    }
    else
    {
        double pasx = GetBaseScreen()->m_UserGrid.x * m_InternalUnits;
        double pasy = GetBaseScreen()->m_UserGrid.y * m_InternalUnits;

        if( GetBaseScreen()->m_UserGridUnit != INCHES )
        {
            pasx /= 25.4;
            pasy /= 25.4;
        }

        int    nn = (int) round( coord->x / pasx );
        coord->x = (int) round( pasx * nn );

        nn = (int) round( coord->y / pasy );
        coord->y = (int) round( pasy * nn );
    }
}


/**************************************************************/
void WinEDA_DrawFrame::Zoom_Automatique( bool move_mouse_cursor )
/**************************************************************/

/** Redraw the screen with the zoom level which shows all the page or the board
 */
{
    int bestzoom;

    bestzoom = BestZoom();
    GetBaseScreen()->SetZoom( bestzoom );
    Recadre_Trace( move_mouse_cursor );
}


/*************************************************/
void WinEDA_DrawFrame::Window_Zoom( EDA_Rect& Rect )
/*************************************************/

/** Compute the zoom factor and the new draw offset to draw the
 *  selected area (Rect) in full window screen
 *  @param Rect = selected area to show after zooming
 */
{
    int    ii, jj;
    int    bestzoom;
    wxSize size;

    /* Compute the best zoom */
    Rect.Normalize();
    size     = DrawPanel->GetClientSize();
    // Use ceil to at least show the full rect
    ii       = static_cast<int>( ceil(1.0 * Rect.GetSize().x / size.x) );
    jj       = static_cast<int>( ceil(1.0 * Rect.GetSize().y / size.y) );
    bestzoom = MAX( ii, jj );
    if( bestzoom <= 0 )
        bestzoom = 1;

    GetBaseScreen()->SetZoom( bestzoom );

    GetBaseScreen()->m_Curseur = Rect.Centre();
    Recadre_Trace( TRUE );
}


/*****************************************************************/
void WinEDA_DrawPanel::Process_Popup_Zoom( wxCommandEvent& event )
/*****************************************************************/

/* Handle only the Popup command zoom and grid level
 */
{
    int        id = event.GetId();

    switch( id )
    {
    case ID_POPUP_ZOOM_IN:
    case ID_POPUP_ZOOM_OUT:
    case ID_POPUP_ZOOM_CENTER:
    case ID_POPUP_ZOOM_AUTO:
    case ID_POPUP_ZOOM_REDRAW:
        m_Parent->OnZoom( id );
        break;

    case ID_POPUP_ZOOM_SELECT:
        break;

    case ID_POPUP_CANCEL:
        MouseToCursorSchema();
        break;

    case ID_POPUP_ZOOM_LEVEL_1:
        GetScreen()->SetZoom( 1 );
        m_Parent->Recadre_Trace( TRUE );
        break;

    case ID_POPUP_ZOOM_LEVEL_2:
        GetScreen()->SetZoom( 2 );
        m_Parent->Recadre_Trace( TRUE );
        break;

    case ID_POPUP_ZOOM_LEVEL_4:
        GetScreen()->SetZoom( 4 );
        m_Parent->Recadre_Trace( TRUE );
        break;

    case ID_POPUP_ZOOM_LEVEL_8:
        GetScreen()->SetZoom( 8 );
        m_Parent->Recadre_Trace( TRUE );
        break;

    case ID_POPUP_ZOOM_LEVEL_16:
        GetScreen()->SetZoom( 16 );
        m_Parent->Recadre_Trace( TRUE );
        break;

    case ID_POPUP_ZOOM_LEVEL_32:
        GetScreen()->SetZoom( 32 );
        m_Parent->Recadre_Trace( TRUE );
        break;

    case ID_POPUP_ZOOM_LEVEL_64:
        GetScreen()->SetZoom( 64 );
        m_Parent->Recadre_Trace( TRUE );
        break;

    case ID_POPUP_ZOOM_LEVEL_128:
        GetScreen()->SetZoom( 128 );
        m_Parent->Recadre_Trace( TRUE );
        break;

    case ID_POPUP_ZOOM_LEVEL_256:
        GetScreen()->SetZoom( 256 );
        m_Parent->Recadre_Trace( TRUE );
        break;

    case ID_POPUP_ZOOM_LEVEL_512:
        GetScreen()->SetZoom( 512 );
        m_Parent->Recadre_Trace( TRUE );
        break;

    case ID_POPUP_ZOOM_LEVEL_1024:
        GetScreen()->SetZoom( 1024 );
        m_Parent->Recadre_Trace( TRUE );
        break;

    case ID_POPUP_ZOOM_LEVEL_2048:
        GetScreen()->SetZoom( 2048 );
        m_Parent->Recadre_Trace( TRUE );
        break;

    case ID_POPUP_GRID_LEVEL_1:
        GetScreen()->SetGrid( wxSize( 1, 1 ) );
        m_Parent->ReDrawPanel();
        break;

    case ID_POPUP_GRID_LEVEL_2:
        GetScreen()->SetGrid( wxSize( 2, 2 ) );
        m_Parent->ReDrawPanel();
        break;

    case ID_POPUP_GRID_LEVEL_5:
        GetScreen()->SetGrid( wxSize( 5, 5 ) );
        m_Parent->ReDrawPanel();
        break;

    case ID_POPUP_GRID_LEVEL_10:
        GetScreen()->SetGrid( wxSize( 10, 10 ) );
        m_Parent->ReDrawPanel();
        break;

    case ID_POPUP_GRID_LEVEL_20:
        GetScreen()->SetGrid( wxSize( 20, 20 ) );
        m_Parent->ReDrawPanel();
        break;

    case ID_POPUP_GRID_LEVEL_25:
        GetScreen()->SetGrid( wxSize( 25, 25 ) );
        m_Parent->ReDrawPanel();
        break;

    case ID_POPUP_GRID_LEVEL_50:
        GetScreen()->SetGrid( wxSize( 50, 50 ) );
        m_Parent->ReDrawPanel();
        break;

    case ID_POPUP_GRID_LEVEL_100:
        GetScreen()->SetGrid( wxSize( 100, 100 ) );
        m_Parent->ReDrawPanel();
        break;

    case ID_POPUP_GRID_LEVEL_200:
        GetScreen()->SetGrid( wxSize( 200, 200 ) );
        m_Parent->ReDrawPanel();
        break;

    case ID_POPUP_GRID_LEVEL_250:
        GetScreen()->SetGrid( wxSize( 250, 250 ) );
        m_Parent->ReDrawPanel();
        break;

    case ID_POPUP_GRID_LEVEL_500:
        GetScreen()->SetGrid( wxSize( 500, 500 ) );
        m_Parent->ReDrawPanel();
        break;

    case ID_POPUP_GRID_LEVEL_1000:
        GetScreen()->SetGrid( wxSize( 1000, 1000 ) );
        m_Parent->ReDrawPanel();
        break;

    case ID_POPUP_GRID_USER:
        GetScreen()->SetGrid( wxSize( -1, -1 ) );
        m_Parent->ReDrawPanel();
        break;

    default:
        DisplayError( this, wxT( "WinEDA_DrawPanel::Process_Popup_Zoom() ID error" ) );
        break;
    }

    m_Parent->Affiche_Status_Box();
}


class grid_list_struct
{
public:
    int           m_Value;
    int           m_Id;
};


/*************************************************************/
void WinEDA_DrawPanel::AddMenuZoom( wxMenu* MasterMenu )
/*************************************************************/

/* add the zoom list menu the the MasterMenu.
 *  used in OnRightClick(wxMouseEvent& event)
 */
{
    int              zoom;
    wxSize           grid;
    int              zoom_value;
    wxString         zoom_msg = _( "Zoom: " );
    wxString         grid_msg = _( "Grid: " ), msg;
    int              ii;
    wxString         line;

    static const grid_list_struct grid_list_pcb[] =
    {
        { 1000, ID_POPUP_GRID_LEVEL_1000 },
        { 500,  ID_POPUP_GRID_LEVEL_500  },
        { 250,  ID_POPUP_GRID_LEVEL_250  },
        { 200,  ID_POPUP_GRID_LEVEL_200  },
        { 100,  ID_POPUP_GRID_LEVEL_100  },
        { 50,   ID_POPUP_GRID_LEVEL_50   },
        { 25,   ID_POPUP_GRID_LEVEL_25   },
        { 20,   ID_POPUP_GRID_LEVEL_20   },
        { 10,   ID_POPUP_GRID_LEVEL_10   },
        { 5,    ID_POPUP_GRID_LEVEL_5    },
        { 2,    ID_POPUP_GRID_LEVEL_2    },
        { 1,    ID_POPUP_GRID_LEVEL_1    },
        { 0,    ID_POPUP_GRID_USER       }
    };

    static const grid_list_struct grid_list_schematic[] =
    {
        { 50, ID_POPUP_GRID_LEVEL_50 },
        { 25, ID_POPUP_GRID_LEVEL_25 },
        { 10, ID_POPUP_GRID_LEVEL_10 },
        { 5,  ID_POPUP_GRID_LEVEL_5  },
        { 2,  ID_POPUP_GRID_LEVEL_2  },
        { 1,  ID_POPUP_GRID_LEVEL_1  },
        { 0,  ID_POPUP_GRID_USER     }
    };


    ADD_MENUITEM( MasterMenu, ID_POPUP_ZOOM_CENTER, _( "Center" ), zoom_center_xpm );
    ADD_MENUITEM( MasterMenu, ID_POPUP_ZOOM_IN, _( "Zoom in" ), zoom_in_xpm );
    ADD_MENUITEM( MasterMenu, ID_POPUP_ZOOM_OUT, _( "Zoom out" ), zoom_out_xpm );

    wxMenu* zoom_choice = new wxMenu;
    ADD_MENUITEM_WITH_SUBMENU( MasterMenu, zoom_choice,
                               ID_POPUP_ZOOM_SELECT, _( "Zoom Select" ), zoom_select_xpm );

    ADD_MENUITEM( MasterMenu, ID_POPUP_ZOOM_AUTO, _( "Auto" ), zoom_optimal_xpm );
    ADD_MENUITEM( MasterMenu, ID_POPUP_ZOOM_REDRAW, _( "Redraw" ), repaint_xpm );

    /* Create the basic zoom list: */
    zoom = GetScreen()->GetZoom();
    zoom_value = 1;
    for( ii = 0; zoom_value <= m_Parent->m_ZoomMaxValue; zoom_value <<= 1, ii++ ) // Create zoom choice 1 .. zoom max
    {
        line.Printf( wxT( "%u" ), zoom_value );
        zoom_choice->Append( ID_POPUP_ZOOM_LEVEL_1 + ii,
                             zoom_msg + line, wxEmptyString, TRUE );
        if( zoom == zoom_value )
            zoom_choice->Check( ID_POPUP_ZOOM_LEVEL_1 + ii, TRUE );
    }

    wxMenu* grid_choice = new wxMenu;
    ADD_MENUITEM_WITH_SUBMENU( MasterMenu, grid_choice,
                               ID_POPUP_GRID_SELECT, _( "Grid Select" ), grid_select_xpm );

    grid = GetScreen()->GetGrid();

    // Create grid list
    switch( m_Parent->m_Ident )
    {
    case MODULE_EDITOR_FRAME:
    case GERBER_FRAME:
    case PCB_FRAME:
    case CVPCB_DISPLAY_FRAME:
        for( ii = 0; ; ii++ )
        {
            if ( grid_list_pcb[ii].m_Value )
            {
                double grid_value = To_User_Unit(g_UnitMetric, grid_list_pcb[ii].m_Value,
                    ((WinEDA_DrawFrame*)m_Parent)->m_InternalUnits);
                if ( g_UnitMetric == 0)	// inches
                    line.Printf(wxT("%g mils"), grid_value*1000);
                else
                    line.Printf(wxT("%g mm"), grid_value);
            }
            else line = _("grid user");
            msg = grid_msg + line;
            grid_choice->Append( grid_list_pcb[ii].m_Id, msg, wxEmptyString, TRUE );
            if( grid_list_pcb[ii].m_Value <= 0 )
            {
                if( GetScreen()->m_UserGridIsON )
                    grid_choice->Check( grid_list_pcb[ii].m_Id, TRUE );
                break;
            }
            if( grid.x == grid_list_pcb[ii].m_Value )
                grid_choice->Check( grid_list_pcb[ii].m_Id, TRUE );
        }

        break;

    case SCHEMATIC_FRAME:
    case LIBEDITOR_FRAME:
        for( ii = 0; ; ii++ )
        {
            if( grid_list_schematic[ii].m_Value <= 0 )
                break;
            double grid_value = To_User_Unit(g_UnitMetric, grid_list_schematic[ii].m_Value,
                ((WinEDA_DrawFrame*)m_Parent)->m_InternalUnits);
            if ( g_UnitMetric == 0)	// inches
                line.Printf(wxT("%g mils"), grid_value*1000);
            else
                line.Printf(wxT("%g mm"), grid_value);

            msg = grid_msg + line;
            grid_choice->Append( grid_list_schematic[ii].m_Id,
                                 msg, wxEmptyString, TRUE );
            if( grid.x == grid_list_schematic[ii].m_Value )
                grid_choice->Check( grid_list_schematic[ii].m_Id, TRUE );
        }

        break;

    case VIEWER_FRAME:
        break;
    }

    MasterMenu->AppendSeparator();
    ADD_MENUITEM( MasterMenu, ID_POPUP_CANCEL, _( "Close" ), cancel_xpm );
}


/**********************************************************/
void WinEDA_DrawFrame::Process_Zoom( wxCommandEvent& event )
/**********************************************************/

/* Handle the Zoom commands from the zoom tools in the main toolbar.
 *  Calls the active window Zoom function
 */
{
    int id = event.GetId();

    switch( id )
    {
    case ID_ZOOM_IN_BUTT:
    case ID_ZOOM_OUT_BUTT:
    case ID_ZOOM_REDRAW_BUTT:
    case ID_ZOOM_PAGE_BUTT:
        OnZoom( id );
        break;

    default:
        DisplayError( this, wxT( "WinEDA_DrawFrame::Process_Zoom id Error" ) );
        break;
    }
}