MARKER_BASE Class Reference

#include <marker_base.h>

Inheritance diagram for MARKER_BASE:

Public Types
enum	TYPEMARKER { MARKER_UNSPEC, MARKER_ERC, MARKER_PCB, MARKER_SIMUL }

Public Member Functions
	MARKER_BASE (int aScalingFactor, std::shared_ptr< RC_ITEM > aItem, TYPEMARKER aType=MARKER_UNSPEC)
virtual	~MARKER_BASE ()
int	MarkerScale () const
	The scaling factor to convert polygonal shape coordinates to internal units. More...
void	ShapeToPolygon (SHAPE_LINE_CHAIN &aPolygon, int aScale=-1) const
	Return the shape polygon in internal units in a SHAPE_LINE_CHAIN the coordinates are relatives to the marker position (are not absolute). More...
void	PrintMarker (const RENDER_SETTINGS *aSettings, const wxPoint &aOffset)
	Print the shape is the polygon defined in m_Corners (array of wxPoints). More...
const wxPoint &	GetPos () const
virtual const KIID	GetUUID () const =0
void	SetMarkerType (enum TYPEMARKER aMarkerType)
	Accessors to set/get marker type (DRC, ERC, or other) More...
enum TYPEMARKER	GetMarkerType () const
bool	IsExcluded () const
void	SetExcluded (bool aExcluded)
std::shared_ptr< RC_ITEM >	GetRCItem () const
bool	HitTestMarker (const wxPoint &aHitPosition, int aAccuracy) const
	Test if the given wxPoint is within the bounds of this object. More...
EDA_RECT	GetBoundingBoxMarker () const
	Return the orthogonal, bounding box of this object for display purposes. More...

Public Attributes
wxPoint	m_Pos
	position of the marker More...

Protected Member Functions
virtual KIGFX::COLOR4D	getColor () const =0

Protected Attributes
TYPEMARKER	m_markerType
bool	m_excluded
std::shared_ptr< RC_ITEM >	m_rcItem
int	m_scalingFactor
EDA_RECT	m_shapeBoundingBox

Detailed Description

Definition at line 49 of file marker_base.h.

Member Enumeration Documentation

TYPEMARKER

enum MARKER_BASE::TYPEMARKER

Enumerator
MARKER_UNSPEC
MARKER_ERC
MARKER_PCB
MARKER_SIMUL

Definition at line 52 of file marker_base.h.

                    {
        MARKER_UNSPEC,
        MARKER_ERC,
        MARKER_PCB,
        MARKER_SIMUL
    };

Constructor & Destructor Documentation

MARKER_BASE()

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

Definition at line 61 of file marker_base.cpp.

                                                                                             :
        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);
}

References CORNERS_COUNT, m_shapeBoundingBox, MarkerShapeCorners, EDA_RECT::SetEnd(), EDA_RECT::SetOrigin(), VECTOR2< T >::x, and VECTOR2< T >::y.

~MARKER_BASE()

MARKER_BASE::~MARKER_BASE ( )

virtual

Definition at line 85 of file marker_base.cpp.

{
}

Member Function Documentation

GetBoundingBoxMarker()

EDA_RECT MARKER_BASE::GetBoundingBoxMarker

(

)

const

Return the orthogonal, bounding box of this object for display purposes.

This box should be an enclosing perimeter for visible components of this object, and the units should be in the pcb or schematic coordinate system. It is OK to overestimate the size by a few counts.

Definition at line 123 of file marker_base.cpp.

{
    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 );
}

References EDA_RECT::GetPosition(), EDA_RECT::GetSize(), m_Pos, m_scalingFactor, and m_shapeBoundingBox.

Referenced by SCH_MARKER::GetBoundingBox(), and HitTestMarker().

getColor()

virtual KIGFX::COLOR4D MARKER_BASE::getColor ( ) const

protectedpure virtual

Implemented in PCB_MARKER, and SCH_MARKER.

Referenced by PrintMarker().

GetMarkerType()

enum TYPEMARKER MARKER_BASE::GetMarkerType ( ) const

inline

Definition at line 92 of file marker_base.h.

{ return m_markerType; }

References m_markerType.

Referenced by SCH_SCREENS::DeleteMarkers(), SHEETLIST_ERC_ITEMS_PROVIDER::visitMarkers(), and DIALOG_ERC::writeReport().

GetPos()

const wxPoint& MARKER_BASE::GetPos ( ) const

inline

Returns

the position of this marker in internal units.

Definition at line 84 of file marker_base.h.

{ return m_Pos; }

References m_Pos.

Referenced by PCB_SELECTION_TOOL::hitTestDistance().

GetRCItem()

std::shared_ptr<RC_ITEM> MARKER_BASE::GetRCItem ( ) const

inline

Returns

the RC_ITEM held within this marker so that its interface may be used.

Definition at line 100 of file marker_base.h.

{ return m_rcItem; }

References m_rcItem.

Referenced by CollisionMatchesExpected(), SCH_SCREENS::DeleteMarkers(), SHEETLIST_ERC_ITEMS_PROVIDER::GetCount(), SHEETLIST_ERC_ITEMS_PROVIDER::GetERCItem(), BOARD_DRC_ITEMS_PROVIDER::GetItem(), InvalidMatchesExpected(), KI_TEST::IsDrcMarkerOfType(), DIALOG_ERC::OnERCItemRClick(), operator<<(), SHEETLIST_ERC_ITEMS_PROVIDER::SetSeverities(), SHEETLIST_ERC_ITEMS_PROVIDER::visitMarkers(), and DIALOG_ERC::writeReport().

GetUUID()

virtual const KIID MARKER_BASE::GetUUID ( ) const

pure virtual

Implemented in PCB_MARKER, and SCH_MARKER.

HitTestMarker()

bool MARKER_BASE::HitTestMarker	(	const wxPoint &	aHitPosition,
		int	aAccuracy
	)		const

Test if the given wxPoint is within the bounds of this object.

Parameters

aHitPosition

is the wxPoint to test (in internal units).

Returns

true if a hit, else false.

Definition at line 90 of file marker_base.cpp.

{
    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;
}

References EDA_RECT::Contains(), GetBoundingBoxMarker(), EDA_RECT::Inflate(), m_Pos, SHAPE_LINE_CHAIN_BASE::PointInside(), and ShapeToPolygon().

Referenced by PCB_MARKER::HitTest(), and SCH_MARKER::HitTest().

IsExcluded()

bool MARKER_BASE::IsExcluded ( ) const

inline

Definition at line 94 of file marker_base.h.

{ return m_excluded; }

References m_excluded.

Referenced by RC_TREE_MODEL::DeleteItems(), SCH_SCREENS::DeleteMarkers(), SCH_MARKER::GetColorLayer(), PCB_MARKER::GetColorLayer(), SHEETLIST_ERC_ITEMS_PROVIDER::GetCount(), SCH_EDIT_FRAME::RecordERCExclusions(), SHEETLIST_ERC_ITEMS_PROVIDER::SetSeverities(), RC_ITEM::ShowReport(), and PCB_MARKER::ViewGetLayers().

MarkerScale()

int MARKER_BASE::MarkerScale ( ) const

inline

The scaling factor to convert polygonal shape coordinates to internal units.

Definition at line 66 of file marker_base.h.

{ return m_scalingFactor; }

References m_scalingFactor.

Referenced by KIGFX::PCB_PAINTER::draw(), PCB_MARKER::GetBoundingBox(), PrintMarker(), and ShapeToPolygon().

PrintMarker()

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

Print the shape is the polygon defined in m_Corners (array of wxPoints).

Definition at line 137 of file marker_base.cpp.

{
    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() );
}

References CORNERS_COUNT, getColor(), KIGFX::RENDER_SETTINGS::GetPrintDC(), GRClosedPoly(), m_Pos, MarkerScale(), and MarkerShapeCorners.

Referenced by SCH_MARKER::Print().

SetExcluded()

void MARKER_BASE::SetExcluded ( bool  aExcluded )

inline

Definition at line 95 of file marker_base.h.

{ m_excluded = aExcluded; }

References m_excluded.

Referenced by DIALOG_ERC::ExcludeMarker(), EE_INSPECTION_TOOL::ExcludeMarker(), DIALOG_DRC::ExcludeMarker(), DIALOG_DRC::OnDRCItemRClick(), DIALOG_ERC::OnERCItemRClick(), BOARD::ResolveDRCExclusions(), and SCHEMATIC::ResolveERCExclusions().

SetMarkerType()

void MARKER_BASE::SetMarkerType ( enum TYPEMARKER  aMarkerType )

inline

Accessors to set/get marker type (DRC, ERC, or other)

Definition at line 91 of file marker_base.h.

{ m_markerType = aMarkerType; }

References m_markerType.

ShapeToPolygon()

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

Return the shape polygon in internal units in a SHAPE_LINE_CHAIN the coordinates are relatives to the marker position (are not absolute).

Parameters

aPolygon

is the SHAPE_LINE_CHAIN to fill with the shape.

Definition at line 110 of file marker_base.cpp.

{
    if( aScale < 0 )
        aScale = MarkerScale();

    for( const VECTOR2I& corner : MarkerShapeCorners )
        aPolygon.Append( corner * aScale );

    // Be sure aPolygon is seen as a closed polyline:
    aPolygon.SetClosed( true );
}

References SHAPE_LINE_CHAIN::Append(), MarkerScale(), MarkerShapeCorners, and SHAPE_LINE_CHAIN::SetClosed().

Referenced by KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), FOOTPRINT::GetCoverageArea(), PCB_SELECTION_TOOL::hitTestDistance(), and HitTestMarker().

Member Data Documentation

m_excluded

bool MARKER_BASE::m_excluded

protected

Definition at line 127 of file marker_base.h.

Referenced by IsExcluded(), and SetExcluded().

m_markerType

TYPEMARKER MARKER_BASE::m_markerType

protected

Definition at line 126 of file marker_base.h.

Referenced by GetMarkerType(), and SetMarkerType().

m_Pos

wxPoint MARKER_BASE::m_Pos

position of the marker

Definition at line 123 of file marker_base.h.

Referenced by PCB_MARKER::GetBoundingBox(), GetBoundingBoxMarker(), GetPos(), PCB_MARKER::GetPosition(), SCH_MARKER::GetPosition(), HitTestMarker(), PCB_MARKER::Move(), SCH_MARKER::Move(), PCB_MARKER::PCB_MARKER(), PrintMarker(), SCH_MARKER::SCH_MARKER(), PCB_MARKER::Serialize(), SCH_MARKER::Serialize(), PCB_MARKER::SetPosition(), and SCH_MARKER::SetPosition().

m_rcItem

std::shared_ptr<RC_ITEM> MARKER_BASE::m_rcItem

protected

Definition at line 128 of file marker_base.h.

Referenced by SCH_MARKER::GetColorLayer(), PCB_MARKER::GetColorLayer(), PCB_MARKER::GetMsgPanelInfo(), SCH_MARKER::GetMsgPanelInfo(), GetRCItem(), PCB_MARKER::GetSelectMenuText(), PCB_MARKER::Matches(), SCH_MARKER::Matches(), PCB_MARKER::PCB_MARKER(), SCH_MARKER::SCH_MARKER(), SCH_MARKER::Serialize(), PCB_MARKER::Serialize(), SCH_MARKER::ViewGetLayers(), and PCB_MARKER::ViewGetLayers().

m_scalingFactor

int MARKER_BASE::m_scalingFactor

protected

Definition at line 130 of file marker_base.h.

Referenced by GetBoundingBoxMarker(), and MarkerScale().

m_shapeBoundingBox

EDA_RECT MARKER_BASE::m_shapeBoundingBox

protected

Definition at line 132 of file marker_base.h.

Referenced by PCB_MARKER::GetBoundingBox(), GetBoundingBoxMarker(), and MARKER_BASE().

---

The documentation for this class was generated from the following files:

• marker_base.h
• marker_base.cpp