kicad/include/preview_items/arc_assistant.h

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2017 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 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 PREVIEW_ITEMS_ARC_ASSISTANT_H
#define PREVIEW_ITEMS_ARC_ASSISTANT_H

#include <eda_item.h>
#include <preview_items/arc_geom_manager.h>
#include <layer_ids.h>

namespace KIGFX
{
namespace PREVIEW
{
    /**
     * Represents an assistant draw when interactively drawing an arc on a canvas.
     */
    class ARC_ASSISTANT : public EDA_ITEM
    {
    public:
        ARC_ASSISTANT( const ARC_GEOM_MANAGER& aManager,
                       const EDA_IU_SCALE& aIuScale,
                       EDA_UNITS aUnits );

        const BOX2I ViewBBox() const override;

        void ViewGetLayers( int aLayers[], int& aCount ) const override
        {
            aLayers[0] = LAYER_SELECT_OVERLAY;  // Assistant graphics
            aLayers[1] = LAYER_GP_OVERLAY;      // Drop shadows
            aCount = 2;
        }

        /**
         * Draw the assistance (with reference to the construction manager
         */
        void ViewDraw( int aLayer, KIGFX::VIEW* aView ) const override final;

#if defined( DEBUG )
        void Show( int x, std::ostream& st ) const override
        {
        }
#endif

        wxString GetClass() const override
        {
            return "ARC_ASSISTANT";
        }

        void SetUnits( EDA_UNITS aUnits ) { m_units = aUnits; }

    private:
        const ARC_GEOM_MANAGER& m_constructMan;
        const EDA_IU_SCALE&     m_iuScale;
        EDA_UNITS               m_units;
    };
} // namespace PREVIEW
} // namespace KIGFX

#endif // PREVIEW_ITEMS_ARC_ASSISTANT_H