LIB_SHAPE Class Reference

#include <lib_shape.h>

Inheritance diagram for LIB_SHAPE:

Public Types
enum	LIB_CONVERT : int { BASE = 1, DEMORGAN = 2 }
enum	COMPARE_FLAGS : int { UNIT = 0x01, EQUALITY = 0x02, ERC = 0x04 }
	The list of flags used by the compare function. More...

Public Member Functions
	LIB_SHAPE (LIB_SYMBOL *aParent, SHAPE_T aShape, int aLineWidth=0, FILL_T aFillType=FILL_T::NO_FILL)
	~LIB_SHAPE ()
wxString	GetClass () const override
	Return the class name. More...
wxString	GetTypeName () const override
	Provide a user-consumable name of the object type. More...
bool	HitTest (const wxPoint &aPosition, int aAccuracy=0) const override
	Test if aPosition is inside or on the boundary of this item. More...
bool	HitTest (const EDA_RECT &aRect, bool aContained, int aAccuracy=0) const override
	Test if aRect intersects this item. More...
int	GetPenWidth () const override
int	GetEffectivePenWidth (const RENDER_SETTINGS *aSettings) const override
const EDA_RECT	GetBoundingBox () const override
void	GetMsgPanelInfo (EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList) override
	Display basic info (type, part and convert) about the current item in message panel. More...
void	BeginEdit (const wxPoint &aStartPoint) override
	Begin drawing a symbol library draw item at aPosition. More...
bool	ContinueEdit (const wxPoint &aPosition) override
	Continue an edit in progress at aPosition. More...
void	CalcEdit (const wxPoint &aPosition) override
	Calculate the attributes of an item at aPosition when it is being edited. More...
void	EndEdit () override
	End an object editing action. More...
void	SetEditState (int aState)
void	AddPoint (const wxPoint &aPosition)
void	Offset (const wxPoint &aOffset) override
	Set the drawing object by aOffset from the current position. More...
void	MoveTo (const wxPoint &aPosition) override
	Move a draw object to aPosition. More...
wxPoint	GetPosition () const override
void	SetPosition (const wxPoint &aPosition) override
wxPoint	GetCenter () const
void	CalcArcAngles (int &aStartAngle, int &aEndAngle) const
void	MirrorHorizontal (const wxPoint &aCenter) override
	Mirror the draw object along the horizontal (X) axis about aCenter point. More...
void	MirrorVertical (const wxPoint &aCenter) override
	Mirror the draw object along the MirrorVertical (Y) axis about aCenter point. More...
void	Rotate (const wxPoint &aCenter, bool aRotateCCW=true) override
	Rotate the object about aCenter point. More...
void	Plot (PLOTTER *aPlotter, const wxPoint &aOffset, bool aFill, const TRANSFORM &aTransform) const override
	Plot the draw item using the plot object. More...
wxString	GetSelectMenuText (EDA_UNITS aUnits) const override
	Return the text to display to be used in the selection clarification context menu when multiple items are found at the current cursor position. More...
BITMAPS	GetMenuImage () const override
	Return a pointer to an image to be used in menus. More...
EDA_ITEM *	Clone () const override
	Create a duplicate of this item with linked list members set to NULL. More...
virtual void	Print (const RENDER_SETTINGS *aSettings, const wxPoint &aOffset, void *aData, const TRANSFORM &aTransform)
	Draw an item. More...
LIB_SYMBOL *	GetParent () const
void	ViewGetLayers (int aLayers[], int &aCount) const override
	Return the all the layers within the VIEW the object is painted on. More...
bool	operator== (const LIB_ITEM &aOther) const
	Test LIB_ITEM objects for equivalence. More...
bool	operator== (const LIB_ITEM *aOther) const
bool	operator< (const LIB_ITEM &aOther) const
	Test if another draw item is less than this draw object. More...
bool	operator< (const EDA_ITEM &aItem) const
	Test if another item is less than this object. More...
void	SetUnit (int aUnit)
int	GetUnit () const
void	SetConvert (int aConvert)
int	GetConvert () const
KICAD_T	Type () const
	Returns the type of object. More...
virtual void	SetParent (EDA_ITEM *aParent)
bool	IsModified () const
bool	IsNew () const
bool	IsMoving () const
bool	IsDragging () const
bool	IsWireImage () const
bool	IsSelected () const
bool	IsEntered () const
bool	IsResized () const
bool	IsBrightened () const
void	SetWireImage ()
void	SetSelected ()
void	SetBrightened ()
void	ClearSelected ()
void	ClearBrightened ()
void	SetModified ()
int	GetState (EDA_ITEM_FLAGS type) const
void	SetState (EDA_ITEM_FLAGS type, bool state)
EDA_ITEM_FLAGS	GetStatus () const
void	SetStatus (EDA_ITEM_FLAGS aStatus)
void	SetFlags (EDA_ITEM_FLAGS aMask)
void	ClearFlags (EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
EDA_ITEM_FLAGS	GetFlags () const
bool	HasFlag (EDA_ITEM_FLAGS aFlag) const
EDA_ITEM_FLAGS	GetEditFlags () const
void	ClearTempFlags ()
void	ClearEditFlags ()
virtual bool	IsType (const KICAD_T aScanTypes[]) const
	Check whether the item is one of the listed types. More...
void	SetForceVisible (bool aEnable)
	Set and clear force visible flag used to force the item to be drawn even if it's draw attribute is set to not visible. More...
bool	IsForceVisible () const
virtual const wxPoint	GetFocusPosition () const
	Similar to GetPosition, but allows items to return their visual center rather than their anchor. More...
virtual SEARCH_RESULT	Visit (INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
	May be re-implemented for each derived class in order to handle all the types given by its member data. More...
virtual bool	Matches (const wxFindReplaceData &aSearchData, void *aAuxData) const
	Compare the item against the search criteria in aSearchData. More...
virtual bool	Replace (const wxFindReplaceData &aSearchData, void *aAuxData=nullptr)
	Perform a text replace using the find and replace criteria in aSearchData on items that support text find and replace. More...
virtual bool	IsReplaceable () const
	Override this method in any derived object that supports test find and replace. More...
virtual const BOX2I	ViewBBox () const override
	Return the bounding box of the item covering all its layers. More...
virtual void	ViewDraw (int aLayer, VIEW *aView) const
	Draw the parts of the object belonging to layer aLayer. More...
virtual double	ViewGetLOD (int aLayer, VIEW *aView) const
	Return the level of detail (LOD) of the item. More...
VIEW_ITEM_DATA *	viewPrivData () const
void	ClearViewPrivData ()
bool	Set (PROPERTY_BASE *aProperty, wxAny &aValue)
template<typename T >
bool	Set (PROPERTY_BASE *aProperty, T aValue)
template<typename T >
bool	Set (const wxString &aProperty, T aValue)
wxAny	Get (PROPERTY_BASE *aProperty)
template<typename T >
T	Get (PROPERTY_BASE *aProperty)
template<typename T >
boost::optional< T >	Get (const wxString &aProperty)
void	SwapShape (EDA_SHAPE *aImage)
wxString	ShowShape () const
wxString	SHAPE_T_asString () const
void	SetFillMode (FILL_T aFill)
FILL_T	GetFillType () const
bool	IsFilled () const
void	SetFilled (bool aFlag)
void	SetWidth (int aWidth)
int	GetWidth () const
void	SetShape (SHAPE_T aShape)
SHAPE_T	GetShape () const
const wxPoint &	GetStart () const
	Return the starting point of the graphic. More...
int	GetStartY ()
int	GetStartX ()
void	SetStart (const wxPoint &aStart)
void	SetStartY (int y)
void	SetStartX (int x)
const wxPoint &	GetEnd () const
	Return the ending point of the graphic. More...
int	GetEndY ()
int	GetEndX ()
void	SetEnd (const wxPoint &aEnd)
void	SetEndY (int y)
void	SetEndX (int x)
void	SetBezierC1 (const wxPoint &aPt)
const wxPoint &	GetBezierC1 () const
void	SetBezierC2 (const wxPoint &aPt)
const wxPoint &	GetBezierC2 () const
wxPoint	getCenter () const
void	SetCenter (const wxPoint &aCenter)
void	SetArcAngleAndEnd (double aAngle, bool aCheckNegativeAngle=false)
	Set the end point from the angle center and start. More...
double	GetArcAngle () const
bool	EndsSwapped () const
	Have the start and end points been swapped since they were set? More...
wxPoint	GetArcMid () const
std::vector< wxPoint >	GetRectCorners () const
void	CalcArcAngles (double &aStartAngle, double &aEndAngle) const
	Calc arc start and end angles such that aStartAngle < aEndAngle. More...
int	GetRadius () const
void	SetArcGeometry (const wxPoint &aStart, const wxPoint &aMid, const wxPoint &aEnd)
	Set the three controlling points for an arc. More...
void	SetCachedArcData (const wxPoint &aStart, const wxPoint &aMid, const wxPoint &aEnd, const wxPoint &aCenter)
	Set the data used for mid point caching. More...
const std::vector< wxPoint > &	GetBezierPoints () const
void	DupPolyPointsList (std::vector< wxPoint > &aBuffer) const
	Duplicate the list of corners in a std::vector<wxPoint> More...
int	GetPointCount () const
SHAPE_POLY_SET &	GetPolyShape ()
const SHAPE_POLY_SET &	GetPolyShape () const
bool	IsPolyShapeValid () const
void	SetPolyShape (const SHAPE_POLY_SET &aShape)
void	SetPolyPoints (const std::vector< wxPoint > &aPoints)
void	RebuildBezierToSegmentsPointsList (int aMinSegLen)
	Rebuild the m_bezierPoints vertex list that approximate the Bezier curve by a list of segments. More...
std::vector< SHAPE * >	MakeEffectiveShapes () const
	Make a set of SHAPE objects representing the EDA_SHAPE. More...
void	ShapeGetMsgPanelInfo (EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList)
double	GetLength () const
	Return the length of the track using the hypotenuse calculation. More...
void	TransformShapeWithClearanceToPolygon (SHAPE_POLY_SET &aCornerBuffer, int aClearanceValue, int aError, ERROR_LOC aErrorLoc, bool ignoreLineWidth) const
	Convert the shape to a closed polygon. More...
int	Compare (const EDA_SHAPE *aOther) const

Static Public Member Functions
template<class T >
static SEARCH_RESULT	IterateForward (std::deque< T > &aList, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
	This changes first parameter to avoid the DList and use the main queue instead. More...
template<class T >
static SEARCH_RESULT	IterateForward (std::vector< T > &aList, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
	Change first parameter to avoid the DList and use std::vector instead. More...
static bool	Replace (const wxFindReplaceData &aSearchData, wxString &aText)
	Perform a text replace on aText using the find and replace criteria in aSearchData on items that support text find and replace. More...
static bool	Sort (const EDA_ITEM *aLeft, const EDA_ITEM *aRight)
	Helper function to be used by the C++ STL sort algorithm for sorting a STL container of EDA_ITEM pointers. More...

Public Attributes
const KIID	m_Uuid

Protected Member Functions
bool	Matches (const wxString &aText, const wxFindReplaceData &aSearchData) const
	Compare aText against search criteria in aSearchData. More...
void	setPosition (const wxPoint &aPos)
wxPoint	getPosition () const
void	move (const wxPoint &aMoveVector)
void	rotate (const wxPoint &aRotCentre, double aAngle)
void	flip (const wxPoint &aCentre, bool aFlipLeftRight)
void	scale (double aScale)
const EDA_RECT	getBoundingBox () const
void	computeArcBBox (EDA_RECT &aBBox) const
bool	hitTest (const wxPoint &aPosition, int aAccuracy=0) const
bool	hitTest (const EDA_RECT &aRect, bool aContained, int aAccuracy=0) const
const std::vector< wxPoint >	buildBezierToSegmentsPointsList (int aMinSegLen) const
void	beginEdit (const wxPoint &aStartPoint)
bool	continueEdit (const wxPoint &aPosition)
void	calcEdit (const wxPoint &aPosition)
void	endEdit (bool aClosed=true)
	Finishes editing the shape. More...
void	setEditState (int aState)

Protected Attributes
int	m_unit
	Unit identification for multiple parts per package. More...
int	m_convert
	Shape identification for alternate body styles. More...
EDA_ITEM_FLAGS	m_status
EDA_ITEM *	m_parent
	Linked list: Link (parent struct) More...
bool	m_forceVisible
EDA_ITEM_FLAGS	m_flags
bool	m_endsSwapped
SHAPE_T	m_shape
int	m_width
FILL_T	m_fill
wxPoint	m_start
wxPoint	m_end
wxPoint	m_arcCenter
ARC_MID	m_arcMidData
wxPoint	m_bezierC1
wxPoint	m_bezierC2
std::vector< wxPoint >	m_bezierPoints
SHAPE_POLY_SET	m_poly
int	m_editState
bool	m_eeWinding

Private Member Functions
int	compare (const LIB_ITEM &aOther, int aCompareFlags=0) const override
	Provide the draw object specific comparison called by the == and < operators. More...
void	print (const RENDER_SETTINGS *aSettings, const wxPoint &aOffset, void *aData, const TRANSFORM &aTransform) override
	Print the item to aDC. More...
double	getParentOrientation () const override
wxPoint	getParentPosition () const override

Detailed Description

Definition at line 32 of file lib_shape.h.

Member Enumeration Documentation

COMPARE_FLAGS

enum LIB_ITEM::COMPARE_FLAGS : int

inherited

The list of flags used by the compare function.

• UNIT This flag relaxes unit, conversion and pin number constraints. It is used for LIB_ITEM object unit comparisons.
• EQUALITY This flag relaxes ordering contstraints so that fields, etc. don't have to appear in the same order to be considered equal.
• ERC This flag relaxes constraints on data that is settable in the schematic editor. It compares only symbol-editor-only data.

Enumerator
UNIT
EQUALITY
ERC

Definition at line 83 of file lib_item.h.

 : int
 {
 UNIT = 0x01,
 EQUALITY = 0x02,
 ERC = 0x04
 };

LIB_CONVERT

enum LIB_ITEM::LIB_CONVERT : int

inherited

Enumerator
BASE
DEMORGAN

Definition at line 71 of file lib_item.h.

: int { BASE = 1, DEMORGAN = 2 };

Constructor & Destructor Documentation

LIB_SHAPE()

LIB_SHAPE::LIB_SHAPE	(	LIB_SYMBOL *	aParent,
		SHAPE_T	aShape,
		int	aLineWidth = 0,
		FILL_T	aFillType = FILL_T::NO_FILL
	)

Definition at line 36 of file lib_shape.cpp.

 :
 LIB_ITEM( LIB_SHAPE_T, aParent ),
 EDA_SHAPE( aShape, aDefaultLineWidth, aFillType, true )
{
 m_editState = 0;
}

References EDA_SHAPE::m_editState.

Referenced by Clone().

~LIB_SHAPE()

LIB_SHAPE::~LIB_SHAPE ( )

inline

Definition at line 40 of file lib_shape.h.

{ }

Member Function Documentation

AddPoint()

void LIB_SHAPE::AddPoint

(

const wxPoint &

aPosition

)

Definition at line 414 of file lib_shape.cpp.

{
 if( GetShape() == SHAPE_T::POLY )
 {
 if( m_poly.IsEmpty() )
 m_poly.NewOutline();

 m_poly.Outline( 0 ).Append( aPosition, true );
 }
 else
 {
 wxFAIL_MSG( wxT( "LIB_SHAPE::AddPoint not implemented for " ) + SHAPE_T_asString() );
 }
}

References SHAPE_LINE_CHAIN::Append(), EDA_SHAPE::GetShape(), SHAPE_POLY_SET::IsEmpty(), EDA_SHAPE::m_poly, SHAPE_POLY_SET::NewOutline(), SHAPE_POLY_SET::Outline(), POLY, and EDA_SHAPE::SHAPE_T_asString().

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), HelperGeneratePowerPortGraphics(), SCH_EAGLE_PLUGIN::loadFrame(), CADSTAR_SCH_ARCHIVE_LOADER::loadLibrarySymbolShapeVertices(), SCH_LEGACY_PLUGIN_CACHE::loadPolyLine(), SCH_EAGLE_PLUGIN::loadSymbolPolyLine(), SCH_EAGLE_PLUGIN::loadSymbolWire(), SCH_ALTIUM_PLUGIN::ParseBezier(), SCH_ALTIUM_PLUGIN::ParseLine(), SCH_ALTIUM_PLUGIN::ParsePolygon(), and SCH_ALTIUM_PLUGIN::ParsePolyline().

BeginEdit()

void LIB_SHAPE::BeginEdit ( const wxPoint &  aPosition )

inlineoverridevirtual

Begin drawing a symbol library draw item at aPosition.

It typically would be called on a left click when a draw tool is selected in the symbol library editor and one of the graphics tools is selected.

Parameters

aPosition

The position in drawing coordinates where the drawing was started. May or may not be required depending on the item being drawn.

Reimplemented from LIB_ITEM.

Definition at line 74 of file lib_shape.h.

{ beginEdit( aStartPoint ); }

References EDA_SHAPE::beginEdit().

beginEdit()

void EDA_SHAPE::beginEdit ( const wxPoint &  aStartPoint )

protectedinherited

Definition at line 1233 of file eda_shape.cpp.

{
 switch( GetShape() )
 {
 case SHAPE_T::SEGMENT:
 case SHAPE_T::CIRCLE:
 case SHAPE_T::RECT:
 SetStart( aPosition );
 SetEnd( aPosition );
 break;

 case SHAPE_T::ARC:
 SetArcGeometry( aPosition, aPosition, aPosition );
 m_editState = 1;
 break;

 case SHAPE_T::POLY:
 m_poly.NewOutline();
 m_poly.Outline( 0 ).SetClosed( false );

 // Start and end of the first segment (co-located for now)
 m_poly.Outline( 0 ).Append( aPosition );
 m_poly.Outline( 0 ).Append( aPosition, true );
 break;

 default:
 UNIMPLEMENTED_FOR( SHAPE_T_asString() );
 }
}

References SHAPE_LINE_CHAIN::Append(), ARC, CIRCLE, EDA_SHAPE::GetShape(), EDA_SHAPE::m_editState, EDA_SHAPE::m_poly, SHAPE_POLY_SET::NewOutline(), SHAPE_POLY_SET::Outline(), POLY, RECT, SEGMENT, EDA_SHAPE::SetArcGeometry(), SHAPE_LINE_CHAIN::SetClosed(), EDA_SHAPE::SetEnd(), EDA_SHAPE::SetStart(), EDA_SHAPE::SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

Referenced by BeginEdit().

buildBezierToSegmentsPointsList()

const std::vector< wxPoint > EDA_SHAPE::buildBezierToSegmentsPointsList ( int  aMinSegLen ) const

protectedinherited

Definition at line 380 of file eda_shape.cpp.

{
 std::vector<wxPoint> bezierPoints;

 // Rebuild the m_BezierPoints vertex list that approximate the Bezier curve
 std::vector<wxPoint> ctrlPoints = { m_start, m_bezierC1, m_bezierC2, m_end };
 BEZIER_POLY converter( ctrlPoints );
 converter.GetPoly( bezierPoints, aMinSegLen );

 return bezierPoints;
}

References BEZIER_POLY::GetPoly(), EDA_SHAPE::m_bezierC1, EDA_SHAPE::m_bezierC2, EDA_SHAPE::m_end, and EDA_SHAPE::m_start.

Referenced by EDA_SHAPE::MakeEffectiveShapes(), and EDA_SHAPE::RebuildBezierToSegmentsPointsList().

CalcArcAngles() [1/2]

void LIB_SHAPE::CalcArcAngles	(	int &	aStartAngle,
		int &	aEndAngle
	)		const

Definition at line 430 of file lib_shape.cpp.

{
 wxPoint centerStartVector = GetStart() - GetCenter();
 wxPoint centerEndVector = GetEnd() - GetCenter();

 // Angles in Eeschema are still integers
 aStartAngle = KiROUND( ArcTangente( centerStartVector.y, centerStartVector.x ) );
 aEndAngle = KiROUND( ArcTangente( centerEndVector.y, centerEndVector.x ) );

 NORMALIZE_ANGLE_POS( aStartAngle );
 NORMALIZE_ANGLE_POS( aEndAngle ); // angles = 0 .. 3600

 // Restrict angle to less than 180 to avoid PBS display mirror Trace because it is
 // assumed that the arc is less than 180 deg to find orientation after rotate or mirror.
 if( ( aEndAngle - aStartAngle ) > 1800 )
 aEndAngle -= 3600;
 else if( ( aEndAngle - aStartAngle ) <= -1800 )
 aEndAngle += 3600;

 while( ( aEndAngle - aStartAngle ) >= 1800 )
 {
 aEndAngle--;
 aStartAngle++;
 }

 while( ( aStartAngle - aEndAngle ) >= 1800 )
 {
 aEndAngle++;
 aStartAngle--;
 }

 NORMALIZE_ANGLE_POS( aStartAngle );

 if( !IsMoving() )
 NORMALIZE_ANGLE_POS( aEndAngle );
}

References ArcTangente(), GetCenter(), EDA_SHAPE::GetEnd(), EDA_SHAPE::GetStart(), EDA_ITEM::IsMoving(), KiROUND(), and NORMALIZE_ANGLE_POS().

Referenced by KIGFX::SCH_PAINTER::draw(), Plot(), print(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), and SCH_SEXPR_PLUGIN_CACHE::saveSymbolDrawItem().

CalcArcAngles() [2/2]

void EDA_SHAPE::CalcArcAngles ( double &  aStartAngle, double &  aEndAngle  ) const

inherited

Calc arc start and end angles such that aStartAngle < aEndAngle.

Each may be between -360.0 and 360.0.

Definition at line 451 of file eda_shape.cpp.

{
 VECTOR2D startRadial( GetStart() - getCenter() );
 VECTOR2D endRadial( GetEnd() - getCenter() );

 aStartAngle = 180.0 / M_PI * atan2( startRadial.y, startRadial.x );
 aEndAngle = 180.0 / M_PI * atan2( endRadial.y, endRadial.x );

 if( aEndAngle == aStartAngle )
 aEndAngle = aStartAngle + 360.0; // ring, not null

 if( aStartAngle > aEndAngle )
 {
 if( aEndAngle < 0 )
 aEndAngle = NormalizeAngleDegrees( aEndAngle, 0.0, 360.0 );
 else
 aStartAngle = NormalizeAngleDegrees( aStartAngle, -360.0, 0.0 );
 }
}

References EDA_SHAPE::getCenter(), EDA_SHAPE::GetEnd(), EDA_SHAPE::GetStart(), NormalizeAngleDegrees(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by EDA_SHAPE::computeArcBBox(), KIGFX::PCB_PAINTER::draw(), EDA_SHAPE::GetArcAngle(), and EDA_SHAPE::hitTest().

CalcEdit()

void LIB_SHAPE::CalcEdit ( const wxPoint &  aPosition )

inlineoverridevirtual

Calculate the attributes of an item at aPosition when it is being edited.

This method gets called by the Draw() method when the item is being edited. This probably should be a pure virtual method but bezier curves are not yet editable in the symbol library editor. Therefore, the default method does nothing.

Parameters

aPosition

The current mouse position in drawing coordinates.

Reimplemented from LIB_ITEM.

Definition at line 76 of file lib_shape.h.

{ calcEdit( aPosition ); }

References EDA_SHAPE::calcEdit().

Referenced by EE_POINT_EDITOR::updateParentItem().

calcEdit()

void EDA_SHAPE::calcEdit ( const wxPoint &  aPosition )

protectedinherited

Definition at line 1291 of file eda_shape.cpp.

{
#define sq( x ) pow( x, 2 )

 switch( GetShape() )
 {
 case SHAPE_T::SEGMENT:
 case SHAPE_T::CIRCLE:
 case SHAPE_T::RECT:
 SetEnd( aPosition );
 break;

 case SHAPE_T::ARC:
 {
 int radius = GetRadius();

 // Edit state 0: drawing: place start
 // Edit state 1: drawing: place end (center calculated for 90-degree subtended angle)
 // Edit state 2: point edit: move start (center calculated for invariant subtended angle)
 // Edit state 3: point edit: move end (center calculated for invariant subtended angle)
 // Edit state 4: point edit: move center
 // Edit state 5: point edit: move arc-mid-point

 switch( m_editState )
 {
 case 0:
 SetArcGeometry( aPosition, aPosition, aPosition );
 return;

 case 1:
 m_end = aPosition;
 radius = KiROUND( sqrt( sq( GetLineLength( m_start, m_end ) ) / 2.0 ) );
 break;

 case 2:
 case 3:
 {
 wxPoint v = m_start - m_end;
 double chordBefore = sq( v.x ) + sq( v.y );

 if( m_editState == 2 )
 m_start = aPosition;
 else
 m_end = aPosition;

 v = m_start - m_end;
 double chordAfter = sq( v.x ) + sq( v.y );
 double ratio = chordAfter / chordBefore;

 if( ratio != 0 )
 {
 radius = std::max( int( sqrt( sq( radius ) * ratio ) ) + 1,
 int( sqrt( chordAfter ) / 2 ) + 1 );
 }
 }
 break;

 case 4:
 {
 double chordA = GetLineLength( m_start, aPosition );
 double chordB = GetLineLength( m_end, aPosition );
 radius = int( ( chordA + chordB ) / 2.0 ) + 1;
 }
 break;

 case 5:
 SetArcGeometry( GetStart(), aPosition, GetEnd() );
 return;
 }

 // Calculate center based on start, end, and radius
 //
 // Let 'l' be the length of the chord and 'm' the middle point of the chord
 double l = GetLineLength( m_start, m_end );
 wxPoint m = ( m_start + m_end ) / 2;

 // Calculate 'd', the vector from the chord midpoint to the center
 wxPoint d;
 d.x = KiROUND( sqrt( sq( radius ) - sq( l/2 ) ) * ( m_start.y - m_end.y ) / l );
 d.y = KiROUND( sqrt( sq( radius ) - sq( l/2 ) ) * ( m_end.x - m_start.x ) / l );

 wxPoint c1 = m + d;
 wxPoint c2 = m - d;

 // Solution gives us 2 centers; we need to pick one:
 switch( m_editState )
 {
 case 1:
 {
 // Keep center clockwise from chord while drawing
 wxPoint chordVector = m_end - m_start;
 double chordAngle = ArcTangente( chordVector.y, chordVector.x );
 NORMALIZE_ANGLE_POS( chordAngle );

 wxPoint c1Test = c1;
 RotatePoint( &c1Test, m_start, -chordAngle );

 m_arcCenter = c1Test.x > 0 ? c2 : c1;
 }
 break;

 case 2:
 case 3:
 // Pick the one closer to the old center
 m_arcCenter = GetLineLength( c1, m_arcCenter ) < GetLineLength( c2, m_arcCenter ) ? c1 : c2;
 break;

 case 4:
 // Pick the one closer to the mouse position
 m_arcCenter = GetLineLength( c1, aPosition ) < GetLineLength( c2, aPosition ) ? c1 : c2;
 break;
 }
 }
 break;

 case SHAPE_T::POLY:
 m_poly.Outline( 0 ).SetPoint( m_poly.Outline( 0 ).GetPointCount() - 1, aPosition );
 break;

 default:
 UNIMPLEMENTED_FOR( SHAPE_T_asString() );
 }
}

References ARC, ArcTangente(), CIRCLE, EDA_SHAPE::GetEnd(), GetLineLength(), SHAPE_LINE_CHAIN::GetPointCount(), EDA_SHAPE::GetRadius(), EDA_SHAPE::GetShape(), EDA_SHAPE::GetStart(), KiROUND(), EDA_SHAPE::m_arcCenter, EDA_SHAPE::m_editState, EDA_SHAPE::m_end, EDA_SHAPE::m_poly, EDA_SHAPE::m_start, NORMALIZE_ANGLE_POS(), SHAPE_POLY_SET::Outline(), POLY, RECT, RotatePoint(), SEGMENT, EDA_SHAPE::SetArcGeometry(), EDA_SHAPE::SetEnd(), SHAPE_LINE_CHAIN::SetPoint(), EDA_SHAPE::SHAPE_T_asString(), sq, and UNIMPLEMENTED_FOR.

Referenced by CalcEdit().

ClearBrightened()

void EDA_ITEM::ClearBrightened ( )

inlineinherited

Definition at line 132 of file eda_item.h.

{ ClearFlags( BRIGHTENED ); }

References BRIGHTENED, and EDA_ITEM::ClearFlags().

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), SCH_EDIT_FRAME::FocusOnItem(), PCB_BASE_FRAME::FocusOnItems(), PL_SELECTION_TOOL::unhighlight(), EE_SELECTION_TOOL::unhighlight(), PCB_SELECTION_TOOL::unhighlightInternal(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

ClearEditFlags()

void EDA_ITEM::ClearEditFlags ( )

inlineinherited

Definition at line 171 of file eda_item.h.

 {
 ClearFlags( GetEditFlags() );
 }

References EDA_ITEM::ClearFlags(), and EDA_ITEM::GetEditFlags().

Referenced by FOOTPRINT::Add(), BOARD::Add(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), SCH_EDIT_FRAME::PutDataInPreviousState(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), and SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace().

ClearFlags()

void EDA_ITEM::ClearFlags ( EDA_ITEM_FLAGS  aMask = EDA_ITEM_ALL_FLAGS )

inlineinherited

Definition at line 153 of file eda_item.h.

{ m_flags &= ~aMask; }

References EDA_ITEM::m_flags.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PNS_KICAD_IFACE::AddItem(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_MOVE_TOOL::AlignElements(), FOOTPRINT::BuildPolyCourtyards(), EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearEditFlags(), EDA_ITEM::ClearSelected(), EDA_ITEM::ClearTempFlags(), ConvertOutlineToPolygon(), SCH_EDIT_FRAME::ConvertPart(), SYMBOL_EDITOR_EDIT_TOOL::Copy(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), SYMBOL_EDITOR_PIN_TOOL::CreateImagePins(), MICROWAVE_TOOL::createMicrowaveInductor(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), SCH_ITEM::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), PCB_SELECTION_TOOL::ExitGroup(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), EE_SELECTION_TOOL::Main(), EE_SELECTION_TOOL::narrowSelection(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), BOARD_COMMIT::Push(), PCB_SELECTION_TOOL::RebuildSelection(), SCH_EDIT_TOOL::RepeatDrawItem(), SYMBOL_EDIT_FRAME::RollbackSymbolFromUndo(), SCH_EDIT_FRAME::SaveCopyForRepeatItem(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SEXPR_PLUGIN_CACHE::savePin(), EE_SELECTION_TOOL::selectMultiple(), SCH_EDIT_FRAME::SelectUnit(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), and SCH_DRAWING_TOOLS::TwoClickPlace().

ClearSelected()

void EDA_ITEM::ClearSelected ( )

inlineinherited

Definition at line 131 of file eda_item.h.

{ ClearFlags( SELECTED ); }

References EDA_ITEM::ClearFlags(), and SELECTED.

Referenced by PCB_POINT_EDITOR::addCorner(), EDIT_TOOL::Duplicate(), ARRAY_CREATOR::Invoke(), LIB_SYMBOL::LIB_SYMBOL(), EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList(), PL_SELECTION_TOOL::unhighlight(), EE_SELECTION_TOOL::unhighlight(), PCB_SELECTION_TOOL::unhighlightInternal(), and GERBVIEW_SELECTION_TOOL::unselectVisually().

ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )

inlineinherited

Definition at line 165 of file eda_item.h.

 {
 ClearFlags( STARTPOINT | ENDPOINT | CANDIDATE | TEMP_SELECTED | IS_LINKED | SKIP_STRUCT |
 DO_NOT_DRAW );
 }

References CANDIDATE, EDA_ITEM::ClearFlags(), DO_NOT_DRAW, ENDPOINT, IS_LINKED, SKIP_STRUCT, STARTPOINT, and TEMP_SELECTED.

Referenced by SCH_EDIT_FRAME::PutDataInPreviousState().

ClearViewPrivData()

void KIGFX::VIEW_ITEM::ClearViewPrivData ( )

inlineinherited

Definition at line 143 of file view_item.h.

 {
 m_viewPrivData = nullptr;
 }

References KIGFX::VIEW_ITEM::m_viewPrivData.

Referenced by KIGFX::VIEW::OnDestroy().

Clone()

EDA_ITEM * LIB_SHAPE::Clone ( ) const

overridevirtual

Create a duplicate of this item with linked list members set to NULL.

The default version will return NULL in release builds and likely crash the program. In debug builds, a warning message indicating the derived class has not implemented cloning. This really should be a pure virtual function. Due to the fact that there are so many objects derived from EDA_ITEM, the decision was made to return NULL until all the objects derived from EDA_ITEM implement cloning. Once that happens, this function should be made pure.

Returns

A clone of the item.

Reimplemented from EDA_ITEM.

Definition at line 63 of file lib_shape.cpp.

{
 return new LIB_SHAPE( *this );
}

References LIB_SHAPE().

compare()

int LIB_SHAPE::compare ( const LIB_ITEM &  aOther, int  aCompareFlags = 0  ) const

overrideprivatevirtual

Provide the draw object specific comparison called by the == and < operators.

The base object sort order which always proceeds the derived object sort order is as follows:

• Symbol alternate part (DeMorgan) number.
• Symbol part number.
• KICAD_T enum value.
• Result of derived classes comparison.

Note

Make sure you call down to LIB_ITEM::compare before doing any derived object comparisons or you will break the sorting using the symbol library file format.

Parameters

aOther	A reference to the other LIB_ITEM to compare the arc against.
aCompareFlags	The flags used to perform the comparison.

Returns

An integer value less than 0 if the object is less than aOther object, zero if the object is equal to aOther object, or greater than 0 if the object is greater than aOther object.

The circle specific sort order is as follows:

• Circle horizontal (X) position.
• Circle vertical (Y) position.
• Circle radius.

Reimplemented from LIB_ITEM.

Definition at line 69 of file lib_shape.cpp.

{
 int retv = LIB_ITEM::compare( aOther, aCompareFlags );

 if( retv )
 return retv;

 return EDA_SHAPE::Compare( &static_cast<const LIB_SHAPE&>( aOther ) );
}

References EDA_SHAPE::Compare(), and LIB_ITEM::compare().

Compare()

int EDA_SHAPE::Compare ( const EDA_SHAPE *  aOther ) const

inherited

Definition at line 1465 of file eda_shape.cpp.

{
#define EPSILON 2 // Should be enough for rounding errors on calculated items

#define TEST( a, b ) { if( a != b ) return a - b; }
#define TEST_E( a, b ) { if( abs( a - b ) > EPSILON ) return a - b; }
#define TEST_PT( a, b ) { TEST_E( a.x, b.x ); TEST_E( a.y, b.y ); }

 TEST_PT( m_start, aOther->m_start );
 TEST_PT( m_end, aOther->m_end );

 TEST( (int) m_shape, (int) aOther->m_shape );

 if( m_shape == SHAPE_T::ARC )
 {
 TEST_PT( m_arcCenter, aOther->m_arcCenter );
 }
 else if( m_shape == SHAPE_T::BEZIER )
 {
 TEST_PT( m_bezierC1, aOther->m_bezierC1 );
 TEST_PT( m_bezierC2, aOther->m_bezierC2 );
 }
 else if( m_shape == SHAPE_T::POLY )
 {
 TEST( m_poly.TotalVertices(), aOther->m_poly.TotalVertices() );

 for( int ii = 0; ii < m_poly.TotalVertices(); ++ii )
 TEST_PT( m_poly.CVertex( ii ), aOther->m_poly.CVertex( ii ) );
 }

 TEST_E( m_width, aOther->m_width );
 TEST( (int) m_fill, (int) aOther->m_fill );

 return 0;
}

References ARC, BEZIER, SHAPE_POLY_SET::CVertex(), EDA_SHAPE::m_arcCenter, EDA_SHAPE::m_bezierC1, EDA_SHAPE::m_bezierC2, EDA_SHAPE::m_end, EDA_SHAPE::m_fill, EDA_SHAPE::m_poly, EDA_SHAPE::m_shape, EDA_SHAPE::m_start, EDA_SHAPE::m_width, POLY, TEST, TEST_E, TEST_PT, and SHAPE_POLY_SET::TotalVertices().

Referenced by compare(), and BOARD::cmp_drawings::operator()().

computeArcBBox()

void EDA_SHAPE::computeArcBBox ( EDA_RECT &  aBBox ) const

protectedinherited

Definition at line 1017 of file eda_shape.cpp.

{
 wxPoint start = m_start;
 wxPoint end = m_end;
 double t1, t2;

 CalcArcAngles( t1, t2 );

 if( m_eeWinding && NormalizeAngleDegrees( t1 - t2, -180.0, 180.0 ) > 0 )
 std::swap( start, end );

 // Do not include the center, which is not necessarily inside the BB of an arc with a small
 // included angle
 aBBox.SetOrigin( start );
 aBBox.Merge( end );

 // Determine the starting quarter
 // 0 right-bottom
 // 1 left-bottom
 // 2 left-top
 // 3 right-top
 unsigned int quarter;

 if( start.x < m_arcCenter.x )
 {
 if( start.y <= m_arcCenter.y )
 quarter = 2;
 else
 quarter = 1;
 }
 else if( start.x == m_arcCenter.x )
 {
 if( start.y < m_arcCenter.y )
 quarter = 3;
 else
 quarter = 1;
 }
 else
 {
 if( start.y < m_arcCenter.y )
 quarter = 3;
 else
 quarter = 0;
 }

 int radius = GetRadius();
 VECTOR2I startRadial = start - m_arcCenter;
 VECTOR2I endRadial = end - m_arcCenter;
 double angleStart = ArcTangente( startRadial.y, startRadial.x );
 double arcAngle = RAD2DECIDEG( endRadial.Angle() - startRadial.Angle() );
 int angle = (int) NormalizeAnglePos( angleStart ) % 900 + NormalizeAnglePos( arcAngle );

 while( angle > 900 )
 {
 switch( quarter )
 {
 case 0: aBBox.Merge( wxPoint( m_arcCenter.x, m_arcCenter.y + radius ) ); break; // down
 case 1: aBBox.Merge( wxPoint( m_arcCenter.x - radius, m_arcCenter.y ) ); break; // left
 case 2: aBBox.Merge( wxPoint( m_arcCenter.x, m_arcCenter.y - radius ) ); break; // up
 case 3: aBBox.Merge( wxPoint( m_arcCenter.x + radius, m_arcCenter.y ) ); break; // right
 }

 ++quarter %= 4;
 angle -= 900;
 }
}

References PNS::angle(), VECTOR2< T >::Angle(), ArcTangente(), EDA_SHAPE::CalcArcAngles(), EDA_SHAPE::GetRadius(), EDA_SHAPE::m_arcCenter, EDA_SHAPE::m_eeWinding, EDA_SHAPE::m_end, EDA_SHAPE::m_start, EDA_RECT::Merge(), NormalizeAngleDegrees(), NormalizeAnglePos(), RAD2DECIDEG(), EDA_RECT::SetOrigin(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by EDA_SHAPE::getBoundingBox().

ContinueEdit()

bool LIB_SHAPE::ContinueEdit ( const wxPoint &  aPosition )

inlineoverridevirtual

Continue an edit in progress at aPosition.

This is used to perform the next action while drawing an item. This would be called for each additional left click when the mouse is captured while the item is being drawn.

Parameters

aPosition

The position of the mouse left click in drawing coordinates.

Returns

True if additional mouse clicks are required to complete the edit in progress.

Reimplemented from LIB_ITEM.

Definition at line 75 of file lib_shape.h.

{ return continueEdit( aPosition ); }

References EDA_SHAPE::continueEdit().

continueEdit()

bool EDA_SHAPE::continueEdit ( const wxPoint &  aPosition )

protectedinherited

Definition at line 1264 of file eda_shape.cpp.

{
 switch( GetShape() )
 {
 case SHAPE_T::ARC:
 case SHAPE_T::SEGMENT:
 case SHAPE_T::CIRCLE:
 case SHAPE_T::RECT:
 return false;

 case SHAPE_T::POLY:
 {
 SHAPE_LINE_CHAIN& poly = m_poly.Outline( 0 );

 // do not add zero-length segments
 if( poly.CPoint( poly.GetPointCount() - 2 ) != poly.CLastPoint() )
 poly.Append( aPosition, true );
 }
 return true;

 default:
 UNIMPLEMENTED_FOR( SHAPE_T_asString() );
 return false;
 }
}

References SHAPE_LINE_CHAIN::Append(), ARC, CIRCLE, SHAPE_LINE_CHAIN::CLastPoint(), SHAPE_LINE_CHAIN::CPoint(), SHAPE_LINE_CHAIN::GetPointCount(), EDA_SHAPE::GetShape(), EDA_SHAPE::m_poly, SHAPE_POLY_SET::Outline(), POLY, RECT, SEGMENT, EDA_SHAPE::SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

Referenced by ContinueEdit().

DupPolyPointsList()

void EDA_SHAPE::DupPolyPointsList ( std::vector< wxPoint > &  aBuffer ) const

inherited

Duplicate the list of corners in a std::vector<wxPoint>

It must be used only to convert the SHAPE_POLY_SET internal corner buffer to a list of wxPoints, and nothing else, because it duplicates the buffer, that is inefficient to know for instance the corner count

Definition at line 1193 of file eda_shape.cpp.

{
 if( m_poly.OutlineCount() )
 {
 int pointCount = m_poly.COutline( 0 ).PointCount();

 if( pointCount )
 {
 aBuffer.reserve( pointCount );

 for ( auto iter = m_poly.CIterate(); iter; iter++ )
 aBuffer.emplace_back( iter->x, iter->y );
 }
 }
}

References SHAPE_POLY_SET::CIterate(), SHAPE_POLY_SET::COutline(), EDA_SHAPE::m_poly, SHAPE_POLY_SET::OutlineCount(), and SHAPE_LINE_CHAIN::PointCount().

Referenced by PCB_GRID_HELPER::computeAnchors(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), EDA_SHAPE::TransformShapeWithClearanceToPolygon(), and PCB_POINT_EDITOR::updatePoints().

EndEdit()

void LIB_SHAPE::EndEdit ( )

inlineoverridevirtual

End an object editing action.

This is used to end or abort an edit action in progress initiated by BeginEdit().

Reimplemented from LIB_ITEM.

Definition at line 78 of file lib_shape.h.

{ endEdit( false ); }

References EDA_SHAPE::endEdit().

endEdit()

void EDA_SHAPE::endEdit ( bool  aClosed = true )

protectedinherited

Finishes editing the shape.

Parameters

aClosed

Should polygon shapes be closed (yes for pcbnew/fpeditor, no for libedit)

Definition at line 1416 of file eda_shape.cpp.

{
 switch( GetShape() )
 {
 case SHAPE_T::ARC:
 case SHAPE_T::SEGMENT:
 case SHAPE_T::CIRCLE:
 case SHAPE_T::RECT:
 break;

 case SHAPE_T::POLY:
 {
 SHAPE_LINE_CHAIN& poly = m_poly.Outline( 0 );

 // do not include last point twice
 if( poly.GetPointCount() > 2 )
 {
 if( poly.CPoint( poly.GetPointCount() - 2 ) == poly.CLastPoint() )
 {
 poly.SetClosed( aClosed );
 poly.Remove( poly.GetPointCount() - 1 );
 }
 }
 }
 break;

 default:
 UNIMPLEMENTED_FOR( SHAPE_T_asString() );
 }
}

References ARC, CIRCLE, SHAPE_LINE_CHAIN::CLastPoint(), SHAPE_LINE_CHAIN::CPoint(), SHAPE_LINE_CHAIN::GetPointCount(), EDA_SHAPE::GetShape(), EDA_SHAPE::m_poly, SHAPE_POLY_SET::Outline(), POLY, RECT, SHAPE_LINE_CHAIN::Remove(), SEGMENT, SHAPE_LINE_CHAIN::SetClosed(), EDA_SHAPE::SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

Referenced by EndEdit().

EndsSwapped()

bool EDA_SHAPE::EndsSwapped ( ) const

inlineinherited

Have the start and end points been swapped since they were set?

Returns

true if they have

Definition at line 175 of file eda_shape.h.

{ return m_endsSwapped; }

References EDA_SHAPE::m_endsSwapped.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromShapes().

flip()

void EDA_SHAPE::flip ( const wxPoint &  aCentre, bool  aFlipLeftRight  )

protectedinherited

Definition at line 281 of file eda_shape.cpp.

{
 switch ( m_shape )
 {
 case SHAPE_T::SEGMENT:
 case SHAPE_T::RECT:
 if( aFlipLeftRight )
 {
 m_start.x = aCentre.x - ( m_start.x - aCentre.x );
 m_end.x = aCentre.x - ( m_end.x - aCentre.x );
 }
 else
 {
 m_start.y = aCentre.y - ( m_start.y - aCentre.y );
 m_end.y = aCentre.y - ( m_end.y - aCentre.y );
 }

 std::swap( m_start, m_end );
 break;

 case SHAPE_T::CIRCLE:
 if( aFlipLeftRight )
 {
 m_start.x = aCentre.x - ( m_start.x - aCentre.x );
 m_end.x = aCentre.x - ( m_end.x - aCentre.x );
 }
 else
 {
 m_start.y = aCentre.y - ( m_start.y - aCentre.y );
 m_end.y = aCentre.y - ( m_end.y - aCentre.y );
 }
 break;

 case SHAPE_T::ARC:
 if( aFlipLeftRight )
 {
 m_start.x = aCentre.x - ( m_start.x - aCentre.x );
 m_end.x = aCentre.x - ( m_end.x - aCentre.x );
 m_arcCenter.x = aCentre.x - ( m_arcCenter.x - aCentre.x );
 }
 else
 {
 m_start.y = aCentre.y - ( m_start.y - aCentre.y );
 m_end.y = aCentre.y - ( m_end.y - aCentre.y );
 m_arcCenter.y = aCentre.y - ( m_arcCenter.y - aCentre.y );
 }

 std::swap( m_start, m_end );
 break;

 case SHAPE_T::POLY:
 m_poly.Mirror( aFlipLeftRight, !aFlipLeftRight, VECTOR2I( aCentre ) );
 break;

 case SHAPE_T::BEZIER:
 if( aFlipLeftRight )
 {
 m_start.x = aCentre.x - ( m_start.x - aCentre.x );
 m_end.x = aCentre.x - ( m_end.x - aCentre.x );
 m_bezierC1.x = aCentre.x - ( m_bezierC1.x - aCentre.x );
 m_bezierC2.x = aCentre.x - ( m_bezierC2.x - aCentre.x );
 }
 else
 {
 m_start.y = aCentre.y - ( m_start.y - aCentre.y );
 m_end.y = aCentre.y - ( m_end.y - aCentre.y );
 m_bezierC1.y = aCentre.y - ( m_bezierC1.y - aCentre.y );
 m_bezierC2.y = aCentre.y - ( m_bezierC2.y - aCentre.y );
 }

 // Rebuild the poly points shape
 {
 std::vector<wxPoint> ctrlPoints = { m_start, m_bezierC1, m_bezierC2, m_end };
 BEZIER_POLY converter( ctrlPoints );
 converter.GetPoly( m_bezierPoints, m_width );
 }
 break;

 default:
 UNIMPLEMENTED_FOR( SHAPE_T_asString() );
 break;
 }
}

References ARC, BEZIER, CIRCLE, BEZIER_POLY::GetPoly(), EDA_SHAPE::m_arcCenter, EDA_SHAPE::m_bezierC1, EDA_SHAPE::m_bezierC2, EDA_SHAPE::m_bezierPoints, EDA_SHAPE::m_end, EDA_SHAPE::m_poly, EDA_SHAPE::m_shape, EDA_SHAPE::m_start, EDA_SHAPE::m_width, SHAPE_POLY_SET::Mirror(), POLY, RECT, SEGMENT, EDA_SHAPE::SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

Referenced by PCB_SHAPE::Flip(), MirrorHorizontal(), and MirrorVertical().

Get() [1/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE *  aProperty )

inlineinherited

Definition at line 86 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 TYPE_ID thisType = TYPE_HASH( *this );
 void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
 return object ? aProperty->getter( object ) : wxAny();
 }

References PROPERTY_BASE::getter(), PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

Referenced by BOOST_AUTO_TEST_CASE(), CLASS_D_DESC::CLASS_D_DESC(), PCB_EXPR_VAR_REF::GetValue(), and PAD_DESC::PAD_DESC().

Get() [2/3]

template<typename T >

T INSPECTABLE::Get ( PROPERTY_BASE *  aProperty )

inlineinherited

Definition at line 95 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 TYPE_ID thisType = TYPE_HASH( *this );
 void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
 return object ? aProperty->get<T>( object ) : T();
 }

References PROPERTY_BASE::get(), PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

Get() [3/3]

template<typename T >

boost::optional<T> INSPECTABLE::Get ( const wxString &  aProperty )

inlineinherited

Definition at line 104 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 TYPE_ID thisType = TYPE_HASH( *this );
 PROPERTY_BASE* prop = propMgr.GetProperty( thisType, aProperty );
 boost::optional<T> ret = T();

 if( prop )
 {
 void* object = propMgr.TypeCast( this, thisType, prop->OwnerHash() );

 if( object )
 ret = prop->get<T>( object );
 }

 return ret;
 }

References PROPERTY_BASE::get(), PROPERTY_MANAGER::GetProperty(), PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

GetArcAngle()

double EDA_SHAPE::GetArcAngle ( ) const

inherited

Definition at line 536 of file eda_shape.cpp.

{
 double startAngle;
 double endAngle;

 CalcArcAngles( startAngle, endAngle );

 return ( endAngle - startAngle ) * 10;
}

References EDA_SHAPE::CalcArcAngles().

Referenced by BOARD_ADAPTER::addShapeWithClearance(), ConvertOutlineToPolygon(), FootprintWriteShape(), EDA_SHAPE::GetArcMid(), FP_SHAPE::GetArcMid0(), EDA_SHAPE::GetLength(), CADSTAR_PCB_ARCHIVE_LOADER::getLineChainFromShapes(), hash_fp_item(), idf_export_outline(), EDA_SHAPE::MakeEffectiveShapes(), DSN::SPECCTRA_DB::makeIMAGE(), PCB_PARSER::parsePAD(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), BRDITEMS_PLOTTER::PlotPcbShape(), EDA_SHAPE::ShapeGetMsgPanelInfo(), AR_MATRIX::TraceSegmentPcb(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), and DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataToWindow().

GetArcMid()

wxPoint EDA_SHAPE::GetArcMid ( ) const

inherited

Definition at line 437 of file eda_shape.cpp.

{
 // If none of the input data have changed since we loaded the arc,
 // keep the original mid point data to minimize churn
 if( m_arcMidData.start == m_start && m_arcMidData.end == m_end
 && m_arcMidData.center == m_arcCenter )
 return m_arcMidData.mid;

 wxPoint mid = m_start;
 RotatePoint( &mid, m_arcCenter, -GetArcAngle() / 2.0 );
 return mid;
}

References ARC_MID::center, ARC_MID::end, EDA_SHAPE::GetArcAngle(), EDA_SHAPE::m_arcCenter, EDA_SHAPE::m_arcMidData, EDA_SHAPE::m_end, EDA_SHAPE::m_start, ARC_MID::mid, RotatePoint(), and ARC_MID::start.

Referenced by PCB_GRID_HELPER::computeAnchors(), CONVERT_TOOL::CreateLines(), PCB_POINT_EDITOR::editArcMidKeepEndpoints(), PCB_PLUGIN::format(), formatArc(), PCB_SHAPE::GetFocusPosition(), PCB_POINT_EDITOR::makePoints(), CONVERT_TOOL::makePolysFromSegs(), EDA_SHAPE::SetArcGeometry(), EDA_SHAPE::TransformShapeWithClearanceToPolygon(), and PCB_POINT_EDITOR::updatePoints().

GetBezierC1()

const wxPoint& EDA_SHAPE::GetBezierC1 ( ) const

inlineinherited

Definition at line 154 of file eda_shape.h.

{ return m_bezierC1; }

References EDA_SHAPE::m_bezierC1.

Referenced by GRAPHICS_CLEANER::areEquivalent(), KIGFX::PCB_PAINTER::draw(), PCB_PLUGIN::format(), formatBezier(), EDA_SHAPE::getBoundingBox(), PCB_POINT_EDITOR::makePoints(), PCB_PARSER::parsePAD(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), BRDITEMS_PLOTTER::PlotPcbShape(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataToWindow(), EDA_SHAPE::TransformShapeWithClearanceToPolygon(), and PCB_POINT_EDITOR::updatePoints().

GetBezierC2()

const wxPoint& EDA_SHAPE::GetBezierC2 ( ) const

inlineinherited

Definition at line 157 of file eda_shape.h.

{ return m_bezierC2; }

References EDA_SHAPE::m_bezierC2.

Referenced by GRAPHICS_CLEANER::areEquivalent(), KIGFX::PCB_PAINTER::draw(), PCB_PLUGIN::format(), formatBezier(), EDA_SHAPE::getBoundingBox(), PCB_POINT_EDITOR::makePoints(), PCB_PARSER::parsePAD(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), BRDITEMS_PLOTTER::PlotPcbShape(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataToWindow(), EDA_SHAPE::TransformShapeWithClearanceToPolygon(), and PCB_POINT_EDITOR::updatePoints().

GetBezierPoints()

const std::vector<wxPoint>& EDA_SHAPE::GetBezierPoints ( ) const

inlineinherited

Definition at line 210 of file eda_shape.h.

{ return m_bezierPoints; }

References EDA_SHAPE::m_bezierPoints.

Referenced by ConvertOutlineToPolygon(), KIGFX::SCH_PAINTER::draw(), GRAPHICS_CLEANER::isNullShape(), and SCH_LEGACY_PLUGIN_CACHE::saveBezier().

GetBoundingBox()

const EDA_RECT LIB_SHAPE::GetBoundingBox ( ) const

overridevirtual

Returns

the boundary box for this, in library coordinates

Reimplemented from LIB_ITEM.

Definition at line 347 of file lib_shape.cpp.

{
 EDA_RECT rect = getBoundingBox();

 rect.RevertYAxis();

 return rect;
}

References EDA_SHAPE::getBoundingBox(), and EDA_RECT::RevertYAxis().

getBoundingBox()

const EDA_RECT EDA_SHAPE::getBoundingBox ( ) const

protectedinherited

Definition at line 634 of file eda_shape.cpp.

{
 EDA_RECT bbox;

 switch( m_shape )
 {
 case SHAPE_T::RECT:
 for( wxPoint& pt : GetRectCorners() )
 bbox.Merge( pt );

 break;

 case SHAPE_T::SEGMENT:
 bbox.SetOrigin( GetStart() );
 bbox.SetEnd( GetEnd() );
 break;

 case SHAPE_T::CIRCLE:
 bbox.SetOrigin( GetStart() );
 bbox.Inflate( GetRadius() );
 break;

 case SHAPE_T::ARC:
 computeArcBBox( bbox );
 break;

 case SHAPE_T::POLY:
 if( m_poly.IsEmpty() )
 break;

 for( auto iter = m_poly.CIterate(); iter; iter++ )
 {
 wxPoint pt( iter->x, iter->y );

 RotatePoint( &pt, getParentOrientation() );
 pt += getParentPosition();

 bbox.Merge( pt );
 }

 break;

 case SHAPE_T::BEZIER:
 bbox.SetOrigin( GetStart() );
 bbox.Merge( GetBezierC1() );
 bbox.Merge( GetBezierC2() );
 bbox.Merge( GetEnd() );
 break;

 default:
 UNIMPLEMENTED_FOR( SHAPE_T_asString() );
 break;
 }

 bbox.Inflate( std::max( 0, m_width / 2 ) );
 bbox.Normalize();

 return bbox;
}

References ARC, BEZIER, CIRCLE, SHAPE_POLY_SET::CIterate(), EDA_SHAPE::computeArcBBox(), EDA_SHAPE::GetBezierC1(), EDA_SHAPE::GetBezierC2(), EDA_SHAPE::GetEnd(), EDA_SHAPE::getParentOrientation(), EDA_SHAPE::getParentPosition(), EDA_SHAPE::GetRadius(), EDA_SHAPE::GetRectCorners(), EDA_SHAPE::GetStart(), EDA_RECT::Inflate(), SHAPE_POLY_SET::IsEmpty(), EDA_SHAPE::m_poly, EDA_SHAPE::m_shape, EDA_SHAPE::m_width, EDA_RECT::Merge(), EDA_RECT::Normalize(), POLY, RECT, RotatePoint(), SEGMENT, EDA_RECT::SetEnd(), EDA_RECT::SetOrigin(), EDA_SHAPE::SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

Referenced by GetBoundingBox(), PCB_SHAPE::GetBoundingBox(), EDA_SHAPE::getCenter(), and EDA_SHAPE::hitTest().

GetCenter()

wxPoint LIB_SHAPE::GetCenter ( ) const

inline

Definition at line 90 of file lib_shape.h.

{ return getCenter(); }

References EDA_SHAPE::getCenter().

Referenced by CalcArcAngles(), KIGFX::SCH_PAINTER::draw(), SCH_LEGACY_PLUGIN_CACHE::loadArc(), SCH_EAGLE_PLUGIN::loadSymbolRectangle(), and SCH_ALTIUM_PLUGIN::ParseArc().

getCenter()

wxPoint EDA_SHAPE::getCenter ( ) const

inherited

Definition at line 393 of file eda_shape.cpp.

{
 switch( m_shape )
 {
 case SHAPE_T::ARC:
 return m_arcCenter;

 case SHAPE_T::CIRCLE:
 return m_start;

 case SHAPE_T::SEGMENT:
 // Midpoint of the line
 return ( m_start + m_end ) / 2;

 case SHAPE_T::POLY:
 case SHAPE_T::RECT:
 case SHAPE_T::BEZIER:
 return getBoundingBox().Centre();

 default:
 UNIMPLEMENTED_FOR( SHAPE_T_asString() );
 return wxPoint();
 }
}

References ARC, BEZIER, EDA_RECT::Centre(), CIRCLE, EDA_SHAPE::getBoundingBox(), EDA_SHAPE::m_arcCenter, EDA_SHAPE::m_end, EDA_SHAPE::m_shape, EDA_SHAPE::m_start, POLY, RECT, SEGMENT, EDA_SHAPE::SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

Referenced by EDA_SHAPE::CalcArcAngles(), PCB_SHAPE::GetCenter(), GetCenter(), EDA_SHAPE::getPosition(), EDA_SHAPE::hitTest(), EDA_SHAPE::MakeEffectiveShapes(), Plot(), print(), and EDA_SHAPE::TransformShapeWithClearanceToPolygon().

GetClass()

wxString LIB_SHAPE::GetClass ( ) const

inlineoverridevirtual

Return the class name.

Implements EDA_ITEM.

Definition at line 42 of file lib_shape.h.

 {
 return wxT( "LIB_SHAPE" );
 }

GetConvert()

int LIB_ITEM::GetConvert ( ) const

inlineinherited

Definition at line 269 of file lib_item.h.

{ return m_convert; }

References LIB_ITEM::m_convert.

Referenced by SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), SCH_PIN::GetMsgPanelInfo(), EE_COLLECTOR::Inspect(), KIGFX::SCH_PAINTER::isUnitAndConversionShown(), SYMBOL_EDITOR_MOVE_TOOL::Main(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), SCH_LEGACY_PLUGIN_CACHE::saveBezier(), SCH_LEGACY_PLUGIN_CACHE::saveCircle(), SCH_LEGACY_PLUGIN_CACHE::savePin(), SCH_LEGACY_PLUGIN_CACHE::savePolyLine(), SCH_LEGACY_PLUGIN_CACHE::saveRectangle(), SCH_LEGACY_PLUGIN_CACHE::saveText(), EE_SELECTION_TOOL::Selectable(), sort_by_pin_number(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_SHAPE_PROPERTIES::TransferDataToWindow(), and DIALOG_PIN_PROPERTIES::TransferDataToWindow().

GetEditFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetEditFlags ( ) const

inlineinherited

Definition at line 157 of file eda_item.h.

 {
 constexpr int mask = ( IS_NEW | IS_PASTED | IS_MOVING | IS_RESIZING | IS_DRAGGING
 | IS_WIRE_IMAGE | STRUCT_DELETED );

 return m_flags & mask;
 }

References IS_DRAGGING, IS_MOVING, IS_NEW, IS_PASTED, IS_RESIZING, IS_WIRE_IMAGE, EDA_ITEM::m_flags, and STRUCT_DELETED.

Referenced by EDA_ITEM::ClearEditFlags(), SCH_EDIT_FRAME::DeleteJunction(), SCH_EDIT_TOOL::editFieldText(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), SCH_SYMBOL::GetMsgPanelInfo(), SELECTION_CONDITIONS::Idle(), SELECTION_CONDITIONS::IdleSelection(), SYMBOL_EDITOR_MOVE_TOOL::Main(), PCB_POINT_EDITOR::OnSelectionChange(), SYMBOL_EDITOR_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Properties(), PAD_TOOL::recombinePad(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_EDIT_FRAME::SelectUnit(), DIALOG_DIMENSION_PROPERTIES::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_AND_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), and DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow().

GetEffectivePenWidth()

int LIB_SHAPE::GetEffectivePenWidth ( const RENDER_SETTINGS *  aSettings ) const

inlineoverridevirtual

Reimplemented from LIB_ITEM.

Definition at line 57 of file lib_shape.h.

 {
 // For historical reasons, a stored value of 0 means "default width" and negative
 // numbers meant "don't stroke".

 if( GetPenWidth() < 0 && GetFillType() != FILL_T::NO_FILL )
 return 0;
 else if( GetPenWidth() == 0 )
 return aSettings->GetDefaultPenWidth();
 else
 return std::max( GetPenWidth(), aSettings->GetMinPenWidth() );
 }

References KIGFX::RENDER_SETTINGS::GetDefaultPenWidth(), EDA_SHAPE::GetFillType(), KIGFX::RENDER_SETTINGS::GetMinPenWidth(), GetPenWidth(), and NO_FILL.

Referenced by Plot(), and print().

GetEnd()

const wxPoint& EDA_SHAPE::GetEnd ( ) const

inlineinherited

Return the ending point of the graphic.

Definition at line 131 of file eda_shape.h.

{ return m_end; }

References EDA_SHAPE::m_end.

Referenced by PCB_POINT_EDITOR::addCorner(), BOARD_ADAPTER::addShapeWithClearance(), GRAPHICS_CLEANER::areEquivalent(), CalcArcAngles(), EDA_SHAPE::CalcArcAngles(), EDA_SHAPE::calcEdit(), PCB_GRID_HELPER::computeAnchors(), ConvertOutlineToPolygon(), CreateBoardSection(), CONVERT_TOOL::CreateLines(), MICROWAVE_TOOL::createMicrowaveInductor(), CONVERT_TOOL::CreatePolys(), KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), PCB_POINT_EDITOR::editArcEndpointKeepTangent(), PCB_PLUGIN::format(), formatArc(), formatBezier(), formatRect(), EDA_SHAPE::getBoundingBox(), EDA_SHAPE::GetLength(), EDA_SHAPE::GetRectCorners(), CADSTAR_SCH_ARCHIVE_LOADER::getScaledLibPart(), CONVERT_TOOL::getStartEndPoints(), hash_fp_item(), EDA_SHAPE::hitTest(), idf_export_outline(), GRAPHICS_CLEANER::isNullShape(), SCH_LEGACY_PLUGIN_CACHE::loadArc(), SCH_EAGLE_PLUGIN::loadSymbolRectangle(), EDIT_POINTS_FACTORY::Make(), EDA_SHAPE::MakeEffectiveShapes(), DSN::SPECCTRA_DB::makeIMAGE(), PCB_POINT_EDITOR::makePoints(), CONVERT_TOOL::makePolysFromRects(), CONVERT_TOOL::makePolysFromSegs(), GRAPHICS_CLEANER::mergeRects(), PCB_PARSER::parsePAD(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), BRDITEMS_PLOTTER::PlotPcbShape(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), SCH_LEGACY_PLUGIN_CACHE::saveRectangle(), EDA_SHAPE::ShapeGetMsgPanelInfo(), AR_MATRIX::TraceSegmentPcb(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataToWindow(), EDA_SHAPE::TransformShapeWithClearanceToPolygon(), EE_POINT_EDITOR::updatePoints(), and PCB_POINT_EDITOR::updatePoints().

GetEndX()

int EDA_SHAPE::GetEndX ( )

inlineinherited

Definition at line 133 of file eda_shape.h.

{ return m_end.x; }

References EDA_SHAPE::m_end.

Referenced by EDA_SHAPE_DESC::EDA_SHAPE_DESC(), PCB_SHAPE_DESC::PCB_SHAPE_DESC(), and DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run().

GetEndY()

int EDA_SHAPE::GetEndY ( )

inlineinherited

Definition at line 132 of file eda_shape.h.

{ return m_end.y; }

References EDA_SHAPE::m_end.

Referenced by EDA_SHAPE_DESC::EDA_SHAPE_DESC(), PCB_SHAPE_DESC::PCB_SHAPE_DESC(), and DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run().

GetFillType()

FILL_T EDA_SHAPE::GetFillType ( ) const

inlineinherited

Definition at line 88 of file eda_shape.h.

{ return m_fill; }

References EDA_SHAPE::m_fill.

Referenced by GetEffectivePenWidth(), EDA_SHAPE::IsFilled(), LIB_SYMBOL::Plot(), print(), LIB_SYMBOL::Print(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), SCH_LEGACY_PLUGIN_CACHE::saveBezier(), SCH_LEGACY_PLUGIN_CACHE::saveCircle(), SCH_LEGACY_PLUGIN_CACHE::savePolyLine(), SCH_LEGACY_PLUGIN_CACHE::saveRectangle(), SCH_SEXPR_PLUGIN_CACHE::saveSymbolDrawItem(), KIGFX::SCH_PAINTER::setDeviceColors(), and DIALOG_LIB_SHAPE_PROPERTIES::TransferDataToWindow().

GetFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetFlags ( ) const

inlineinherited

Definition at line 154 of file eda_item.h.

{ return m_flags; }

References EDA_ITEM::m_flags.

Referenced by BACK_ANNOTATE::applyChangelist(), calcIsInsideArea(), ConvertOutlineToPolygon(), SCH_EDIT_FRAME::ConvertPart(), KIGFX::SCH_PAINTER::draw(), DRC_ENGINE::EvalRules(), PCB_SELECTION_TOOL::expandConnection(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), BOARD_INSPECTION_TOOL::InspectConstraints(), LIB_SYMBOL::LIB_SYMBOL(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), LIB_SYMBOL::operator=(), BOARD_COMMIT::Push(), FOOTPRINT::Remove(), BOARD::Remove(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_EDIT_FRAME::SelectUnit(), DS_DATA_ITEM::SyncDrawItems(), DS_DATA_ITEM_POLYGONS::SyncDrawItems(), DS_DATA_ITEM_BITMAP::SyncDrawItems(), CONNECTIVITY_DATA::TestTrackEndpointDangling(), and DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow().

GetFocusPosition()

virtual const wxPoint EDA_ITEM::GetFocusPosition ( ) const

inlinevirtualinherited

Similar to GetPosition, but allows items to return their visual center rather than their anchor.

Reimplemented in BOARD, PCB_TRACK, and PCB_SHAPE.

Definition at line 258 of file eda_item.h.

{ return GetPosition(); }

References EDA_ITEM::GetPosition().

Referenced by SCH_EDIT_FRAME::FocusOnItem().

GetLength()

double EDA_SHAPE::GetLength ( ) const

inherited

Return the length of the track using the hypotenuse calculation.

Returns

the length of the track

Definition at line 106 of file eda_shape.cpp.

{
 double length = 0.0;

 switch( m_shape )
 {
 case SHAPE_T::BEZIER:
 for( size_t ii = 1; ii < m_bezierPoints.size(); ++ii )
 length += GetLineLength( m_bezierPoints[ ii - 1], m_bezierPoints[ii] );

 return length;

 case SHAPE_T::SEGMENT:
 return GetLineLength( GetStart(), GetEnd() );

 case SHAPE_T::POLY:
 for( int ii = 0; ii < m_poly.COutline( 0 ).SegmentCount(); ii++ )
 length += m_poly.COutline( 0 ).CSegment( ii ).Length();

 return length;

 case SHAPE_T::ARC:
 return 2 * M_PI * GetRadius() * ( GetArcAngle() / 3600.0 );

 default:
 UNIMPLEMENTED_FOR( SHAPE_T_asString() );
 return 0.0;
 }
}

References ARC, BEZIER, SHAPE_POLY_SET::COutline(), SHAPE_LINE_CHAIN::CSegment(), EDA_SHAPE::GetArcAngle(), EDA_SHAPE::GetEnd(), GetLineLength(), EDA_SHAPE::GetRadius(), EDA_SHAPE::GetStart(), SEG::Length(), EDA_SHAPE::m_bezierPoints, EDA_SHAPE::m_poly, EDA_SHAPE::m_shape, POLY, SEGMENT, SHAPE_LINE_CHAIN::SegmentCount(), EDA_SHAPE::SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

Referenced by EDA_SHAPE::ShapeGetMsgPanelInfo().

GetMenuImage()

BITMAPS LIB_SHAPE::GetMenuImage ( ) const

overridevirtual

Return a pointer to an image to be used in menus.

The default version returns the right arrow image. Override this function to provide object specific menu images.

Returns

The menu image associated with the item.

Reimplemented from EDA_ITEM.

Definition at line 397 of file lib_shape.cpp.

{
 switch( GetShape() )
 {
 case SHAPE_T::SEGMENT: return BITMAPS::add_line;
 case SHAPE_T::ARC: return BITMAPS::add_arc;
 case SHAPE_T::CIRCLE: return BITMAPS::add_circle;
 case SHAPE_T::RECT: return BITMAPS::add_rectangle;
 case SHAPE_T::POLY: return BITMAPS::add_graphical_segments;

 default:
 UNIMPLEMENTED_FOR( SHAPE_T_asString() );
 return BITMAPS::question_mark;
 }
}

References add_arc, add_circle, add_graphical_segments, add_line, add_rectangle, ARC, CIRCLE, EDA_SHAPE::GetShape(), POLY, question_mark, RECT, SEGMENT, EDA_SHAPE::SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

GetMsgPanelInfo()

void LIB_SHAPE::GetMsgPanelInfo ( EDA_DRAW_FRAME *  aFrame, std::vector< MSG_PANEL_ITEM > &  aList  )

overridevirtual

Display basic info (type, part and convert) about the current item in message panel.

This base function is used to display the information common to the all library items. Call the base class from the derived class or the common information will not be updated in the message panel.

Parameters

aList

is the list to populate.

Reimplemented from LIB_ITEM.

Definition at line 357 of file lib_shape.cpp.

{
 LIB_ITEM::GetMsgPanelInfo( aFrame, aList );

 ShapeGetMsgPanelInfo( aFrame, aList );
}

References LIB_ITEM::GetMsgPanelInfo(), and EDA_SHAPE::ShapeGetMsgPanelInfo().

GetParent()

LIB_SYMBOL* LIB_ITEM::GetParent ( void  ) const

inlineinherited

Definition at line 164 of file lib_item.h.

 {
 return (LIB_SYMBOL*) m_parent;
 }

References EDA_ITEM::m_parent.

Referenced by SYMBOL_EDITOR_PIN_TOOL::CreateImagePins(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_EDIT_TOOL::editFieldProperties(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), LIB_PIN::GetBoundingBox(), LIB_FIELD::GetFullText(), LIB_PIN::IsPowerConnection(), DIALOG_LIB_EDIT_PIN_TABLE::OnAddRow(), LIB_PIN::Plot(), LIB_PIN::print(), SYMBOL_EDITOR_EDIT_TOOL::Properties(), DIALOG_LIB_SHAPE_PROPERTIES::TransferDataToWindow(), DIALOG_PIN_PROPERTIES::TransferDataToWindow(), and DIALOG_LIB_FIELD_PROPERTIES::UpdateField().

getParentOrientation()

double LIB_SHAPE::getParentOrientation ( ) const

inlineoverrideprivatevirtual

Implements EDA_SHAPE.

Definition at line 121 of file lib_shape.h.

{ return 0.0; }

getParentPosition()

wxPoint LIB_SHAPE::getParentPosition ( ) const

inlineoverrideprivatevirtual

Implements EDA_SHAPE.

Definition at line 122 of file lib_shape.h.

{ return wxPoint(); }

GetPenWidth()

int LIB_SHAPE::GetPenWidth ( ) const

overridevirtual

Implements LIB_ITEM.

Definition at line 208 of file lib_shape.cpp.

{
 return GetWidth();
}

References EDA_SHAPE::GetWidth().

Referenced by GetEffectivePenWidth().

GetPointCount()

int EDA_SHAPE::GetPointCount ( ) const

inherited

Returns

the number of corners of the polygonal shape

Definition at line 1222 of file eda_shape.cpp.

{
 // return the number of corners of the polygonal shape
 // this shape is expected to be only one polygon without hole
 if( GetPolyShape().OutlineCount() )
 return GetPolyShape().VertexCount( 0 );

 return 0;
}

References EDA_SHAPE::GetPolyShape(), and SHAPE_POLY_SET::VertexCount().

Referenced by GRAPHICS_CLEANER::isNullShape(), and EE_POINT_EDITOR::updatePoints().

GetPolyShape() [1/2]

SHAPE_POLY_SET& EDA_SHAPE::GetPolyShape ( )

inlineinherited

Definition at line 227 of file eda_shape.h.

{ return m_poly; }

References EDA_SHAPE::m_poly.

Referenced by EE_POINT_EDITOR::addCorner(), PCB_POINT_EDITOR::addCorner(), ConvertOutlineToPolygon(), CONVERT_TOOL::CreateLines(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::DIALOG_PAD_PRIMITIVE_POLY_PROPS(), KIGFX::SCH_PAINTER::draw(), CADSTAR_SCH_ARCHIVE_LOADER::fixUpLibraryPins(), PCB_PLUGIN::format(), formatPoly(), PCB_SHAPE::GetFocusPosition(), CADSTAR_PCB_ARCHIVE_LOADER::getKiCadPad(), EDA_SHAPE::GetPointCount(), CADSTAR_SCH_ARCHIVE_LOADER::getScaledLibPart(), ALTIUM_PCB::HelperShapeSetLocalCoord(), EDA_SHAPE::IsPolyShapeValid(), EDIT_POINTS_FACTORY::Make(), EDA_SHAPE::MakeEffectiveShapes(), PCB_POINT_EDITOR::makePoints(), EAGLE_PLUGIN::packagePolygon(), PCB_PARSER::parsePAD(), BRDITEMS_PLOTTER::PlotPcbShape(), EE_POINT_EDITOR::removeCorner(), PCB_POINT_EDITOR::removeCorner(), EE_POINT_EDITOR::removeCornerCondition(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), SCH_LEGACY_PLUGIN_CACHE::savePolyLine(), EDA_SHAPE::ShapeGetMsgPanelInfo(), PCB_POINT_EDITOR::updateItem(), EE_POINT_EDITOR::updateParentItem(), and EE_POINT_EDITOR::updatePoints().

GetPolyShape() [2/2]

const SHAPE_POLY_SET& EDA_SHAPE::GetPolyShape ( ) const

inlineinherited

Definition at line 228 of file eda_shape.h.

{ return m_poly; }

References EDA_SHAPE::m_poly.

GetPosition()

wxPoint LIB_SHAPE::GetPosition ( ) const

inlineoverridevirtual

Reimplemented from EDA_ITEM.

Definition at line 87 of file lib_shape.h.

{ return getPosition(); }

References EDA_SHAPE::getPosition().

Referenced by KIGFX::SCH_PAINTER::draw(), CADSTAR_SCH_ARCHIVE_LOADER::getScaledLibPart(), HelperGeneratePowerPortGraphics(), SCH_EAGLE_PLUGIN::loadSymbolRectangle(), EDIT_POINTS_FACTORY::Make(), SCH_ALTIUM_PLUGIN::ParseArc(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), SCH_LEGACY_PLUGIN_CACHE::saveCircle(), SCH_LEGACY_PLUGIN_CACHE::saveRectangle(), and EE_POINT_EDITOR::updatePoints().

getPosition()

wxPoint EDA_SHAPE::getPosition ( ) const

protectedinherited

Definition at line 95 of file eda_shape.cpp.

{
 if( m_shape == SHAPE_T::ARC )
 return getCenter();
 else if( m_shape == SHAPE_T::POLY )
 return (wxPoint) m_poly.CVertex( 0 );
 else
 return m_start;
}

References ARC, SHAPE_POLY_SET::CVertex(), EDA_SHAPE::getCenter(), EDA_SHAPE::m_poly, EDA_SHAPE::m_shape, EDA_SHAPE::m_start, and POLY.

Referenced by PCB_SHAPE::GetPosition(), GetPosition(), and EDA_SHAPE::setPosition().

GetRadius()

int EDA_SHAPE::GetRadius ( ) const

inherited

Definition at line 472 of file eda_shape.cpp.

{
 double radius = 0.0;

 switch( m_shape )
 {
 case SHAPE_T::ARC:
 radius = GetLineLength( m_arcCenter, m_start );
 break;

 case SHAPE_T::CIRCLE:
 radius = GetLineLength( m_start, m_end );
 break;

 default:
 UNIMPLEMENTED_FOR( SHAPE_T_asString() );
 }

 // don't allow degenerate circles/arcs
 return std::max( 1, KiROUND( radius ) );
}

References ARC, CIRCLE, GetLineLength(), KiROUND(), EDA_SHAPE::m_arcCenter, EDA_SHAPE::m_end, EDA_SHAPE::m_shape, EDA_SHAPE::m_start, EDA_SHAPE::SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

Referenced by BOARD_ADAPTER::addShapeWithClearance(), EDA_SHAPE::calcEdit(), EDA_SHAPE::computeArcBBox(), ConvertOutlineToPolygon(), KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), formatCircle(), EDA_SHAPE::getBoundingBox(), PCB_SHAPE::GetFocusPosition(), EDA_SHAPE::GetLength(), GetSelectMenuText(), hash_fp_item(), EDA_SHAPE::hitTest(), idf_export_outline(), GRAPHICS_CLEANER::isNullShape(), EDA_SHAPE::MakeEffectiveShapes(), DSN::SPECCTRA_DB::makeIMAGE(), CONVERT_TOOL::makePolysFromCircles(), ALTIUM_PCB::Parse(), PCB_PARSER::parsePAD(), Plot(), BRDITEMS_PLOTTER::PlotPcbShape(), print(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), SCH_LEGACY_PLUGIN_CACHE::saveCircle(), EDA_SHAPE::scale(), EDA_SHAPE::ShapeGetMsgPanelInfo(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataToWindow(), and EDA_SHAPE::TransformShapeWithClearanceToPolygon().

GetRectCorners()

std::vector< wxPoint > EDA_SHAPE::GetRectCorners ( ) const

inherited

Definition at line 981 of file eda_shape.cpp.

{
 std::vector<wxPoint> pts;
 wxPoint topLeft = GetStart();
 wxPoint botRight = GetEnd();

 // Un-rotate rect topLeft and botRight
 if( KiROUND( getParentOrientation() ) % 900 != 0 )
 {
 topLeft -= getParentPosition();
 RotatePoint( &topLeft, -getParentOrientation() );

 botRight -= getParentPosition();
 RotatePoint( &botRight, -getParentOrientation() );
 }

 // Set up the un-rotated 4 corners
 pts.emplace_back( topLeft );
 pts.emplace_back( botRight.x, topLeft.y );
 pts.emplace_back( botRight );
 pts.emplace_back( topLeft.x, botRight.y );

 // Now re-rotate the 4 corners to get a diamond
 if( KiROUND( getParentOrientation() ) % 900 != 0 )
 {
 for( wxPoint& pt : pts )
 {
 RotatePoint( &pt, getParentOrientation() );
 pt += getParentPosition();
 }
 }

 return pts;
}

References EDA_SHAPE::GetEnd(), EDA_SHAPE::getParentOrientation(), EDA_SHAPE::getParentPosition(), EDA_SHAPE::GetStart(), KiROUND(), and RotatePoint().

Referenced by BOARD_ADAPTER::addShapeWithClearance(), ConvertOutlineToPolygon(), KIGFX::PCB_PAINTER::draw(), EDA_SHAPE::getBoundingBox(), EDA_SHAPE::hitTest(), EDA_SHAPE::MakeEffectiveShapes(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), BRDITEMS_PLOTTER::PlotPcbShape(), and EDA_SHAPE::TransformShapeWithClearanceToPolygon().

GetSelectMenuText()

wxString LIB_SHAPE::GetSelectMenuText ( EDA_UNITS  aUnits ) const

overridevirtual

Return the text to display to be used in the selection clarification context menu when multiple items are found at the current cursor position.

The default version of this function raises an assertion in the debug mode and returns a string to indicate that it was not overridden to provide the object specific text.

Returns

The menu text string.

Reimplemented from EDA_ITEM.

Definition at line 365 of file lib_shape.cpp.

{
 switch( GetShape() )
 {
 case SHAPE_T::ARC:
 return wxString::Format( _( "Arc, radius %s" ),
 MessageTextFromValue( aUnits, GetRadius() ) );

 case SHAPE_T::CIRCLE:
 return wxString::Format( _( "Circle, radius %s" ),
 MessageTextFromValue( aUnits, GetRadius() ) );

 case SHAPE_T::RECT:
 return wxString::Format( _( "Rectangle, width %s height %s" ),
 MessageTextFromValue( aUnits, std::abs( m_start.x - m_end.x ) ),
 MessageTextFromValue( aUnits, std::abs( m_start.y - m_end.y ) ) );

 case SHAPE_T::POLY:
 return wxString::Format( _( "Polyline, %d points" ),
 int( m_poly.Outline( 0 ).GetPointCount() ) );

 case SHAPE_T::BEZIER:
 return wxString::Format( _( "Bezier Curve, %d points" ),
 int( m_bezierPoints.size() ) );

 default:
 UNIMPLEMENTED_FOR( SHAPE_T_asString() );
 return wxEmptyString;
 }
}

References _, ARC, BEZIER, CIRCLE, Format(), SHAPE_LINE_CHAIN::GetPointCount(), EDA_SHAPE::GetRadius(), EDA_SHAPE::GetShape(), EDA_SHAPE::m_bezierPoints, EDA_SHAPE::m_end, EDA_SHAPE::m_poly, EDA_SHAPE::m_start, MessageTextFromValue(), SHAPE_POLY_SET::Outline(), POLY, RECT, EDA_SHAPE::SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

GetShape()

SHAPE_T EDA_SHAPE::GetShape ( ) const

inlineinherited

Definition at line 101 of file eda_shape.h.

{ return m_shape; }

References EDA_SHAPE::m_shape.

Referenced by PCB_POINT_EDITOR::addCorner(), EE_POINT_EDITOR::addCornerCondition(), AddPoint(), BOARD_ADAPTER::addShapeWithClearance(), GRAPHICS_CLEANER::areEquivalent(), EDA_SHAPE::beginEdit(), EDA_SHAPE::calcEdit(), PCB_POINT_EDITOR::canAddCorner(), PCB_GRID_HELPER::computeAnchors(), EDA_SHAPE::continueEdit(), ConvertOutlineToPolygon(), CONVERT_TOOL::CreateLines(), CONVERT_TOOL::CreatePolys(), KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), EDA_SHAPE_DESC::EDA_SHAPE_DESC(), EDA_SHAPE::endEdit(), PAD_TOOL::explodePad(), CADSTAR_SCH_ARCHIVE_LOADER::fixUpLibraryPins(), FP_SHAPE::Flip(), FootprintWriteShape(), PCB_PLUGIN::format(), FOOTPRINT::GetCoverageArea(), GetMenuImage(), CADSTAR_SCH_ARCHIVE_LOADER::getScaledLibPart(), GetSelectMenuText(), EE_SELECTION_TOOL::GuessSelectionCandidates(), hash_fp_item(), idf_export_outline(), GRAPHICS_CLEANER::isNullShape(), EE_POINT_EDITOR::Main(), EDIT_POINTS_FACTORY::Make(), DSN::SPECCTRA_DB::makeIMAGE(), PCB_POINT_EDITOR::makePoints(), CONVERT_TOOL::makePolysFromCircles(), CONVERT_TOOL::makePolysFromRects(), GRAPHICS_CLEANER::mergeRects(), FP_SHAPE::Mirror(), FP_SHAPE::Move(), PCB_SHAPE::cmp_drawings::operator()(), FOOTPRINT::cmp_drawings::operator()(), ALTIUM_PCB::Parse(), Plot(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), BRDITEMS_PLOTTER::PlotPcbShape(), print(), PAD_TOOL::recombinePad(), PCB_POINT_EDITOR::removeCorner(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), SCH_LEGACY_PLUGIN_CACHE::saveBezier(), SCH_LEGACY_PLUGIN_CACHE::saveCircle(), SCH_LEGACY_PLUGIN_CACHE::savePolyLine(), SCH_LEGACY_PLUGIN_CACHE::saveRectangle(), SCH_LEGACY_PLUGIN_CACHE::SaveSymbol(), SCH_SEXPR_PLUGIN_CACHE::saveSymbolDrawItem(), PNS_KICAD_IFACE_BASE::syncGraphicalItem(), AR_MATRIX::TraceSegmentPcb(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataToWindow(), PCB_POINT_EDITOR::updateItem(), EE_POINT_EDITOR::updateParentItem(), EE_POINT_EDITOR::updatePoints(), PCB_POINT_EDITOR::updatePoints(), and DIALOG_GRAPHIC_ITEM_PROPERTIES::Validate().

GetStart()

const wxPoint& EDA_SHAPE::GetStart ( ) const

inlineinherited

Return the starting point of the graphic.

Definition at line 106 of file eda_shape.h.

{ return m_start; }

References EDA_SHAPE::m_start.

Referenced by PCB_POINT_EDITOR::addCorner(), BOARD_ADAPTER::addShapeWithClearance(), GRAPHICS_CLEANER::areEquivalent(), CalcArcAngles(), EDA_SHAPE::CalcArcAngles(), EDA_SHAPE::calcEdit(), PCB_GRID_HELPER::computeAnchors(), ConvertOutlineToPolygon(), CreateBoardSection(), CONVERT_TOOL::CreateLines(), MICROWAVE_TOOL::createMicrowaveInductor(), CONVERT_TOOL::CreatePolys(), KIGFX::PCB_PAINTER::draw(), PCB_POINT_EDITOR::editArcEndpointKeepCenter(), PCB_POINT_EDITOR::editArcEndpointKeepTangent(), PCB_PLUGIN::format(), formatArc(), formatBezier(), formatCircle(), formatRect(), EDA_SHAPE::getBoundingBox(), PCB_SHAPE::GetFocusPosition(), EDA_SHAPE::GetLength(), EDA_SHAPE::GetRectCorners(), CADSTAR_SCH_ARCHIVE_LOADER::getScaledLibPart(), CONVERT_TOOL::getStartEndPoints(), hash_fp_item(), EDA_SHAPE::hitTest(), idf_export_outline(), GRAPHICS_CLEANER::isNullShape(), SCH_LEGACY_PLUGIN_CACHE::loadArc(), EDIT_POINTS_FACTORY::Make(), DSN::SPECCTRA_DB::makeIMAGE(), PCB_POINT_EDITOR::makePoints(), CONVERT_TOOL::makePolysFromRects(), CONVERT_TOOL::makePolysFromSegs(), GRAPHICS_CLEANER::mergeRects(), PCB_PARSER::parsePAD(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), BRDITEMS_PLOTTER::PlotPcbShape(), BRDITEMS_PLOTTER::PlotPcbTarget(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), EDA_SHAPE::ShapeGetMsgPanelInfo(), AR_MATRIX::TraceSegmentPcb(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataToWindow(), EDA_SHAPE::TransformShapeWithClearanceToPolygon(), EE_POINT_EDITOR::updatePoints(), and PCB_POINT_EDITOR::updatePoints().

GetStartX()

int EDA_SHAPE::GetStartX ( )

inlineinherited

Definition at line 108 of file eda_shape.h.

{ return m_start.x; }

References EDA_SHAPE::m_start.

Referenced by EDA_SHAPE_DESC::EDA_SHAPE_DESC(), and DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run().

GetStartY()

int EDA_SHAPE::GetStartY ( )

inlineinherited

Definition at line 107 of file eda_shape.h.

{ return m_start.y; }

References EDA_SHAPE::m_start.

Referenced by EDA_SHAPE_DESC::EDA_SHAPE_DESC(), and DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run().

GetState()

int EDA_ITEM::GetState ( EDA_ITEM_FLAGS  type ) const

inlineinherited

Definition at line 136 of file eda_item.h.

 {
 return m_status & type;
 }

References EDA_ITEM::m_status.

Referenced by BOARD_ITEM::IsLocked().

GetStatus()

EDA_ITEM_FLAGS EDA_ITEM::GetStatus ( ) const

inlineinherited

Definition at line 149 of file eda_item.h.

{ return m_status; }

References EDA_ITEM::m_status.

GetTypeName()

wxString LIB_SHAPE::GetTypeName ( ) const

inlineoverridevirtual

Provide a user-consumable name of the object type.

Perform localization when called so that run-time language selection works.

Implements LIB_ITEM.

Definition at line 47 of file lib_shape.h.

 {
 return ShowShape();
 }

References EDA_SHAPE::ShowShape().

GetUnit()

int LIB_ITEM::GetUnit ( ) const

inlineinherited

Definition at line 266 of file lib_item.h.

{ return m_unit; }

References LIB_ITEM::m_unit.

Referenced by SYMBOL_EDITOR_PIN_TOOL::CreateImagePins(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), CADSTAR_SCH_ARCHIVE_LOADER::fixUpLibraryPins(), SCH_SYMBOL::GetEndPoints(), SCH_PIN::GetMsgPanelInfo(), EE_COLLECTOR::Inspect(), KIGFX::SCH_PAINTER::isUnitAndConversionShown(), SYMBOL_EDITOR_MOVE_TOOL::Main(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), SCH_LEGACY_PLUGIN_CACHE::saveBezier(), SCH_LEGACY_PLUGIN_CACHE::saveCircle(), SCH_LEGACY_PLUGIN_CACHE::savePin(), SCH_LEGACY_PLUGIN_CACHE::savePolyLine(), SCH_LEGACY_PLUGIN_CACHE::saveRectangle(), SCH_LEGACY_PLUGIN_CACHE::saveText(), EE_SELECTION_TOOL::Selectable(), sort_by_pin_number(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_SHAPE_PROPERTIES::TransferDataToWindow(), and DIALOG_PIN_PROPERTIES::TransferDataToWindow().

GetWidth()

int EDA_SHAPE::GetWidth ( ) const

inlineinherited

Definition at line 98 of file eda_shape.h.

{ return m_width; }

References EDA_SHAPE::m_width.

Referenced by BOARD_ADAPTER::addShapeWithClearance(), GRAPHICS_CLEANER::areEquivalent(), ConvertOutlineToPolygon(), KIGFX::PCB_PAINTER::draw(), EDA_SHAPE_DESC::EDA_SHAPE_DESC(), PCB_PLUGIN::format(), FOOTPRINT::GetCoverageArea(), GetPenWidth(), CONVERT_TOOL::getStartEndPoints(), hash_fp_item(), EDA_SHAPE::hitTest(), GRAPHICS_CLEANER::isNullShape(), SCH_LEGACY_PLUGIN_CACHE::loadBezier(), FABMASTER::loadPolygon(), EDA_SHAPE::MakeEffectiveShapes(), DSN::SPECCTRA_DB::makeIMAGE(), CONVERT_TOOL::makePolysFromRects(), CONVERT_TOOL::makePolysFromSegs(), PCB_PARSER::parsePAD(), PCB_SHAPE_DESC::PCB_SHAPE_DESC(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), BRDITEMS_PLOTTER::PlotPcbShape(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), SCH_LEGACY_PLUGIN_CACHE::saveBezier(), SCH_LEGACY_PLUGIN_CACHE::saveCircle(), SCH_LEGACY_PLUGIN_CACHE::savePolyLine(), SCH_LEGACY_PLUGIN_CACHE::saveRectangle(), SCH_SEXPR_PLUGIN_CACHE::saveSymbolDrawItem(), CONVERT_TOOL::SegmentToArc(), AR_MATRIX::TraceSegmentPcb(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_SHAPE_PROPERTIES::TransferDataToWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataToWindow(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::TransferDataToWindow(), PCB_POINT_EDITOR::updateItem(), and PCB_SHAPE::ViewBBox().

HasFlag()

bool EDA_ITEM::HasFlag ( EDA_ITEM_FLAGS  aFlag ) const

inlineinherited

Definition at line 155 of file eda_item.h.

{ return ( m_flags & aFlag ) == aFlag; }

References EDA_ITEM::m_flags.

Referenced by TRACKS_CLEANER::cleanup(), GRAPHICS_CLEANER::cleanupShapes(), SCH_EDIT_TOOL::DoDelete(), KIGFX::SCH_PAINTER::draw(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_MOVE_TOOL::moveItem(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SCH_EDIT_TOOL::Rotate(), and EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList().

HitTest() [1/2]

bool LIB_SHAPE::HitTest ( const wxPoint &  aPosition, int  aAccuracy = 0  ) const

overridevirtual

Test if aPosition is inside or on the boundary of this item.

Parameters

aPosition	A reference to a wxPoint object containing the coordinates to test.
aAccuracy	Increase the item bounding box by this amount.

Returns

True if aPosition is within the item bounding box.

Reimplemented from LIB_ITEM.

Definition at line 45 of file lib_shape.cpp.

{
 if( aAccuracy < Mils2iu( MINIMUM_SELECTION_DISTANCE ) )
 aAccuracy = Mils2iu( MINIMUM_SELECTION_DISTANCE );

 return hitTest( DefaultTransform.TransformCoordinate( aPosRef ), aAccuracy );
}

References DefaultTransform, EDA_SHAPE::hitTest(), MINIMUM_SELECTION_DISTANCE, and TRANSFORM::TransformCoordinate().

Referenced by EE_POINT_EDITOR::addCornerCondition().

HitTest() [2/2]

bool LIB_SHAPE::HitTest ( const EDA_RECT &  aRect, bool  aContained, int  aAccuracy = 0  ) const

overridevirtual

Test if aRect intersects this item.

Parameters

aRect	A reference to a EDA_RECT object containing the rectangle to test.
aContained	Set to true to test for containment instead of an intersection.
aAccuracy	Increase aRect by this amount.

Returns

True if aRect contains or intersects the item bounding box.

Reimplemented from LIB_ITEM.

Definition at line 54 of file lib_shape.cpp.

{
 if( m_flags & (STRUCT_DELETED | SKIP_STRUCT ) )
 return false;

 return hitTest( DefaultTransform.TransformCoordinate( aRect ), aContained, aAccuracy );
}

References DefaultTransform, EDA_SHAPE::hitTest(), EDA_ITEM::m_flags, SKIP_STRUCT, STRUCT_DELETED, and TRANSFORM::TransformCoordinate().

hitTest() [1/2]

bool EDA_SHAPE::hitTest ( const wxPoint &  aPosition, int  aAccuracy = 0  ) const

protectedinherited

Definition at line 695 of file eda_shape.cpp.

{
 int maxdist = aAccuracy;

 if( m_width > 0 )
 maxdist += m_width / 2;

 switch( m_shape )
 {
 case SHAPE_T::CIRCLE:
 {
 int radius = GetRadius();
 int dist = KiROUND( EuclideanNorm( aPosition - getCenter() ) );

 if( IsFilled() )
 return dist <= radius + maxdist; // Filled circle hit-test
 else
 return abs( radius - dist ) <= maxdist; // Ring hit-test
 }

 case SHAPE_T::ARC:
 {
 if( EuclideanNorm( aPosition - m_start ) <= maxdist )
 return true;

 if( EuclideanNorm( aPosition - m_end ) <= maxdist )
 return true;

 wxPoint relPos = aPosition - getCenter();
 int radius = GetRadius();
 int dist = KiROUND( EuclideanNorm( relPos ) );

 if( abs( radius - dist ) <= maxdist )
 {
 double startAngle;
 double endAngle;
 CalcArcAngles( startAngle, endAngle );

 if( m_eeWinding && NormalizeAngleDegrees( startAngle - endAngle, -180.0, 180.0 ) > 0 )
 std::swap( startAngle, endAngle );

 double relPosAngle = 180.0 / M_PI * atan2( relPos.y, relPos.x );

 startAngle = NormalizeAngleDegrees( startAngle, 0.0, 360.0 );
 endAngle = NormalizeAngleDegrees( endAngle, 0.0, 360.0 );
 relPosAngle = NormalizeAngleDegrees( relPosAngle, 0.0, 360.0 );

 if( endAngle > startAngle )
 return relPosAngle >= startAngle && relPosAngle <= endAngle;
 else
 return relPosAngle >= startAngle || relPosAngle <= endAngle;
 }

 return false;
 }

 case SHAPE_T::BEZIER:
 const_cast<EDA_SHAPE*>( this )->RebuildBezierToSegmentsPointsList( m_width );

 for( unsigned int i= 1; i < m_bezierPoints.size(); i++)
 {
 if( TestSegmentHit( aPosition, m_bezierPoints[ i - 1], m_bezierPoints[i], maxdist ) )
 return true;
 }

 return false;

 case SHAPE_T::SEGMENT:
 return TestSegmentHit( aPosition, GetStart(), GetEnd(), maxdist );

 case SHAPE_T::RECT:
 if( IsFilled() ) // Filled rect hit-test
 {
 SHAPE_POLY_SET poly;
 poly.NewOutline();

 for( const wxPoint& pt : GetRectCorners() )
 poly.Append( pt );

 return poly.Collide( VECTOR2I( aPosition ), maxdist );
 }
 else // Open rect hit-test
 {
 std::vector<wxPoint> pts = GetRectCorners();

 return TestSegmentHit( aPosition, pts[0], pts[1], maxdist )
 || TestSegmentHit( aPosition, pts[1], pts[2], maxdist )
 || TestSegmentHit( aPosition, pts[2], pts[3], maxdist )
 || TestSegmentHit( aPosition, pts[3], pts[0], maxdist );
 }

 case SHAPE_T::POLY:
 if( IsFilled() )
 {
 return m_poly.Collide( VECTOR2I( aPosition ), maxdist );
 }
 else
 {
 SHAPE_POLY_SET::VERTEX_INDEX dummy;
 return m_poly.CollideEdge( VECTOR2I( aPosition ), dummy, maxdist );
 }

 default:
 UNIMPLEMENTED_FOR( SHAPE_T_asString() );
 return false;
 }
}

References SHAPE_POLY_SET::Append(), ARC, BEZIER, EDA_SHAPE::CalcArcAngles(), CIRCLE, SHAPE_POLY_SET::Collide(), SHAPE_POLY_SET::CollideEdge(), dummy(), EuclideanNorm(), EDA_SHAPE::getCenter(), EDA_SHAPE::GetEnd(), EDA_SHAPE::GetRadius(), EDA_SHAPE::GetRectCorners(), EDA_SHAPE::GetStart(), EDA_SHAPE::IsFilled(), KiROUND(), EDA_SHAPE::m_bezierPoints, EDA_SHAPE::m_eeWinding, EDA_SHAPE::m_end, EDA_SHAPE::m_poly, EDA_SHAPE::m_shape, EDA_SHAPE::m_start, EDA_SHAPE::m_width, SHAPE_POLY_SET::NewOutline(), NormalizeAngleDegrees(), POLY, RECT, SEGMENT, EDA_SHAPE::SHAPE_T_asString(), TestSegmentHit(), and UNIMPLEMENTED_FOR.

Referenced by HitTest(), and PCB_SHAPE::HitTest().

hitTest() [2/2]

bool EDA_SHAPE::hitTest ( const EDA_RECT &  aRect, bool  aContained, int  aAccuracy = 0  ) const

protectedinherited

Definition at line 804 of file eda_shape.cpp.

{
 EDA_RECT arect = aRect;
 arect.Normalize();
 arect.Inflate( aAccuracy );

 EDA_RECT arcRect;
 EDA_RECT bb = getBoundingBox();

 switch( m_shape )
 {
 case SHAPE_T::CIRCLE:
 // Test if area intersects or contains the circle:
 if( aContained )
 {
 return arect.Contains( bb );
 }
 else
 {
 // If the rectangle does not intersect the bounding box, this is a much quicker test
 if( !aRect.Intersects( bb ) )
 {
 return false;
 }
 else
 {
 return arect.IntersectsCircleEdge( getCenter(), GetRadius(), GetWidth() );
 }
 }

 case SHAPE_T::ARC:
 // Test for full containment of this arc in the rect
 if( aContained )
 {
 return arect.Contains( bb );
 }
 // Test if the rect crosses the arc
 else
 {
 arcRect = bb.Common( arect );

 /* All following tests must pass:
 * 1. Rectangle must intersect arc BoundingBox
 * 2. Rectangle must cross the outside of the arc
 */
 return arcRect.Intersects( arect ) &&
 arcRect.IntersectsCircleEdge( getCenter(), GetRadius(), GetWidth() );
 }

 case SHAPE_T::RECT:
 if( aContained )
 {
 return arect.Contains( bb );
 }
 else
 {
 std::vector<wxPoint> pts = GetRectCorners();

 // Account for the width of the lines
 arect.Inflate( GetWidth() / 2 );
 return ( arect.Intersects( pts[0], pts[1] )
 || arect.Intersects( pts[1], pts[2] )
 || arect.Intersects( pts[2], pts[3] )
 || arect.Intersects( pts[3], pts[0] ) );
 }

 case SHAPE_T::SEGMENT:
 if( aContained )
 {
 return arect.Contains( GetStart() ) && aRect.Contains( GetEnd() );
 }
 else
 {
 // Account for the width of the line
 arect.Inflate( GetWidth() / 2 );
 return arect.Intersects( GetStart(), GetEnd() );
 }

 case SHAPE_T::POLY:
 if( aContained )
 {
 return arect.Contains( bb );
 }
 else
 {
 // Fast test: if aRect is outside the polygon bounding box,
 // rectangles cannot intersect
 if( !arect.Intersects( bb ) )
 return false;

 // Account for the width of the line
 arect.Inflate( GetWidth() / 2 );

 // Polygons in footprints use coordinates relative to the footprint.
 // Therefore, instead of using m_poly, we make a copy which is translated
 // to the actual location in the board.
 double orientation = 0.0;
 wxPoint offset = getParentPosition();

 if( getParentOrientation() )
 orientation = -DECIDEG2RAD( getParentOrientation() );

 SHAPE_LINE_CHAIN poly = m_poly.Outline( 0 );
 poly.Rotate( orientation );
 poly.Move( offset );

 int count = poly.GetPointCount();

 for( int ii = 0; ii < count; ii++ )
 {
 VECTOR2I vertex = poly.GetPoint( ii );

 // Test if the point is within aRect
 if( arect.Contains( ( wxPoint ) vertex ) )
 return true;

 if( ii + 1 < count )
 {
 VECTOR2I vertexNext = poly.GetPoint( ii + 1 );

 // Test if this edge intersects aRect
 if( arect.Intersects( ( wxPoint ) vertex, ( wxPoint ) vertexNext ) )
 return true;
 }
 else if( poly.IsClosed() )
 {
 VECTOR2I vertexNext = poly.GetPoint( 0 );

 // Test if this edge intersects aRect
 if( arect.Intersects( ( wxPoint ) vertex, ( wxPoint ) vertexNext ) )
 return true;
 }
 }

 return false;
 }

 case SHAPE_T::BEZIER:
 if( aContained )
 {
 return arect.Contains( bb );
 }
 else
 {
 // Fast test: if aRect is outside the polygon bounding box,
 // rectangles cannot intersect
 if( !arect.Intersects( bb ) )
 return false;

 // Account for the width of the line
 arect.Inflate( GetWidth() / 2 );
 unsigned count = m_bezierPoints.size();

 for( unsigned ii = 1; ii < count; ii++ )
 {
 wxPoint vertex = m_bezierPoints[ ii - 1];
 wxPoint vertexNext = m_bezierPoints[ii];

 // Test if the point is within aRect
 if( arect.Contains( ( wxPoint ) vertex ) )
 return true;

 // Test if this edge intersects aRect
 if( arect.Intersects( vertex, vertexNext ) )
 return true;
 }

 return false;
 }

 default:
 UNIMPLEMENTED_FOR( SHAPE_T_asString() );
 return false;
 }
}

References ARC, BEZIER, CIRCLE, EDA_RECT::Common(), EDA_RECT::Contains(), DECIDEG2RAD(), EDA_SHAPE::getBoundingBox(), EDA_SHAPE::getCenter(), EDA_SHAPE::GetEnd(), EDA_SHAPE::getParentOrientation(), EDA_SHAPE::getParentPosition(), SHAPE_LINE_CHAIN::GetPoint(), SHAPE_LINE_CHAIN::GetPointCount(), EDA_SHAPE::GetRadius(), EDA_SHAPE::GetRectCorners(), EDA_SHAPE::GetStart(), EDA_SHAPE::GetWidth(), EDA_RECT::Inflate(), EDA_RECT::Intersects(), EDA_RECT::IntersectsCircleEdge(), SHAPE_LINE_CHAIN::IsClosed(), EDA_SHAPE::m_bezierPoints, EDA_SHAPE::m_poly, EDA_SHAPE::m_shape, SHAPE_LINE_CHAIN::Move(), EDA_RECT::Normalize(), SHAPE_POLY_SET::Outline(), POLY, RECT, SHAPE_LINE_CHAIN::Rotate(), SEGMENT, EDA_SHAPE::SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const

inlineinherited

Definition at line 125 of file eda_item.h.

{ return m_flags & BRIGHTENED; }

References BRIGHTENED, and EDA_ITEM::m_flags.

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), KIGFX::SCH_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::draw(), KIGFX::DS_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), KIGFX::SCH_PAINTER::getRenderColor(), SCH_EDITOR_CONTROL::UpdateFind(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

IsDragging()

bool EDA_ITEM::IsDragging ( ) const

inlineinherited

Definition at line 120 of file eda_item.h.

{ return m_flags & IS_DRAGGING; }

References IS_DRAGGING, and EDA_ITEM::m_flags.

Referenced by DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES().

IsEntered()

bool EDA_ITEM::IsEntered ( ) const

inlineinherited

Definition at line 123 of file eda_item.h.

{ return m_flags & ENTERED; }

References ENTERED, and EDA_ITEM::m_flags.

Referenced by KIGFX::PCB_PAINTER::draw().

IsFilled()

bool EDA_SHAPE::IsFilled ( ) const

inlineinherited

Definition at line 90 of file eda_shape.h.

{ return GetFillType() != FILL_T::NO_FILL; }

References EDA_SHAPE::GetFillType(), and NO_FILL.

Referenced by BOARD_ADAPTER::addShapeWithClearance(), KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), PCB_PLUGIN::format(), FOOTPRINT::GetCoverageArea(), PCB_SHAPE::GetFocusPosition(), hash_fp_item(), EDA_SHAPE::hitTest(), EDA_SHAPE::MakeEffectiveShapes(), PCB_PARSER::parsePAD(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), BRDITEMS_PLOTTER::PlotPcbShape(), print(), KIGFX::SCH_PAINTER::setDeviceColors(), PNS_KICAD_IFACE_BASE::syncGraphicalItem(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataToWindow(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::TransferDataToWindow(), and EDA_SHAPE::TransformShapeWithClearanceToPolygon().

IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const

inlineinherited

Definition at line 205 of file eda_item.h.

{ return m_forceVisible; }

References EDA_ITEM::m_forceVisible.

Referenced by KIGFX::SCH_PAINTER::draw(), and SCH_FIELD::Print().

IsModified()

bool EDA_ITEM::IsModified ( ) const

inlineinherited

Definition at line 117 of file eda_item.h.

{ return m_flags & IS_CHANGED; }

References IS_CHANGED, and EDA_ITEM::m_flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

IsMoving()

bool EDA_ITEM::IsMoving ( ) const

inlineinherited

Definition at line 119 of file eda_item.h.

{ return m_flags & IS_MOVING; }

References IS_MOVING, and EDA_ITEM::m_flags.

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_EDIT_TOOL::AutoplaceFields(), CalcArcAngles(), LIB_PIN::CalcEdit(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), SCH_EDIT_TOOL::Mirror(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_EDIT_TOOL::Rotate(), and SCH_EDIT_TOOL::Rotate().

IsNew()

bool EDA_ITEM::IsNew ( ) const

inlineinherited

Definition at line 118 of file eda_item.h.

{ return m_flags & IS_NEW; }

References IS_NEW, and EDA_ITEM::m_flags.

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_EDIT_TOOL::ConvertDeMorgan(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), EDIT_TOOL::DragArcTrack(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), SYMBOL_EDITOR_DRAWING_TOOLS::Init(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus(), EE_POINT_EDITOR::Main(), PL_POINT_EDITOR::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), SCH_MOVE_TOOL::Main(), EDIT_TOOL::MoveExact(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SCH_EDIT_FRAME::SaveSymbolToSchematic(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_AND_LABEL_PROPERTIES::TransferDataFromWindow(), and DIALOG_SHEET_PROPERTIES::TransferDataFromWindow().

IsPolyShapeValid()

bool EDA_SHAPE::IsPolyShapeValid ( ) const

inherited

Returns

true if the polygonal shape is valid (has more than 2 points)

Definition at line 1210 of file eda_shape.cpp.

{
 // return true if the polygonal shape is valid (has more than 2 points)
 if( GetPolyShape().OutlineCount() == 0 )
 return false;

 const SHAPE_LINE_CHAIN& outline = ( (SHAPE_POLY_SET&)GetPolyShape() ).Outline( 0 );

 return outline.PointCount() > 2;
}

References EDA_SHAPE::GetPolyShape(), and SHAPE_LINE_CHAIN::PointCount().

Referenced by PCB_PLUGIN::format(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), BRDITEMS_PLOTTER::PlotPcbShape(), and EDA_SHAPE::TransformShapeWithClearanceToPolygon().

IsReplaceable()

virtual bool EDA_ITEM::IsReplaceable ( ) const

inlinevirtualinherited

Override this method in any derived object that supports test find and replace.

Returns

True if the item has replaceable text that can be modified using the find and replace dialog.

Reimplemented in SCH_SYMBOL, SCH_SHEET, SCH_LABEL, SCH_TEXT, SCH_FIELD, and SCH_SHEET_PIN.

Definition at line 402 of file eda_item.h.

{ return false; }

Referenced by EDA_ITEM::Matches().

IsResized()

bool EDA_ITEM::IsResized ( ) const

inlineinherited

Definition at line 124 of file eda_item.h.

{ return m_flags & IS_RESIZING; }

References IS_RESIZING, and EDA_ITEM::m_flags.

IsSelected()

bool EDA_ITEM::IsSelected ( ) const

inlineinherited

Definition at line 122 of file eda_item.h.

{ return m_flags & SELECTED; }

References EDA_ITEM::m_flags, and SELECTED.

Referenced by ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), SCH_EDIT_FRAME::ConvertPart(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::Draw(), KIGFX::PCB_PAINTER::draw(), DS_PROXY_UNDO_ITEM::DS_PROXY_UNDO_ITEM(), KIGFX::DS_RENDER_SETTINGS::GetColor(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), SCH_MOVE_TOOL::getConnectedDragItems(), KIGFX::SCH_PAINTER::getLineWidth(), KIGFX::SCH_PAINTER::getRenderColor(), KIGFX::SCH_PAINTER::getTextThickness(), DIALOG_EXCHANGE_FOOTPRINTS::isMatch(), DIALOG_CHANGE_SYMBOLS::isMatch(), SCH_LINE::MergeOverlap(), SCH_EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), SCH_MOVE_TOOL::moveItem(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), BOARD_COMMIT::Push(), PCB_SELECTION_TOOL::RebuildSelection(), EE_SELECTION_TOOL::RebuildSelection(), RENDER_3D_OPENGL::renderFootprint(), SCH_EDIT_TOOL::Rotate(), EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList(), SCH_EDIT_FRAME::SchematicCleanUp(), GERBVIEW_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::selectionContains(), PCB_SELECTION_TOOL::selectMultiple(), GERBVIEW_SELECTION_TOOL::selectPoint(), KIGFX::SCH_PAINTER::setDeviceColors(), GERBVIEW_SELECTION_TOOL::unselect(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

IsType()

virtual bool EDA_ITEM::IsType ( const KICAD_T  aScanTypes[] ) const

inlinevirtualinherited

Check whether the item is one of the listed types.

Parameters

aScanTypes

List of item types

Returns

true if the item type is contained in the list aScanTypes

Reimplemented in PCB_VIA, SCH_LABEL, PCB_DIMENSION_BASE, PAD, SCH_FIELD, FP_TEXT, SCH_LINE, PCB_SHAPE, FP_SHAPE, and PCB_TEXT.

Definition at line 182 of file eda_item.h.

 {
 if( aScanTypes[0] == SCH_LOCATE_ANY_T )
 return true;

 for( const KICAD_T* p = aScanTypes; *p != EOT; ++p )
 {
 if( m_structType == *p )
 return true;
 }

 return false;
 }

References EOT, EDA_ITEM::m_structType, and SCH_LOCATE_ANY_T.

Referenced by SCH_EDIT_TOOL::AutoplaceFields(), ROUTER_TOOL::CanInlineDrag(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingBus(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLine(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingWire(), PCB_TEXT::IsType(), FP_SHAPE::IsType(), PCB_SHAPE::IsType(), SCH_LINE::IsType(), FP_TEXT::IsType(), SCH_FIELD::IsType(), PAD::IsType(), PCB_DIMENSION_BASE::IsType(), SCH_LABEL::IsType(), PCB_VIA::IsType(), EE_POINT_EDITOR::Main(), PL_POINT_EDITOR::Main(), EE_SELECTION_TOOL::RequestSelection(), SCH_BASE_FRAME::UpdateItem(), EDA_ITEM::Visit(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

IsWireImage()

bool EDA_ITEM::IsWireImage ( ) const

inlineinherited

Definition at line 121 of file eda_item.h.

{ return m_flags & IS_WIRE_IMAGE; }

References IS_WIRE_IMAGE, and EDA_ITEM::m_flags.

IterateForward() [1/2]

template<class T >

static SEARCH_RESULT EDA_ITEM::IterateForward ( std::deque< T > &  aList, INSPECTOR  inspector, void *  testData, const KICAD_T  scanTypes[]  )

inlinestaticinherited

This changes first parameter to avoid the DList and use the main queue instead.

Definition at line 294 of file eda_item.h.

 {
 for( auto it : aList )
 {
 if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
 == SEARCH_RESULT::QUIT )
 return SEARCH_RESULT::QUIT;
 }

 return SEARCH_RESULT::CONTINUE;
 }

References CONTINUE, QUIT, and EDA_ITEM::Visit().

Referenced by GERBER_FILE_IMAGE::Visit().

IterateForward() [2/2]

template<class T >

static SEARCH_RESULT EDA_ITEM::IterateForward ( std::vector< T > &  aList, INSPECTOR  inspector, void *  testData, const KICAD_T  scanTypes[]  )

inlinestaticinherited

Change first parameter to avoid the DList and use std::vector instead.

Definition at line 313 of file eda_item.h.

 {
 for( auto it : aList )
 {
 if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
 == SEARCH_RESULT::QUIT )
 return SEARCH_RESULT::QUIT;
 }

 return SEARCH_RESULT::CONTINUE;
 }

References CONTINUE, QUIT, and EDA_ITEM::Visit().

MakeEffectiveShapes()

std::vector< SHAPE * > EDA_SHAPE::MakeEffectiveShapes ( ) const

inherited

Make a set of SHAPE objects representing the EDA_SHAPE.

Caller owns the objects.

Definition at line 1095 of file eda_shape.cpp.

{
 std::vector<SHAPE*> effectiveShapes;

 switch( m_shape )
 {
 case SHAPE_T::ARC:
 effectiveShapes.emplace_back( new SHAPE_ARC( m_arcCenter, m_start, GetArcAngle() / 10.0,
 m_width ) );
 break;

 case SHAPE_T::SEGMENT:
 effectiveShapes.emplace_back( new SHAPE_SEGMENT( m_start, m_end, m_width ) );
 break;

 case SHAPE_T::RECT:
 {
 std::vector<wxPoint> pts = GetRectCorners();

 if( IsFilled() )
 effectiveShapes.emplace_back( new SHAPE_SIMPLE( pts ) );

 if( m_width > 0 || !IsFilled() )
 {
 effectiveShapes.emplace_back( new SHAPE_SEGMENT( pts[0], pts[1], m_width ) );
 effectiveShapes.emplace_back( new SHAPE_SEGMENT( pts[1], pts[2], m_width ) );
 effectiveShapes.emplace_back( new SHAPE_SEGMENT( pts[2], pts[3], m_width ) );
 effectiveShapes.emplace_back( new SHAPE_SEGMENT( pts[3], pts[0], m_width ) );
 }
 }
 break;

 case SHAPE_T::CIRCLE:
 {
 if( IsFilled() )
 effectiveShapes.emplace_back( new SHAPE_CIRCLE( getCenter(), GetRadius() ) );

 if( m_width > 0 || !IsFilled() )
 {
 // SHAPE_CIRCLE has no ConvertToPolyline() method, so use a 360.0 SHAPE_ARC
 SHAPE_ARC circle( getCenter(), GetEnd(), 360.0 );
 SHAPE_LINE_CHAIN l = circle.ConvertToPolyline();

 for( int i = 0; i < l.SegmentCount(); i++ )
 {
 effectiveShapes.emplace_back( new SHAPE_SEGMENT( l.Segment( i ).A, l.Segment( i ).B,
 m_width ) );
 }
 }

 break;
 }

 case SHAPE_T::BEZIER:
 {
 auto bezierPoints = buildBezierToSegmentsPointsList( GetWidth() );
 wxPoint start_pt = bezierPoints[0];

 for( unsigned int jj = 1; jj < bezierPoints.size(); jj++ )
 {
 wxPoint end_pt = bezierPoints[jj];
 effectiveShapes.emplace_back( new SHAPE_SEGMENT( start_pt, end_pt, m_width ) );
 start_pt = end_pt;
 }

 break;
 }

 case SHAPE_T::POLY:
 {
 if( GetPolyShape().OutlineCount() == 0 ) // malformed/empty polygon
 break;

 SHAPE_LINE_CHAIN l = GetPolyShape().COutline( 0 );

 l.Rotate( -DECIDEG2RAD( getParentOrientation() ) );
 l.Move( getParentPosition() );

 if( IsFilled() )
 effectiveShapes.emplace_back( new SHAPE_SIMPLE( l ) );

  if( m_width > 0 || !IsFilled() )
 {
 for( int i = 0; i < l.SegmentCount(); i++ )
 effectiveShapes.emplace_back( new SHAPE_SEGMENT( l.Segment( i ), m_width ) );
 }
 }
 break;

 default:
 UNIMPLEMENTED_FOR( SHAPE_T_asString() );
 break;
 }

 return effectiveShapes;
}

References SEG::A, ARC, SEG::B, BEZIER, EDA_SHAPE::buildBezierToSegmentsPointsList(), CIRCLE, SHAPE_ARC::ConvertToPolyline(), SHAPE_POLY_SET::COutline(), DECIDEG2RAD(), EDA_SHAPE::GetArcAngle(), EDA_SHAPE::getCenter(), EDA_SHAPE::GetEnd(), EDA_SHAPE::getParentOrientation(), EDA_SHAPE::getParentPosition(), EDA_SHAPE::GetPolyShape(), EDA_SHAPE::GetRadius(), EDA_SHAPE::GetRectCorners(), EDA_SHAPE::GetWidth(), EDA_SHAPE::IsFilled(), EDA_SHAPE::m_arcCenter, EDA_SHAPE::m_end, EDA_SHAPE::m_shape, EDA_SHAPE::m_start, EDA_SHAPE::m_width, SHAPE_LINE_CHAIN::Move(), POLY, RECT, SHAPE_LINE_CHAIN::Rotate(), SEGMENT, SHAPE_LINE_CHAIN::Segment(), SHAPE_LINE_CHAIN::SegmentCount(), EDA_SHAPE::SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

Referenced by PCB_SHAPE::GetEffectiveShape(), and PNS_KICAD_IFACE_BASE::syncGraphicalItem().

Matches() [1/2]

virtual bool EDA_ITEM::Matches ( const wxFindReplaceData &  aSearchData, void *  aAuxData  ) const

inlinevirtualinherited

Compare the item against the search criteria in aSearchData.

The base class returns false since many of the objects derived from EDA_ITEM do not have any text to search.

Parameters

aSearchData	A reference to a wxFindReplaceData object containing the search criteria.
aAuxData	A pointer to optional data required for the search or NULL if not used.

Returns

True if the item's text matches the search criteria in aSearchData.

Reimplemented in SCH_SYMBOL, SCH_SHEET, SCH_TEXT, SCH_FIELD, SCH_SHEET_PIN, ZONE, SCH_PIN, PCB_MARKER, SCH_MARKER, FP_TEXT, and PCB_TEXT.

Definition at line 364 of file eda_item.h.

 {
 return false;
 }

Referenced by SCH_EDITOR_CONTROL::HasMatch(), PCB_TEXT::Matches(), FP_TEXT::Matches(), SCH_MARKER::Matches(), PCB_MARKER::Matches(), SCH_PIN::Matches(), ZONE::Matches(), SCH_SHEET_PIN::Matches(), SCH_FIELD::Matches(), SCH_TEXT::Matches(), SCH_EDITOR_CONTROL::ReplaceAndFindNext(), and SCH_EDITOR_CONTROL::UpdateFind().

Matches() [2/2]

bool EDA_ITEM::Matches ( const wxString &  aText, const wxFindReplaceData &  aSearchData  ) const

protectedinherited

Compare aText against search criteria in aSearchData.

This is a helper function for simplify derived class logic.

Parameters

aText	A reference to a wxString object containing the string to test.
aSearchData	The criteria to search against.

Returns

True if aText matches the search criteria in aSearchData.

Definition at line 118 of file eda_item.cpp.

{
 wxString text = aText;
 int flags = aSearchData.GetFlags();
 wxString searchText = aSearchData.GetFindString();

 // Don't match if searching for replaceable item and the item doesn't support text replace.
 if( ( flags & FR_SEARCH_REPLACE ) && !IsReplaceable() )
 return false;

 if( !( flags & wxFR_MATCHCASE ) )
 {
 text.MakeUpper();
 searchText.MakeUpper();
 }

 if( flags & wxFR_WHOLEWORD )
 {
 int ii = 0;

 while( ii < (int) text.length() )
 {
 int next = text.find( searchText, ii );

 if( next == wxNOT_FOUND )
 return false;

 ii = next;
 next += searchText.length();

 bool startOK = ( ii == 0 || !wxIsalnum( text.GetChar( ii - 1 ) ) );
 bool endOK = ( next == (int) text.length() || !wxIsalnum( text.GetChar( next ) ) );

 if( startOK && endOK )
 return true;
 else
 ii++;
 }

 return false;
 }
 else if( flags & FR_MATCH_WILDCARD )
 {
 return text.Matches( searchText );
 }
 else
 {
 return text.Find( searchText ) != wxNOT_FOUND;
 }
}

References FR_MATCH_WILDCARD, FR_SEARCH_REPLACE, EDA_ITEM::IsReplaceable(), next(), and text.

MirrorHorizontal()

void LIB_SHAPE::MirrorHorizontal ( const wxPoint &  aCenter )

overridevirtual

Mirror the draw object along the horizontal (X) axis about aCenter point.

Parameters

aCenter

Point to mirror around.

Implements LIB_ITEM.

Definition at line 92 of file lib_shape.cpp.

{
 flip( aCenter, true );
}

References EDA_SHAPE::flip().

MirrorVertical()

void LIB_SHAPE::MirrorVertical ( const wxPoint &  aCenter )

overridevirtual

Mirror the draw object along the MirrorVertical (Y) axis about aCenter point.

Parameters

aCenter

Point to mirror around.

Implements LIB_ITEM.

Definition at line 98 of file lib_shape.cpp.

{
 flip( aCenter, false );
}

References EDA_SHAPE::flip().

move()

void EDA_SHAPE::move ( const wxPoint &  aMoveVector )

protectedinherited

Definition at line 137 of file eda_shape.cpp.

{
 switch ( m_shape )
 {
 case SHAPE_T::ARC:
 case SHAPE_T::SEGMENT:
 case SHAPE_T::RECT:
 case SHAPE_T::CIRCLE:
 m_start += aMoveVector;
 m_end += aMoveVector;
 m_arcCenter += aMoveVector;
 break;

 case SHAPE_T::POLY:
 m_poly.Move( VECTOR2I( aMoveVector ) );
 break;

 case SHAPE_T::BEZIER:
 m_start += aMoveVector;
 m_end += aMoveVector;
 m_bezierC1 += aMoveVector;
 m_bezierC2 += aMoveVector;

 for( wxPoint& pt : m_bezierPoints)
 pt += aMoveVector;

 break;

 default:
 UNIMPLEMENTED_FOR( SHAPE_T_asString() );
 break;
 }
}

References ARC, BEZIER, CIRCLE, EDA_SHAPE::m_arcCenter, EDA_SHAPE::m_bezierC1, EDA_SHAPE::m_bezierC2, EDA_SHAPE::m_bezierPoints, EDA_SHAPE::m_end, EDA_SHAPE::m_poly, EDA_SHAPE::m_shape, EDA_SHAPE::m_start, SHAPE_POLY_SET::Move(), POLY, RECT, SEGMENT, EDA_SHAPE::SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

Referenced by PCB_SHAPE::Move(), Offset(), and EDA_SHAPE::setPosition().

MoveTo()

void LIB_SHAPE::MoveTo ( const wxPoint &  aPosition )

overridevirtual

Move a draw object to aPosition.

Parameters

aPosition

Position to move draw item to.

Implements LIB_ITEM.

Definition at line 86 of file lib_shape.cpp.

{
 setPosition( aPosition );
}

References EDA_SHAPE::setPosition().

Offset()

void LIB_SHAPE::Offset ( const wxPoint &  aOffset )

overridevirtual

Set the drawing object by aOffset from the current position.

Parameters

aOffset

Coordinates to offset the item position.

Implements LIB_ITEM.

Definition at line 80 of file lib_shape.cpp.

{
 move( aOffset );
}

References EDA_SHAPE::move().

operator<() [1/2]

bool LIB_ITEM::operator< ( const LIB_ITEM &  aOther ) const

inherited

Test if another draw item is less than this draw object.

Parameters

aOther

- Draw item to compare against.

Returns

- True if object is less than this object.

Definition at line 92 of file lib_item.cpp.

{
 if( Type() != aOther.Type() )
 return Type() < aOther.Type();

 return ( compare( aOther ) < 0 );
}

References LIB_ITEM::compare(), and EDA_ITEM::Type().

operator<() [2/2]

bool EDA_ITEM::operator< ( const EDA_ITEM &  aItem ) const

inherited

Test if another item is less than this object.

Parameters

aItem

- Item to compare against.

Returns

- True if aItem is less than the item.

Definition at line 234 of file eda_item.cpp.

{
 wxFAIL_MSG( wxString::Format( wxT( "Less than operator not defined for item type %s." ),
 GetClass() ) );

 return false;
}

References Format(), and EDA_ITEM::GetClass().

operator==() [1/2]

bool LIB_ITEM::operator== ( const LIB_ITEM &  aOther ) const

inherited

Test LIB_ITEM objects for equivalence.

Parameters

aOther

Object to test against.

Returns

True if object is identical to this object.

Definition at line 83 of file lib_item.cpp.

{
 if( Type() != aOther.Type() )
 return false;

 return compare( aOther, LIB_ITEM::COMPARE_FLAGS::EQUALITY ) == 0;
}

References LIB_ITEM::compare(), and EDA_ITEM::Type().

operator==() [2/2]

bool LIB_ITEM::operator== ( const LIB_ITEM *  aOther ) const

inlineinherited

Definition at line 203 of file lib_item.h.

 {
 return *this == *aOther;
 }

Plot()

void LIB_SHAPE::Plot ( PLOTTER *  aPlotter, const wxPoint &  aOffset, bool  aFill, const TRANSFORM &  aTransform  ) const

overridevirtual

Plot the draw item using the plot object.

Parameters

aPlotter	The plot object to plot to.
aOffset	Plot offset position.
aFill	Flag to indicate whether or not the object is filled.
aTransform	The plot transform.

Implements LIB_ITEM.

Definition at line 112 of file lib_shape.cpp.

{
 wxPoint start = aTransform.TransformCoordinate( m_start ) + aOffset;
 wxPoint end = aTransform.TransformCoordinate( m_end ) + aOffset;
 wxPoint center;
 int startAngle = 0;
 int endAngle = 0;
 int pen_size = GetEffectivePenWidth( aPlotter->RenderSettings() );
 FILL_T fill = aFill ? m_fill : FILL_T::NO_FILL;

 static std::vector<wxPoint> cornerList;

 if( GetShape() == SHAPE_T::POLY )
 {
 const SHAPE_LINE_CHAIN& poly = m_poly.Outline( 0 );
 cornerList.clear();

 for( const VECTOR2I& pt : poly.CPoints() )
 cornerList.push_back( aTransform.TransformCoordinate( (wxPoint) pt ) + aOffset );
 }
 else if( GetShape() == SHAPE_T::BEZIER )
 {
 cornerList.clear();

 for( const wxPoint& pt : m_bezierPoints )
 cornerList.push_back( aTransform.TransformCoordinate( pt ) + aOffset );
 }
 else if( GetShape() == SHAPE_T::ARC )
 {
 center = aTransform.TransformCoordinate( getCenter() ) + aOffset;

 CalcArcAngles( startAngle, endAngle );
 aTransform.MapAngles( &startAngle, &endAngle );
 }

 if( fill == FILL_T::FILLED_WITH_BG_BODYCOLOR )
 {
 aPlotter->SetColor( aPlotter->RenderSettings()->GetLayerColor( LAYER_DEVICE_BACKGROUND ) );

 switch( GetShape() )
 {
 case SHAPE_T::ARC:
 aPlotter->Arc( center, -endAngle, -startAngle, GetRadius(), fill, 0 );
 break;

 case SHAPE_T::CIRCLE:
 aPlotter->Circle( start, GetRadius() * 2, fill, 0 );
 break;

 case SHAPE_T::RECT:
 aPlotter->Rect( start, end, fill, 0 );
 break;

 case SHAPE_T::POLY:
 case SHAPE_T::BEZIER:
 aPlotter->PlotPoly( cornerList, fill, 0 );
 break;

 default:
 UNIMPLEMENTED_FOR( SHAPE_T_asString() );
 }

 if( pen_size <= 0 )
 return;
 else
 fill = FILL_T::NO_FILL;
 }

 aPlotter->SetColor( aPlotter->RenderSettings()->GetLayerColor( LAYER_DEVICE ) );

 switch( GetShape() )
 {
 case SHAPE_T::ARC:
 aPlotter->Arc( center, -endAngle, -startAngle, GetRadius(), fill, pen_size );
 break;

 case SHAPE_T::CIRCLE:
 aPlotter->Circle( start, GetRadius() * 2, fill, pen_size );
 break;

 case SHAPE_T::RECT:
 aPlotter->Rect( start, end, fill, pen_size );
 break;

 case SHAPE_T::POLY:
 case SHAPE_T::BEZIER:
 aPlotter->PlotPoly( cornerList, fill, pen_size );
 break;

 default:
 UNIMPLEMENTED_FOR( SHAPE_T_asString() );
 }
}

References ARC, PLOTTER::Arc(), BEZIER, CalcArcAngles(), CIRCLE, PLOTTER::Circle(), SHAPE_LINE_CHAIN::CPoints(), FILLED_WITH_BG_BODYCOLOR, EDA_SHAPE::getCenter(), GetEffectivePenWidth(), KIGFX::RENDER_SETTINGS::GetLayerColor(), EDA_SHAPE::GetRadius(), EDA_SHAPE::GetShape(), LAYER_DEVICE, LAYER_DEVICE_BACKGROUND, EDA_SHAPE::m_bezierPoints, EDA_SHAPE::m_end, EDA_SHAPE::m_fill, EDA_SHAPE::m_poly, EDA_SHAPE::m_start, TRANSFORM::MapAngles(), NO_FILL, SHAPE_POLY_SET::Outline(), PLOTTER::PlotPoly(), POLY, RECT, PLOTTER::Rect(), PLOTTER::RenderSettings(), PLOTTER::SetColor(), EDA_SHAPE::SHAPE_T_asString(), TRANSFORM::TransformCoordinate(), and UNIMPLEMENTED_FOR.

Referenced by LIB_SYMBOL::Plot().

print()

void LIB_SHAPE::print ( const RENDER_SETTINGS *  aSettings, const wxPoint &  aOffset, void *  aData, const TRANSFORM &  aTransform  )

overrideprivatevirtual

Print the item to aDC.

Parameters

aOffset	A reference to a wxPoint object containing the offset where to draw from the object's current position.
aData	A pointer to any object specific data required to perform the draw.
aTransform	A reference to a TRANSFORM object containing drawing transform.

Implements LIB_ITEM.

Definition at line 214 of file lib_shape.cpp.

{
 bool forceNoFill = static_cast<bool>( aData );
 int penWidth = GetEffectivePenWidth( aSettings );

 if( forceNoFill && IsFilled() && penWidth == 0 )
 return;

 wxDC* DC = aSettings->GetPrintDC();
 wxPoint pt1 = aTransform.TransformCoordinate( m_start ) + aOffset;
 wxPoint pt2 = aTransform.TransformCoordinate( m_end ) + aOffset;
 wxPoint c;
 COLOR4D color = aSettings->GetLayerColor( LAYER_DEVICE );
 COLOR4D fillColor = color;

 unsigned ptCount = 0;
 wxPoint* buffer = nullptr;

 if( GetShape() == SHAPE_T::POLY )
 {
 const SHAPE_LINE_CHAIN& poly = m_poly.Outline( 0 );

 ptCount = poly.GetPointCount();
 buffer = new wxPoint[ ptCount ];

 for( unsigned ii = 0; ii < ptCount; ++ii )
 buffer[ii] = aTransform.TransformCoordinate( (wxPoint) poly.CPoint( ii ) ) + aOffset;
 }
 else if( GetShape() == SHAPE_T::BEZIER )
 {
 ptCount = m_bezierPoints.size();
 buffer = new wxPoint[ ptCount ];

 for( size_t ii = 0; ii < ptCount; ++ii )
 buffer[ii] = aTransform.TransformCoordinate( m_bezierPoints[ii] ) + aOffset;
 }
 else if( GetShape() == SHAPE_T::ARC )
 {
 c = aTransform.TransformCoordinate( getCenter() ) + aOffset;

 int t1, t2;

 CalcArcAngles( t1, t2 );

 // N.B. The order of evaluation is critical here as MapAngles will modify t1, t2
 // and the Normalize routine depends on these modifications for the correct output
 bool transformed = aTransform.MapAngles( &t1, &t2 );
 bool transformed2 = ( NormalizeAngle180( t1 - t2 ) > 0 );

 if( transformed == transformed2 )
 std::swap( pt1, pt2 );
 }

 if( forceNoFill || GetFillType() == FILL_T::NO_FILL )
 {
 penWidth = std::max( penWidth, aSettings->GetDefaultPenWidth() );

 switch( GetShape() )
 {
 case SHAPE_T::ARC:
 GRArc1( nullptr, DC, pt1, pt2, c, penWidth, color );
 break;

 case SHAPE_T::CIRCLE:
 GRCircle( nullptr, DC, pt1.x, pt1.y, GetRadius(), penWidth, color );
 break;

 case SHAPE_T::RECT:
 GRRect( nullptr, DC, pt1.x, pt1.y, pt2.x, pt2.y, penWidth, color );
 break;

 case SHAPE_T::POLY:
 GRPoly( nullptr, DC, ptCount, buffer, false, penWidth, color, color );
 break;

 case SHAPE_T::BEZIER:
 GRPoly( nullptr, DC, ptCount, buffer, false, penWidth, color, color );
 break;

 default:
 UNIMPLEMENTED_FOR( SHAPE_T_asString() );
 }
 }
 else
 {
 if( GetFillType() == FILL_T::FILLED_WITH_BG_BODYCOLOR )
 fillColor = aSettings->GetLayerColor( LAYER_DEVICE_BACKGROUND );

 switch( GetShape() )
 {
 case SHAPE_T::ARC:
 // If we stroke in GRFilledArc it will stroke the two radials too, so we have to
 // fill and stroke separately

 GRFilledArc1( nullptr, DC, pt1, pt2, c, 0, fillColor, fillColor );

 GRArc1( nullptr, DC, pt1, pt2, c, penWidth, color );
 break;

 case SHAPE_T::CIRCLE:
 GRFilledCircle( nullptr, DC, pt1.x, pt1.y, GetRadius(), 0, color, fillColor );
 break;

 case SHAPE_T::RECT:
 GRFilledRect( nullptr, DC, pt1.x, pt1.y, pt2.x, pt2.y, penWidth, color, fillColor );
 break;

 case SHAPE_T::POLY:

 GRPoly( nullptr, DC, ptCount, buffer, true, 0, fillColor, fillColor );

 if( penWidth > 0 )
 GRPoly( nullptr, DC, ptCount, buffer, false, penWidth, color, fillColor );

 break;

 case SHAPE_T::BEZIER:
 if( penWidth > 0 )
 GRPoly( nullptr, DC, ptCount, buffer, true, penWidth, color, fillColor );
 else
 GRPoly( nullptr, DC, ptCount, buffer, true, 0, fillColor, fillColor );
 break;

 default:
 UNIMPLEMENTED_FOR( SHAPE_T_asString() );
 }
 }

 delete[] buffer;
}

References ARC, BEZIER, CalcArcAngles(), CIRCLE, color, SHAPE_LINE_CHAIN::CPoint(), FILLED_WITH_BG_BODYCOLOR, EDA_SHAPE::getCenter(), KIGFX::RENDER_SETTINGS::GetDefaultPenWidth(), GetEffectivePenWidth(), EDA_SHAPE::GetFillType(), KIGFX::RENDER_SETTINGS::GetLayerColor(), SHAPE_LINE_CHAIN::GetPointCount(), KIGFX::RENDER_SETTINGS::GetPrintDC(), EDA_SHAPE::GetRadius(), EDA_SHAPE::GetShape(), GRArc1(), GRCircle(), GRFilledArc1(), GRFilledCircle(), GRFilledRect(), GRPoly(), GRRect(), EDA_SHAPE::IsFilled(), LAYER_DEVICE, LAYER_DEVICE_BACKGROUND, EDA_SHAPE::m_bezierPoints, EDA_SHAPE::m_end, EDA_SHAPE::m_poly, EDA_SHAPE::m_start, TRANSFORM::MapAngles(), NO_FILL, NormalizeAngle180(), SHAPE_POLY_SET::Outline(), POLY, RECT, EDA_SHAPE::SHAPE_T_asString(), TRANSFORM::TransformCoordinate(), and UNIMPLEMENTED_FOR.

Print()

void LIB_ITEM::Print ( const RENDER_SETTINGS *  aSettings, const wxPoint &  aOffset, void *  aData, const TRANSFORM &  aTransform  )

virtualinherited

Draw an item.

Parameters

aDC	Device Context (can be null)
aOffset	Offset to draw
aData	Value or pointer used to pass others parameters, depending on body items. Used for some items to force to force no fill mode ( has meaning only for items what can be filled ). used in printing or moving objects mode or to pass reference to the lib symbol for pins.
aTransform	Transform Matrix (rotation, mirror ..)

Definition at line 118 of file lib_item.cpp.

{
 print( aSettings, aOffset, aData, aTransform );
}

References LIB_ITEM::print().

Referenced by DIALOG_PIN_PROPERTIES::OnPaintShowPanel(), and LIB_SYMBOL::Print().

RebuildBezierToSegmentsPointsList()

void EDA_SHAPE::RebuildBezierToSegmentsPointsList ( int  aMinSegLen )

inherited

Rebuild the m_bezierPoints vertex list that approximate the Bezier curve by a list of segments.

Has meaning only for BEZIER shape.

Parameters

aMinSegLen

is the min length of segments approximating the bezier. The shape's last segment can be shorter. This parameter avoids having too many very short segment in list. Good values are between m_width/2 and m_width.

Definition at line 366 of file eda_shape.cpp.

{
 // Has meaning only for S_CURVE DRAW_SEGMENT shape
 if( m_shape != SHAPE_T::BEZIER )
 {
 m_bezierPoints.clear();
 return;
 }

 // Rebuild the m_BezierPoints vertex list that approximate the Bezier curve
 m_bezierPoints = buildBezierToSegmentsPointsList( aMinSegLen );
}

References BEZIER, EDA_SHAPE::buildBezierToSegmentsPointsList(), EDA_SHAPE::m_bezierPoints, and EDA_SHAPE::m_shape.

Referenced by ConvertOutlineToPolygon(), FP_SHAPE::Flip(), GRAPHICS_CLEANER::isNullShape(), SCH_LEGACY_PLUGIN_CACHE::loadBezier(), FP_SHAPE::Mirror(), FP_SHAPE::SetDrawCoord(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), and PCB_POINT_EDITOR::updateItem().

Replace() [1/2]

bool EDA_ITEM::Replace ( const wxFindReplaceData &  aSearchData, wxString &  aText  )

staticinherited

Perform a text replace on aText using the find and replace criteria in aSearchData on items that support text find and replace.

Parameters

aSearchData	A reference to a wxFindReplaceData object containing the search and replace criteria.
aText	A reference to a wxString object containing the text to be replaced.

Returns

True if aText was modified, otherwise false.

Definition at line 170 of file eda_item.cpp.

{
 wxString text = aText;
 int flags = aSearchData.GetFlags();
 wxString searchText = aSearchData.GetFindString();
 wxString result;
 bool replaced = false;

 if( flags & wxFR_MATCHCASE )
 {
 text = text.Upper();
 searchText = searchText.Upper();
 }

 int ii = 0;

 while( ii < (int) text.length() )
 {
 int next = text.find( searchText, ii );

 if( next == wxNOT_FOUND )
 {
 result += aText.Mid( ii, wxString::npos );
 break;
 }

 if( next > ii )
 result += aText.Mid( ii, next - ii );

 ii = next;
 next += searchText.length();

 bool startOK;
 bool endOK;

 if( flags & wxFR_WHOLEWORD )
 {
 startOK = ( ii == 0 || !wxIsalnum( text.GetChar( ii - 1 ) ) );
 endOK = ( next == (int) text.length() || !wxIsalnum( text.GetChar( next ) ) );
 }
 else
 {
 startOK = true;
 endOK = true;
 }

 if( startOK && endOK )
 {
 result += aSearchData.GetReplaceString();
 replaced = true;
 ii = next;
 }
 else
 {
 result += aText.GetChar( ii );
 ii++;
 }
 }

 aText = result;
 return replaced;
}

References next(), and text.

Referenced by SCH_FIELD::Replace(), EDA_TEXT::Replace(), SCH_EDITOR_CONTROL::ReplaceAll(), and SCH_EDITOR_CONTROL::ReplaceAndFindNext().

Replace() [2/2]

virtual bool EDA_ITEM::Replace ( const wxFindReplaceData &  aSearchData, void *  aAuxData = nullptr  )

inlinevirtualinherited

Perform a text replace using the find and replace criteria in aSearchData on items that support text find and replace.

This function must be overridden for items that support text replace.

Parameters

aSearchData	A reference to a wxFindReplaceData object containing the search and replace criteria.
aAuxData	A pointer to optional data required for the search or NULL if not used.

Returns

True if the item text was modified, otherwise false.

Reimplemented in SCH_TEXT, SCH_FIELD, SCH_SHEET_PIN, and SCH_PIN.

Definition at line 391 of file eda_item.h.

 {
 return false;
 }

Rotate()

void LIB_SHAPE::Rotate ( const wxPoint &  aCenter, bool  aRotateCCW = true  )

overridevirtual

Rotate the object about aCenter point.

Parameters

aCenter	Point to rotate around.
aRotateCCW	True to rotate counter clockwise. False to rotate clockwise.

Implements LIB_ITEM.

Definition at line 104 of file lib_shape.cpp.

{
 int rot_angle = aRotateCCW ? -900 : 900;

 rotate( aCenter, rot_angle );
}

References EDA_SHAPE::rotate().

rotate()

void EDA_SHAPE::rotate ( const wxPoint &  aRotCentre, double  aAngle  )

protectedinherited

Definition at line 224 of file eda_shape.cpp.

{
 switch( m_shape )
 {
 case SHAPE_T::SEGMENT:
 case SHAPE_T::CIRCLE:
 RotatePoint( &m_start, aRotCentre, aAngle );
 RotatePoint( &m_end, aRotCentre, aAngle );
 break;

 case SHAPE_T::ARC:
 RotatePoint( &m_start, aRotCentre, aAngle );
 RotatePoint( &m_end, aRotCentre, aAngle );
 RotatePoint( &m_arcCenter, aRotCentre, aAngle );
 break;

 case SHAPE_T::RECT:
 if( KiROUND( aAngle ) % 900 == 0 )
 {
 RotatePoint( &m_start, aRotCentre, aAngle );
 RotatePoint( &m_end, aRotCentre, aAngle );
 break;
 }

 // Convert non-cartesian-rotated rect to a diamond
 m_shape = SHAPE_T::POLY;
 m_poly.RemoveAllContours();
 m_poly.NewOutline();
 m_poly.Append( m_start );
 m_poly.Append( m_end.x, m_start.y );
 m_poly.Append( m_end );
 m_poly.Append( m_start.x, m_end.y );

 KI_FALLTHROUGH;

 case SHAPE_T::POLY:
 m_poly.Rotate( -DECIDEG2RAD( aAngle ), VECTOR2I( aRotCentre ) );
 break;

 case SHAPE_T::BEZIER:
 RotatePoint( &m_start, aRotCentre, aAngle);
 RotatePoint( &m_end, aRotCentre, aAngle);
 RotatePoint( &m_bezierC1, aRotCentre, aAngle);
 RotatePoint( &m_bezierC2, aRotCentre, aAngle);

 for( wxPoint& pt : m_bezierPoints )
 RotatePoint( &pt, aRotCentre, aAngle);

 break;

 default:
 UNIMPLEMENTED_FOR( SHAPE_T_asString() );
 break;
 }
}

References SHAPE_POLY_SET::Append(), ARC, BEZIER, CIRCLE, DECIDEG2RAD(), KI_FALLTHROUGH, KiROUND(), EDA_SHAPE::m_arcCenter, EDA_SHAPE::m_bezierC1, EDA_SHAPE::m_bezierC2, EDA_SHAPE::m_bezierPoints, EDA_SHAPE::m_end, EDA_SHAPE::m_poly, EDA_SHAPE::m_shape, EDA_SHAPE::m_start, SHAPE_POLY_SET::NewOutline(), POLY, RECT, SHAPE_POLY_SET::RemoveAllContours(), SHAPE_POLY_SET::Rotate(), RotatePoint(), SEGMENT, EDA_SHAPE::SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

Referenced by Rotate(), and PCB_SHAPE::Rotate().

scale()

void EDA_SHAPE::scale ( double  aScale )

protectedinherited

Definition at line 172 of file eda_shape.cpp.

{
 auto scalePt = [&]( wxPoint& pt )
 {
 pt.x = KiROUND( pt.x * aScale );
 pt.y = KiROUND( pt.y * aScale );
 };

 switch( m_shape )
 {
 case SHAPE_T::ARC:
 case SHAPE_T::SEGMENT:
 case SHAPE_T::RECT:
 scalePt( m_start );
 scalePt( m_end );
 scalePt( m_arcCenter );
 break;

 case SHAPE_T::CIRCLE: // ring or circle
 scalePt( m_start );
 m_end.x = m_start.x + KiROUND( GetRadius() * aScale );
 m_end.y = m_start.y;
 break;

 case SHAPE_T::POLY: // polygon
 {
 std::vector<wxPoint> pts;

 for( const VECTOR2I& pt : m_poly.Outline( 0 ).CPoints() )
 {
 pts.emplace_back( pt );
 scalePt( pts.back() );
 }

 SetPolyPoints( pts );
 }
 break;

 case SHAPE_T::BEZIER:
 scalePt( m_start );
 scalePt( m_end );
 scalePt( m_bezierC1 );
 scalePt( m_bezierC2 );
 break;

 default:
 UNIMPLEMENTED_FOR( SHAPE_T_asString() );
 break;
 }
}

References ARC, BEZIER, CIRCLE, SHAPE_LINE_CHAIN::CPoints(), EDA_SHAPE::GetRadius(), KiROUND(), EDA_SHAPE::m_arcCenter, EDA_SHAPE::m_bezierC1, EDA_SHAPE::m_bezierC2, EDA_SHAPE::m_end, EDA_SHAPE::m_poly, EDA_SHAPE::m_shape, EDA_SHAPE::m_start, SHAPE_POLY_SET::Outline(), POLY, RECT, SEGMENT, EDA_SHAPE::SetPolyPoints(), EDA_SHAPE::SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

Referenced by PCB_SHAPE::Scale().

Set() [1/3]

bool INSPECTABLE::Set ( PROPERTY_BASE *  aProperty, wxAny &  aValue  )

inlineinherited

Definition at line 42 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 TYPE_ID thisType = TYPE_HASH( *this );
 void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );

 if( object )
 aProperty->setter( object, aValue );

 return object != nullptr;
 }

References PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), PROPERTY_BASE::setter(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

Set() [2/3]

template<typename T >

bool INSPECTABLE::Set ( PROPERTY_BASE *  aProperty, T  aValue  )

inlineinherited

Definition at line 55 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 TYPE_ID thisType = TYPE_HASH( *this );
 void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );

 if( object )
 aProperty->set<T>( object, aValue );

 return object != nullptr;
 }

References PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), PROPERTY_BASE::set(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

Set() [3/3]

template<typename T >

bool INSPECTABLE::Set ( const wxString &  aProperty, T  aValue  )

inlineinherited

Definition at line 68 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 TYPE_ID thisType = TYPE_HASH( *this );
 PROPERTY_BASE* prop = propMgr.GetProperty( thisType, aProperty );
 void* object = nullptr;

 if( prop )
 {
 object = propMgr.TypeCast( this, thisType, prop->OwnerHash() );

 if( object )
 prop->set<T>( object, aValue );
 }

 return object != nullptr;
 }

References PROPERTY_MANAGER::GetProperty(), PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), PROPERTY_BASE::set(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

SetArcAngleAndEnd()

void EDA_SHAPE::SetArcAngleAndEnd ( double  aAngle, bool  aCheckNegativeAngle = false  )

inherited

Set the end point from the angle center and start.

Parameters

aAngle

is tenths of degrees.

Definition at line 547 of file eda_shape.cpp.

{
 m_end = m_start;
 RotatePoint( &m_end, m_arcCenter, -NormalizeAngle360Max( aAngle ) );

 if( aCheckNegativeAngle && aAngle < 0 )
 {
 std::swap( m_start, m_end );
 m_endsSwapped = true;
 }
}

References EDA_SHAPE::m_arcCenter, EDA_SHAPE::m_end, EDA_SHAPE::m_endsSwapped, EDA_SHAPE::m_start, NormalizeAngle360Max(), and RotatePoint().

Referenced by PAD::AddPrimitiveArc(), PCAD2KICAD::PCB_ARC::AddToBoard(), DRAWING_TOOL::drawArc(), CADSTAR_PCB_ARCHIVE_LOADER::getShapeFromVertex(), EAGLE_PLUGIN::loadPlain(), ALTIUM_PCB::ParseArcs6Data(), and DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataFromWindow().

SetArcGeometry()

void EDA_SHAPE::SetArcGeometry ( const wxPoint &  aStart, const wxPoint &  aMid, const wxPoint &  aEnd  )

inherited

Set the three controlling points for an arc.

NB: these are NOT what's currently stored, so we have to do some calculations behind the scenes. However, they are what SHOULD be stored.

Definition at line 504 of file eda_shape.cpp.

{
 m_arcMidData = {};
 m_start = aStart;
 m_end = aEnd;
 m_arcCenter = CalcArcCenter( aStart, aMid, aEnd );
 wxPoint new_mid = GetArcMid();

 m_endsSwapped = false;

 // Watch the ordering here. GetArcMid above needs to be called prior to initializing the
 // m_arcMidData structure in order to ensure we get the calculated variant, not the cached
 SetCachedArcData( aStart, aMid, aEnd, m_arcCenter );

 /*
 * If the input winding doesn't match our internal winding, the calculated midpoint will end
 * up on the other side of the arc. In this case, we need to flip the start/end points and
 * flag this change for the system.
 */

 VECTOR2D dist( new_mid - aMid );
 VECTOR2D dist2( new_mid - m_arcCenter );

 if( dist.SquaredEuclideanNorm() > dist2.SquaredEuclideanNorm() )
 {
 std::swap( m_start, m_end );
 m_endsSwapped = true;
 }

}

References CalcArcCenter(), EDA_SHAPE::GetArcMid(), EDA_SHAPE::m_arcCenter, EDA_SHAPE::m_arcMidData, EDA_SHAPE::m_end, EDA_SHAPE::m_endsSwapped, EDA_SHAPE::m_start, EDA_SHAPE::SetCachedArcData(), and VECTOR2< T >::SquaredEuclideanNorm().

Referenced by EDA_SHAPE::beginEdit(), EDA_SHAPE::calcEdit(), PCB_POINT_EDITOR::editArcMidKeepEndpoints(), ALTIUM_PCB::HelperCreateBoardOutline(), and SCH_EAGLE_PLUGIN::loadSymbolWire().

SetBezierC1()

void EDA_SHAPE::SetBezierC1 ( const wxPoint &  aPt )

inlineinherited

Definition at line 153 of file eda_shape.h.

{ m_bezierC1 = aPt; }

References EDA_SHAPE::m_bezierC1.

Referenced by PAD::AddPrimitiveCurve(), PAD_TOOL::explodePad(), SCH_LEGACY_PLUGIN_CACHE::loadBezier(), SCH_ALTIUM_PLUGIN::ParseBezier(), PAD_TOOL::recombinePad(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataFromWindow(), and PCB_POINT_EDITOR::updateItem().

SetBezierC2()

void EDA_SHAPE::SetBezierC2 ( const wxPoint &  aPt )

inlineinherited

Definition at line 156 of file eda_shape.h.

{ m_bezierC2 = aPt; }

References EDA_SHAPE::m_bezierC2.

Referenced by PAD::AddPrimitiveCurve(), PAD_TOOL::explodePad(), SCH_LEGACY_PLUGIN_CACHE::loadBezier(), SCH_ALTIUM_PLUGIN::ParseBezier(), PAD_TOOL::recombinePad(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataFromWindow(), and PCB_POINT_EDITOR::updateItem().

SetBrightened()

void EDA_ITEM::SetBrightened ( )

inlineinherited

Definition at line 129 of file eda_item.h.

{ SetFlags( BRIGHTENED ); }

References BRIGHTENED, and EDA_ITEM::SetFlags().

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), KIGFX::SCH_PAINTER::draw(), SCH_EDIT_FRAME::FocusOnItem(), PCB_BASE_FRAME::FocusOnItems(), PL_SELECTION_TOOL::highlight(), EE_SELECTION_TOOL::highlight(), PCB_SELECTION_TOOL::highlightInternal(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

SetCachedArcData()

void EDA_SHAPE::SetCachedArcData ( const wxPoint &  aStart, const wxPoint &  aMid, const wxPoint &  aEnd, const wxPoint &  aCenter  )

inherited

Set the data used for mid point caching.

If the controlling points remain constant, then we keep the midpoint the same as it was when read in. This minimizes VCS churn

Parameters

aStart	Cached start point
aMid	Cached mid point
aEnd	Cached end point
aCenter	Calculated center point using the preceeding three

Definition at line 495 of file eda_shape.cpp.

{
 m_arcMidData.start = aStart;
 m_arcMidData.end = aEnd;
 m_arcMidData.center = aCenter;
 m_arcMidData.mid = aMid;
}

References ARC_MID::center, ARC_MID::end, EDA_SHAPE::m_arcMidData, ARC_MID::mid, and ARC_MID::start.

Referenced by EDA_SHAPE::SetArcGeometry().

SetCenter()

void EDA_SHAPE::SetCenter ( const wxPoint &  aCenter )

inherited

Definition at line 419 of file eda_shape.cpp.

{
 switch( m_shape )
 {
 case SHAPE_T::ARC:
 m_arcCenter = aCenter;
 break;

 case SHAPE_T::CIRCLE:
 m_start = aCenter;
 break;

 default:
 UNIMPLEMENTED_FOR( SHAPE_T_asString() );
 }
}

References ARC, CIRCLE, EDA_SHAPE::m_arcCenter, EDA_SHAPE::m_shape, EDA_SHAPE::m_start, EDA_SHAPE::SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

Referenced by PAD::AddPrimitiveArc(), PCAD2KICAD::PCB_ARC::AddToBoard(), PCB_POINT_EDITOR::editArcEndpointKeepCenter(), PCB_POINT_EDITOR::editArcEndpointKeepTangent(), PAD_TOOL::explodePad(), CADSTAR_PCB_ARCHIVE_LOADER::getShapeFromVertex(), EAGLE_PLUGIN::loadPlain(), SCH_ALTIUM_PLUGIN::ParseArc(), ALTIUM_PCB::ParseArcs6Data(), PAD_TOOL::recombinePad(), CONVERT_TOOL::SegmentToArc(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataFromWindow(), and updateArcFromConstructionMgr().

SetConvert()

void LIB_ITEM::SetConvert ( int  aConvert )

inlineinherited

Definition at line 268 of file lib_item.h.

{ m_convert = aConvert; }

References LIB_ITEM::m_convert.

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), LIB_PIN::LIB_PIN(), SCH_LEGACY_PLUGIN_CACHE::loadArc(), SCH_LEGACY_PLUGIN_CACHE::loadBezier(), SCH_LEGACY_PLUGIN_CACHE::loadCircle(), SCH_LEGACY_PLUGIN_CACHE::loadPolyLine(), SCH_LEGACY_PLUGIN_CACHE::loadRect(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_SHAPE_PROPERTIES::TransferDataFromWindow(), and DIALOG_PIN_PROPERTIES::TransferDataFromWindow().

SetEditState()

void LIB_SHAPE::SetEditState ( int  aState )

inline

Definition at line 79 of file lib_shape.h.

{ setEditState( aState ); }

References EDA_SHAPE::setEditState().

Referenced by EE_POINT_EDITOR::updateParentItem().

setEditState()

void EDA_SHAPE::setEditState ( int  aState )

inlineprotectedinherited

Definition at line 315 of file eda_shape.h.

{ m_editState = aState; }

References EDA_SHAPE::m_editState.

Referenced by SetEditState().

SetEnd()

void EDA_SHAPE::SetEnd ( const wxPoint &  aEnd )

inlineinherited

Definition at line 135 of file eda_shape.h.

 {
 m_end = aEnd;
 m_endsSwapped = false;
 }

References EDA_SHAPE::m_end, and EDA_SHAPE::m_endsSwapped.

Referenced by PCB_POINT_EDITOR::addCorner(), PAD::AddPrimitiveCircle(), PAD::AddPrimitiveCurve(), PAD::AddPrimitiveRect(), PAD::AddPrimitiveSegment(), PCAD2KICAD::PCB_LINE::AddToBoard(), EDA_SHAPE::beginEdit(), EDA_SHAPE::calcEdit(), CONVERT_TOOL::CreateLines(), MICROWAVE_TOOL::createMicrowaveInductor(), PCB_POINT_EDITOR::editArcEndpointKeepCenter(), PCB_POINT_EDITOR::editArcEndpointKeepTangent(), PCB_POINT_EDITOR::editArcMidKeepCenter(), PAD_TOOL::explodePad(), CADSTAR_SCH_ARCHIVE_LOADER::getScaledLibPart(), CADSTAR_PCB_ARCHIVE_LOADER::getShapeFromVertex(), ALTIUM_PCB::HelperCreateBoardOutline(), HelperGeneratePowerPortGraphics(), ALTIUM_PCB::HelperParseDimensions6Leader(), ALTIUM_PCB::HelperParsePad6NonCopper(), SCH_LEGACY_PLUGIN_CACHE::loadArc(), SCH_LEGACY_PLUGIN_CACHE::loadBezier(), SCH_LEGACY_PLUGIN_CACHE::loadCircle(), CADSTAR_SCH_ARCHIVE_LOADER::loadLibrarySymbolShapeVertices(), EAGLE_PLUGIN::loadPlain(), SCH_LEGACY_PLUGIN_CACHE::loadRect(), SCH_EAGLE_PLUGIN::loadSymbolCircle(), SCH_EAGLE_PLUGIN::loadSymbolRectangle(), GRAPHICS_CLEANER::mergeRects(), SCH_ALTIUM_PLUGIN::ParseArc(), ALTIUM_PCB::ParseArcs6Data(), SCH_ALTIUM_PLUGIN::ParseBezier(), SCH_ALTIUM_PLUGIN::ParseRectangle(), SCH_ALTIUM_PLUGIN::ParseRoundRectangle(), ALTIUM_PCB::ParseTracks6Data(), BRDITEMS_PLOTTER::PlotDimension(), BRDITEMS_PLOTTER::PlotPcbTarget(), PAD_TOOL::recombinePad(), CONVERT_TOOL::SegmentToArc(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataFromWindow(), PCB_TARGET::TransformShapeWithClearanceToPolygon(), updateArcFromConstructionMgr(), PCB_POINT_EDITOR::updateItem(), EE_POINT_EDITOR::updateParentItem(), and updateSegmentFromGeometryMgr().

SetEndX()

void EDA_SHAPE::SetEndX ( int  x )

inlineinherited

Definition at line 147 of file eda_shape.h.

 {
 m_end.x = x;
 m_endsSwapped = false;
 }

References EDA_SHAPE::m_end, and EDA_SHAPE::m_endsSwapped.

Referenced by EDA_SHAPE_DESC::EDA_SHAPE_DESC(), initTextTable(), PCB_SHAPE_DESC::PCB_SHAPE_DESC(), DRAWING_TOOL::PlaceCharacteristics(), DRAWING_TOOL::PlaceStackup(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), PCB_TARGET::TransformShapeWithClearanceToPolygon(), and PCB_POINT_EDITOR::updateItem().

SetEndY()

void EDA_SHAPE::SetEndY ( int  y )

inlineinherited

Definition at line 141 of file eda_shape.h.

 {
 m_end.y = y;
 m_endsSwapped = false;
 }

References EDA_SHAPE::m_end, and EDA_SHAPE::m_endsSwapped.

Referenced by EDA_SHAPE_DESC::EDA_SHAPE_DESC(), initTextTable(), PCB_SHAPE_DESC::PCB_SHAPE_DESC(), DRAWING_TOOL::PlaceCharacteristics(), DRAWING_TOOL::PlaceStackup(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), and PCB_POINT_EDITOR::updateItem().

SetFilled()

void EDA_SHAPE::SetFilled ( bool  aFlag )

inlineinherited

Definition at line 92 of file eda_shape.h.

 {
 m_fill = aFlag ? FILL_T::FILLED_SHAPE : FILL_T::NO_FILL;
 }

References FILLED_SHAPE, EDA_SHAPE::m_fill, and NO_FILL.

Referenced by PAD::AddPrimitiveArc(), PAD::AddPrimitiveCircle(), PAD::AddPrimitiveCurve(), PAD::AddPrimitivePoly(), PAD::AddPrimitiveRect(), PAD::AddPrimitiveSegment(), PCAD2KICAD::PCB_ARC::AddToBoard(), ZONE_CREATE_HELPER::commitZone(), MICROWAVE_TOOL::createPolygonShape(), CONVERT_TOOL::CreatePolys(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarShape(), PAD_TOOL::explodePad(), CADSTAR_PCB_ARCHIVE_LOADER::getKiCadPad(), ALTIUM_PCB::HelperParsePad6NonCopper(), FABMASTER::loadGraphics(), EAGLE_PLUGIN::loadPlain(), FABMASTER::loadPolygon(), GRAPHICS_CLEANER::mergeRects(), DIALOG_PAD_PROPERTIES::onAddPrimitive(), EAGLE_PLUGIN::packageCircle(), EAGLE_PLUGIN::packagePolygon(), EAGLE_PLUGIN::packageRectangle(), ALTIUM_PCB::ParseFills6Data(), ALTIUM_PCB::ParseShapeBasedRegions6Data(), BRDITEMS_PLOTTER::PlotDimension(), BRDITEMS_PLOTTER::PlotPcbTarget(), PAD_TOOL::recombinePad(), CONVERT_TOOL::SegmentToArc(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataFromWindow(), and DIALOG_PAD_PRIMITIVE_POLY_PROPS::TransferDataFromWindow().

SetFillMode()

void EDA_SHAPE::SetFillMode ( FILL_T  aFill )

inlineinherited

Definition at line 87 of file eda_shape.h.

{ m_fill = aFill; }

References EDA_SHAPE::m_fill.

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), SCH_LEGACY_PLUGIN_CACHE::loadArc(), SCH_LEGACY_PLUGIN_CACHE::loadBezier(), SCH_LEGACY_PLUGIN_CACHE::loadCircle(), SCH_LEGACY_PLUGIN_CACHE::loadPolyLine(), SCH_LEGACY_PLUGIN_CACHE::loadRect(), SCH_EAGLE_PLUGIN::loadSymbolPolyLine(), SCH_EAGLE_PLUGIN::loadSymbolRectangle(), SCH_EAGLE_PLUGIN::loadSymbolWire(), SCH_ALTIUM_PLUGIN::ParsePolygon(), SCH_ALTIUM_PLUGIN::ParseRectangle(), SCH_ALTIUM_PLUGIN::ParseRoundRectangle(), and DIALOG_LIB_SHAPE_PROPERTIES::TransferDataFromWindow().

SetFlags()

void EDA_ITEM::SetFlags ( EDA_ITEM_FLAGS  aMask )

inlineinherited

Definition at line 152 of file eda_item.h.

{ m_flags |= aMask; }

References EDA_ITEM::m_flags.

Referenced by SCH_EAGLE_PLUGIN::addBusEntries(), PCB_BASE_FRAME::AddFootprintToBoard(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), SCH_MOVE_TOOL::AlignElements(), PCB_CONTROL::AppendBoard(), FOOTPRINT::BuildPolyCourtyards(), SCH_EDIT_TOOL::ChangeTextT