LIB_BEZIER Class Reference

Class LIB_BEZIER defines bezier curve graphic body item. More...

#include <lib_bezier.h>

Inheritance diagram for LIB_BEZIER:

Public Types
enum	LIB_CONVERT : int { BASE = 1, DEMORGAN = 2 }

Public Member Functions
	LIB_BEZIER (LIB_PART *aParent)
	~LIB_BEZIER ()
wxString	GetClass () const override
	Function GetClass returns the class name. More...
wxString	GetTypeName () override
	Provide a user-consumable name of the object type. More...
void	Reserve (size_t aCount)
void	AddPoint (const wxPoint &aPoint)
void	Offset (const wxPoint &aOffset) override
	Set the drawing object by aOffset from the current position. More...
const wxPoint	GetOffset () const
unsigned	GetCornerCount () const
const std::vector< wxPoint > &	GetPoints () const
bool	HitTest (const wxPoint &aPosition, int aAccuracy=0) const override
	Function HitTest tests if aPosition is contained within or on the bounding box of an item. More...
bool	HitTest (const EDA_RECT &aRect, bool aContained, int aAccuracy=0) const override
	Function HitTest tests if aRect intersects or is contained within the bounding box of an item. More...
const EDA_RECT	GetBoundingBox () const override
	Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes. More...
bool	Inside (EDA_RECT &aRect) const override
	Test if any part of the draw object is inside rectangle bounds of aRect. More...
void	MoveTo (const wxPoint &aPosition) override
	Move a draw object to aPosition. More...
wxPoint	GetPosition () const override
	Return the current draw object position. More...
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) override
	Plot the draw item using the plot object. More...
int	GetWidth () const override
	Return the width of the draw item. More...
void	SetWidth (int aWidth) override
	Set the width of the draw item to aWidth. More...
int	GetPenSize () const override
void	GetMsgPanelInfo (EDA_UNITS_T aUnits, std::vector< MSG_PANEL_ITEM > &aList) override
	Function GetMsgPanelInfo populates aList of MSG_PANEL_ITEM objects with it's internal state for display purposes. More...
EDA_ITEM *	Clone () const override
	Function Clone creates a duplicate of this item with linked list members set to NULL. More...
virtual void	BeginEdit (STATUS_FLAGS aEditMode, const wxPoint aPosition)
	Begin an editing a component library draw item in aEditMode at aPosition. More...
virtual bool	ContinueEdit (const wxPoint aPosition)
	Continue an edit in progress at aPosition. More...
virtual void	EndEdit (const wxPoint &aPosition)
	End an object editing action. More...
virtual void	CalcEdit (const wxPoint &aPosition)
	Calculates the attributes of an item at aPosition when it is being edited. More...
virtual void	Draw (EDA_DRAW_PANEL *aPanel, wxDC *aDC, const wxPoint &aOffset, void *aData, const TRANSFORM &aTransform)
	Draw an item. More...
LIB_PART *	GetParent () const
void	ViewGetLayers (int aLayers[], int &aCount) const override
	Function ViewGetLayers() Returns 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	SetPosition (const wxPoint &aPosition)
virtual void	Rotate ()
	Rotate the draw item. More...
bool	IsFillable () const
	Check if draw object can be filled. More...
bool	InEditMode () const
	Return the draw item editing mode status. More...
virtual COLOR4D	GetDefaultColor ()
void	SetUnit (int aUnit)
int	GetUnit () const
void	SetConvert (int aConvert)
int	GetConvert () const
void	SetFillMode (FILL_T aFillMode)
FILL_T	GetFillMode () const
KICAD_T	Type () const
	Function Type() More...
void	SetTimeStamp (timestamp_t aNewTimeStamp)
timestamp_t	GetTimeStamp () const
EDA_ITEM *	Next () const
EDA_ITEM *	Back () const
DHEAD *	GetList () const
void	SetNext (EDA_ITEM *aNext)
void	SetBack (EDA_ITEM *aBack)
void	SetParent (EDA_ITEM *aParent)
void	SetList (DHEAD *aList)
bool	IsNew () const
bool	IsModified () const
bool	IsMoving () const
bool	IsDragging () const
bool	IsWireImage () const
bool	IsSelected () const
bool	IsResized () const
bool	IsHighlighted () const
bool	IsBrightened () const
void	SetWireImage ()
void	SetSelected ()
void	SetHighlighted ()
void	SetBrightened ()
void	ClearSelected ()
void	ClearHighlighted ()
void	ClearBrightened ()
void	SetModified ()
int	GetState (int type) const
void	SetState (int type, int state)
STATUS_FLAGS	GetStatus () const
void	SetStatus (STATUS_FLAGS aStatus)
void	SetFlags (STATUS_FLAGS aMask)
void	ClearFlags (STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
STATUS_FLAGS	GetFlags () const
STATUS_FLAGS	GetEditFlags () const
void	ClearTempFlags ()
void	ClearEditFlags ()
virtual bool	IsType (const KICAD_T aScanTypes[])
	Function IsType Checks whether the item is one of the listed types. More...
void	SetForceVisible (bool aEnable)
	Function SetForceVisible is used to set and cleag force visible flag used to force the item to be drawn even if it's draw attribute is set to not visible. More...
virtual SEARCH_RESULT	Visit (INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
	Function Visit may be re-implemented for each derived class in order to handle all the types given by its member data. More...
virtual wxString	GetSelectMenuText (EDA_UNITS_T aUnits) const
	Function GetSelectMenuText returns the text to display to be used in the selection clarification context menu when multiple items are found at the current cursor position. More...
virtual BITMAP_DEF	GetMenuImage () const
	Function GetMenuImage returns a pointer to an image to be used in menus. More...
virtual bool	Matches (wxFindReplaceData &aSearchData, void *aAuxData, wxPoint *aFindLocation)
	Function Matches compares the item against the search criteria in aSearchData. More...
bool	Replace (wxFindReplaceData &aSearchData, wxString &aText)
	Helper function used in search and replace dialog Function Replace performs a text replace on aText using the find and replace criteria in aSearchData on items that support text find and replace. More...
virtual bool	Replace (wxFindReplaceData &aSearchData, void *aAuxData=NULL)
	Function Replace performs a text replace using the find and replace criteria in aSearchData on items that support text find and replace. More...
virtual bool	IsReplaceable () const
	Function IsReplaceable. More...
virtual const BOX2I	ViewBBox () const override
	Function ViewBBox() returns the bounding box of the item covering all its layers. More...
virtual void	ViewDraw (int aLayer, VIEW *aView) const
	Function ViewDraw() Draws the parts of the object belonging to layer aLayer. More...
virtual unsigned int	ViewGetLOD (int aLayer, VIEW *aView) const
	Function ViewGetLOD() Returns the level of detail (LOD) of the item. More...
VIEW_ITEM_DATA *	viewPrivData () const
void	ClearViewPrivData ()

Static Public Member Functions
static SEARCH_RESULT	IterateForward (EDA_ITEM *listStart, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
	Function IterateForward walks through the object tree calling the inspector() on each object type requested in scanTypes. More...
static bool	Sort (const EDA_ITEM *aLeft, const EDA_ITEM *aRight)
	Function Sort is a helper function to be used by the C++ STL sort algorithm for sorting a STL container of EDA_ITEM pointers. More...

Protected Member Functions
bool	Matches (const wxString &aText, wxFindReplaceData &aSearchData)
	Function Matches compares aText against search criteria in aSearchData. More...

Protected Attributes
int	m_Unit
	Unit identification for multiple parts per package. More...
int	m_Convert
	Shape identification for alternate body styles. More...
FILL_T	m_Fill
	The body fill type. More...
wxPoint	m_initialPos
	Temporary position when moving an existing item. More...
wxPoint	m_initialCursorPos
	Initial cursor position at the beginning of a move. More...
bool	m_isFillable
	Flag to indicate if draw item is fillable. More...
EDA_ITEM *	Pnext
	next in linked list More...
EDA_ITEM *	Pback
	previous in linked list More...
DHEAD *	m_List
	which DLIST I am on. More...
EDA_ITEM *	m_Parent
	Linked list: Link (parent struct) More...
timestamp_t	m_TimeStamp
	Time stamp used for logical links. More...
bool	m_forceVisible
	Set to true to override the visibility setting of the item. More...
STATUS_FLAGS	m_Flags
	Flag bits for editing and other uses. More...

Private Member Functions
void	drawGraphic (EDA_DRAW_PANEL *aPanel, wxDC *aDC, const wxPoint &aOffset, void *aData, const TRANSFORM &aTransform) override
	Draw the item on aPanel. More...
int	compare (const LIB_ITEM &aOther) const override
	Provide the draw object specific comparison called by the == and < operators. More...

Private Attributes
int	m_Width
std::vector< wxPoint >	m_BezierPoints
std::vector< wxPoint >	m_PolyPoints

Detailed Description

Class LIB_BEZIER defines bezier curve graphic body item.

Definition at line 39 of file lib_bezier.h.

Member Enumeration Documentation

LIB_CONVERT

enum LIB_ITEM::LIB_CONVERT : int

inherited

Enumerator
BASE
DEMORGAN

Definition at line 124 of file lib_draw_item.h.

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

Constructor & Destructor Documentation

LIB_BEZIER()

LIB_BEZIER::LIB_BEZIER

(

LIB_PART *

aParent

)

Definition at line 43 of file lib_bezier.cpp.

                                          :
    LIB_ITEM( LIB_BEZIER_T, aParent )
{
    m_Fill       = NO_FILL;
    m_Width      = 0;
    m_isFillable = true;
}

References LIB_ITEM::m_Fill, LIB_ITEM::m_isFillable, m_Width, and NO_FILL.

Referenced by Clone().

~LIB_BEZIER()

LIB_BEZIER::~LIB_BEZIER ( )

inline

Definition at line 53 of file lib_bezier.h.

{ }

Member Function Documentation

AddPoint()

void LIB_BEZIER::AddPoint ( const wxPoint &  aPoint )

inline

Definition at line 66 of file lib_bezier.h.

{ m_BezierPoints.push_back( aPoint ); }

References m_BezierPoints.

Back()

EDA_ITEM* EDA_ITEM::Back ( ) const

inlineinherited

Definition at line 213 of file base_struct.h.

{ return Pback; }

References EDA_ITEM::Pback.

Referenced by DHEAD::insert(), and DHEAD::remove().

BeginEdit()

virtual void LIB_ITEM::BeginEdit ( STATUS_FLAGS  aEditMode, const wxPoint  aPosition  )

inlinevirtualinherited

Begin an editing a component library draw item in aEditMode at aPosition.

This is used to start an editing action such as resize or move a draw object. It typically would be called on a left click when a draw tool is selected in the component library editor and one of the graphics tools is selected. It allows the draw item to maintain it's own internal state while it is being edited. Call AbortEdit() to quit the editing mode.

Parameters

aEditMode	The editing mode being performed. See base_struct.h for a list of mode flags.
aPosition	The position in drawing coordinates where the editing mode was started. This may or may not be required depending on the item being edited and the edit mode.

Reimplemented in LIB_FIELD, LIB_TEXT, LIB_ARC, LIB_POLYLINE, LIB_RECTANGLE, and LIB_CIRCLE.

Definition at line 147 of file lib_draw_item.h.

    {
        SetFlags( aEditMode );
    }

References EDA_ITEM::SetFlags().

Referenced by LIB_CIRCLE::BeginEdit(), LIB_RECTANGLE::BeginEdit(), LIB_POLYLINE::BeginEdit(), LIB_ARC::BeginEdit(), LIB_TEXT::BeginEdit(), LIB_FIELD::BeginEdit(), and LIB_DRAWING_TOOLS::DrawShape().

CalcEdit()

virtual void LIB_ITEM::CalcEdit ( const wxPoint &  aPosition )

inlinevirtualinherited

Calculates 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 component library editor. Therefore, the default method does nothing.

Parameters

aPosition

The current mouse position in drawing coordinates.

Reimplemented in LIB_PIN, LIB_TEXT, LIB_ARC, LIB_POLYLINE, LIB_FIELD, LIB_RECTANGLE, and LIB_CIRCLE.

Definition at line 188 of file lib_draw_item.h.

{}

Referenced by LIB_DRAWING_TOOLS::DrawShape().

ClearBrightened()

void EDA_ITEM::ClearBrightened ( )

inlineinherited

Definition at line 239 of file base_struct.h.

{ ClearFlags( BRIGHTENED ); }

References BRIGHTENED, and EDA_ITEM::ClearFlags().

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), EE_SELECTION_TOOL::unhighlight(), and SELECTION_TOOL::unhighlight().

ClearEditFlags()

void EDA_ITEM::ClearEditFlags ( )

inlineinherited

Definition at line 276 of file base_struct.h.

    {
        ClearFlags( GetEditFlags() );
    }

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

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), LIB_DRAWING_TOOLS::doTwoClickPlace(), LIB_ITEM::EndEdit(), SCH_FIELD::Place(), SCH_EDIT_FRAME::PutDataInPreviousState(), and PCB_BASE_EDIT_FRAME::SaveCopyInUndoList().

ClearFlags()

void EDA_ITEM::ClearFlags ( STATUS_FLAGS  aMask = EDA_ITEM_ALL_FLAGS )

inlineinherited

Definition at line 260 of file base_struct.h.

{ m_Flags &= ~aMask; }

References EDA_ITEM::m_Flags.

Referenced by Abort_Edit_Pcb_Text(), Abort_EditEdge(), Abort_Move_ModuleOutline(), Abort_Move_Pad(), Abort_MoveOrCopyModule(), Abort_MoveTrack(), Abort_Zone_Create_Outline(), Abort_Zone_Move_Corner_Or_Outlines(), AbortMoveAndEditTarget(), AbortMoveDimensionText(), AbortMoveTextModule(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PNS_KICAD_IFACE::AddItem(), PCB_EDIT_FRAME::Begin_DrawSegment(), FOOTPRINT_EDIT_FRAME::Begin_Edge_Module(), PCB_EDIT_FRAME::Begin_Zone(), PCB_EDIT_FRAME::Block_Delete(), PCB_EDIT_FRAME::Block_Flip(), PCB_EDIT_FRAME::Block_Move(), PCB_EDIT_FRAME::Change_Side_Module(), SCH_COMPONENT::ClearAllHighlightFlags(), SCH_SCREEN::ClearAnnotation(), EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearEditFlags(), EDA_ITEM::ClearHighlighted(), ClearMarkItems(), clearModuleItemFlags(), EDA_ITEM::ClearSelected(), EDA_ITEM::ClearTempFlags(), SCH_EDIT_FRAME::ConvertPart(), LIB_EDIT_TOOL::Copy(), CopyMarkedItems(), MWAVE::CreateMicrowaveInductor(), FOOTPRINT_EDIT_FRAME::CreateTextModule(), PCB_EDIT_FRAME::Delete_LastCreatedCorner(), PCB_EDIT_FRAME::Delete_Segment_Edge(), DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), KIGFX::SCH_PAINTER::draw(), SCH_ITEM::Duplicate(), PCB_EDIT_FRAME::EditDimension(), PCB_EDIT_FRAME::End_Edge(), FOOTPRINT_EDIT_FRAME::End_Edge_Module(), PCB_EDIT_FRAME::End_Move_Zone_Corner_Or_Outlines(), PCB_EDIT_FRAME::End_Route(), PCB_EDIT_FRAME::End_Zone(), PCB_EDIT_FRAME::Exchange_Module(), LIB_EDIT_FRAME::GetComponentFromRedoList(), LIB_EDIT_FRAME::GetComponentFromUndoList(), SCH_MOVE_TOOL::getConnectedDragItems(), PCB_BASE_FRAME::Import_Pad_Settings(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), EDIT_POINTS_FACTORY::Make(), MarkItemsInBloc(), FOOTPRINT_EDIT_FRAME::OnLeftClick(), PCB_EDIT_FRAME::OnLeftClick(), PCB_EDIT_FRAME::Place_DrawItem(), FOOTPRINT_EDIT_FRAME::Place_EdgeMod(), PCB_EDIT_FRAME::Place_Texte_Pcb(), PCB_EDIT_FRAME::PlaceDimensionText(), PCB_EDIT_FRAME::PlaceDraggedOrMovedTrackSegment(), PCB_BASE_FRAME::PlaceModule(), PCB_BASE_FRAME::PlacePad(), PCB_EDIT_FRAME::PlaceTarget(), DRAWING_TOOL::PlaceText(), PCB_BASE_FRAME::PlaceTexteModule(), FOOTPRINT_EDIT_FRAME::Process_Special_Functions(), BOARD_COMMIT::Push(), SCH_EDIT_TOOL::RepeatDrawItem(), LIB_PIN_TOOL::RepeatPin(), BOARD_COMMIT::Revert(), LIB_EDIT_FRAME::RollbackPartFromUndo(), PCB_BASE_FRAME::Rotate_Module(), SCH_EDIT_FRAME::SaveCopyForRepeatItem(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_LEGACY_PLUGIN_CACHE::savePin(), SCH_EDIT_FRAME::SelectUnit(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), PCB_EDIT_FRAME::StartMoveModule(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

ClearHighlighted()

void EDA_ITEM::ClearHighlighted ( )

inlineinherited

Definition at line 238 of file base_struct.h.

{ ClearFlags( HIGHLIGHTED ); }

References EDA_ITEM::ClearFlags(), and HIGHLIGHTED.

ClearSelected()

void EDA_ITEM::ClearSelected ( )

inlineinherited

Definition at line 237 of file base_struct.h.

{ ClearFlags( SELECTED ); }

References EDA_ITEM::ClearFlags(), and SELECTED.

Referenced by POINT_EDITOR::addCorner(), EDIT_TOOL::Duplicate(), GAL_ARRAY_CREATOR::prePushAction(), EE_SELECTION_TOOL::unhighlight(), SELECTION_TOOL::unhighlight(), and GERBVIEW_SELECTION_TOOL::unselectVisually().

ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )

inlineinherited

Definition at line 271 of file base_struct.h.

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

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

Referenced by SCH_EDIT_FRAME::PutDataInPreviousState().

ClearViewPrivData()

void KIGFX::VIEW_ITEM::ClearViewPrivData ( )

inlineinherited

Definition at line 153 of file view_item.h.

    {
        m_viewPrivData = NULL;
    }

References KIGFX::VIEW_ITEM::m_viewPrivData.

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

Clone()

EDA_ITEM * LIB_BEZIER::Clone ( ) const

overridevirtual

Function Clone creates 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 52 of file lib_bezier.cpp.

{
    return new LIB_BEZIER( *this );
}

References LIB_BEZIER().

compare()

int LIB_BEZIER::compare ( const LIB_ITEM &  aOther ) 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:

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

Parameters

aOther

A reference to the other LIB_ITEM to compare the arc against.

Returns

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

The bezier curve specific sort order for each curve segment point is as follows:

• Bezier horizontal (X) point position.
• Bezier vertical (Y) point position.

Implements LIB_ITEM.

Definition at line 58 of file lib_bezier.cpp.

{
    wxASSERT( aOther.Type() == LIB_BEZIER_T );

    const LIB_BEZIER* tmp = ( LIB_BEZIER* ) &aOther;

    if( m_BezierPoints.size() != tmp->m_BezierPoints.size() )
        return m_BezierPoints.size() - tmp->m_BezierPoints.size();

    for( size_t i = 0; i < m_BezierPoints.size(); i++ )
    {
        if( m_BezierPoints[i].x != tmp->m_BezierPoints[i].x )
            return m_BezierPoints[i].x - tmp->m_BezierPoints[i].x;

        if( m_BezierPoints[i].y != tmp->m_BezierPoints[i].y )
            return m_BezierPoints[i].y - tmp->m_BezierPoints[i].y;
    }

    return 0;
}

References i, LIB_BEZIER_T, m_BezierPoints, and EDA_ITEM::Type().

ContinueEdit()

virtual bool LIB_ITEM::ContinueEdit ( const wxPoint  aPosition )

inlinevirtualinherited

Continue an edit in progress at aPosition.

This is used to perform the next action while editing a draw item. This would be called for each additional left click when the mouse is captured while the item is being edited.

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 in LIB_ARC, and LIB_POLYLINE.

Definition at line 162 of file lib_draw_item.h.

    {
        return false;
    }

Referenced by LIB_DRAWING_TOOLS::DrawShape().

Draw()

void LIB_ITEM::Draw ( EDA_DRAW_PANEL *  aPanel, wxDC *  aDC, const wxPoint &  aOffset, void *  aData, const TRANSFORM &  aTransform  )

virtualinherited

Draw an item.

Parameters

aPanel	DrawPanel to use (can be null) mainly used for clipping purposes.
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 component for pins.
aTransform	Transform Matrix (rotation, mirror ..)

Definition at line 127 of file lib_draw_item.cpp.

{
    drawGraphic( aPanel, aDC, aOffset, aData, aTransform );
}

References LIB_ITEM::drawGraphic().

Referenced by DIALOG_LIB_EDIT_PIN::OnPaintShowPanel().

drawGraphic()

void LIB_BEZIER::drawGraphic ( EDA_DRAW_PANEL *  aPanel, wxDC *  aDC, const wxPoint &  aOffset, void *  aData, const TRANSFORM &  aTransform  )

overrideprivatevirtual

Draw the item on aPanel.

Parameters

aPanel	A pointer to the panel to draw the object upon.
aDC	A pointer to the device context used to draw the object.
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 231 of file lib_bezier.cpp.

{
    std::vector<wxPoint> PolyPointsTraslated;

    COLOR4D color   = GetLayerColor( LAYER_DEVICE );
    COLOR4D bgColor = GetLayerColor( LAYER_DEVICE_BACKGROUND );
    BEZIER_POLY converter( m_BezierPoints );
    converter.GetPoly( m_PolyPoints );

    PolyPointsTraslated.clear();

    for( unsigned int i = 0; i < m_PolyPoints.size() ; i++ )
        PolyPointsTraslated.push_back( aTransform.TransformCoordinate( m_PolyPoints[i] ) +
                                       aOffset );

    FILL_T fill = aData ? NO_FILL : m_Fill;

    EDA_RECT* const clipbox  = aPanel? aPanel->GetClipBox() : NULL;

    if( fill == FILLED_WITH_BG_BODYCOLOR )
    {
        GRPoly( clipbox, aDC, m_PolyPoints.size(), &PolyPointsTraslated[0], 1, GetPenSize(),
                bgColor, bgColor );
    }
    else if( fill == FILLED_SHAPE  )
    {
        GRPoly( clipbox, aDC, m_PolyPoints.size(), &PolyPointsTraslated[0], 1, GetPenSize(),
                color, color );
    }
    else
    {
        GRPoly( clipbox, aDC, m_PolyPoints.size(), &PolyPointsTraslated[0], 0, GetPenSize(),
                color, color );
    }
}

References color, FILLED_SHAPE, FILLED_WITH_BG_BODYCOLOR, EDA_DRAW_PANEL::GetClipBox(), GetLayerColor(), GetPenSize(), BEZIER_POLY::GetPoly(), GRPoly(), i, LAYER_DEVICE, LAYER_DEVICE_BACKGROUND, m_BezierPoints, LIB_ITEM::m_Fill, m_PolyPoints, NO_FILL, and TRANSFORM::TransformCoordinate().

EndEdit()

virtual void LIB_ITEM::EndEdit ( const wxPoint &  aPosition )

inlinevirtualinherited

End an object editing action.

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

Parameters

aPosition

The position of the last edit event in drawing coordinates.

Reimplemented in LIB_FIELD, LIB_TEXT, LIB_ARC, LIB_POLYLINE, and LIB_RECTANGLE.

Definition at line 174 of file lib_draw_item.h.

    {
        ClearEditFlags();
    }

References EDA_ITEM::ClearEditFlags().

Referenced by LIB_DRAWING_TOOLS::DrawShape(), LIB_RECTANGLE::EndEdit(), LIB_POLYLINE::EndEdit(), LIB_ARC::EndEdit(), LIB_TEXT::EndEdit(), and LIB_FIELD::EndEdit().

GetBoundingBox()

const EDA_RECT LIB_BEZIER::GetBoundingBox ( ) const

overridevirtual

Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.

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

Reimplemented from EDA_ITEM.

Definition at line 326 of file lib_bezier.cpp.

{
    EDA_RECT rect;
    int      xmin, xmax, ymin, ymax;

    if( !GetCornerCount() )
        return rect;

    xmin = xmax = m_PolyPoints[0].x;
    ymin = ymax = m_PolyPoints[0].y;

    for( unsigned ii = 1; ii < GetCornerCount(); ii++ )
    {
        xmin = std::min( xmin, m_PolyPoints[ii].x );
        xmax = std::max( xmax, m_PolyPoints[ii].x );
        ymin = std::min( ymin, m_PolyPoints[ii].y );
        ymax = std::max( ymax, m_PolyPoints[ii].y );
    }

    rect.SetOrigin( xmin, ymin );
    rect.SetEnd( xmax, ymax );
    rect.Inflate( ( GetPenSize()+1 ) / 2 );

    rect.RevertYAxis();

    return rect;
}

References GetCornerCount(), GetPenSize(), EDA_RECT::Inflate(), m_PolyPoints, max, min, EDA_RECT::RevertYAxis(), EDA_RECT::SetEnd(), and EDA_RECT::SetOrigin().

Referenced by GetMsgPanelInfo(), and HitTest().

GetClass()

wxString LIB_BEZIER::GetClass ( ) const

inlineoverridevirtual

Function GetClass returns the class name.

Returns

wxString

Implements EDA_ITEM.

Definition at line 55 of file lib_bezier.h.

    {
        return wxT( "LIB_BEZIER" );
    }

GetConvert()

int LIB_ITEM::GetConvert ( ) const

inlineinherited

Definition at line 369 of file lib_draw_item.h.

{ return m_Convert; }

References LIB_ITEM::m_Convert.

Referenced by LIB_EDIT_TOOL::DoDelete(), LIB_PIN_TOOL::EditPinProperties(), SCH_SCREEN::GetPin(), EE_COLLECTOR::Inspect(), KIGFX::SCH_PAINTER::isUnitAndConversionShown(), LIB_MOVE_TOOL::Main(), LIB_EDIT_FRAME::OnCheckComponent(), LIB_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_EDIT_DRAW_ITEM::TransferDataToWindow(), DIALOG_LIB_EDIT_TEXT::TransferDataToWindow(), and DIALOG_LIB_EDIT_PIN::TransferDataToWindow().

GetCornerCount()

unsigned LIB_BEZIER::GetCornerCount ( ) const

inline

Returns

the number of corners

Definition at line 74 of file lib_bezier.h.

{ return m_PolyPoints.size(); }

References m_PolyPoints.

Referenced by GetBoundingBox(), and HitTest().

GetDefaultColor()

COLOR4D LIB_ITEM::GetDefaultColor ( )

virtualinherited

Reimplemented in LIB_FIELD.

Definition at line 143 of file lib_draw_item.cpp.

{
    return GetLayerColor( LAYER_DEVICE );
}

References GetLayerColor(), and LAYER_DEVICE.

Referenced by LIB_TEXT::drawGraphic(), and LIB_TEXT::Plot().

GetEditFlags()

STATUS_FLAGS EDA_ITEM::GetEditFlags ( ) const

inlineinherited

Definition at line 263 of file base_struct.h.

    {
        int mask = EDA_ITEM_ALL_FLAGS - ( SELECTED | HIGHLIGHTED | BRIGHTENED |
                                          STARTPOINT | ENDPOINT | IS_DANGLING |
                                          BEGIN_ONPAD | END_ONPAD | DP_COUPLED );
        return m_Flags & mask;
    }

References BEGIN_ONPAD, BRIGHTENED, DP_COUPLED, EDA_ITEM_ALL_FLAGS, END_ONPAD, ENDPOINT, HIGHLIGHTED, IS_DANGLING, EDA_ITEM::m_Flags, SELECTED, and STARTPOINT.

Referenced by AbortMoveAndEditTarget(), SCH_EDIT_TOOL::ChangeShape(), EDA_ITEM::ClearEditFlags(), SCH_EDIT_FRAME::ConvertTextType(), PCB_EDIT_FRAME::createPopUpMenuForFootprints(), PCB_EDIT_FRAME::createPopUpMenuForFpPads(), PCB_EDIT_FRAME::createPopUpMenuForFpTexts(), PCB_EDIT_FRAME::createPopUpMenuForTexts(), PCB_EDIT_FRAME::createPopupMenuForTracks(), PCB_EDIT_FRAME::createPopUpMenuForZones(), PCB_EDIT_FRAME::Delete_Segment_Edge(), SCH_EDIT_FRAME::DeleteJunction(), PCB_BASE_FRAME::DeleteTextModule(), BOARD::Draw(), PCB_EDIT_FRAME::Edit_TrackSegm_Width(), SCH_EDIT_FRAME::EditComponentFieldText(), SCH_EDIT_FRAME::EditImage(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), PCB_EDIT_FRAME::FlipTextePcb(), LIB_VIEW_FRAME::GeneralControl(), FOOTPRINT_EDIT_FRAME::OnHotKey(), PCB_EDIT_FRAME::OnHotKey(), PCB_EDIT_FRAME::OnHotkeyBeginRoute(), PCB_EDIT_FRAME::OnHotkeyCopyItem(), PCB_EDIT_FRAME::OnHotkeyDeleteItem(), PCB_EDIT_FRAME::OnHotkeyDuplicateOrArrayItem(), PCB_EDIT_FRAME::OnHotkeyEditItem(), PCB_EDIT_FRAME::OnHotkeyFlipItem(), PCB_EDIT_FRAME::OnHotkeyMoveItem(), PCB_EDIT_FRAME::OnHotkeyPlaceItem(), PCB_EDIT_FRAME::OnHotkeyRotateItem(), FOOTPRINT_EDIT_FRAME::OnLeftClick(), PCB_EDIT_FRAME::OnLeftClick(), FOOTPRINT_EDIT_FRAME::OnLeftDClick(), PCB_EDIT_FRAME::OnLeftDClick(), EDA_DRAW_PANEL::OnMouseEvent(), FOOTPRINT_EDIT_FRAME::OnRightClick(), GERBVIEW_FRAME::OnRightClick(), PCB_EDIT_FRAME::OnRightClick(), PCB_EDIT_FRAME::PlaceTarget(), FOOTPRINT_EDIT_FRAME::PrepareItemForHotkey(), TRACKS_CLEANER::removeDuplicatesOfTrack(), PCB_BASE_FRAME::Rotate_Module(), PCB_EDIT_FRAME::Rotate_Texte_Pcb(), PCB_BASE_FRAME::RotateTextModule(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_EDIT_FRAME::SelectUnit(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), and DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataFromWindow().

GetFillMode()

FILL_T LIB_ITEM::GetFillMode ( ) const

inlineinherited

Definition at line 373 of file lib_draw_item.h.

{ return m_Fill; }

References LIB_ITEM::m_Fill.

Referenced by 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(), KIGFX::SCH_PAINTER::setColors(), and DIALOG_LIB_EDIT_DRAW_ITEM::TransferDataToWindow().

GetFlags()

STATUS_FLAGS EDA_ITEM::GetFlags ( ) const

inlineinherited

Definition at line 261 of file base_struct.h.

{ return m_Flags; }

References EDA_ITEM::m_Flags.

Referenced by Collect_TrackSegmentsToDrag(), SCH_EDIT_FRAME::ConvertPart(), KIGFX::SCH_PAINTER::draw(), SCH_MOVE_TOOL::getConnectedDragItems(), InitialiseDragParameters(), LIB_PART::LIB_PART(), Magnetize(), SCH_MOVE_TOOL::moveItem(), SCH_EDIT_TOOL::Rotate(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::SelectUnit(), Show_Drag_Track_Segment_With_Cte_Slope(), Show_MoveNode(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), and EE_POINT_EDITOR::updateItem().

GetList()

DHEAD* EDA_ITEM::GetList ( ) const

inlineinherited

Definition at line 215 of file base_struct.h.

{ return m_List; }

References EDA_ITEM::m_List.

Referenced by BOARD::CreateLockPoint(), BOARD_ITEM::DeleteStructure(), DHEAD::insert(), BOARD::MarkTrace(), DHEAD::remove(), SwapItemData(), BOARD_ITEM::UnLink(), and GERBER_DRAW_ITEM::UnLink().

GetMenuImage()

BITMAP_DEF EDA_ITEM::GetMenuImage ( ) const

virtualinherited

Function GetMenuImage returns 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 in D_PAD, ZONE_CONTAINER, MODULE, SCH_COMPONENT, SCH_SHEET, LIB_PIN, VIA, GERBER_DRAW_ITEM, SCH_HIERLABEL, TRACK, SCH_GLOBALLABEL, DRAWSEGMENT, DIMENSION, SCH_LABEL, LIB_FIELD, TEXTE_MODULE, SCH_BUS_BUS_ENTRY, SCH_FIELD, SCH_TEXT, SCH_LINE, SCH_SHEET_PIN, SCH_BUS_WIRE_ENTRY, SCH_BITMAP, LIB_ARC, EDGE_MODULE, LIB_TEXT, TEXTE_PCB, LIB_POLYLINE, MARKER_PCB, PCB_TARGET, LIB_RECTANGLE, LIB_CIRCLE, SCH_NO_CONNECT, SCH_JUNCTION, and SCH_MARKER.

Definition at line 272 of file base_struct.cpp.

{
    return dummy_xpm;
}

References dummy_xpm.

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), EE_SELECTION_TOOL::doSelectionMenu(), SELECTION_TOOL::doSelectionMenu(), FOOTPRINT_EDIT_FRAME::ModeditLocateAndDisplay(), and PCB_BASE_FRAME::PcbGeneralLocateAndDisplay().

GetMsgPanelInfo()

void LIB_BEZIER::GetMsgPanelInfo ( EDA_UNITS_T  aUnits, std::vector< MSG_PANEL_ITEM > &  aList  )

overridevirtual

Function GetMsgPanelInfo populates aList of MSG_PANEL_ITEM objects with it's internal state for display purposes.

Note

This method replaces DisplayInfo() so that KiCad objects no longer have any knowledge of wxWidgets UI objects.

Parameters

aList

is the list to populate.

Reimplemented from EDA_ITEM.

Definition at line 355 of file lib_bezier.cpp.

{
    wxString msg;
    EDA_RECT bBox = GetBoundingBox();

    LIB_ITEM::GetMsgPanelInfo( aUnits, aList );

    msg = MessageTextFromValue( aUnits, m_Width, true );

    aList.push_back( MSG_PANEL_ITEM( _( "Line Width" ), msg, BLUE ) );

    msg.Printf( wxT( "(%d, %d, %d, %d)" ), bBox.GetOrigin().x,
                bBox.GetOrigin().y, bBox.GetEnd().x, bBox.GetEnd().y );

    aList.push_back( MSG_PANEL_ITEM( _( "Bounding Box" ), msg, BROWN ) );
}

References BLUE, BROWN, GetBoundingBox(), EDA_RECT::GetEnd(), LIB_ITEM::GetMsgPanelInfo(), EDA_RECT::GetOrigin(), m_Width, and MessageTextFromValue().

GetOffset()

const wxPoint LIB_BEZIER::GetOffset

(

)

const

Definition at line 114 of file lib_bezier.cpp.

{
    if ( !m_PolyPoints.size() )
    {
        return wxPoint(0, 0);
    }

    return m_PolyPoints[0];
}

References m_PolyPoints.

GetParent()

LIB_PART* LIB_ITEM::GetParent ( ) const

inlineinherited

Definition at line 211 of file lib_draw_item.h.

    {
        return (LIB_PART*) m_Parent;
    }

References EDA_ITEM::m_Parent.

Referenced by CONNECTION_GRAPH::buildConnectionGraph(), LIB_PIN_TOOL::CreateImagePins(), KIGFX::SCH_PAINTER::draw(), LIB_PIN::drawGraphic(), LIB_EDIT_TOOL::editFieldProperties(), LIB_PIN::EnableEditMode(), LIB_FIELD::GetFullText(), LIB_PIN::IsPowerConnection(), LIB_PIN::Plot(), LIB_EDIT_TOOL::Properties(), LIB_PIN::SetConversion(), LIB_PIN::SetLength(), LIB_PIN::SetName(), LIB_PIN::SetNameTextSize(), LIB_PIN::SetNumberTextSize(), LIB_PIN::SetOrientation(), LIB_PIN::SetPartNumber(), LIB_PIN::SetPinPosition(), LIB_PIN::SetShape(), LIB_PIN::SetType(), LIB_PIN::SetVisible(), DIALOG_LIB_EDIT_PIN::TransferDataFromWindow(), DIALOG_LIB_EDIT_DRAW_ITEM::TransferDataToWindow(), and DIALOG_LIB_EDIT_ONE_FIELD::UpdateField().

GetPenSize()

int LIB_BEZIER::GetPenSize ( ) const

overridevirtual

Returns

the size of the "pen" that be used to draw or plot this item

Implements LIB_ITEM.

Definition at line 219 of file lib_bezier.cpp.

{
    if( m_Width > 0 )
        return m_Width;

    if( m_Width == 0 )
       return GetDefaultLineThickness();

    return -1;   // a value to use a minimal pen size
}

References GetDefaultLineThickness(), and m_Width.

Referenced by drawGraphic(), GetBoundingBox(), HitTest(), and Plot().

GetPoints()

const std::vector< wxPoint >& LIB_BEZIER::GetPoints ( ) const

inline

Definition at line 76 of file lib_bezier.h.

    {
        return m_BezierPoints;
    }

References m_BezierPoints.

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

GetPosition()

wxPoint LIB_BEZIER::GetPosition ( ) const

overridevirtual

Return the current draw object position.

Returns

A wxPoint object containing the position of the object.

Implements LIB_ITEM.

Definition at line 372 of file lib_bezier.cpp.

{
    if( !m_PolyPoints.size() )
        return wxPoint(0, 0);

    return m_PolyPoints[0];
}

References m_PolyPoints.

GetSelectMenuText()

wxString EDA_ITEM::GetSelectMenuText ( EDA_UNITS_T  aUnits ) const

virtualinherited

Function GetSelectMenuText returns 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 in D_PAD, ZONE_CONTAINER, MODULE, SCH_COMPONENT, BOARD, SCH_SHEET, LIB_PIN, VIA, GERBER_DRAW_ITEM, SCH_HIERLABEL, TRACK, SCH_GLOBALLABEL, DRAWSEGMENT, DIMENSION, SCH_LABEL, LIB_FIELD, TEXTE_MODULE, SCH_BUS_BUS_ENTRY, SCH_FIELD, SCH_TEXT, SCH_LINE, SCH_SHEET_PIN, DELETED_SCH_ITEM, SCH_BUS_WIRE_ENTRY, SCH_BITMAP, LIB_ARC, EDGE_MODULE, LIB_TEXT, TEXTE_PCB, LIB_POLYLINE, MARKER_PCB, PCB_TARGET, LIB_RECTANGLE, LIB_CIRCLE, SCH_NO_CONNECT, SCH_JUNCTION, SCH_MARKER, DELETED_BOARD_ITEM, and SCH_PIN.

Definition at line 165 of file base_struct.cpp.

{
    wxFAIL_MSG( wxT( "GetSelectMenuText() was not overridden for schematic item type " ) +
                GetClass() );

    return wxString( wxT( "Undefined menu text for " ) + GetClass() );
}

References EDA_ITEM::GetClass().

Referenced by CONNECTION_GRAPH::buildConnectionGraph(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), EE_SELECTION_TOOL::doSelectionMenu(), SELECTION_TOOL::doSelectionMenu(), CONNECTION_GRAPH::ercCheckBusToBusConflicts(), CONNECTION_GRAPH::ercCheckBusToBusEntryConflicts(), CONNECTION_GRAPH::ercCheckBusToNetConflicts(), SCH_FIND_COLLECTOR::GetText(), FOOTPRINT_EDIT_FRAME::ModeditLocateAndDisplay(), PCB_BASE_FRAME::PcbGeneralLocateAndDisplay(), DRC_ITEM::SetData(), and DIALOG_POSITION_RELATIVE::UpdateAnchor().

GetState()

int EDA_ITEM::GetState ( int  type ) const

inlineinherited

Definition at line 243 of file base_struct.h.

    {
        return m_Status & type;
    }

References EDA_ITEM::m_Status.

Referenced by BOARD::chainMarkedSegments(), PCB_EDIT_FRAME::createPopupMenuForTracks(), DRAG_SEGM_PICKER::DRAG_SEGM_PICKER(), TRACK::Draw(), ZONE_CONTAINER::DrawFilledArea(), PCB_BASE_EDIT_FRAME::duplicateItem(), PCB_EDIT_FRAME::EraseRedundantTrack(), SELECTION_TOOL::expandConnection(), PCB_EDIT_FRAME::GeneralControl(), TRACK::GetEndSegments(), TRACK::GetMsgPanelInfoBase_Common(), TRACK::GetTrack(), PCB_EDIT_FRAME::HandleBlockEnd(), TRACK::IsLocked(), BOARD::MarkTrace(), TRACKS_CLEANER::mergeCollinearSegments(), PCB_EDIT_FRAME::OnHotkeyFlipItem(), and PCB_EDIT_FRAME::OnHotkeyRotateItem().

GetStatus()

STATUS_FLAGS EDA_ITEM::GetStatus ( ) const

inlineinherited

Definition at line 256 of file base_struct.h.

{ return m_Status; }

References EDA_ITEM::m_Status.

Referenced by PCB_IO::format().

GetTimeStamp()

timestamp_t EDA_ITEM::GetTimeStamp ( ) const

inlineinherited

Definition at line 210 of file base_struct.h.

{ return m_TimeStamp; }

References EDA_ITEM::m_TimeStamp.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::AddColumn(), SCH_COMPONENT::AddSheetPathReferenceEntryIfMissing(), SCH_EDIT_FRAME::AnnotateComponents(), FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), SCH_SHEET_PATH::Cmp(), SCH_ITEM::Duplicate(), DIALOG_FOOTPRINT_BOARD_EDITOR::EditFootprint(), EDIT_TOOL::editFootprintInFpEditor(), SCH_EDIT_FRAME::EditSheet(), PCB_EDIT_FRAME::Exchange_Module(), PCB_IO::format(), FormatProbeItem(), SCH_PIN::GetDefaultNetName(), NETLIST_OBJECT::GetShortNetName(), FIELDS_EDITOR_GRID_DATA_MODEL::groupMatch(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), NETLIST_EXPORTER_GENERIC::makeComponents(), mapExistingAnnotation(), FOOTPRINT_EDIT_FRAME::OnUpdateInsertModuleInBoard(), SCH_SCREENS::ReplaceDuplicateTimeStamps(), SCH_LEGACY_PLUGIN::saveComponent(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_LEGACY_PLUGIN::saveSheet(), SCH_REFERENCE::SCH_REFERENCE(), SortByTimeStamp(), SwapItemData(), DIALOG_SCH_SHEET_PROPS::TransferDataToWindow(), and DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataToWindow().

GetTypeName()

wxString LIB_BEZIER::GetTypeName ( )

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 60 of file lib_bezier.h.

    {
        return _( "Bezier" );
    }

GetUnit()

int LIB_ITEM::GetUnit ( ) const

inlineinherited

Definition at line 365 of file lib_draw_item.h.

{ return m_Unit; }

References LIB_ITEM::m_Unit.

Referenced by LIB_PIN_TOOL::CreateImagePins(), LIB_PIN_TOOL::EditPinProperties(), SCH_SCREEN::GetPin(), EE_COLLECTOR::Inspect(), KIGFX::SCH_PAINTER::isUnitAndConversionShown(), LIB_EDIT_FRAME::OnCheckComponent(), 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_EDIT_DRAW_ITEM::TransferDataToWindow(), DIALOG_LIB_EDIT_TEXT::TransferDataToWindow(), and DIALOG_LIB_EDIT_PIN::TransferDataToWindow().

GetWidth()

int LIB_BEZIER::GetWidth ( ) const

inlineoverridevirtual

Return the width of the draw item.

Returns

Width of draw object.

Implements LIB_ITEM.

Definition at line 100 of file lib_bezier.h.

{ return m_Width; }

References m_Width.

Referenced by HitTest(), and SCH_LEGACY_PLUGIN_CACHE::saveBezier().

HitTest() [1/2]

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

overridevirtual

Function HitTest tests if aPosition is contained within or on the bounding box of an 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 EDA_ITEM.

Definition at line 269 of file lib_bezier.cpp.

{
    int     mindist = std::max( aAccuracy + GetPenSize() / 2, MINIMUM_SELECTION_DISTANCE );
    wxPoint start, end;

    for( unsigned ii = 1; ii < GetCornerCount(); ii++ )
    {
        start = DefaultTransform.TransformCoordinate( m_PolyPoints[ii - 1] );
        end   = DefaultTransform.TransformCoordinate( m_PolyPoints[ii] );

        if ( TestSegmentHit( aRefPos, start, end, mindist ) )
            return true;
    }

    return false;
}

References DefaultTransform, GetCornerCount(), GetPenSize(), m_PolyPoints, max, MINIMUM_SELECTION_DISTANCE, TestSegmentHit(), and TRANSFORM::TransformCoordinate().

HitTest() [2/2]

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

overridevirtual

Function HitTest tests if aRect intersects or is contained within the bounding box of an 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 EDA_ITEM.

Definition at line 287 of file lib_bezier.cpp.

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

    EDA_RECT sel = aRect;

    if ( aAccuracy )
        sel.Inflate( aAccuracy );

    if( aContained )
        return sel.Contains( GetBoundingBox() );

    // Fast test: if aRect is outside the polygon bounding box, rectangles cannot intersect
    if( !sel.Intersects( GetBoundingBox() ) )
        return false;

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

    for( unsigned ii = 1; ii < count; ii++ )
    {
        wxPoint vertex = DefaultTransform.TransformCoordinate( m_BezierPoints[ii-1] );
        wxPoint vertexNext = DefaultTransform.TransformCoordinate( m_BezierPoints[ii] );

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

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

    return false;
}

References EDA_RECT::Contains(), DefaultTransform, GetBoundingBox(), GetWidth(), EDA_RECT::Inflate(), EDA_RECT::Intersects(), m_BezierPoints, EDA_ITEM::m_Flags, SKIP_STRUCT, STRUCT_DELETED, and TRANSFORM::TransformCoordinate().

InEditMode()

bool LIB_ITEM::InEditMode ( ) const

inlineinherited

Return the draw item editing mode status.

Returns

True if the item is being edited.

Definition at line 359 of file lib_draw_item.h.

{ return ( m_Flags & ( IS_NEW | IS_DRAGGED | IS_MOVED | IS_RESIZED ) ) != 0; }

References IS_DRAGGED, IS_MOVED, IS_NEW, IS_RESIZED, and EDA_ITEM::m_Flags.

Referenced by LIB_EDIT_TOOL::Properties(), LIB_TEXT::Rotate(), LIB_FIELD::Rotate(), LIB_TEXT::SetText(), LIB_FIELD::SetText(), and DIALOG_LIB_EDIT_PIN::TransferDataFromWindow().

Inside()

bool LIB_BEZIER::Inside ( EDA_RECT &  aRect ) const

overridevirtual

Test if any part of the draw object is inside rectangle bounds of aRect.

Parameters

aRect

Rectangle to check against.

Returns

True if object is inside rectangle.

Implements LIB_ITEM.

Definition at line 92 of file lib_bezier.cpp.

{
    for( size_t i = 0; i < m_PolyPoints.size(); i++ )
    {
        if( aRect.Contains( m_PolyPoints[i].x, -m_PolyPoints[i].y ) )
            return true;
    }

    return false;
}

References EDA_RECT::Contains(), i, and m_PolyPoints.

IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const

inlineinherited

Definition at line 230 of file base_struct.h.

{ return m_Flags & BRIGHTENED; }

References BRIGHTENED, and EDA_ITEM::m_Flags.

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

IsDragging()

bool EDA_ITEM::IsDragging ( ) const

inlineinherited

Definition at line 225 of file base_struct.h.

{ return m_Flags & IS_DRAGGED; }

References IS_DRAGGED, and EDA_ITEM::m_Flags.

Referenced by Abort_Zone_Move_Corner_Or_Outlines(), Collect_TrackSegmentsToDrag(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::DIALOG_EDIT_COMPONENT_IN_SCHEMATIC(), PCB_EDIT_FRAME::OnHotkeyPlaceItem(), PCB_EDIT_FRAME::OnLeftClick(), KIGFX::SCH_PAINTER::setColors(), Show_Zone_Corner_Or_Outline_While_Move_Mouse(), and ShowClearance().

IsFillable()

bool LIB_ITEM::IsFillable ( ) const

inlineinherited

Check if draw object can be filled.

The default setting is false. If the derived object support filling, set the m_isFillable member to true.

Returns

True if draw object can be filled. Default is false.

Definition at line 352 of file lib_draw_item.h.

{ return m_isFillable; }

References LIB_ITEM::m_isFillable.

Referenced by LIB_EDIT_TOOL::editGraphicProperties(), and DIALOG_LIB_EDIT_DRAW_ITEM::TransferDataToWindow().

IsHighlighted()

bool EDA_ITEM::IsHighlighted ( ) const

inlineinherited

Definition at line 229 of file base_struct.h.

{ return m_Flags & HIGHLIGHTED; }

References HIGHLIGHTED, and EDA_ITEM::m_Flags.

Referenced by KIGFX::SCH_PAINTER::getRenderColor().

IsModified()

bool EDA_ITEM::IsModified ( ) const

inlineinherited

Definition at line 223 of file base_struct.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 224 of file base_struct.h.

{ return m_Flags & IS_MOVED; }

References IS_MOVED, and EDA_ITEM::m_Flags.

Referenced by Abort_MoveOrCopyModule(), Abort_Zone_Move_Corner_Or_Outlines(), AbortMoveTextModule(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), LIB_CIRCLE::CalcEdit(), LIB_RECTANGLE::CalcEdit(), LIB_FIELD::CalcEdit(), LIB_POLYLINE::CalcEdit(), LIB_ARC::CalcEdit(), LIB_TEXT::CalcEdit(), LIB_PIN::CalcEdit(), LIB_ARC::CalcRadiusAngles(), PCB_EDIT_FRAME::Change_Side_Module(), KIGFX::SCH_PAINTER::draw(), MODULE::Draw(), LIB_EDIT_TOOL::Duplicate(), LIB_EDIT_TOOL::Mirror(), SCH_EDIT_TOOL::Mirror(), PCB_EDIT_FRAME::Place_Texte_Pcb(), PCB_BASE_FRAME::PlaceModule(), LIB_EDIT_TOOL::Rotate(), SCH_EDIT_TOOL::Rotate(), PCB_BASE_FRAME::Rotate_Module(), KIGFX::SCH_PAINTER::setColors(), Show_Zone_Corner_Or_Outline_While_Move_Mouse(), ShowClearance(), and DIALOG_TARGET_PROPERTIES::TransferDataFromWindow().

IsNew()

bool EDA_ITEM::IsNew ( ) const

inlineinherited

Definition at line 222 of file base_struct.h.

{ return m_Flags & IS_NEW; }

References IS_NEW, and EDA_ITEM::m_Flags.

Referenced by Abort_Edit_Pcb_Text(), Abort_EditEdge(), Abort_Move_ModuleOutline(), Abort_MoveOrCopyModule(), Abort_Zone_Create_Outline(), AbortBuildDimension(), AbortMoveAndEditTarget(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_EDIT_TOOL::AutoplaceFields(), LIB_CIRCLE::CalcEdit(), LIB_RECTANGLE::CalcEdit(), LIB_FIELD::CalcEdit(), LIB_POLYLINE::CalcEdit(), LIB_ARC::CalcEdit(), LIB_TEXT::CalcEdit(), LIB_POLYLINE::ContinueEdit(), LIB_ARC::ContinueEdit(), SCH_EDIT_TOOL::ConvertDeMorgan(), SCH_EDIT_FRAME::ConvertTextType(), PCB_EDIT_FRAME::Delete_Segment(), PCB_EDIT_FRAME::Delete_Segment_Edge(), LIB_ARC::drawGraphic(), LIB_EDIT_TOOL::Duplicate(), SCH_EDIT_TOOL::Duplicate(), LIB_PIN::EnableEditMode(), LIB_DRAWING_TOOLS::Init(), isNewSegment(), SCH_MOVE_TOOL::Main(), LIB_MOVE_TOOL::Main(), EDIT_TOOL::MoveExact(), FOOTPRINT_EDIT_FRAME::OnLeftClick(), PCB_EDIT_FRAME::OnLeftClick(), FOOTPRINT_EDIT_FRAME::OnLeftDClick(), PCB_EDIT_FRAME::OnLeftDClick(), PCB_EDIT_FRAME::Place_Texte_Pcb(), PCB_BASE_FRAME::PlaceModule(), LIB_PIN_TOOL::PlacePin(), PCB_EDIT_FRAME::PlaceTarget(), ShowClearance(), PCB_EDIT_FRAME::StartMoveTextePcb(), PCB_EDIT_FRAME::SwitchLayer(), DIALOG_SCH_EDIT_SHEET_PIN::TransferDataFromWindow(), and DIALOG_LABEL_EDITOR::TransferDataFromWindow().

IsReplaceable()

virtual bool EDA_ITEM::IsReplaceable ( ) const

inlinevirtualinherited

Function IsReplaceable.

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_COMPONENT, SCH_SHEET, SCH_LABEL, SCH_FIELD, SCH_SHEET_PIN, and SCH_TEXT.

Definition at line 502 of file base_struct.h.

{ return false; }

Referenced by EDA_ITEM::Matches(), and EDA_ITEM::Replace().

IsResized()

bool EDA_ITEM::IsResized ( ) const

inlineinherited

Definition at line 228 of file base_struct.h.

{ return m_Flags & IS_RESIZED; }

References IS_RESIZED, and EDA_ITEM::m_Flags.

Referenced by LIB_POLYLINE::CalcEdit(), and KIGFX::SCH_PAINTER::setColors().

IsSelected()

bool EDA_ITEM::IsSelected ( ) const

inlineinherited

Definition at line 227 of file base_struct.h.

{ return m_Flags & SELECTED; }

References EDA_ITEM::m_Flags, and SELECTED.

Referenced by SCH_EDIT_FRAME::ConvertPart(), SCH_EDIT_FRAME::ConvertTextType(), KIGFX::PCB_PAINTER::draw(), DrawMovingBlockOutlines(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), KIGFX::SCH_PAINTER::getRenderColor(), MirrorMarkedItems(), MoveMarkedItems(), MoveMarkedItemsExactly(), LIB_TEXT::Plot(), SELECTION_TOOL::RebuildSelection(), EE_SELECTION_TOOL::RebuildSelection(), RotateMarkedItems(), GERBVIEW_SELECTION_TOOL::select(), SELECTION_TOOL::select(), GERBVIEW_SELECTION_TOOL::toggleSelection(), EE_SELECTION_TOOL::toggleSelection(), SELECTION_TOOL::toggleSelection(), and GERBVIEW_SELECTION_TOOL::unselect().

IsType()

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

inlinevirtualinherited

Function IsType Checks 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 SCH_FIELD, and SCH_LINE.

Definition at line 287 of file base_struct.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_SCREEN::GetItem(), SCH_WIRE_BUS_TOOL::IsDrawingBus(), SCH_WIRE_BUS_TOOL::IsDrawingLine(), SCH_WIRE_BUS_TOOL::IsDrawingWire(), SCH_LINE::IsType(), SCH_FIELD::IsType(), EE_POINT_EDITOR::Main(), EE_SELECTION_TOOL::RequestSelection(), and EDA_ITEM::Visit().

IsWireImage()

bool EDA_ITEM::IsWireImage ( ) const

inlineinherited

Definition at line 226 of file base_struct.h.

{ return m_Flags & IS_WIRE_IMAGE; }

References IS_WIRE_IMAGE, and EDA_ITEM::m_Flags.

IterateForward()

SEARCH_RESULT EDA_ITEM::IterateForward ( EDA_ITEM *  listStart, INSPECTOR  inspector, void *  testData, const KICAD_T  scanTypes[]  )

staticinherited

Function IterateForward walks through the object tree calling the inspector() on each object type requested in scanTypes.

Parameters

listStart	The first in a list of EDA_ITEMs to iterate over.
inspector	Is an INSPECTOR to call on each object that is one of the requested scanTypes.
testData	Is an aid to testFunc, and should be sufficient to allow it to fully determine if an item meets the match criteria, but it may also be used to collect output.
scanTypes	A KICAD_T array that is EOT terminated, and provides both the order and interest level of of the types of objects to be iterated over.

Returns

SEARCH_RESULT SEARCH_QUIT if the called INSPECTOR returned SEARCH_QUIT, else SCAN_CONTINUE;

Definition at line 130 of file base_struct.cpp.

{
    EDA_ITEM* p = listStart;

    for( ; p; p = p->Pnext )
    {
        if( SEARCH_QUIT == p->Visit( inspector, testData, scanTypes ) )
            return SEARCH_QUIT;
    }

    return SEARCH_CONTINUE;
}

References EDA_ITEM::Pnext, SEARCH_CONTINUE, SEARCH_QUIT, and EDA_ITEM::Visit().

Referenced by EE_COLLECTOR::Collect(), SCH_FIND_COLLECTOR::Collect(), EE_TYPE_COLLECTOR::Collect(), SCH_FIND_COLLECTOR::GetItem(), EE_SELECTION_TOOL::RebuildSelection(), GERBER_FILE_IMAGE::Visit(), MODULE::Visit(), and BOARD::Visit().

Matches() [1/2]

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

inlinevirtualinherited

Function Matches compares 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.
aFindLocation	A pointer to a wxPoint object to store the location of matched item. The pointer can be NULL if it is not used.

Returns

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

Reimplemented in SCH_COMPONENT, SCH_SHEET, SCH_FIELD, SCH_SHEET_PIN, SCH_TEXT, LIB_PIN, and SCH_MARKER.

Definition at line 458 of file base_struct.h.

    {
        return false;
    }

Referenced by SCH_FIND_COLLECTOR::Inspect(), SCH_MARKER::Matches(), LIB_PIN::Matches(), SCH_TEXT::Matches(), SCH_SHEET_PIN::Matches(), SCH_FIELD::Matches(), and SCH_SHEET::Matches().

Matches() [2/2]

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

protectedinherited

Function Matches compares 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 174 of file base_struct.cpp.

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

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

    if( aSearchData.GetFlags() & wxFR_WHOLEWORD )
        return aText.IsSameAs( searchText, aSearchData.GetFlags() & wxFR_MATCHCASE );

    if( aSearchData.GetFlags() & FR_MATCH_WILDCARD )
    {
        if( aSearchData.GetFlags() & wxFR_MATCHCASE )
            return text.Matches( searchText );

        return text.MakeUpper().Matches( searchText.MakeUpper() );
    }

    if( aSearchData.GetFlags() & wxFR_MATCHCASE )
        return aText.Find( searchText ) != wxNOT_FOUND;

    return text.MakeUpper().Find( searchText.MakeUpper() ) != wxNOT_FOUND;
}

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

MirrorHorizontal()

void LIB_BEZIER::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 124 of file lib_bezier.cpp.

{
    size_t i, imax = m_PolyPoints.size();

    for( i = 0; i < imax; i++ )
    {
        m_PolyPoints[i].x -= aCenter.x;
        m_PolyPoints[i].x *= -1;
        m_PolyPoints[i].x += aCenter.x;
    }

    imax = m_BezierPoints.size();

    for( i = 0; i < imax; i++ )
    {
        m_BezierPoints[i].x -= aCenter.x;
        m_BezierPoints[i].x *= -1;
        m_BezierPoints[i].x += aCenter.x;
    }
}

References i, m_BezierPoints, and m_PolyPoints.

MirrorVertical()

void LIB_BEZIER::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 145 of file lib_bezier.cpp.

{
    size_t i, imax = m_PolyPoints.size();

    for( i = 0; i < imax; i++ )
    {
        m_PolyPoints[i].y -= aCenter.y;
        m_PolyPoints[i].y *= -1;
        m_PolyPoints[i].y += aCenter.y;
    }

    imax = m_BezierPoints.size();

    for( i = 0; i < imax; i++ )
    {
        m_BezierPoints[i].y -= aCenter.y;
        m_BezierPoints[i].y *= -1;
        m_BezierPoints[i].y += aCenter.y;
    }
}

References i, m_BezierPoints, and m_PolyPoints.

MoveTo()

void LIB_BEZIER::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 104 of file lib_bezier.cpp.

{
    if ( !m_PolyPoints.size() )
    {
        m_PolyPoints.push_back( wxPoint(0, 0) );
    }

    Offset( aPosition - m_PolyPoints[ 0 ] );
}

References m_PolyPoints, and Offset().

Next()

EDA_ITEM* EDA_ITEM::Next ( ) const

inlineinherited

Definition at line 212 of file base_struct.h.

{ return Pnext; }

References EDA_ITEM::Pnext.

Referenced by DHEAD::append(), SCH_SCREENS::buildScreenList(), SCH_SHEET_LIST::BuildSheetList(), SCH_SHEET::CleanupSheet(), ClearMarkItems(), SCH_SHEET::ComponentCount(), SCH_SHEET::CountSheets(), DHEAD::DeleteAll(), NETLIST_EXPORTER::findNextComponent(), NETLIST_EXPORTER::findNextComponentAndCreatePinList(), FootprintWriteShape(), MODULE::GetMsgPanelInfo(), SCH_EDIT_FRAME::GetSchematicConnections(), SCH_SHEET::HasUndefinedPins(), SCH_EDIT_FRAME::ImportSheetPin(), ListSetState(), SCH_SHEET::LocatePathOfScreen(), MarkItemsInBloc(), MoveMarkedItems(), MoveMarkedItemsExactly(), SCH_EDIT_FRAME::OnUpdateFields(), DHEAD::remove(), SCH_SHEET::SearchHierarchy(), SCH_EDIT_FRAME::TestDanglingEnds(), SCH_SHEET_PATH::UpdateAllScreenReferences(), and NETLIST_EXPORTER_CADSTAR::WriteNetlist().

Offset()

void LIB_BEZIER::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_bezier.cpp.

{
    size_t i;

    for( i = 0; i < m_BezierPoints.size(); i++ )
        m_BezierPoints[i] += aOffset;

    for( i = 0; i < m_PolyPoints.size(); i++ )
        m_PolyPoints[i] += aOffset;
}

References i, m_BezierPoints, and m_PolyPoints.

Referenced by MoveTo().

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 89 of file lib_draw_item.cpp.

{
    int result = m_Convert - aOther.m_Convert;

    if( result != 0 )
        return result < 0;

    result = m_Unit - aOther.m_Unit;

    if( result != 0 )
        return result < 0;

    result = Type() - aOther.Type();

    if( result != 0 )
        return result < 0;

    return ( compare( aOther ) < 0 );
}

References LIB_ITEM::compare(), LIB_ITEM::m_Convert, LIB_ITEM::m_Unit, 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 231 of file base_struct.cpp.

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

    return false;
}

References Format(), GetChars(), 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 80 of file lib_draw_item.cpp.

{
    return ( ( Type() == aOther.Type() )
             && ( m_Unit == aOther.m_Unit )
             && ( m_Convert == aOther.m_Convert )
             && compare( aOther ) == 0 );
}

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

operator==() [2/2]

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

inlineinherited

Definition at line 250 of file lib_draw_item.h.

    {
        return *this == *aOther;
    }

Plot()

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

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 186 of file lib_bezier.cpp.

{
    wxASSERT( aPlotter != NULL );

    static std::vector< wxPoint > cornerList;
    cornerList.clear();

    for( unsigned ii = 0; ii < m_PolyPoints.size(); ii++ )
    {
        wxPoint pos = m_PolyPoints[ii];
        pos = aTransform.TransformCoordinate( pos ) + aOffset;
        cornerList.push_back( pos );
    }

    if( aFill && m_Fill == FILLED_WITH_BG_BODYCOLOR )
    {
        aPlotter->SetColor( GetLayerColor( LAYER_DEVICE_BACKGROUND ) );
        aPlotter->PlotPoly( cornerList, FILLED_WITH_BG_BODYCOLOR, 0 );
    }

    bool already_filled = m_Fill == FILLED_WITH_BG_BODYCOLOR;
    auto pen_size = GetPenSize();

    if( !already_filled || pen_size > 0 )
    {
        pen_size = std::max( 0, pen_size );
        aPlotter->SetColor( GetLayerColor( LAYER_DEVICE ) );
        aPlotter->PlotPoly( cornerList, already_filled ? NO_FILL : m_Fill, GetPenSize() );
    }
}

References FILLED_WITH_BG_BODYCOLOR, GetLayerColor(), GetPenSize(), LAYER_DEVICE, LAYER_DEVICE_BACKGROUND, LIB_ITEM::m_Fill, m_PolyPoints, max, NO_FILL, PLOTTER::PlotPoly(), PLOTTER::SetColor(), and TRANSFORM::TransformCoordinate().

Replace() [1/2]

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

inherited

Helper function used in search and replace dialog Function Replace performs 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 201 of file base_struct.cpp.

{
    wxCHECK_MSG( IsReplaceable(), false,
                 wxT( "Attempt to replace text in <" ) + GetClass() + wxT( "> item." ) );

    wxString searchString = (aSearchData.GetFlags() & wxFR_MATCHCASE) ? aText : aText.Upper();

    int result = searchString.Find( (aSearchData.GetFlags() & wxFR_MATCHCASE) ?
                                    aSearchData.GetFindString() :
                                    aSearchData.GetFindString().Upper() );

    if( result == wxNOT_FOUND )
        return false;

    wxString prefix = aText.Left( result );
    wxString suffix;

    if( aSearchData.GetFindString().length() + result < aText.length() )
        suffix = aText.Right( aText.length() - ( aSearchData.GetFindString().length() + result ) );

    wxLogTrace( traceFindReplace, wxT( "Replacing '%s', prefix '%s', replace '%s', suffix '%s'." ),
                GetChars( aText ), GetChars( prefix ), GetChars( aSearchData.GetReplaceString() ),
                GetChars( suffix ) );

    aText = prefix + aSearchData.GetReplaceString() + suffix;

    return true;
}

References GetChars(), EDA_ITEM::GetClass(), EDA_ITEM::IsReplaceable(), and traceFindReplace.

Referenced by FOOTPRINT_INFO_GENERATOR::GetHtmlFieldRow(), SCH_TEXT::Replace(), SCH_SHEET_PIN::Replace(), SCH_FIELD::Replace(), SCH_SHEET::Replace(), and SCH_FIND_COLLECTOR::ReplaceItem().

Replace() [2/2]

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

inlinevirtualinherited

Function Replace performs 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_SHEET, SCH_FIELD, SCH_SHEET_PIN, and SCH_TEXT.

Definition at line 490 of file base_struct.h.

{ return false; }

Reserve()

void LIB_BEZIER::Reserve ( size_t  aCount )

inline

Definition at line 65 of file lib_bezier.h.

{ m_BezierPoints.reserve( aCount ); }

References m_BezierPoints.

Rotate() [1/2]

void LIB_BEZIER::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 166 of file lib_bezier.cpp.

{
    int rot_angle = aRotateCCW ? -900 : 900;

    size_t i, imax = m_PolyPoints.size();

    for( i = 0; i < imax; i++ )
    {
        RotatePoint( &m_PolyPoints[i], aCenter, rot_angle );
    }

    imax = m_BezierPoints.size();

    for( i = 0; i < imax; i++ )
    {
        RotatePoint( &m_BezierPoints[i], aCenter, rot_angle );
    }
}

References i, m_BezierPoints, m_PolyPoints, and RotatePoint().

Rotate() [2/2]

virtual void LIB_ITEM::Rotate ( )

inlinevirtualinherited

Rotate the draw item.

Reimplemented in LIB_PIN, LIB_FIELD, and LIB_TEXT.

Definition at line 319 of file lib_draw_item.h.

{}

SetBack()

void EDA_ITEM::SetBack ( EDA_ITEM *  aBack )

inlineinherited

Definition at line 218 of file base_struct.h.

{ Pback = aBack; }

References EDA_ITEM::Pback.

Referenced by DHEAD::append(), DHEAD::insert(), SCH_EDIT_FRAME::PutDataInPreviousState(), DHEAD::remove(), and SwapItemData().

SetBrightened()

void EDA_ITEM::SetBrightened ( )

inlineinherited

Definition at line 235 of file base_struct.h.

{ SetFlags( BRIGHTENED ); }

References BRIGHTENED, and EDA_ITEM::SetFlags().

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), EE_SELECTION_TOOL::highlight(), and SELECTION_TOOL::highlight().

SetConvert()

void LIB_ITEM::SetConvert ( int  aConvert )

inlineinherited

Definition at line 367 of file lib_draw_item.h.

{ m_Convert = aConvert; }

References LIB_ITEM::m_Convert.

Referenced by LIB_PIN_TOOL::CreatePin(), LIB_DRAWING_TOOLS::DrawShape(), SCH_LEGACY_PLUGIN_CACHE::loadArc(), SCH_LEGACY_PLUGIN_CACHE::loadCircle(), SCH_LEGACY_PLUGIN_CACHE::loadPolyLine(), SCH_LEGACY_PLUGIN_CACHE::loadRectangle(), SCH_LEGACY_PLUGIN_CACHE::loadText(), and DIALOG_LIB_EDIT_TEXT::TransferDataFromWindow().

SetFillMode()

void LIB_ITEM::SetFillMode ( FILL_T  aFillMode )

inlineinherited

Definition at line 371 of file lib_draw_item.h.

{ m_Fill = aFillMode; }

References LIB_ITEM::m_Fill.

Referenced by LIB_DRAWING_TOOLS::DrawShape(), LIB_EDIT_TOOL::editGraphicProperties(), SCH_LEGACY_PLUGIN_CACHE::loadArc(), SCH_LEGACY_PLUGIN_CACHE::loadCircle(), SCH_LEGACY_PLUGIN_CACHE::loadPolyLine(), and SCH_LEGACY_PLUGIN_CACHE::loadRectangle().

SetFlags()

void EDA_ITEM::SetFlags ( STATUS_FLAGS  aMask )

inlineinherited

Definition at line 259 of file base_struct.h.

{ m_Flags |= aMask; }

References EDA_ITEM::m_Flags.

Referenced by SCH_EAGLE_PLUGIN::addBusEntries(), PCB_BASE_FRAME::AddModuleToBoard(), AddSegmentToDragList(), PCBNEW_CONTROL::AppendBoard(), PCB_EDIT_FRAME::AppendBoardFile(), PCB_EDIT_FRAME::Begin_DrawSegment(), FOOTPRINT_EDIT_FRAME::Begin_Edge_Module(), PCB_EDIT_FRAME::Begin_Route(), PCB_EDIT_FRAME::Begin_Zone(), LIB_ITEM::BeginEdit(), PCB_EDIT_FRAME::BeginMoveDimensionText(), PCB_EDIT_FRAME::BeginMoveTarget(), PCB_EDIT_FRAME::Change_Side_Module(), SCH_EDIT_FRAME::ConvertPart(), SCH_EDIT_FRAME::ConvertTextType(), CopyMarkedItems(), SCH_EDIT_FRAME::CreateNewText(), LIB_PIN_TOOL::CreatePin(), SCH_EDIT_FRAME::CreateSheetPin(), PCB_EDIT_FRAME::CreateTarget(), PCB_EDIT_FRAME::CreateTextePcb(), FOOTPRINT_EDIT_FRAME::CreateTextModule(), SCH_WIRE_BUS_TOOL::doDrawSegments(), SCH_DRAWING_TOOLS::doPlaceComponent(), SCH_DRAWING_TOOLS::doSingleClickPlace(), LIB_DRAWING_TOOLS::doTwoClickPlace(), SCH_DRAWING_TOOLS::doTwoClickPlace(), KIGFX::SCH_PAINTER::draw(), SCH_DRAWING_TOOLS::DrawSheet(), LIB_EDIT_TOOL::Duplicate(), SCH_EDIT_TOOL::Duplicate(), PCB_EDIT_FRAME::EditDimension(), PCB_EDIT_FRAME::FlipTextePcb(), LIB_EDIT_FRAME::GetComponentFromRedoList(), LIB_EDIT_FRAME::GetComponentFromUndoList(), SCH_MOVE_TOOL::getConnectedDragItems(), FOOTPRINT_EDIT_FRAME::HandleBlockEnd(), KIGFX::SCH_VIEW::HighlightItem(), PCB_BASE_FRAME::Import_Pad_Settings(), SCH_EDIT_FRAME::ImportSheetPin(), InvokeDialogImportGfxBoard(), InvokeDialogImportGfxModule(), EDIT_POINTS_FACTORY::Make(), SCH_SCREEN::MarkConnections(), MarkItemsInBloc(), SCH_MOVE_TOOL::moveItem(), LIB_MOVE_TOOL::moveItem(), KIGFX::ORIGIN_VIEWITEM::ORIGIN_VIEWITEM(), PCB_EDIT_FRAME::Other_Layer_Route(), LIB_EDIT_TOOL::Paste(), SCH_EDITOR_CONTROL::Paste(), SCH_DRAWING_TOOLS::PlaceImage(), PCB_EDITOR_CONTROL::PlaceModule(), DRAWING_TOOL::PlaceText(), SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_TOOL::RepeatDrawItem(), LIB_PIN_TOOL::RepeatPin(), PCB_BASE_FRAME::Rotate_Module(), PCB_EDIT_FRAME::Rotate_Texte_Pcb(), LIB_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::SelectUnit(), EDA_ITEM::SetBrightened(), LIB_PIN::SetConversion(), BLOCK_SELECTOR::SetFlags(), EDA_ITEM::SetHighlighted(), EDA_ITEM::SetModified(), EDA_ITEM::SetSelected(), EDA_ITEM::SetWireImage(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), PCB_EDIT_FRAME::Start_Move_DrawItem(), FOOTPRINT_EDIT_FRAME::Start_Move_EdgeMod(), PCB_EDIT_FRAME::Start_Move_Zone_Corner(), PCB_EDIT_FRAME::Start_Move_Zone_Drag_Outline_Edge(), PCB_EDIT_FRAME::Start_Move_Zone_Outlines(), PCB_EDIT_FRAME::StartMoveModule(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), PCB_BASE_FRAME::StartMovePad(), PCB_BASE_FRAME::StartMoveTexteModule(), PCB_EDIT_FRAME::StartMoveTextePcb(), SCH_WIRE_BUS_TOOL::startSegments(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), and UndrawAndMarkSegmentsToDrag().

SetForceVisible()

void EDA_ITEM::SetForceVisible ( bool  aEnable )

inlineinherited

Function SetForceVisible is used to set and cleag force visible flag used to force the item to be drawn even if it's draw attribute is set to not visible.

Parameters

aEnable

True forces the item to be drawn. False uses the item's visibility setting to determine if the item is to be drawn.

Definition at line 309 of file base_struct.h.

{ m_forceVisible = aEnable; }

References EDA_ITEM::m_forceVisible.

Referenced by SCH_EDIT_FRAME::OnFindSchematicItem(), and SCH_EDIT_FRAME::updateFindReplaceView().

SetHighlighted()

void EDA_ITEM::SetHighlighted ( )

inlineinherited

Definition at line 234 of file base_struct.h.

{ SetFlags( HIGHLIGHTED ); }

References HIGHLIGHTED, and EDA_ITEM::SetFlags().

SetList()

void EDA_ITEM::SetList ( DHEAD *  aList )

inlineinherited

Definition at line 220 of file base_struct.h.

{ m_List = aList; }

References EDA_ITEM::m_List.

Referenced by DHEAD::append(), DHEAD::insert(), DHEAD::remove(), and SwapItemData().

SetModified()

void EDA_ITEM::SetModified ( )

inherited

Definition at line 100 of file base_struct.cpp.

{
    SetFlags( IS_CHANGED );

    // If this a child object, then the parent modification state also needs to be set.
    if( m_Parent )
        m_Parent->SetModified();
}

References IS_CHANGED, EDA_ITEM::m_Parent, EDA_ITEM::SetFlags(), and EDA_ITEM::SetModified().

Referenced by SCH_COMPONENT::ClearAnnotation(), LEGACY_PLUGIN::loadZONE_CONTAINER(), SCH_LINE::Move(), SCH_COMPONENT::Move(), SCH_LINE::MoveEnd(), SCH_LINE::MoveStart(), LIB_PIN::MoveTo(), LIB_PART::RemoveDrawItem(), SCH_COMPONENT::SetConvert(), LIB_PIN::SetLength(), SCH_COMPONENT::SetLibId(), EDA_ITEM::SetModified(), LIB_FIELD::SetName(), LIB_PIN::SetName(), LIB_PIN::SetNameTextSize(), LIB_PIN::SetNumber(), LIB_PIN::SetNumberTextSize(), LIB_PIN::SetOrientation(), LIB_PIN::SetPartNumber(), LIB_PIN::SetPinPosition(), LIB_PIN::SetShape(), SCH_COMPONENT::SetTransform(), LIB_PIN::SetType(), SCH_COMPONENT::SetUnit(), LIB_PIN::SetVisible(), and LIB_PIN::SetWidth().

SetNext()

void EDA_ITEM::SetNext ( EDA_ITEM *  aNext )

inlineinherited

Definition at line 217 of file base_struct.h.

{ Pnext = aNext; }

References EDA_ITEM::Pnext.

Referenced by DHEAD::append(), DHEAD::insert(), SCH_EDIT_FRAME::PutDataInPreviousState(), DHEAD::remove(), and SwapItemData().

SetParent()

void EDA_ITEM::SetParent ( EDA_ITEM *  aParent )

inlineinherited

Definition at line 219 of file base_struct.h.

{ m_Parent = aParent; }

References EDA_ITEM::m_Parent.

Referenced by MODULE::Add(), BOARD::Add(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), BOARD_NETLIST_UPDATER::addNewComponent(), LIB_FIELD::Copy(), CopyMarkedItems(), DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), SCH_WIRE_BUS_TOOL::doUnfoldBus(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_EDIT_TOOL::Duplicate(), PCB_EDIT_FRAME::Exchange_Module(), PCB_IO::FootprintSave(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), LIB_PART::LIB_PART(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), SCH_LEGACY_PLUGIN::loadHierarchy(), LIB_EDIT_FRAME::LoadOneSymbol(), MODULE::MODULE(), DIALOG_LIB_EDIT_PIN::OnPaintShowPanel(), MODULE::operator=(), PCB_PARSER::parseMODULE_unchecked(), PCBNEW_CONTROL::PasteItemsFromClipboard(), PCB_EDITOR_CONTROL::PlaceModule(), BOARD_COMMIT::Push(), FOOTPRINT_PREVIEW_PANEL::renderFootprint(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), SaveCopyOfZones(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SHEET::SCH_SHEET(), SCH_SHEET_PIN::SCH_SHEET_PIN(), LIB_PART::SetFields(), PCB_EDIT_FRAME::StartMoveModule(), SCH_SHEET::SwapData(), SCH_COMPONENT::SwapData(), SwapItemData(), and DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::UpdateFieldsFromLibrary().

SetPosition()

void LIB_ITEM::SetPosition ( const wxPoint &  aPosition )

inlineinherited

Definition at line 292 of file lib_draw_item.h.

{ MoveTo( aPosition ); }

References LIB_ITEM::MoveTo().

Referenced by LIB_DRAWING_TOOLS::doTwoClickPlace(), SCH_LEGACY_PLUGIN_CACHE::loadArc(), SCH_LEGACY_PLUGIN_CACHE::loadCircle(), SCH_LEGACY_PLUGIN_CACHE::loadField(), SCH_LEGACY_PLUGIN_CACHE::loadRectangle(), SCH_LEGACY_PLUGIN_CACHE::loadText(), DIALOG_LIB_EDIT_PIN_TABLE::OnAddRow(), DIALOG_LIB_EDIT_TEXT::TransferDataFromWindow(), and EE_POINT_EDITOR::updateItem().

SetSelected()

void EDA_ITEM::SetSelected ( )

inlineinherited

Definition at line 233 of file base_struct.h.

{ SetFlags( SELECTED ); }

References SELECTED, and EDA_ITEM::SetFlags().

Referenced by EE_SELECTION_TOOL::highlight(), SELECTION_TOOL::highlight(), and GERBVIEW_SELECTION_TOOL::selectVisually().

SetState()

void EDA_ITEM::SetState ( int  type, int  state  )

inlineinherited

Definition at line 248 of file base_struct.h.

    {
        if( state )
            m_Status |= type; // state = ON or OFF
        else
            m_Status &= ~type;
    }

References EDA_ITEM::m_Status.

Referenced by Abort_Move_Pad(), Abort_MoveOrCopyModule(), Abort_MoveTrack(), PCB_EDIT_FRAME::Attribut_net(), PCB_EDIT_FRAME::Attribut_Segment(), PCB_EDIT_FRAME::Attribut_Track(), PCB_EDIT_FRAME::Begin_Route(), BOARD::chainMarkedSegments(), BOARD::CreateLockPoint(), PCB_EDIT_FRAME::Delete_Module(), DeleteNullTrackSegments(), PCB_EDIT_FRAME::End_Route(), PCB_EDIT_FRAME::EraseRedundantTrack(), TRACK::GetEndSegments(), LEGACY_PLUGIN::loadTrackList(), BOARD::MarkTrace(), TRACKS_CLEANER::mergeCollinearSegments(), TRACKS_CLEANER::MergeCollinearTracks(), PCB_EDIT_FRAME::PlaceDraggedOrMovedTrackSegment(), PCB_BASE_FRAME::PlaceModule(), PCB_BASE_FRAME::PlacePad(), PCB_EDIT_FRAME::Remove_One_Track(), TRACK::SetLocked(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), PCB_EDIT_FRAME::StartMoveModule(), UndrawAndMarkSegmentsToDrag(), and updateConn().

SetStatus()

void EDA_ITEM::SetStatus ( STATUS_FLAGS  aStatus )

inlineinherited

Definition at line 257 of file base_struct.h.

{ m_Status = aStatus; }

References EDA_ITEM::m_Status.

Referenced by DeleteNullTrackSegments(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), and BOARD_NETLIST_UPDATER::UpdateNetlist().

SetTimeStamp()

void EDA_ITEM::SetTimeStamp ( timestamp_t  aNewTimeStamp )

inlineinherited

Definition at line 209 of file base_struct.h.

{ m_TimeStamp = aNewTimeStamp; }

References EDA_ITEM::m_TimeStamp.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCB_BASE_FRAME::AddModuleToBoard(), BOARD_NETLIST_UPDATER::addNewComponent(), PCAD2KICAD::PCB_TEXT::AddToBoard(), PCAD2KICAD::PCB_LINE::AddToBoard(), PCAD2KICAD::PCB_ARC::AddToBoard(), PCAD2KICAD::PCB_PAD::AddToBoard(), PCAD2KICAD::PCB_POLYGON::AddToBoard(), PCAD2KICAD::PCB_MODULE::AddToBoard(), SCH_EDIT_FRAME::AppendSchematic(), PCB_EDIT_FRAME::Begin_Zone(), Diagnose(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_EDIT_TOOL::Duplicate(), SCH_ITEM::Duplicate(), DIALOG_FOOTPRINT_BOARD_EDITOR::EditFootprint(), EDIT_TOOL::editFootprintInFpEditor(), PCB_EDIT_FRAME::Exchange_Module(), PCB_IO::FootprintSave(), EDA_ITEM::initVars(), BOARD::InsertArea(), LEGACY_PLUGIN::loadMODULE(), LEGACY_PLUGIN::loadPCB_TARGET(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), EAGLE_PLUGIN::loadPolygon(), EAGLE_PLUGIN::loadSignals(), LEGACY_PLUGIN::loadTrackList(), EDA_ITEM::operator=(), EAGLE_PLUGIN::packageCircle(), EAGLE_PLUGIN::packagePolygon(), EAGLE_PLUGIN::packageRectangle(), EAGLE_PLUGIN::packageText(), PCB_PARSER::parseDIMENSION(), SCH_EDITOR_CONTROL::Paste(), PCB_EDITOR_CONTROL::PlaceModule(), PCB_EDIT_FRAME::Process_Special_Functions(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_SCREENS::ReplaceDuplicateTimeStamps(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SHEET::SCH_SHEET(), SCH_COMPONENT::SetTimeStamp(), SimilarLabelsDiagnose(), SwapItemData(), TestDuplicateSheetNames(), DIALOG_ERC::TestErc(), and TestMultiunitFootprints().

SetUnit()

void LIB_ITEM::SetUnit ( int  aUnit )

inlineinherited

Definition at line 363 of file lib_draw_item.h.

{ m_Unit = aUnit; }

References LIB_ITEM::m_Unit.

Referenced by LIB_PIN_TOOL::CreateImagePins(), LIB_PIN_TOOL::CreatePin(), LIB_DRAWING_TOOLS::DrawShape(), SCH_LEGACY_PLUGIN_CACHE::loadArc(), SCH_LEGACY_PLUGIN_CACHE::loadCircle(), SCH_LEGACY_PLUGIN_CACHE::loadPolyLine(), SCH_LEGACY_PLUGIN_CACHE::loadRectangle(), SCH_LEGACY_PLUGIN_CACHE::loadText(), and DIALOG_LIB_EDIT_TEXT::TransferDataFromWindow().

SetWidth()

void LIB_BEZIER::SetWidth ( int  aWidth )

inlineoverridevirtual

Set the width of the draw item to aWidth.

Implements LIB_ITEM.

Definition at line 101 of file lib_bezier.h.

{ m_Width = aWidth; }

References m_Width.

SetWireImage()

void EDA_ITEM::SetWireImage ( )

inlineinherited

Definition at line 232 of file base_struct.h.

{ SetFlags( IS_WIRE_IMAGE ); }

References IS_WIRE_IMAGE, and EDA_ITEM::SetFlags().

Sort()

static bool EDA_ITEM::Sort ( const EDA_ITEM *  aLeft, const EDA_ITEM *  aRight  )

inlinestaticinherited

Function Sort is a helper function to be used by the C++ STL sort algorithm for sorting a STL container of EDA_ITEM pointers.

Parameters

aLeft	The left hand item to compare.
aRight	The right hand item to compare.

Returns

True if aLeft is less than aRight.

Definition at line 521 of file base_struct.h.

{ return *aLeft < *aRight; }

Referenced by PART_LIB::GetEntryTypePowerNames().

Type()

KICAD_T EDA_ITEM::Type ( ) const

inlineinherited

Function Type()

returns the type of object. This attribute should never be changed after a constructor sets it, so there is no public "setter" method.

Returns

KICAD_T - the type of object.

Definition at line 204 of file base_struct.h.

    {
        return m_StructType;
    }

References EDA_ITEM::m_StructType.

Referenced by Abort_Move_ModuleOutline(), MODULE::Add(), CN_CONNECTIVITY_ALGO::Add(), BOARD::Add(), CN_CLUSTER::Add(), PCB_EDIT_FRAME::Add45DegreeSegment(), POINT_EDITOR::addCorner(), CONNECTION_SUBGRAPH::AddItem(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_MOVE_TOOL::addJunctionsIfNeeded(), SCH_SHEET::AddPin(), ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), CN_ITEM::AnchorCount(), PCB_EDIT_FRAME::Begin_Route(), PCB_EDIT_FRAME::Block_Delete(), PCB_EDIT_FRAME::Block_Duplicate(), PCB_EDIT_FRAME::Block_Flip(), PCB_EDIT_FRAME::Block_Move(), PCB_EDIT_FRAME::Block_Rotate(), CONNECTION_GRAPH::buildConnectionGraph(), HIERARCHY_NAVIG_DLG::buildHierarchyTree(), SCH_SCREENS::buildScreenList(), SCH_SHEET_LIST::BuildSheetList(), calcArea(), calcMaxArea(), POINT_EDITOR::canAddCorner(), SCH_JUNCTION::CanConnect(), SCH_NO_CONNECT::CanConnect(), SCH_BUS_WIRE_ENTRY::CanConnect(), SCH_LINE::CanConnect(), SCH_BUS_BUS_ENTRY::CanConnect(), SCH_LABEL::CanConnect(), SCH_GLOBALLABEL::CanConnect(), SCH_HIERLABEL::CanConnect(), SCH_SHEET::CanConnect(), SCH_COMPONENT::CanConnect(), ROUTER_TOOL::CanInlineDrag(), SCH_SCREENS::ChangeSymbolLibNickname(), CN_VISITOR::checkZoneItemConnection(), TEXTE_PCB::ClassOf(), EDGE_MODULE::ClassOf(), BOARD_CONNECTED_ITEM::ClassOf(), PCB_TARGET::ClassOf(), TEXTE_MODULE::ClassOf(), DRAWSEGMENT::ClassOf(), ZONE_CONTAINER::ClassOf(), MARKER_PCB::ClassOf(), DIMENSION::ClassOf(), NETINFO_ITEM::ClassOf(), TRACK::ClassOf(), MODULE::ClassOf(), SCH_COMPONENT::ClassOf(), D_PAD::ClassOf(), BOARD::ClassOf(), VIA::ClassOf(), SCH_SHEET::CleanupSheet(), EE_COLLECTOR::Collect(), Collect_TrackSegmentsToDrag(), LIB_CIRCLE::compare(), LIB_RECTANGLE::compare(), compare(), LIB_POLYLINE::compare(), LIB_TEXT::compare(), LIB_ARC::compare(), LIB_FIELD::compare(), LIB_PIN::compare(), SCH_SHEET::ComponentCount(), GRID_HELPER::computeAnchors(), SCH_BUS_WIRE_ENTRY::ConnectionPropagatesTo(), SCH_EDIT_FRAME::ConvertTextType(), SCH_SCREEN::CountConnectedItems(), SCH_SHEET::CountSheets(), MODULE::CoverageRatio(), CINFO3D_VISU::createLayers(), BOARD::CreateLockPoint(), SCH_EDIT_FRAME::CreateNewText(), CINFO3D_VISU::createNewTrack(), PCB_EDIT_FRAME::createPopupMenuForTracks(), CreateRoutesSection(), PCB_EDITOR_CONTROL::CrossProbeSchToPcb(), D_PAD::D_PAD(), FOOTPRINT_EDIT_FRAME::Delete_Edge_Module(), SCH_SCREENS::DeleteAllMarkers(), SCH_SCREEN::DeleteItem(), DeleteNullTrackSegments(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_SCH_EDIT_ONE_FIELD::DIALOG_SCH_EDIT_ONE_FIELD(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_ERC::DisplayERC_MarkersList(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), DRC::doTrackDrc(), DRC::doTrackKeepoutDrc(), LIB_DRAWING_TOOLS::doTwoClickPlace(), KIGFX::SCH_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::Draw(), KIGFX::PCB_PAINTER::Draw(), KIGFX::PCB_PAINTER::draw(), DrawMovingBlockOutlines(), drawPickedItems(), CN_ITEM::Dump(), SCH_ITEM::Duplicate(), BOARD::Duplicate(), MODULE::Duplicate(), PCB_EDIT_FRAME::duplicateItems(), SCH_EDIT_FRAME::EditComponent(), SCH_EDIT_FRAME::EditComponentFieldText(), SCH_EDIT_TOOL::EditField(), LIB_EDIT_TOOL::editTextProperties(), EditToolSelectionFilter(), PCB_EDIT_FRAME::EraseRedundantTrack(), CONNECTION_GRAPH::ercCheckLabels(), find_vias_and_tracks_at(), SCH_EDIT_FRAME::FindComponentAndItem(), NETLIST_EXPORTER::findNextComponent(), NETLIST_EXPORTER::findNextComponentAndCreatePinList(), SCH_SHEET_PATH::FindNextItem(), SCH_SHEET_LIST::FindNextItem(), SCH_SHEET_PATH::FindPreviousItem(), SCH_SHEET_LIST::FindPreviousItem(), EDIT_TOOL::FootprintFilter(), FootprintWriteShape(), SCH_LEGACY_PLUGIN::Format(), PCB_IO::Format(), PCB_IO::format(), FormatProbeItem(), POINT_EDITOR::get45DegConstrainer(), CN_ITEM::GetAnchor(), BOARD_ITEM::GetBoard(), TRACK::GetBoundingBox(), BOARD_CONNECTED_ITEM::GetClearance(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), NETLIST_OBJECT::GetComponentParent(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_TEXT::GetConnectionPoints(), CONNECTION_SUBGRAPH::GetDriverPriority(), SCH_TEXT::GetEndPoints(), SCH_SHEET::GetEndPoints(), GetFirstTrack(), GetFirstVia(), SCH_SCREEN::GetHierarchicalItems(), SCH_SCREENS::GetLibNicknames(), TEXTE_PCB::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), CONNECTION_SUBGRAPH::GetNameForDriver(), BOARD_CONNECTED_ITEM::GetNetClass(), CONNECTIVITY_DATA::GetNetItems(), LIB_PART::GetNextDrawItem(), DRAWSEGMENT::GetParentModule(), SCH_SCREEN::GetPin(), LIB_PART::GetPin(), SCH_COMPONENT::GetPinPhysicalPosition(), getRect(), SELECTION::GetTopLeftItem(), EE_SELECTION_TOOL::guessSelectionCandidates(), SELECTION_TOOL::guessSelectionCandidates(), hash_eda(), SCH_SCREENS::HasNoFullyDefinedLibIds(), SCH_SHEET::HasUndefinedPins(), EE_SELECTION_TOOL::highlight(), SELECTION_TOOL::highlight(), KIGFX::SCH_VIEW::HighlightItem(), SCH_EDIT_FRAME::ImportSheetPin(), SCH_EDIT_TOOL::Init(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), EE_COLLECTOR::Inspect(), SCH_FIND_COLLECTOR::Inspect(), GENERAL_COLLECTOR::Inspect(), PCB_LAYER_COLLECTOR::Inspect(), ARRAY_CREATOR::Invoke(), isNewSegment(), TRACK::IsNull(), SCH_LINE::IsParallel(), SCH_SCREEN::IsTerminalPoint(), BOARD_ITEM::IsTrack(), itemIsIncludedByFilter(), CLIPBOARD_IO::Load(), PNS_PCBNEW_RULE_RESOLVER::localPadClearance(), SCH_SHEET::LocatePathOfScreen(), Magnetize(), LIB_MOVE_TOOL::Main(), EE_SELECTION_TOOL::Main(), EDIT_POINTS_FACTORY::Make(), SCH_SCREEN::MarkConnections(), CN_CONNECTIVITY_ALGO::markItemNetAsDirty(), CONNECTIVITY_DATA::MarkItemNetAsDirty(), MarkItemsInBloc(), BOARD::MarkTrace(), TRACKS_CLEANER::mergeCollinearSegments(), TRACKS_CLEANER::MergeCollinearTracks(), SCH_LINE::MergeOverlap(), SCH_EDIT_TOOL::Mirror(), FOOTPRINT_EDIT_FRAME::ModeditLocateAndDisplay(), SCH_MOVE_TOOL::moveItem(), MoveMarkedItems(), MoveMarkedItemsExactly(), SCH_CONNECTION::Name(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), PCB_EDIT_FRAME::OnEditItemRequest(), PCB_EDIT_FRAME::OnHotkeyCopyItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyDeleteItem(), PCB_EDIT_FRAME::OnHotkeyDeleteItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyDuplicateItem(), PCB_EDIT_FRAME::OnHotkeyDuplicateOrArrayItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyEditItem(), PCB_EDIT_FRAME::OnHotkeyEditItem(), PCB_EDIT_FRAME::OnHotkeyFlipItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyMoveItem(), PCB_EDIT_FRAME::OnHotkeyMoveItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyMoveItemExact(), PCB_EDIT_FRAME::OnHotkeyPlaceItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyRotateItem(), PCB_EDIT_FRAME::OnHotkeyRotateItem(), FOOTPRINT_EDIT_FRAME::OnLeftClick(), PCB_EDIT_FRAME::OnLeftClick(), PCB_EDIT_FRAME::OnLeftDClick(), FOOTPRINT_EDIT_FRAME::OnRightClick(), PCB_EDIT_FRAME::OnRightClick(), POINT_EDITOR::OnSelectionChange(), SCH_LINE::operator<(), LIB_ITEM::operator<(), SCH_ITEM::operator<(), SCH_COMPONENT::operator<(), SCH_BITMAP::operator=(), SCH_SHEET::operator=(), SCH_COMPONENT::operator=(), LIB_ITEM::operator==(), OrCell_Trace(), EDIT_TOOL::PadFilter(), BOARD_COMMIT::parentObject(), SCH_EDITOR_CONTROL::Paste(), PCBNEW_CONTROL::PasteItemsFromClipboard(), PCB_BASE_FRAME::PcbGeneralLocateAndDisplay(), DRAWING_TOOL::PlaceImportedGraphics(), SCH_FIELD::Plot(), BRDITEMS_PLOTTER::Plot_1_EdgeModule(), GAL_ARRAY_CREATOR::prePushAction(), PCB_EDIT_FRAME::Process_Special_Functions(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::processItem(), DIALOG_EXCHANGE_FOOTPRINTS::processMatchingModules(), LIB_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Properties(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SELECTION_TOOL::RebuildSelection(), SCH_BASE_FRAME::RefreshItem(), DIALOG_SYMBOL_REMAP::remapSymbolsToLibTable(), MODULE::Remove(), CN_CONNECTIVITY_ALGO::Remove(), BOARD::Remove(), POINT_EDITOR::removeCorner(), POINT_EDITOR::removeCornerCondition(), LIB_PART::RemoveDrawItem(), TRACKS_CLEANER::removeDuplicatesOfTrack(), SCH_SHEET::RemovePin(), FOOTPRINT_EDIT_FRAME::RemoveStruct(), PCB_EDIT_FRAME::RemoveStruct(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_SCREENS::ReplaceDuplicateTimeStamps(), SCH_SCREEN::ReplaceWires(), PCB_BASE_FRAME::ResetTextSize(), BOARD_COMMIT::Revert(), SCH_EDIT_TOOL::Rotate(), SCH_TEXT::Rotate(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), SCH_LEGACY_PLUGIN_CACHE::saveBezier(), SCH_LEGACY_PLUGIN_CACHE::saveCircle(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN_CACHE::savePin(), SCH_LEGACY_PLUGIN_CACHE::savePolyLine(), SCH_LEGACY_PLUGIN_CACHE::saveRectangle(), SCH_LEGACY_PLUGIN_CACHE::saveText(), SCH_EDIT_FRAME::SaveUndoItemInUndoList(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_SHEET::SearchHierarchy(), SELECTION_TOOL::select(), EE_SELECTION_TOOL::selectable(), SELECTION_TOOL::selectable(), PCB_EDIT_FRAME::SelectHighLight(), ITEM_PICKER::SetItem(), DIALOG_LABEL_EDITOR::SetTitle(), PCB_EDIT_FRAME::SetTrackSegmentWidth(), PCB_EDIT_FRAME::Show_1_Ratsnest(), Show_MoveNode(), ShowClearance(), ShowNewTrackWhenMovingCursor(), SortByTimeStamp(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), SCH_JUNCTION::SwapData(), SCH_NO_CONNECT::SwapData(), PCB_TARGET::SwapData(), SCH_BITMAP::SwapData(), SCH_SHEET_PIN::SwapData(), TEXTE_PCB::SwapData(), SCH_FIELD::SwapData(), DIMENSION::SwapData(), DRAWSEGMENT::SwapData(), TRACK::SwapData(), SCH_SHEET::SwapData(), VIA::SwapData(), SCH_COMPONENT::SwapData(), MODULE::SwapData(), ZONE_CONTAINER::SwapData(), D_PAD::SwapData(), SwapItemData(), PCB_EDIT_FRAME::SwitchLayer(), TestDuplicateSheetNames(), TRACKS_CLEANER::testTrackEndpointDangling(), TEXTE_MODULE::TEXTE_MODULE(), AR_MATRIX::TraceSegmentPcb(), TraceSegmentPcb(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LABEL_EDITOR::TransferDataToWindow(), TRACK::TransformShapeWithClearanceToPolygon(), EE_SELECTION_TOOL::unhighlight(), SELECTION_TOOL::unhighlight(), SCH_SHEET_PATH::UpdateAllScreenReferences(), SCH_TEXT::UpdateDanglingState(), EE_POINT_EDITOR::updateItem(), POINT_EDITOR::updateItem(), CONNECTION_GRAPH::updateItemConnectivity(), EE_POINT_EDITOR::updatePoints(), POINT_EDITOR::updatePoints(), EE_TOOL_BASE< SCH_BASE_FRAME >::updateView(), PCB_BRIGHT_BOX::ViewDraw(), SCH_BUS_ENTRY_BASE::ViewGetLayers(), TRACK::Visit(), GERBER_DRAW_ITEM::Visit(), SCH_SHEET::Visit(), and SCH_COMPONENT::Visit().

ViewBBox()

const BOX2I EDA_ITEM::ViewBBox ( ) const

overridevirtualinherited

Function ViewBBox() returns the bounding box of the item covering all its layers.

Returns

BOX2I - the current bounding box

Implements KIGFX::VIEW_ITEM.

Reimplemented in D_PAD, MODULE, EDIT_POINTS, GERBER_DRAW_ITEM, TRACK, DRAWSEGMENT, DIMENSION, TEXTE_MODULE, LIB_ALIAS, KIGFX::WORKSHEET_VIEWITEM, MARKER_PCB, ROUTER_PREVIEW_ITEM, KIGFX::PREVIEW::CENTRELINE_RECT_ITEM, KIGFX::ORIGIN_VIEWITEM, KIGFX::PREVIEW::POLYGON_ITEM, KIGFX::PREVIEW::SELECTION_AREA, KIGFX::PREVIEW::RULER_ITEM, KIGFX::RATSNEST_VIEWITEM, BRIGHT_BOX, and KIGFX::PREVIEW::ARC_ASSISTANT.

Definition at line 257 of file base_struct.cpp.

{
    // Basic fallback
    return BOX2I( VECTOR2I( GetBoundingBox().GetOrigin() ),
                  VECTOR2I( GetBoundingBox().GetSize() ) );
}

References EDA_ITEM::GetBoundingBox().

Referenced by BRIGHT_BOX::ViewBBox(), DIMENSION::ViewBBox(), DRAWSEGMENT::ViewBBox(), and BRIGHT_BOX::ViewDraw().

ViewDraw()

virtual void KIGFX::VIEW_ITEM::ViewDraw ( int  aLayer, VIEW *  aView  ) const

inlinevirtualinherited

Function ViewDraw() Draws the parts of the object belonging to layer aLayer.

viewDraw() is an alternative way for drawing objects if if there is no PAINTER assigned for the view or if the PAINTER doesn't know how to paint this particular implementation of VIEW_ITEM. The preferred way of drawing is to design an appropriate PAINTER object, the method below is intended only for quick hacks and debugging purposes.

Parameters

aLayer	current drawing layer
aView	pointer to the VIEW device we are drawing on

Reimplemented in EDIT_POINTS, KIGFX::WORKSHEET_VIEWITEM, ROUTER_PREVIEW_ITEM, KIGFX::VIEW_GROUP, KIGFX::PREVIEW::SELECTION_AREA, KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM, KIGFX::VIEW_OVERLAY, KIGFX::ORIGIN_VIEWITEM, BRIGHT_BOX, KIGFX::PREVIEW::RULER_ITEM, KIGFX::RATSNEST_VIEWITEM, KIGFX::PREVIEW::ARC_ASSISTANT, and PCB_BRIGHT_BOX.

Definition at line 116 of file view_item.h.

    {}

Referenced by KIGFX::VIEW::draw(), and KIGFX::VIEW::updateItemGeometry().

ViewGetLayers()

void LIB_ITEM::ViewGetLayers ( int  aLayers[], int &  aCount  ) const

overridevirtualinherited

Function ViewGetLayers() Returns the all the layers within the VIEW the object is painted on.

For instance, a D_PAD spans zero or more copper layers and a few technical layers. ViewDraw() or PAINTER::Draw() is repeatedly called for each of the layers returned by ViewGetLayers(), depending on the rendering order.

Parameters

aLayers[]	output layer index array
aCount	number of layer indices in aLayers[]

Reimplemented from EDA_ITEM.

Reimplemented in LIB_FIELD, and LIB_TEXT.

Definition at line 134 of file lib_draw_item.cpp.

{
    // Basic fallback
    aCount      = 2;
    aLayers[0]  = LAYER_DEVICE;
    aLayers[1]  = LAYER_DEVICE_BACKGROUND;
}

References LAYER_DEVICE, and LAYER_DEVICE_BACKGROUND.

ViewGetLOD()

virtual unsigned int KIGFX::VIEW_ITEM::ViewGetLOD ( int  aLayer, VIEW *  aView  ) const

inlinevirtualinherited

Function ViewGetLOD() Returns the level of detail (LOD) of the item.

A level of detail is the minimal VIEW scale that is sufficient for an item to be shown on a given layer.

Parameters

aLayer	current drawing layer
aView	pointer to the VIEW device we are drawing on

Returns

the level of detail. 0 always show the item, because the actual zoom level (or VIEW scale) is always > 0

Reimplemented in D_PAD, MODULE, VIA, GERBER_DRAW_ITEM, TRACK, TEXTE_MODULE, and EDGE_MODULE.

Definition at line 140 of file view_item.h.

    {
        // By default always show the item
        return 0;
    }

Referenced by KIGFX::VIEW::drawItem::operator()().

viewPrivData()

VIEW_ITEM_DATA* KIGFX::VIEW_ITEM::viewPrivData ( ) const

inlineinherited

Definition at line 148 of file view_item.h.

    {
        return m_viewPrivData;
    }

References KIGFX::VIEW_ITEM::m_viewPrivData.

Referenced by KIGFX::VIEW::Add(), KIGFX::VIEW::drawItem::deferredDraw(), KIGFX::VIEW::draw(), KIGFX::VIEW::Hide(), KIGFX::VIEW::invalidateItem(), KIGFX::VIEW::IsVisible(), KIGFX::VIEW::OnDestroy(), KIGFX::queryVisitor< Container >::operator()(), KIGFX::VIEW::updateItemsColor::operator()(), KIGFX::VIEW::changeItemsDepth::operator()(), KIGFX::VIEW::drawItem::operator()(), KIGFX::VIEW::recacheItem::operator()(), KIGFX::VIEW::clearLayerCache::operator()(), KIGFX::VIEW::Remove(), KIGFX::VIEW::SetVisible(), KIGFX::VIEW::Update(), KIGFX::VIEW::updateItemColor(), KIGFX::VIEW::updateItemGeometry(), and KIGFX::VIEW::updateLayers().

Visit()

SEARCH_RESULT EDA_ITEM::Visit ( INSPECTOR  inspector, void *  testData, const KICAD_T  scanTypes[]  )

virtualinherited

Function Visit may be re-implemented for each derived class in order to handle all the types given by its member data.

Implementations should call inspector->Inspect() on types in scanTypes[], and may use IterateForward() to do so on lists of such data.

Parameters

inspector	An INSPECTOR instance to use in the inspection.
testData	Arbitrary data used by the inspector.
scanTypes	Which KICAD_T types are of interest and the order is significant too, terminated by EOT.

Returns

SEARCH_RESULT SEARCH_QUIT if the Iterator is to stop the scan, else SCAN_CONTINUE, and determined by the inspector.

Reimplemented in BOARD, LIB_PART, MODULE, SCH_COMPONENT, SCH_SHEET, GERBER_FILE_IMAGE, GERBER_DRAW_ITEM, TRACK, and GBR_LAYOUT.

Definition at line 149 of file base_struct.cpp.

{
#if 0 && defined(DEBUG)
    std::cout << GetClass().mb_str() << ' ';
#endif

    if( IsType( scanTypes ) )
    {
        if( SEARCH_QUIT == inspector( this, testData ) )
            return SEARCH_QUIT;
    }

    return SEARCH_CONTINUE;
}

References EDA_ITEM::GetClass(), EDA_ITEM::IsType(), SEARCH_CONTINUE, and SEARCH_QUIT.

Referenced by GERBER_COLLECTOR::Collect(), GENERAL_COLLECTOR::Collect(), PCB_TYPE_COLLECTOR::Collect(), PCB_LAYER_COLLECTOR::Collect(), and EDA_ITEM::IterateForward().

Member Data Documentation

m_BezierPoints

std::vector<wxPoint> LIB_BEZIER::m_BezierPoints

private

Definition at line 42 of file lib_bezier.h.

Referenced by AddPoint(), compare(), drawGraphic(), GetPoints(), HitTest(), MirrorHorizontal(), MirrorVertical(), Offset(), Reserve(), and Rotate().

m_Convert

int LIB_ITEM::m_Convert

protectedinherited

Shape identification for alternate body styles.

Set 0 if the item is common to all body styles. This is commonly referred to as DeMorgan style and this is typically how it is used in KiCad.

Definition at line 96 of file lib_draw_item.h.

Referenced by LIB_TEXT::Clone(), LIB_ITEM::GetConvert(), LIB_ITEM::GetMsgPanelInfo(), LIB_ITEM::LIB_ITEM(), SCH_LEGACY_PLUGIN_CACHE::loadPin(), LIB_ITEM::operator<(), LIB_ITEM::operator==(), LIB_PIN::SetConversion(), LIB_PART::SetConversion(), LIB_ITEM::SetConvert(), LIB_PIN::SetLength(), LIB_PIN::SetPartNumber(), LIB_PIN::SetPinPosition(), and LIB_PIN::SetShape().

m_Fill

FILL_T LIB_ITEM::m_Fill

protectedinherited

The body fill type.

This has meaning only for some items. For a list of fill types see FILL_T.

Definition at line 102 of file lib_draw_item.h.

Referenced by LIB_CIRCLE::drawGraphic(), LIB_POLYLINE::drawGraphic(), LIB_RECTANGLE::drawGraphic(), drawGraphic(), LIB_ARC::drawGraphic(), LIB_ITEM::GetFillMode(), LIB_ARC::LIB_ARC(), LIB_BEZIER(), LIB_CIRCLE::LIB_CIRCLE(), LIB_ITEM::LIB_ITEM(), LIB_POLYLINE::LIB_POLYLINE(), LIB_RECTANGLE::LIB_RECTANGLE(), LIB_CIRCLE::Plot(), LIB_RECTANGLE::Plot(), Plot(), LIB_POLYLINE::Plot(), LIB_ARC::Plot(), and LIB_ITEM::SetFillMode().

m_Flags

STATUS_FLAGS EDA_ITEM::m_Flags

protectedinherited

Flag bits for editing and other uses.

Definition at line 181 of file base_struct.h.

Referenced by EDA_ITEM::ClearFlags(), LIB_TEXT::Clone(), TRACK::Draw(), DRAWSEGMENT::Draw(), MODULE::Draw(), D_PAD::Draw(), DRAWSEGMENT::DRAWSEGMENT(), LIB_POLYLINE::EndEdit(), EDA_ITEM::GetEditFlags(), EDA_ITEM::GetFlags(), TRACK::GetMsgPanelInfoBase_Common(), LIB_CIRCLE::HitTest(), LIB_POLYLINE::HitTest(), HitTest(), LIB_ARC::HitTest(), SCH_JUNCTION::HitTest(), SCH_LINE::HitTest(), LIB_ITEM::HitTest(), SCH_COMPONENT::HitTest(), LIB_ITEM::InEditMode(), EDA_ITEM::initVars(), EDA_ITEM::IsBrightened(), SCH_ITEM::IsConnected(), EDA_ITEM::IsDragging(), EDA_ITEM::IsHighlighted(), EDA_ITEM::IsModified(), EDA_ITEM::IsMoving(), EDA_ITEM::IsNew(), EDA_ITEM::IsResized(), EDA_ITEM::IsSelected(), EDA_ITEM::IsWireImage(), EDA_ITEM::operator=(), LIB_PIN::SetConversion(), EDA_ITEM::SetFlags(), LIB_PIN::SetLength(), LIB_PIN::SetName(), LIB_PIN::SetNameTextSize(), LIB_PIN::SetNumberTextSize(), LIB_PIN::SetOrientation(), LIB_PIN::SetPartNumber(), LIB_PIN::SetPinPosition(), LIB_PIN::SetShape(), LIB_PIN::SetType(), and LIB_PIN::SetVisible().

m_forceVisible

bool EDA_ITEM::m_forceVisible

protectedinherited

Set to true to override the visibility setting of the item.

Definition at line 178 of file base_struct.h.

Referenced by SCH_FIELD::Draw(), EDA_ITEM::initVars(), EDA_ITEM::operator=(), and EDA_ITEM::SetForceVisible().

m_initialCursorPos

wxPoint LIB_ITEM::m_initialCursorPos

protectedinherited

Initial cursor position at the beginning of a move.

Definition at line 105 of file lib_draw_item.h.

Referenced by LIB_CIRCLE::BeginEdit(), LIB_RECTANGLE::BeginEdit(), LIB_POLYLINE::BeginEdit(), LIB_ARC::BeginEdit(), LIB_TEXT::BeginEdit(), LIB_FIELD::BeginEdit(), LIB_CIRCLE::CalcEdit(), LIB_RECTANGLE::CalcEdit(), LIB_FIELD::CalcEdit(), LIB_POLYLINE::CalcEdit(), LIB_ARC::CalcEdit(), and LIB_TEXT::CalcEdit().

m_initialPos

wxPoint LIB_ITEM::m_initialPos

protectedinherited

Temporary position when moving an existing item.

Definition at line 104 of file lib_draw_item.h.

Referenced by LIB_CIRCLE::BeginEdit(), LIB_RECTANGLE::BeginEdit(), LIB_POLYLINE::BeginEdit(), LIB_ARC::BeginEdit(), LIB_TEXT::BeginEdit(), LIB_FIELD::BeginEdit(), LIB_CIRCLE::CalcEdit(), LIB_RECTANGLE::CalcEdit(), LIB_FIELD::CalcEdit(), LIB_POLYLINE::CalcEdit(), LIB_ARC::CalcEdit(), and LIB_TEXT::CalcEdit().

m_isFillable

bool LIB_ITEM::m_isFillable

protectedinherited

Flag to indicate if draw item is fillable.

Default is false.

Definition at line 108 of file lib_draw_item.h.

Referenced by LIB_ITEM::IsFillable(), LIB_ARC::LIB_ARC(), LIB_BEZIER(), LIB_CIRCLE::LIB_CIRCLE(), LIB_ITEM::LIB_ITEM(), LIB_POLYLINE::LIB_POLYLINE(), and LIB_RECTANGLE::LIB_RECTANGLE().

m_List

DHEAD* EDA_ITEM::m_List

protectedinherited

which DLIST I am on.

Definition at line 172 of file base_struct.h.

Referenced by EDA_ITEM::GetList(), EDA_ITEM::initVars(), and EDA_ITEM::SetList().

m_Parent

EDA_ITEM* EDA_ITEM::m_Parent

protectedinherited

Linked list: Link (parent struct)

Definition at line 174 of file base_struct.h.

Referenced by LIB_FIELD::Copy(), D_PAD::D_PAD(), EDGE_MODULE::Draw(), SCH_FIELD::Draw(), TEXTE_MODULE::Draw(), EDA_ITEM::EDA_ITEM(), SCH_FIELD::GetBoundingBox(), LIB_PIN::GetBoundingBox(), TEXTE_MODULE::GetDrawRotation(), SCH_FIELD::GetFullyQualifiedText(), TEXTE_PCB::GetMsgPanelInfo(), EDGE_MODULE::GetMsgPanelInfo(), TEXTE_MODULE::GetMsgPanelInfo(), D_PAD::GetMsgPanelInfo(), BOARD_ITEM::GetParent(), SCH_SHEET_PIN::GetParent(), D_PAD::GetParent(), LIB_ITEM::GetParent(), EDA_ITEM::GetParent(), DRAWSEGMENT::GetParentModule(), LIB_FIELD::HitTest(), EDA_ITEM::initVars(), LIB_ITEM::LIB_ITEM(), SCH_FIELD::Matches(), LIB_FIELD::operator=(), EDA_ITEM::operator=(), SCH_FIELD::Replace(), SCH_COMPONENT::SCH_COMPONENT(), EDGE_MODULE::SetDrawCoord(), TEXTE_MODULE::SetDrawCoord(), D_PAD::SetDrawCoord(), EDGE_MODULE::SetLocalCoord(), TEXTE_MODULE::SetLocalCoord(), D_PAD::SetLocalCoord(), EDA_ITEM::SetModified(), EDA_ITEM::SetParent(), and TEXTE_MODULE::TEXTE_MODULE().

m_PolyPoints

std::vector<wxPoint> LIB_BEZIER::m_PolyPoints

private

Definition at line 43 of file lib_bezier.h.

Referenced by drawGraphic(), GetBoundingBox(), GetCornerCount(), GetOffset(), GetPosition(), HitTest(), Inside(), MirrorHorizontal(), MirrorVertical(), MoveTo(), Offset(), Plot(), and Rotate().

m_TimeStamp

timestamp_t EDA_ITEM::m_TimeStamp

protectedinherited

Time stamp used for logical links.

Definition at line 175 of file base_struct.h.

Referenced by SCH_SHEET::GetMsgPanelInfo(), SCH_COMPONENT::GetPath(), EDA_ITEM::GetTimeStamp(), SCH_COMPONENT::SCH_COMPONENT(), SCH_SHEET::SCH_SHEET(), EDA_ITEM::SetTimeStamp(), and SCH_COMPONENT::SetTimeStamp().

m_Unit

int LIB_ITEM::m_Unit

protectedinherited

Unit identification for multiple parts per package.

Set to 0 if the item is common to all units.

Definition at line 89 of file lib_draw_item.h.

Referenced by LIB_TEXT::Clone(), LIB_ITEM::GetMsgPanelInfo(), LIB_PIN::GetPartNumber(), LIB_ITEM::GetUnit(), LIB_ITEM::LIB_ITEM(), SCH_LEGACY_PLUGIN_CACHE::loadPin(), LIB_ITEM::operator<(), LIB_ITEM::operator==(), LIB_PIN::SetConversion(), LIB_PIN::SetPartNumber(), LIB_ITEM::SetUnit(), and LIB_PART::SetUnitCount().

m_Width

int LIB_BEZIER::m_Width

private

Definition at line 41 of file lib_bezier.h.

Referenced by GetMsgPanelInfo(), GetPenSize(), GetWidth(), LIB_BEZIER(), and SetWidth().

Pback

EDA_ITEM* EDA_ITEM::Pback

protectedinherited

previous in linked list

Definition at line 171 of file base_struct.h.

Referenced by SCH_LINE::Back(), TRACK::Back(), BOARD_ITEM::Back(), GERBER_DRAW_ITEM::Back(), MODULE::Back(), SCH_ITEM::Back(), EDA_ITEM::Back(), EDA_ITEM::initVars(), GERBER_DRAW_ITEM::SetBack(), EDA_ITEM::SetBack(), and TRACK::SetBack().

Pnext

EDA_ITEM* EDA_ITEM::Pnext

protectedinherited

next in linked list

Definition at line 170 of file base_struct.h.

Referenced by TRACK::GetEndNetCode(), TRACK::GetStartNetCode(), EDA_ITEM::initVars(), EDA_ITEM::IterateForward(), GBR_SCREEN::Next(), SCH_LINE::Next(), PCB_SCREEN::Next(), TRACK::Next(), BOARD_ITEM::Next(), GERBER_DRAW_ITEM::Next(), MODULE::Next(), SCH_ITEM::Next(), D_PAD::Next(), EDA_ITEM::Next(), GERBER_DRAW_ITEM::SetNext(), EDA_ITEM::SetNext(), and TRACK::SetNext().

---

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

• lib_bezier.h
• lib_bezier.cpp