marker_base.h

Go to the documentation of this file.

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


#ifndef MARKER_BASE_H
#define MARKER_BASE_H

#include <memory>

#include <rc_item.h>
#include <gr_basic.h>
#include <eda_rect.h>


class SHAPE_LINE_CHAIN;

namespace KIGFX
{
 class RENDER_SETTINGS;
}

using KIGFX::RENDER_SETTINGS;


/*
 * Marker are mainly used to show a DRC or ERC error or warning
 */
class MARKER_BASE
{
public:
 enum TYPEMARKER {
 MARKER_UNSPEC,
 MARKER_ERC,
 MARKER_PCB,
 MARKER_SIMUL
 };

 MARKER_BASE( int aScalingFactor, std::shared_ptr<RC_ITEM> aItem,
 TYPEMARKER aType = MARKER_UNSPEC );
 virtual ~MARKER_BASE();

 int MarkerScale() const { return m_scalingFactor; }
 void SetMarkerScale( int aScale ) { m_scalingFactor = aScale; }

 void ShapeToPolygon( SHAPE_LINE_CHAIN& aPolygon, int aScale = -1 ) const;

 void PrintMarker( const RENDER_SETTINGS* aSettings, const wxPoint& aOffset );

 const wxPoint& GetPos() const { return m_Pos; }

 virtual const KIID GetUUID() const = 0;

 void SetMarkerType( enum TYPEMARKER aMarkerType ) { m_markerType = aMarkerType; }
 enum TYPEMARKER GetMarkerType() const { return m_markerType; }

 bool IsExcluded() const { return m_excluded; }
 void SetExcluded( bool aExcluded ) { m_excluded = aExcluded; }

 std::shared_ptr<RC_ITEM> GetRCItem() const { return m_rcItem; }

 bool HitTestMarker( const wxPoint& aHitPosition, int aAccuracy ) const;

 EDA_RECT GetBoundingBoxMarker() const;

protected:
 virtual KIGFX::COLOR4D getColor() const = 0;

public:
 wxPoint m_Pos; 

protected:
 TYPEMARKER m_markerType; // The type of marker (useful to filter markers)
 bool m_excluded; // User has excluded this specific error
 std::shared_ptr<RC_ITEM> m_rcItem;

 int m_scalingFactor; // Scaling factor to convert corners coordinates
 // to internal units coordinates
 EDA_RECT m_shapeBoundingBox; // Bounding box of the graphic symbol, relative
 // to the position of the shape, in marker shape
 // units
};


#endif // MARKER_BASE_H