kicad/gerbview/locate.cpp

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2016 Jean-Pierre Charras, jp.charras at wanadoo.fr
 * Copyright (C) 1992-2016 KiCad Developers, see change_log.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
 */

/**
 * @file locate.cpp
 */

#include <fctsys.h>
#include <common.h>
#include <msgpanel.h>

#include <gerbview.h>
#include <gerbview_frame.h>
#include <gerber_file_image.h>
#include <gerber_file_image_list.h>


/* locate a gerber item and return a pointer to it.
 * Display info about this item
 * Items on non visible layers are not taken in account
 */
GERBER_DRAW_ITEM* GERBVIEW_FRAME::Locate( const wxPoint& aPosition, int aTypeloc )
{
    m_messagePanel->EraseMsgBox();
    wxPoint ref = aPosition;

    if( aTypeloc == CURSEUR_ON_GRILLE )
        ref = GetNearestGridPosition( ref );

    int layer = GetActiveLayer();
    GERBER_FILE_IMAGE* gerber = GetGbrImage( layer );

    GERBER_DRAW_ITEM* gerb_item = nullptr;

    // Search first on active layer
    // A not used graphic layer can be selected. So gerber can be NULL
    if( gerber && gerber->m_IsVisible )
    {
        for( auto item = gerber->GetItemsList(); item; item = item->Next() )
        {
            if( item->HitTest( ref ) )
            {
                gerb_item = item;
                break;
            }
        }
    }

    if( gerb_item == nullptr ) // Search on all layers
    {
        for( layer = 0; layer < (int)ImagesMaxCount(); ++layer )
        {
            gerber = GetGbrImage( layer );

            if( gerber == nullptr )    // Graphic layer not yet used
                continue;

            if( !gerber->m_IsVisible )
                continue;

            if( layer == GetActiveLayer() )
                continue;

            for( auto item = gerber->GetItemsList(); item; item = item->Next() )
            {
                if( item->HitTest( ref ) )
                {
                    gerb_item = item;
                    break;
                }
            }

            if( gerb_item )
                break;
        }
    }

    if( gerb_item )
    {
        MSG_PANEL_ITEMS items;
        gerb_item->GetMsgPanelInfo( m_UserUnits, items );
        SetMsgPanel( items );
    }

    return gerb_item;
}