kicad/pcbnew/router/router_preview_item.h

146 lines
4.0 KiB
C++

/*
* KiRouter - a push-and-(sometimes-)shove PCB router
*
* Copyright (C) 2013-2014 CERN
* Copyright (C) 2016-2023 KiCad Developers, see AUTHORS.txt for contributors.
* Author: Tomasz Wlostowski <tomasz.wlostowski@cern.ch>
*
* 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 <http://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 <eda_item.h>
namespace PNS {
class ITEM;
class ROUTER;
}
#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
};
/**
* We draw this item on a single layer, but we stack up all the layers from
* the various components that form this preview item. In order to make this
* work, we need to map that layer stack onto fractional depths that are less
* than 1.0 so that this preview item doesn't draw on top of other overlays
* that are in front of it.
*
* This factor is chosen to be fairly small so that we can fit an entire
* GAL layer stack into the space of one view group sublayer (which is
* currently hard-coded via GAL::AdvanceDepth take a depth of 0.1)
*/
static constexpr double LayerDepthFactor = 0.0001;
static constexpr double PathOverlayDepth = LayerDepthFactor * static_cast<double>( LAYER_ZONE_END );
ROUTER_PREVIEW_ITEM( const SHAPE& aShape, KIGFX::VIEW* aView = nullptr );
ROUTER_PREVIEW_ITEM( const PNS::ITEM* aItem = nullptr, KIGFX::VIEW* aView = nullptr,
int aFlags = 0 );
~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; }
void ShowClearance( bool aEnabled ) { m_showClearance = aEnabled; }
double GetOriginDepth() const { return m_originDepth; }
#if defined(DEBUG)
void Show( int aA, std::ostream& aB ) const override {}
#endif
/** Get class name
* @return string "ROUTER_PREVIEW_ITEM"
*/
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 void ViewGetLayers( int aLayers[], int& aCount ) const override
{
aLayers[0] = m_layer;
aCount = 1;
}
void drawLineChain( const SHAPE_LINE_CHAIN_BASE* aL, KIGFX::GAL* aGal ) const;
void drawShape( const SHAPE* aShape, KIGFX::GAL* aGal ) const;
private:
const KIGFX::COLOR4D getLayerColor( int aLayer ) const;
private:
KIGFX::VIEW* m_view;
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;
bool m_showClearance;
double m_originDepth;
double m_depth;
KIGFX::COLOR4D m_color;
VECTOR2I m_pos;
};
#endif