kicad/common/marker_base.cpp

199 lines
6.0 KiB
C++

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2018 Jean-Pierre Charras, jp.charras at wanadoo.fr
* Copyright (C) 2018-2020 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
*/
/**
* @file marker_base.cpp
* @brief Implementation of MARKER_BASE class.
* Markers are used to show something (usually a drc/erc problem).
* Markers in Pcbnew and Eeschema are derived from this base class.
*/
#include "fctsys.h"
#include "base_screen.h"
#include "common.h"
#include "macros.h"
#include "marker_base.h"
#include <geometry/shape_line_chain.h>
#include <render_settings.h>
#include "dialog_display_info_HTML_base.h"
/* The graphic shape of markers is a polygon.
* MarkerShapeCorners contains the coordinates of corners of the polygonal default shape
* they are arbitrary units to make coding shape easy.
* internal units coordinates are these values scaled by .m_ScalingFactor
*/
static const VECTOR2I MarkerShapeCorners[] =
{
VECTOR2I( 0, 0 ),
VECTOR2I( 8, 1 ),
VECTOR2I( 4, 3 ),
VECTOR2I( 13, 8 ),
VECTOR2I( 9, 9 ),
VECTOR2I( 8, 13 ),
VECTOR2I( 3, 4 ),
VECTOR2I( 1, 8 ),
VECTOR2I( 0, 0 )
};
const unsigned CORNERS_COUNT = arrayDim( MarkerShapeCorners );
MARKER_BASE::MARKER_BASE( int aScalingFactor, RC_ITEM* aItem, TYPEMARKER aType ) :
m_markerType( aType ),
m_excluded( false ),
m_rcItem( aItem ),
m_scalingFactor( aScalingFactor )
{
const VECTOR2I* point_shape = MarkerShapeCorners;
wxPoint start( point_shape->x, point_shape->y );
wxPoint end = start;
for( unsigned ii = 1; ii < CORNERS_COUNT; ii++ )
{
++point_shape;
start.x = std::min( start.x, point_shape->x);
start.y = std::min( start.y, point_shape->y);
end.x = std::max( end.x, point_shape->x);
end.y = std::max( end.y, point_shape->y);
}
m_shapeBoundingBox.SetOrigin( start);
m_shapeBoundingBox.SetEnd( end);
}
MARKER_BASE::~MARKER_BASE()
{
}
void MARKER_BASE::SetData( EDA_UNITS aUnits, int aErrorCode, const wxPoint& aMarkerPos,
EDA_ITEM* aItem, const wxPoint& aPos,
EDA_ITEM* bItem, const wxPoint& bPos )
{
m_Pos = aMarkerPos;
m_rcItem->SetData( aUnits, aErrorCode, aItem, aPos, bItem, bPos );
m_rcItem->SetParent( this );
}
void MARKER_BASE::SetData( int aErrorCode, const wxPoint& aMarkerPos,
const wxString& aText, const wxPoint& aPos,
const wxString& bText, const wxPoint& bPos )
{
m_Pos = aMarkerPos;
m_rcItem->SetData( aErrorCode, aText, aPos, bText, bPos );
m_rcItem->SetParent( this );
}
void MARKER_BASE::SetData( EDA_UNITS aUnits, int aErrorCode, const wxPoint& aMarkerPos,
EDA_ITEM* aItem,
EDA_ITEM* bItem )
{
m_Pos = aMarkerPos;
m_rcItem->SetData( aUnits, aErrorCode, aItem, bItem );
m_rcItem->SetParent( this );
}
void MARKER_BASE::SetData( int aErrorCode, const wxPoint& aMarkerPos,
const wxString& aText,
const wxString& bText )
{
m_Pos = aMarkerPos;
m_rcItem->SetData( aErrorCode, aText, bText );
m_rcItem->SetParent( this );
}
void MARKER_BASE::SetData( int aErrorCode, const wxPoint& aMarkerPos,
const wxString& aText, const KIID& aID,
const wxString& bText, const KIID& bID )
{
m_Pos = aMarkerPos;
m_rcItem->SetData( aErrorCode, aText, aID, bText, bID );
m_rcItem->SetParent( this );
}
bool MARKER_BASE::HitTestMarker( const wxPoint& aHitPosition, int aAccuracy ) const
{
EDA_RECT bbox = GetBoundingBoxMarker();
bbox.Inflate( aAccuracy );
// Fast hit test using boundary box. A finer test will be made if requested
bool hit = bbox.Contains( aHitPosition );
if( hit ) // Fine test
{
SHAPE_LINE_CHAIN polygon;
ShapeToPolygon( polygon );
VECTOR2I rel_pos( aHitPosition - m_Pos );
hit = polygon.PointInside( rel_pos, aAccuracy );
}
return hit;
}
void MARKER_BASE::ShapeToPolygon( SHAPE_LINE_CHAIN& aPolygon) const
{
for( const VECTOR2I& corner : MarkerShapeCorners )
aPolygon.Append( corner * MarkerScale() );
// Be sure aPolygon is seen as a closed polyline:
aPolygon.SetClosed( true );
}
EDA_RECT MARKER_BASE::GetBoundingBoxMarker() const
{
wxSize size_iu = m_shapeBoundingBox.GetSize();
wxPoint position_iu = m_shapeBoundingBox.GetPosition();
size_iu.x *= m_scalingFactor;
size_iu.y *= m_scalingFactor;
position_iu.x *= m_scalingFactor;
position_iu.y *= m_scalingFactor;
position_iu += m_Pos;
return EDA_RECT( position_iu, size_iu );
}
void MARKER_BASE::PrintMarker( RENDER_SETTINGS* aSettings, const wxPoint& aOffset )
{
wxDC* DC = aSettings->GetPrintDC();
// Build the marker shape polygon in internal units:
std::vector<wxPoint> shape;
shape.reserve( CORNERS_COUNT );
for( const VECTOR2I& corner : MarkerShapeCorners )
shape.emplace_back( corner * MarkerScale() + m_Pos + aOffset );
GRClosedPoly( nullptr, DC, CORNERS_COUNT, &shape[0], true, 0, getColor(), getColor() );
}