router_preview_item.h

Go to the documentation of this file.

/*
 * KiRouter - a push-and-(sometimes-)shove PCB router
 *
 * Copyright (C) 2013-2014 CERN
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 * Author: Tomasz Wlostowski <[email protected]>
 *
 * 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 __ROUTER_PREVIEW_ITEM_H
#define __ROUTER_PREVIEW_ITEM_H
 
#include <cstdio>
 
#include <view/view.h>
#include <view/view_item.h>
#include <view/view_group.h>
 
#include <math/vector2d.h>
#include <math/box2.h>
 
#include <geometry/shape_line_chain.h>
#include <geometry/shape_circle.h>
 
#include <gal/color4d.h>
 
#include <layer_ids.h>
#include <eda_item.h>
 
namespace PNS {
 
class ITEM;
class ROUTER;
class ROUTER_IFACE;
 
}
 
#define PNS_HEAD_TRACE 1
#define PNS_HOVER_ITEM 2
#define PNS_SEMI_SOLID 4
#define PNS_COLLISION  8
 
 
class ROUTER_PREVIEW_ITEM : public EDA_ITEM
{
public:
    enum ITEM_TYPE
    {
        PR_STUCK_MARKER = 0,
        PR_POINT,
        PR_SHAPE
    };

    enum DISPLAY_MODE
    {
        DM_SHAPE,   
        DM_SHADOW   
    };

    static constexpr double LayerDepthFactor = 0.001;
    static constexpr double PathOverlayDepth = LayerDepthFactor * static_cast<double>( LAYER_ZONE_END );
 
    ROUTER_PREVIEW_ITEM( const SHAPE& aShape, PNS::ROUTER_IFACE* aIface, KIGFX::VIEW* aView );
    ROUTER_PREVIEW_ITEM( const PNS::ITEM* aItem, PNS::ROUTER_IFACE* aIface, KIGFX::VIEW* aView,
                         int aFlags = 0, DISPLAY_MODE aMode = DM_SHAPE );
    ~ROUTER_PREVIEW_ITEM();
 
    void Update( const PNS::ITEM* aItem );
 
    void SetColor( const KIGFX::COLOR4D& aColor ) { m_color = aColor; }
    void SetDepth( double aDepth ) { m_depth = aDepth; }
    void SetWidth( int aWidth ) { m_width = aWidth; }
 
    void SetClearance( int aClearance ) { m_clearance = aClearance; }
 
    bool IsCollisionFlagged() const { return ( m_flags & PNS_COLLISION ) != 0; }
 
    double GetOriginDepth() const { return m_originDepth; }
 
#if defined(DEBUG)
    void Show( int aA, std::ostream& aB ) const override {}
#endif

    virtual wxString GetClass() const override
    {
        return wxT( "ROUTER_PREVIEW_ITEM" );
    }
 
    const BOX2I ViewBBox() const override;
 
    virtual void ViewDraw( int aLayer, KIGFX::VIEW* aView ) const override;
 
    virtual std::vector<int> ViewGetLayers() const override
    {
        return { m_layer };
    }
 
    void drawLineChain( const SHAPE_LINE_CHAIN_BASE* aL, KIGFX::GAL* aGal ) const;
 
    void drawShape( const SHAPE* aShape, KIGFX::GAL* aGal ) const;
 
    void drawClearanceHalo( const SHAPE* aShape, KIGFX::GAL* aGal ) const;
 
private:
    const KIGFX::COLOR4D getLayerColor( int aLayer, const PNS::ITEM* aItem = nullptr ) const;
 
    int chooseLayer() const;
 
private:
    KIGFX::VIEW*   m_view;
 
    PNS::ROUTER_IFACE* m_iface;
 
    SHAPE*         m_shape;
    SHAPE*         m_hole;
 
    ITEM_TYPE      m_type;
 
    int            m_flags;
    int            m_width;
    int            m_layer;
    int            m_originLayer;
    int            m_clearance;
    DISPLAY_MODE   m_mode;
 
    double         m_originDepth;
    double         m_depth;
 
    KIGFX::COLOR4D m_color;
    VECTOR2I       m_pos;
};
 
#endif