LIB_BEZIER Class Reference

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

#include <lib_bezier.h>

Inheritance diagram for LIB_BEZIER:

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	AddPoint (const wxPoint &aPoint)
void	SetOffset (const wxPoint &aOffset) override
	Set the drawing object by aOffset from the current position. More...
unsigned	GetCornerCount () const
const std::vector< wxPoint > &	GetPoints () const
bool	HitTest (const wxPoint &aPosition) const override
	Function HitTest tests if aPosition is contained within or on the bounding area of an item. More...
bool	HitTest (const wxPoint &aPosRef, int aThreshold, const TRANSFORM &aTransform) const override
const EDA_RECT	GetBoundingBox () const override
bool	Inside (EDA_RECT &aRect) const override
	Test if any part of the draw object is inside rectangle bounds of aRect. More...
void	Move (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 (std::vector< MSG_PANEL_ITEM > &aList) override
	Display basic info (type, part and convert) about the current item in message panel. 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=wxPoint(0, 0))
	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, bool aAbort=false)
	End an object editing action. More...
virtual void	Draw (EDA_DRAW_PANEL *aPanel, wxDC *aDC, const wxPoint &aOffset, COLOR4D aColor, GR_DRAWMODE aDrawMode, void *aData, const TRANSFORM &aTransform)
	Draw an item. More...
LIB_PART *	GetParent () const
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...
void	SetEraseLastDrawItem (bool aErase=true)
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
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 () 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	ViewGetLayers (int aLayers[], int &aCount) const override
	Function ViewGetLayers() Returns the all the layers within the VIEW the object is painted on. 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

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, COLOR4D aColor, GR_DRAWMODE aDrawMode, 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.

Constructor & Destructor Documentation

LIB_BEZIER::LIB_BEZIER

(

LIB_PART *

aParent

)

Definition at line 43 of file lib_bezier.cpp.

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

Referenced by Clone().

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

LIB_BEZIER::~LIB_BEZIER ( )

inline

Definition at line 54 of file lib_bezier.h.

{ }

Member Function Documentation

void LIB_BEZIER::AddPoint ( const wxPoint &  aPoint )

inline

Definition at line 66 of file lib_bezier.h.

References SetOffset().

{ m_BezierPoints.push_back( aPoint ); }

EDA_ITEM* EDA_ITEM::Back ( ) const

inlineinherited

Definition at line 218 of file base_struct.h.

References EDA_ITEM::Pback.

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

{ return Pback; }

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

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_ARC, LIB_TEXT, LIB_POLYLINE, LIB_RECTANGLE, and LIB_CIRCLE.

Definition at line 170 of file lib_draw_item.h.

Referenced by LIB_EDIT_FRAME::CreateGraphicItem(), LIB_EDIT_FRAME::StartModifyDrawSymbol(), and LIB_EDIT_FRAME::StartMoveDrawSymbol().

{}

void EDA_ITEM::ClearBrightened ( )

inlineinherited

Definition at line 244 of file base_struct.h.

References BRIGHTENED, EDA_ITEM::ClearFlags(), and EDA_ITEM::SetModified().

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

{ ClearFlags( BRIGHTENED ); }

void EDA_ITEM::ClearFlags ( STATUS_FLAGS  aMask = EDA_ITEM_ALL_FLAGS )

inlineinherited

Definition at line 265 of file base_struct.h.

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(), abortMoveBitmap(), AbortMoveDimensionText(), abortMoveItem(), AbortMoveTextModule(), AbortPinMove(), SCH_SCREEN::addConnectedItemsToBlock(), SCH_EDIT_FRAME::addCurrentItemToList(), PNS_KICAD_IFACE::AddItem(), PCB_EDIT_FRAME::AppendBoardFile(), PCB_EDIT_FRAME::Begin_DrawSegment(), FOOTPRINT_EDIT_FRAME::Begin_Edge_Module(), PCB_EDIT_FRAME::Begin_Zone(), SCH_EDIT_FRAME::BeginSegment(), PCB_EDIT_FRAME::Block_Delete(), PCB_EDIT_FRAME::Block_Flip(), PCB_EDIT_FRAME::Block_Move(), PCB_EDIT_FRAME::Change_Side_Module(), SCH_SCREEN::ClearAnnotation(), EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearHighlighted(), DRAG_LIST::ClearList(), ClearMarkItems(), clearModuleItemFlags(), EDA_ITEM::ClearSelected(), SCH_EDIT_FRAME::ConvertPart(), SCH_EDIT_FRAME::copyBlockItems(), CopyMarkedItems(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::copyPanelToOptions(), 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(), 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_Zone(), EraseDragList(), PCB_EDIT_FRAME::Exchange_Module(), ExitSheet(), SCH_SCREEN::GetConnection(), PCB_BASE_FRAME::GlobalChange_PadSettings(), PCB_BASE_FRAME::Import_Pad_Settings(), SCH_JUNCTION::IsSelectStateChanged(), SCH_NO_CONNECT::IsSelectStateChanged(), SCH_MARKER::IsSelectStateChanged(), SCH_BUS_ENTRY_BASE::IsSelectStateChanged(), SCH_BITMAP::IsSelectStateChanged(), SCH_LINE::IsSelectStateChanged(), SCH_TEXT::IsSelectStateChanged(), SCH_SHEET::IsSelectStateChanged(), SCH_COMPONENT::IsSelectStateChanged(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), MarkItemsInBloc(), MirrorX(), MirrorY(), moveBitmap(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), LIB_EDIT_FRAME::OnEditPin(), FOOTPRINT_EDIT_FRAME::OnLeftClick(), SCH_EDIT_FRAME::OnLeftClick(), PCB_EDIT_FRAME::OnLeftClick(), LIB_EDIT_FRAME::OnRotateItem(), SCH_EDIT_FRAME::OnSelectUnit(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), SCH_FIELD::Place(), PCB_EDIT_FRAME::Place_DrawItem(), FOOTPRINT_EDIT_FRAME::Place_EdgeMod(), PCB_EDIT_FRAME::Place_Texte_Pcb(), PCBNEW_CONTROL::placeBoardItems(), 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(), LIB_EDIT_FRAME::Process_Special_Functions(), EDIT_TOOL::Properties(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_FRAME::RepeatDrawItem(), LIB_EDIT_FRAME::RepeatPinItem(), BOARD_COMMIT::Revert(), PCB_BASE_FRAME::Rotate_Module(), RotateListOfItems(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), SCH_LEGACY_PLUGIN_CACHE::savePin(), FOOTPRINT_VIEWER_FRAME::SelectCurrentFootprint(), SCH_EDIT_FRAME::SetRepeatItem(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), PCB_EDIT_FRAME::StartMoveModule(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

{ m_Flags &= ~aMask; }

void EDA_ITEM::ClearHighlighted ( )

inlineinherited

Definition at line 243 of file base_struct.h.

References EDA_ITEM::ClearFlags(), and HIGHLIGHTED.

{ ClearFlags( HIGHLIGHTED ); }

void EDA_ITEM::ClearSelected ( )

inlineinherited

Definition at line 242 of file base_struct.h.

References EDA_ITEM::ClearFlags(), and SELECTED.

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

{ ClearFlags( SELECTED ); }

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.

References LIB_BEZIER().

Referenced by SetWidth().

{
    return new LIB_BEZIER( *this );
}

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.

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

Referenced by SetWidth().

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

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_FIELD, LIB_ARC, LIB_TEXT, LIB_POLYLINE, LIB_RECTANGLE, and LIB_CIRCLE.

Definition at line 182 of file lib_draw_item.h.

{ return false; }

void LIB_ITEM::Draw ( EDA_DRAW_PANEL *  aPanel, wxDC *  aDC, const wxPoint &  aOffset, COLOR4D  aColor, GR_DRAWMODE  aDrawMode, 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
aColor	Draw color, or COLOR4D::UNSPECIFIED to use the normal body item color
aDrawMode	GR_OR, GR_XOR, ...
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 115 of file lib_draw_item.cpp.

References LIB_ITEM::calcEdit(), color, LIB_ITEM::drawEditGraphics(), LIB_ITEM::drawGraphic(), g_XorMode, EDA_DRAW_PANEL::GetClipBox(), LIB_ITEM::GetDefaultColor(), GRSetDrawMode(), LIB_ITEM::InEditMode(), LIB_ITEM::m_eraseLastDrawItem, LIB_ITEM::m_Fill, and NO_FILL.

Referenced by LIB_EDIT_FRAME::CreatePin(), DrawMovePin(), DrawMovingBlockOutlines(), LIB_EDIT_FRAME::EditSymbolText(), LIB_ITEM::EndEdit(), LIB_EDIT_FRAME::GraphicItemBeginDraw(), DIALOG_LIB_EDIT_PIN::OnPaintShowPanel(), LIB_EDIT_FRAME::Process_Special_Functions(), RedrawWhileMovingCursor(), LIB_PART::RemoveDrawItem(), and SymbolDisplayDraw().

{
    if( InEditMode() )
    {
        // Temporarily disable filling while the item is being edited.
        FILL_T fillMode = m_Fill;
        COLOR4D color = GetDefaultColor();

        m_Fill = NO_FILL;

#ifndef USE_WX_OVERLAY
        // Erase the old items using the previous attributes.
        if( m_eraseLastDrawItem )
        {
            GRSetDrawMode( aDC, g_XorMode );
            drawEditGraphics( aPanel->GetClipBox(), aDC, color );
            drawGraphic( aPanel, aDC, wxPoint( 0, 0 ), color, g_XorMode, aData,
                         aTransform );
        }
#endif
        // Calculate the new attributes at the current cursor position.
        calcEdit( aOffset );

        // Draw the items using the new attributes.
        drawEditGraphics( aPanel->GetClipBox(), aDC, color );
        drawGraphic( aPanel, aDC, wxPoint( 0, 0 ), color, g_XorMode, aData,
                     aTransform );

        m_Fill = fillMode;
    }
    else
    {
        drawGraphic( aPanel, aDC, aOffset, aColor, aDrawMode, aData, aTransform );
    }
}

void LIB_BEZIER::drawGraphic ( EDA_DRAW_PANEL *  aPanel, wxDC *  aDC, const wxPoint &  aOffset, COLOR4D  aColor, GR_DRAWMODE  aDrawMode, 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.
aColor	A COLOR4D to draw the object or COLOR4D::UNSPECIFIED to draw the object in it's default color.
aDrawMode	The mode used to perform the draw (GR_OR, GR_COPY, etc.).
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 205 of file lib_bezier.cpp.

References color, FILLED_SHAPE, FILLED_WITH_BG_BODYCOLOR, GetBoundingBox(), EDA_DRAW_PANEL::GetClipBox(), GetItemSelectedColor(), GetLayerColor(), EDA_RECT::GetOrigin(), GetPenSize(), BEZIER_POLY::GetPoly(), GRPoly(), GRRect(), GRSetDrawMode(), i, IS_MOVED, EDA_ITEM::IsSelected(), LAYER_DEVICE, LAYER_DEVICE_BACKGROUND, LIGHTMAGENTA, m_BezierPoints, LIB_ITEM::m_Fill, EDA_ITEM::m_Flags, m_PolyPoints, NO_FILL, TRANSFORM::TransformCoordinate(), and wxPoint::x.

{
    std::vector<wxPoint> PolyPointsTraslated;

    COLOR4D color = GetLayerColor( LAYER_DEVICE );
    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 );

    if( aColor == COLOR4D::UNSPECIFIED )                // Used normal color or selected color
    {
        if( IsSelected() )
            color = GetItemSelectedColor();
    }
    else
    {
        color = aColor;
    }

    FILL_T fill = aData ? NO_FILL : m_Fill;

    if( aColor != COLOR4D::UNSPECIFIED )
        fill = NO_FILL;

    GRSetDrawMode( aDC, aDrawMode );
    EDA_RECT* const clipbox  = aPanel? aPanel->GetClipBox() : NULL;

    if( fill == FILLED_WITH_BG_BODYCOLOR )
        GRPoly( clipbox, aDC, m_PolyPoints.size(),
                &PolyPointsTraslated[0], 1, GetPenSize(),
                (m_Flags & IS_MOVED) ? color : GetLayerColor( LAYER_DEVICE_BACKGROUND ),
                GetLayerColor( LAYER_DEVICE_BACKGROUND ) );
    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 );

    /* Set to one (1) to draw bounding box around bezier curve to validate
     * bounding box calculation. */
#if 0
    EDA_RECT bBox = GetBoundingBox();
    GRRect( aPanel->GetClipBox(), aDC, bBox.GetOrigin().x, bBox.GetOrigin().y,
            bBox.GetEnd().x, bBox.GetEnd().y, 0, LIGHTMAGENTA );
#endif
}

virtual void LIB_ITEM::EndEdit ( const wxPoint &  aPosition, bool  aAbort = false  )

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.
aAbort	Set to true to abort the current edit in progress.

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

Definition at line 192 of file lib_draw_item.h.

References LIB_ITEM::Draw(), LIB_ITEM::GetPenSize(), and EDA_ITEM::m_Flags.

Referenced by AbortSymbolTraceOn(), and LIB_EDIT_FRAME::EndDrawGraphicItem().

{ m_Flags = 0; }

const EDA_RECT LIB_BEZIER::GetBoundingBox ( ) const

overridevirtual

Returns

the boundary box for this, in library coordinates

Reimplemented from LIB_ITEM.

Definition at line 293 of file lib_bezier.cpp.

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

Referenced by drawGraphic(), GetMsgPanelInfo(), and GetPoints().

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

wxString LIB_BEZIER::GetClass ( ) const

inlineoverridevirtual

Function GetClass returns the class name.

Returns

wxString

Implements EDA_ITEM.

Definition at line 56 of file lib_bezier.h.

    {
        return wxT( "LIB_BEZIER" );
    }

int LIB_ITEM::GetConvert ( ) const

inlineinherited

Definition at line 381 of file lib_draw_item.h.

References LIB_ITEM::m_Convert.

Referenced by LIB_EDIT_FRAME::deleteItem(), LIB_EDIT_FRAME::EditGraphicSymbol(), SCH_SCREEN::GetPin(), DIALOG_LIB_EDIT_TEXT::initDlg(), LIB_COLLECTOR::Inspect(), LIB_EDIT_FRAME::OnCheckComponent(), LIB_EDIT_FRAME::OnEditPin(), LIB_EDIT_FRAME::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(), sort_by_pin_number(), and LIB_EDIT_FRAME::StartMovePin().

{ return m_Convert; }

unsigned LIB_BEZIER::GetCornerCount ( ) const

inline

Returns

the number of corners

Definition at line 73 of file lib_bezier.h.

Referenced by GetBoundingBox(), and HitTest().

{ return m_PolyPoints.size(); }

COLOR4D LIB_ITEM::GetDefaultColor ( )

virtualinherited

Reimplemented in LIB_FIELD.

Definition at line 155 of file lib_draw_item.cpp.

References GetLayerColor(), and LAYER_DEVICE.

Referenced by LIB_ITEM::Draw(), LIB_TEXT::drawGraphic(), LIB_TEXT::Plot(), and LIB_ITEM::SetEraseLastDrawItem().

{
    return GetLayerColor( LAYER_DEVICE );
}

FILL_T LIB_ITEM::GetFillMode ( ) const

inlineinherited

Definition at line 385 of file lib_draw_item.h.

References LIB_ITEM::compare(), and LIB_ITEM::m_Fill.

Referenced by LIB_EDIT_FRAME::EditGraphicSymbol(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), SCH_LEGACY_PLUGIN_CACHE::saveBezier(), SCH_LEGACY_PLUGIN_CACHE::saveCircle(), SCH_LEGACY_PLUGIN_CACHE::savePolyLine(), and SCH_LEGACY_PLUGIN_CACHE::saveRectangle().

{ return m_Fill; }

STATUS_FLAGS EDA_ITEM::GetFlags ( ) const

inlineinherited

Definition at line 266 of file base_struct.h.

References EDA_ITEM::m_Flags.

Referenced by AbortMoveAndEditTarget(), SCH_SCREEN::addConnectedItemsToBlock(), AddMenusForBitmap(), AddMenusForBusEntry(), AddMenusForComponent(), AddMenusForComponentField(), AddMenusForEditComponent(), AddMenusForGLabel(), AddMenusForHierchicalSheet(), AddMenusForHLabel(), AddMenusForLabel(), AddMenusForSheetPin(), AddMenusForText(), SCH_EDIT_FRAME::BeginSegment(), SCH_EDIT_FRAME::ChangeTextOrient(), Collect_TrackSegmentsToDrag(), SCH_EDIT_FRAME::ConvertPart(), SCH_EDIT_FRAME::copyBlockItems(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::copyPanelToOptions(), LIB_EDIT_FRAME::copySelectedItems(), LIB_EDIT_FRAME::CreatePin(), 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::DeleteItem(), SCH_EDIT_FRAME::DeleteItemsInList(), SCH_EDIT_FRAME::DeleteJunction(), BOARD::Draw(), PCB_EDIT_FRAME::Edit_TrackSegm_Width(), SCH_EDIT_FRAME::EditComponentFieldText(), SCH_EDIT_FRAME::EditImage(), PCB_EDIT_FRAME::FlipTextePcb(), LIB_VIEW_FRAME::GeneralControl(), SCH_EDIT_FRAME::GeneralControl(), LIB_EDIT_FRAME::GetComponentFromRedoList(), LIB_EDIT_FRAME::GetComponentFromUndoList(), SCH_SCREEN::GetConnection(), InitialiseDragParameters(), EDA_DRAW_FRAME::isBusy(), Magnetize(), SCH_EDIT_FRAME::MirrorImage(), SCH_EDIT_FRAME::MirrorSheet(), moveBitmap(), SCH_EDIT_FRAME::OnAutoplaceFields(), SCH_EDIT_FRAME::OnConvertTextType(), SCH_EDIT_FRAME::OnCopySchematicItemRequest(), SCH_EDIT_FRAME::OnDragItem(), SCH_EDIT_FRAME::OnEditItem(), LIB_EDIT_FRAME::OnEditPin(), FOOTPRINT_EDIT_FRAME::OnHotKey(), SCH_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(), SCH_EDIT_FRAME::OnLeftClick(), PCB_EDIT_FRAME::OnLeftClick(), FOOTPRINT_EDIT_FRAME::OnLeftDClick(), SCH_EDIT_FRAME::OnLeftDClick(), PCB_EDIT_FRAME::OnLeftDClick(), EDA_DRAW_PANEL::OnMouseEvent(), SCH_EDIT_FRAME::OnMoveItem(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnOKButtonClick(), TARGET_PROPERTIES_DIALOG_EDITOR::OnOkClick(), SCH_EDIT_FRAME::OnOpenLibraryEditor(), SCH_EDIT_FRAME::OnOrient(), FOOTPRINT_EDIT_FRAME::OnRightClick(), GERBVIEW_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRightClick(), PCB_EDIT_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRotate(), SCH_EDIT_FRAME::OnSelectUnit(), SCH_EDIT_FRAME::OrientComponent(), PCBNEW_CONTROL::placeBoardItems(), PCB_EDIT_FRAME::PlaceTarget(), FOOTPRINT_EDIT_FRAME::PrepareItemForHotkey(), LIB_EDIT_FRAME::Process_Special_Functions(), EDIT_TOOL::Properties(), TRACKS_CLEANER::removeDuplicatesOfTrack(), PCB_BASE_FRAME::Rotate_Module(), PCB_EDIT_FRAME::Rotate_Texte_Pcb(), SCH_EDIT_FRAME::RotateField(), SCH_EDIT_FRAME::RotateHierarchicalSheet(), SCH_EDIT_FRAME::RotateImage(), PCB_BASE_FRAME::RotateTextModule(), LIB_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_SCREEN::SelectBlockItems(), SCH_EDIT_FRAME::SetBusEntryShape(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::SetInitCmp(), Show_Drag_Track_Segment_With_Cte_Slope(), Show_MoveNode(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), DIALOG_LABEL_EDITOR::TextPropertiesAccept(), DIALOG_PCB_TEXT_PROPERTIES::TransferDataFromWindow(), and DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataFromWindow().

{ return m_Flags; }

DHEAD* EDA_ITEM::GetList ( ) const

inlineinherited

Definition at line 220 of file base_struct.h.

References EDA_ITEM::m_List.

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

{ return m_List; }

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

Definition at line 281 of file base_struct.cpp.

References dummy_xpm, EDA_ITEM::GetClass(), i, operator<<(), wxPoint::x, and wxPoint::y.

Referenced by SCH_BUS_WIRE_ENTRY::CanConnect(), SCH_BUS_BUS_ENTRY::CanConnect(), SELECTION_TOOL::disambiguationMenu(), EDA_ITEM::HitTest(), FOOTPRINT_EDIT_FRAME::ModeditLocateAndDisplay(), and PCB_BASE_FRAME::PcbGeneralLocateAndDisplay().

{
    return dummy_xpm;
}

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

overridevirtual

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

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

Parameters

aList

is the list to populate.

Reimplemented from LIB_ITEM.

Definition at line 322 of file lib_bezier.cpp.

References BLUE, BROWN, g_UserUnit, GetBoundingBox(), EDA_RECT::GetEnd(), LIB_ITEM::GetMsgPanelInfo(), EDA_RECT::GetOrigin(), m_Width, StringFromValue(), wxPoint::x, and wxPoint::y.

Referenced by SetWidth().

{
    wxString msg;
    EDA_RECT bBox = GetBoundingBox();

    LIB_ITEM::GetMsgPanelInfo( aList );

    msg = StringFromValue( g_UserUnit, 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 ) );
}

LIB_PART* LIB_ITEM::GetParent ( ) const

inlineinherited

Definition at line 217 of file lib_draw_item.h.

References EDA_ITEM::m_Parent.

Referenced by LIB_EDIT_FRAME::CreateImagePins(), LIB_PIN::drawGraphic(), LIB_EDIT_FRAME::EditField(), LIB_EDIT_FRAME::EditGraphicSymbol(), LIB_PIN::EnableEditMode(), LIB_FIELD::GetFullText(), LIB_PIN::IsPowerConnection(), LIB_EDIT_FRAME::OnEditPin(), LIB_PIN::Plot(), 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_FIELD::SetText(), LIB_PIN::SetType(), and LIB_PIN::SetVisible().

    {
        return (LIB_PART *)m_Parent;
    }

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

References GetDefaultLineThickness(), and m_Width.

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

{
    return ( m_Width == 0 ) ? GetDefaultLineThickness() : m_Width;
}

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

inline

Definition at line 75 of file lib_bezier.h.

References GetBoundingBox(), HitTest(), Inside(), m_BezierPoints, and Move().

Referenced by SCH_LEGACY_PLUGIN_CACHE::saveBezier().

    {
        return m_BezierPoints;
    }

wxPoint LIB_BEZIER::GetPosition ( ) const

inlineoverridevirtual

Return the current draw object position.

Returns

A wxPoint object containing the position of the object.

Implements LIB_ITEM.

Definition at line 90 of file lib_bezier.h.

References MirrorHorizontal(), MirrorVertical(), Plot(), and LIB_ITEM::Rotate().

{ return m_PolyPoints[0]; }

wxString EDA_ITEM::GetSelectMenuText ( ) 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, SCH_COMPONENT, MODULE, ZONE_CONTAINER, SCH_SHEET, LIB_PIN, VIA, SEGZONE, SCH_HIERLABEL, DELETED_SCH_ITEM, GERBER_DRAW_ITEM, SCH_GLOBALLABEL, TRACK, DRAWSEGMENT, SCH_LABEL, LIB_FIELD, DIMENSION, TEXTE_MODULE, SCH_SHEET_PIN, SCH_TEXT, SCH_BUS_BUS_ENTRY, SCH_FIELD, SCH_LINE, LIB_ARC, SCH_BUS_WIRE_ENTRY, TEXTE_PCB, LIB_TEXT, SCH_BITMAP, EDGE_MODULE, LIB_POLYLINE, MARKER_PCB, LIB_RECTANGLE, LIB_CIRCLE, PCB_TARGET, SCH_MARKER, SCH_NO_CONNECT, and SCH_JUNCTION.

Definition at line 174 of file base_struct.cpp.

References EDA_ITEM::GetClass().

Referenced by SCH_BUS_WIRE_ENTRY::CanConnect(), SCH_BUS_BUS_ENTRY::CanConnect(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), SELECTION_TOOL::disambiguationMenu(), DRC::fillMarker(), SCH_FIND_COLLECTOR::GetText(), EDA_ITEM::HitTest(), FOOTPRINT_EDIT_FRAME::ModeditLocateAndDisplay(), and PCB_BASE_FRAME::PcbGeneralLocateAndDisplay().

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

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

int EDA_ITEM::GetState ( int  type ) const

inlineinherited

Definition at line 248 of file base_struct.h.

Referenced by BOARD::chainMarkedSegments(), PCB_EDIT_FRAME::createPopupMenuForTracks(), DRAG_SEGM_PICKER::DRAG_SEGM_PICKER(), SCH_JUNCTION::Draw(), SCH_BUS_ENTRY_BASE::Draw(), SCH_LINE::Draw(), SCH_TEXT::Draw(), TRACK::Draw(), SCH_GLOBALLABEL::Draw(), SCH_HIERLABEL::Draw(), SEGZONE::Draw(), ZONE_CONTAINER::DrawFilledArea(), PCB_BASE_EDIT_FRAME::duplicateItem(), PCB_EDIT_FRAME::EraseRedundantTrack(), SCH_EDIT_FRAME::GeneralControl(), LIB_EDIT_FRAME::GeneralControl(), PCB_EDIT_FRAME::GeneralControl(), TRACK::GetEndSegments(), TRACK::GetMsgPanelInfoBase_Common(), TRACK::GetTrack(), PCB_EDIT_FRAME::HandleBlockEnd(), BOARD::HitTestForAnyFilledArea(), TRACK::IsLocked(), BOARD::MarkTrace(), TRACKS_CLEANER::mergeCollinearSegmentIfPossible(), PCB_EDIT_FRAME::OnHotkeyFlipItem(), and PCB_EDIT_FRAME::OnHotkeyRotateItem().

    {
        return m_Status & type;
    }

STATUS_FLAGS EDA_ITEM::GetStatus ( ) const

inlineinherited

Definition at line 261 of file base_struct.h.

References EDA_ITEM::m_Status.

Referenced by PCB_IO::format(), and GERBER_DRAW_ITEM::HitTest().

{ return m_Status; }

timestamp_t EDA_ITEM::GetTimeStamp ( ) const

inlineinherited

Definition at line 215 of file base_struct.h.

References EDA_ITEM::m_TimeStamp.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::AddColumn(), SCH_EDIT_FRAME::AnnotateComponents(), FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::copyOptionsToPanel(), PCB_EDIT_FRAME::Delete_OldZone_Fill(), PCB_EDIT_FRAME::Delete_Zone_Contour(), DuplicateStruct(), EDIT_TOOL::editFootprintInFpEditor(), SCH_EDIT_FRAME::EditSheet(), PCB_EDIT_FRAME::Exchange_Module(), PCB_IO::format(), FormatProbeItem(), EDGE_MODULE::GetMsgPanelInfo(), NETLIST_OBJECT::GetShortNetName(), DIALOG_FOOTPRINT_BOARD_EDITOR::GotoModuleEditor(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), NETLIST_EXPORTER_GENERIC::makeComponents(), mapExistingAnnotation(), FIELDS_EDITOR_GRID_DATA_MODEL::match(), FOOTPRINT_EDIT_FRAME::OnUpdateInsertModuleInBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateReplaceModuleInBoard(), SCH_SHEET_PATH::Path(), PCB_BASE_FRAME::PcbGeneralLocateAndDisplay(), FOOTPRINT_EDIT_FRAME::Process_Special_Functions(), RecreateCmpFile(), SCH_SCREENS::ReplaceDuplicateTimeStamps(), SCH_LEGACY_PLUGIN::saveComponent(), SCH_LEGACY_PLUGIN::saveSheet(), SCH_REFERENCE::SCH_REFERENCE(), SortByTimeStamp(), and SwapItemData().

{ return m_TimeStamp; }

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

    {
        return _( "Bezier" );
    }

int LIB_ITEM::GetUnit ( ) const

inlineinherited

Definition at line 377 of file lib_draw_item.h.

References LIB_ITEM::m_Unit.

Referenced by LIB_EDIT_FRAME::CreateImagePins(), LIB_EDIT_FRAME::EditGraphicSymbol(), SCH_SCREEN::GetPin(), DIALOG_LIB_EDIT_TEXT::initDlg(), LIB_COLLECTOR::Inspect(), LIB_EDIT_FRAME::OnCheckComponent(), LIB_EDIT_FRAME::OnEditPin(), 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(), and sort_by_pin_number().

{ return m_Unit; }

int LIB_BEZIER::GetWidth ( ) const

inlineoverridevirtual

Return the width of the draw item.

Returns

Width of draw object.

Implements LIB_ITEM.

Definition at line 101 of file lib_bezier.h.

References m_Width.

Referenced by SCH_LEGACY_PLUGIN_CACHE::saveBezier().

{ return m_Width; }

bool LIB_BEZIER::HitTest ( const wxPoint &  aPosition ) const

overridevirtual

Function HitTest tests if aPosition is contained within or on the bounding area of an item.

Parameters

aPosition

A reference to a wxPoint object containing the coordinates to test.

Returns

True if aPosition is within or on the item bounding area.

Reimplemented from LIB_ITEM.

Definition at line 261 of file lib_bezier.cpp.

References DefaultTransform, GetPenSize(), and MINIMUM_SELECTION_DISTANCE.

Referenced by GetPoints().

{
    int mindist = GetPenSize() / 2;

    // Have a minimal tolerance for hit test
    if ( mindist < MINIMUM_SELECTION_DISTANCE )
        mindist = MINIMUM_SELECTION_DISTANCE;

    return HitTest( aRefPos, mindist, DefaultTransform );
}

bool LIB_BEZIER::HitTest ( const wxPoint &  aPosition, int  aThreshold, const TRANSFORM &  aTransform  ) const

overridevirtual

Parameters

aPosition	A wxPoint to test.
aThreshold	Maximum distance to this object (usually the half thickness of a line) if < 0, it will be automatically set to half pen size when locating lines or arcs and set to 0 for other items.
aTransform	The transform matrix.

Returns

True if the point aPosition is near this object

Implements LIB_ITEM.

Definition at line 273 of file lib_bezier.cpp.

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

{
    wxPoint start, end;

    if( aThreshold < 0 )
        aThreshold = GetPenSize() / 2;

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

        if ( TestSegmentHit( aPosRef, start, end, aThreshold ) )
            return true;
    }

    return false;
}

bool LIB_ITEM::InEditMode ( ) const

inlineinherited

Return the draw item editing mode status.

Returns

True if the item is being edited.

Definition at line 369 of file lib_draw_item.h.

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

Referenced by LIB_ITEM::Draw(), LIB_EDIT_FRAME::EditField(), LIB_EDIT_FRAME::EditGraphicSymbol(), LIB_EDIT_FRAME::EditSymbolText(), LIB_EDIT_FRAME::IsEditingDrawItem(), LIB_EDIT_FRAME::OnEditPin(), LIB_EDIT_FRAME::OnLeftClick(), LIB_EDIT_FRAME::OnLeftDClick(), LIB_EDIT_FRAME::OnRightClick(), LIB_EDIT_FRAME::OnRotateItem(), LIB_TEXT::Rotate(), LIB_FIELD::Rotate(), LIB_TEXT::SetText(), and LIB_FIELD::SetText().

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

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.

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

Referenced by GetPoints().

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

bool EDA_ITEM::IsBrightened ( ) const

inlineinherited

Definition at line 235 of file base_struct.h.

References BRIGHTENED.

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

{ return m_Flags & BRIGHTENED; }

bool EDA_ITEM::IsDragging ( ) const

inlineinherited

Definition at line 230 of file base_struct.h.

References IS_DRAGGED.

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

{ return m_Flags & IS_DRAGGED; }

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 362 of file lib_draw_item.h.

References LIB_ITEM::m_isFillable.

Referenced by LIB_EDIT_FRAME::EditGraphicSymbol().

{ return m_isFillable; }

bool EDA_ITEM::IsHighlighted ( ) const

inlineinherited

Definition at line 234 of file base_struct.h.

References HIGHLIGHTED.

{ return m_Flags & HIGHLIGHTED; }

bool EDA_ITEM::IsModified ( ) const

inlineinherited

Definition at line 228 of file base_struct.h.

References IS_CHANGED.

Referenced by LIB_EDIT_FRAME::OnEditPin().

{ return m_Flags & IS_CHANGED; }

bool EDA_ITEM::IsMoving ( ) const

inlineinherited

Definition at line 229 of file base_struct.h.

References IS_MOVED.

Referenced by Abort_MoveOrCopyModule(), Abort_Zone_Move_Corner_Or_Outlines(), AbortMoveTextModule(), AddMenusForPin(), LIB_ARC::CalcRadiusAngles(), PCB_EDIT_FRAME::Change_Side_Module(), SCH_EDIT_FRAME::ConvertPart(), MODULE::Draw(), SCH_COMPONENT::Draw(), ExitSheet(), TARGET_PROPERTIES_DIALOG_EDITOR::OnOkClick(), PCB_EDIT_FRAME::Place_Texte_Pcb(), PCB_BASE_FRAME::PlaceModule(), PCB_BASE_FRAME::Rotate_Module(), Show_Zone_Corner_Or_Outline_While_Move_Mouse(), ShowClearance(), and DIALOG_EDIT_FPTEXT::TransferDataFromWindow().

{ return m_Flags & IS_MOVED; }

bool EDA_ITEM::IsNew ( ) const

inlineinherited

Definition at line 227 of file base_struct.h.

References IS_NEW.

Referenced by Abort_Edit_Pcb_Text(), Abort_EditEdge(), Abort_Move_ModuleOutline(), Abort_MoveOrCopyModule(), Abort_Zone_Create_Outline(), AbortBuildDimension(), AbortMoveAndEditTarget(), abortMoveBitmap(), abortMoveItem(), AbortPinMove(), AbortSymbolTraceOn(), SCH_EDIT_FRAME::addCurrentItemToList(), SCH_EDIT_FRAME::addJunctionMenuEntries(), AddMenusForBus(), AddMenusForWire(), PCB_EDIT_FRAME::Delete_Segment(), PCB_EDIT_FRAME::Delete_Segment_Edge(), SCH_EDIT_FRAME::DeleteCurrentSegment(), LIB_ARC::drawEditGraphics(), LIB_ARC::drawGraphic(), DrawMovePin(), SCH_EDIT_FRAME::EditSheetPin(), LIB_PIN::EnableEditMode(), LIB_EDIT_FRAME::EndDrawGraphicItem(), SCH_EDIT_FRAME::EndSegment(), ExitSheet(), LIB_PART::LIB_PART(), SCH_EDIT_FRAME::OnAutoplaceFields(), SCH_EDIT_FRAME::OnConvertTextType(), LIB_EDIT_FRAME::OnEditPin(), SCH_EDIT_FRAME::OnHotKey(), FOOTPRINT_EDIT_FRAME::OnLeftClick(), LIB_EDIT_FRAME::OnLeftClick(), PCB_EDIT_FRAME::OnLeftClick(), FOOTPRINT_EDIT_FRAME::OnLeftDClick(), LIB_EDIT_FRAME::OnLeftDClick(), SCH_EDIT_FRAME::OnLeftDClick(), PCB_EDIT_FRAME::OnLeftDClick(), LIB_EDIT_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRotate(), PCB_EDIT_FRAME::Place_Texte_Pcb(), PCB_BASE_FRAME::PlaceModule(), LIB_EDIT_FRAME::PlacePin(), PCB_EDIT_FRAME::PlaceTarget(), SCH_EDIT_FRAME::PrepareMoveItem(), SCH_EDIT_FRAME::ReSizeSheet(), ShowClearance(), PCB_EDIT_FRAME::StartMoveTextePcb(), PCB_EDIT_FRAME::SwitchLayer(), and DIALOG_LABEL_EDITOR::TextPropertiesAccept().

{ return m_Flags & IS_NEW; }

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 455 of file base_struct.h.

References EDA_ITEM::operator<().

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

{ return false; }

bool EDA_ITEM::IsResized ( ) const

inlineinherited

Definition at line 233 of file base_struct.h.

References IS_RESIZED.

Referenced by ExitSheet().

{ return m_Flags & IS_RESIZED; }

bool EDA_ITEM::IsSelected ( ) const

inlineinherited

Definition at line 232 of file base_struct.h.

References SELECTED.

Referenced by SCH_SCREEN::addConnectedItemsToBlock(), AddMenusForPin(), KIGFX::PCB_PAINTER::draw(), LIB_CIRCLE::drawGraphic(), LIB_POLYLINE::drawGraphic(), LIB_RECTANGLE::drawGraphic(), drawGraphic(), LIB_TEXT::drawGraphic(), LIB_ARC::drawGraphic(), LIB_FIELD::drawGraphic(), DrawMovingBlockOutlines(), LIB_PIN::DrawPinElectricalTypeName(), LIB_PIN::DrawPinSymbol(), LIB_PIN::DrawPinTexts(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), LIB_EDIT_FRAME::GlobalSetPins(), SCH_JUNCTION::IsSelectStateChanged(), SCH_NO_CONNECT::IsSelectStateChanged(), SCH_MARKER::IsSelectStateChanged(), SCH_BUS_ENTRY_BASE::IsSelectStateChanged(), SCH_BITMAP::IsSelectStateChanged(), SCH_LINE::IsSelectStateChanged(), SCH_TEXT::IsSelectStateChanged(), SCH_SHEET::IsSelectStateChanged(), SCH_COMPONENT::IsSelectStateChanged(), MirrorMarkedItems(), MoveMarkedItems(), MoveMarkedItemsExactly(), LIB_TEXT::Plot(), RotateMarkedItems(), SELECTION_TOOL::SanitizeSelection(), GERBVIEW_SELECTION_TOOL::select(), SELECTION_TOOL::select(), SCH_SCREEN::SelectBlockItems(), GERBVIEW_SELECTION_TOOL::toggleSelection(), SELECTION_TOOL::toggleSelection(), GERBVIEW_SELECTION_TOOL::unselect(), and SELECTION_TOOL::unselect().

{ return m_Flags & SELECTED; }

bool EDA_ITEM::IsWireImage ( ) const

inlineinherited

Definition at line 231 of file base_struct.h.

References IS_WIRE_IMAGE.

Referenced by abortMoveItem(), and SCH_FIELD::Draw().

{ return m_Flags & IS_WIRE_IMAGE; }

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 131 of file base_struct.cpp.

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

Referenced by SCH_COLLECTOR::Collect(), SCH_FIND_COLLECTOR::Collect(), SCH_TYPE_COLLECTOR::Collect(), SCH_FIND_COLLECTOR::GetItem(), EDA_ITEM::HitTest(), GERBER_FILE_IMAGE::Visit(), MODULE::Visit(), and BOARD::Visit().

{
    EDA_ITEM* p = listStart;

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

    return SEARCH_CONTINUE;
}

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_SHEET_PIN, SCH_FIELD, SCH_TEXT, LIB_PIN, and SCH_MARKER.

Definition at line 411 of file base_struct.h.

References EDA_ITEM::Replace().

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

    {
        return false;
    }

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 183 of file base_struct.cpp.

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

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

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

References i, m_BezierPoints, m_PolyPoints, and wxPoint::x.

Referenced by GetPosition().

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

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

References i, m_BezierPoints, m_PolyPoints, and wxPoint::y.

Referenced by GetPosition().

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

void LIB_BEZIER::Move ( 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.

References m_PolyPoints, and SetOffset().

Referenced by GetPoints().

{
    SetOffset( aPosition - m_PolyPoints[0] );
}

EDA_ITEM* EDA_ITEM::Next ( ) const

inlineinherited

Definition at line 217 of file base_struct.h.

References EDA_ITEM::Pnext.

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

{ return Pnext; }

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

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

Referenced by LIB_ITEM::operator==().

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

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 240 of file base_struct.cpp.

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

Referenced by EDA_ITEM::IsReplaceable(), and LIB_ALIAS::operator==().

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

    return false;
}

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

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

Referenced by LIB_ITEM::GetBoundingBox().

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

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

inlineinherited

Definition at line 260 of file lib_draw_item.h.

References LIB_ITEM::GetPosition(), LIB_ITEM::Inside(), LIB_ITEM::Move(), LIB_ITEM::operator<(), and LIB_ITEM::SetOffset().

    {
        return *this == *aOther;
    }

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

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

Referenced by GetPosition().

{
    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;
    aPlotter->SetColor( GetLayerColor( LAYER_DEVICE ) );
    aPlotter->PlotPoly( cornerList, already_filled ? NO_FILL : m_Fill, GetPenSize() );
}

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 210 of file base_struct.cpp.

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

Referenced by EDA_ITEM::Matches(), SCH_TEXT::Replace(), SCH_FIELD::Replace(), SCH_SHEET_PIN::Replace(), SCH_SHEET::Replace(), and SCH_FIND_COLLECTOR::ReplaceItem().

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

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_SHEET_PIN, SCH_FIELD, and SCH_TEXT.

Definition at line 443 of file base_struct.h.

{ return false; }

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

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

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

virtual void LIB_ITEM::Rotate ( )

inlinevirtualinherited

Rotate the draw item.

Reimplemented in LIB_PIN, LIB_FIELD, and LIB_TEXT.

Definition at line 329 of file lib_draw_item.h.

References LIB_ITEM::GetWidth(), LIB_ITEM::Plot(), and LIB_ITEM::SetWidth().

Referenced by LIB_CIRCLE::GetPosition(), GetPosition(), LIB_RECTANGLE::GetPosition(), LIB_POLYLINE::GetPosition(), LIB_ARC::GetPosition(), and LIB_ITEM::SetPosition().

{}

void EDA_ITEM::SetBack ( EDA_ITEM *  aBack )

inlineinherited

Definition at line 223 of file base_struct.h.

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

{ Pback = aBack; }

void EDA_ITEM::SetBrightened ( )

inlineinherited

Definition at line 240 of file base_struct.h.

References BRIGHTENED, and EDA_ITEM::SetFlags().

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

{ SetFlags( BRIGHTENED ); }

void LIB_ITEM::SetConvert ( int  aConvert )

inlineinherited

Definition at line 379 of file lib_draw_item.h.

Referenced by LIB_EDIT_FRAME::CreateGraphicItem(), LIB_EDIT_FRAME::CreatePin(), LIB_EDIT_FRAME::EditGraphicSymbol(), and DIALOG_LIB_EDIT_TEXT::OnOkClick().

{ m_Convert = aConvert; }

void LIB_ITEM::SetEraseLastDrawItem ( bool  aErase = true )

inlineinherited

Definition at line 371 of file lib_draw_item.h.

References LIB_ITEM::GetDefaultColor().

Referenced by LIB_CIRCLE::BeginEdit(), LIB_RECTANGLE::BeginEdit(), LIB_POLYLINE::BeginEdit(), LIB_TEXT::BeginEdit(), LIB_ARC::BeginEdit(), LIB_FIELD::BeginEdit(), LIB_CIRCLE::calcEdit(), LIB_POLYLINE::calcEdit(), LIB_RECTANGLE::calcEdit(), LIB_TEXT::calcEdit(), LIB_ARC::calcEdit(), LIB_ARC::ContinueEdit(), LIB_CIRCLE::EndEdit(), LIB_RECTANGLE::EndEdit(), LIB_POLYLINE::EndEdit(), LIB_TEXT::EndEdit(), LIB_ARC::EndEdit(), LIB_FIELD::EndEdit(), RedrawWhileMovingCursor(), and SymbolDisplayDraw().

{ m_eraseLastDrawItem = aErase; }

void LIB_ITEM::SetFillMode ( FILL_T  aFillMode )

inlineinherited

Definition at line 383 of file lib_draw_item.h.

Referenced by LIB_EDIT_FRAME::CreateGraphicItem(), and LIB_EDIT_FRAME::EditGraphicSymbol().

{ m_Fill = aFillMode; }

void EDA_ITEM::SetFlags ( STATUS_FLAGS  aMask )

inlineinherited

Definition at line 264 of file base_struct.h.

Referenced by SCH_EAGLE_PLUGIN::addBusEntries(), SCH_SCREEN::addConnectedItemsToBlock(), 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(), PCB_EDIT_FRAME::BeginMoveDimensionText(), PCB_EDIT_FRAME::BeginMoveTarget(), SCH_EDIT_FRAME::BeginSegment(), PCB_EDIT_FRAME::Change_Side_Module(), SCH_EDIT_FRAME::ConvertPart(), SCH_EDIT_FRAME::copyBlockItems(), CopyMarkedItems(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::copyPanelToOptions(), LIB_PART::CopySelectedItems(), LIB_EDIT_FRAME::copySelectedItems(), SCH_EDIT_FRAME::CreateBusBusEntry(), SCH_EDIT_FRAME::CreateBusWireEntry(), SCH_EDIT_FRAME::CreateNewImage(), SCH_EDIT_FRAME::CreateNewText(), LIB_EDIT_FRAME::CreatePin(), SCH_EDIT_FRAME::CreateSheet(), SCH_EDIT_FRAME::CreateSheetPin(), PCB_EDIT_FRAME::CreateTarget(), PCB_EDIT_FRAME::CreateTextePcb(), FOOTPRINT_EDIT_FRAME::CreateTextModule(), SCH_EDIT_FRAME::DeleteItem(), PCB_EDIT_FRAME::EditDimension(), PCB_EDIT_FRAME::FlipTextePcb(), LIB_EDIT_FRAME::GetComponentFromRedoList(), LIB_EDIT_FRAME::GetComponentFromUndoList(), SCH_SCREEN::GetConnection(), PCB_BASE_FRAME::GlobalChange_PadSettings(), FOOTPRINT_EDIT_FRAME::HandleBlockEnd(), PCB_BASE_FRAME::Import_Pad_Settings(), SCH_EDIT_FRAME::ImportSheetPin(), SCH_JUNCTION::IsSelectStateChanged(), SCH_NO_CONNECT::IsSelectStateChanged(), SCH_MARKER::IsSelectStateChanged(), SCH_BUS_ENTRY_BASE::IsSelectStateChanged(), SCH_BITMAP::IsSelectStateChanged(), SCH_LINE::IsSelectStateChanged(), SCH_TEXT::IsSelectStateChanged(), SCH_SHEET::IsSelectStateChanged(), SCH_COMPONENT::IsSelectStateChanged(), SCH_EDIT_FRAME::Load_Component(), SCH_SCREEN::MarkConnections(), MarkItemsInBloc(), moveBitmap(), SCH_EDIT_FRAME::MoveImage(), SCH_EDIT_FRAME::OnConvertTextType(), SCH_EDIT_FRAME::OnCopySchematicItemRequest(), LIB_EDIT_FRAME::OnEditPin(), TARGET_PROPERTIES_DIALOG_EDITOR::OnOkClick(), SCH_EDIT_FRAME::OnSelectUnit(), KIGFX::ORIGIN_VIEWITEM::ORIGIN_VIEWITEM(), PCB_EDIT_FRAME::Other_Layer_Route(), DRAWING_TOOL::PlaceText(), SCH_EDIT_FRAME::PrepareMoveItem(), LIB_EDIT_FRAME::Process_Special_Functions(), EDIT_TOOL::Properties(), SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_FRAME::RepeatDrawItem(), LIB_EDIT_FRAME::RepeatPinItem(), SCH_EDIT_FRAME::ReSizeSheet(), PCB_BASE_FRAME::Rotate_Module(), PCB_EDIT_FRAME::Rotate_Texte_Pcb(), LIB_EDIT_FRAME::SaveCopyInUndoList(), SCH_SCREEN::SelectBlockItems(), 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(), LIB_EDIT_FRAME::StartMovePin(), PCB_BASE_FRAME::StartMoveTexteModule(), PCB_EDIT_FRAME::StartMoveTextePcb(), DIALOG_PCB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), and UndrawAndMarkSegmentsToDrag().

{ m_Flags |= aMask; }

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 276 of file base_struct.h.

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

{ m_forceVisible = aEnable; }

void EDA_ITEM::SetHighlighted ( )

inlineinherited

Definition at line 239 of file base_struct.h.

References HIGHLIGHTED, and EDA_ITEM::SetFlags().

{ SetFlags( HIGHLIGHTED ); }

void EDA_ITEM::SetList ( DHEAD *  aList )

inlineinherited

Definition at line 225 of file base_struct.h.

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

{ m_List = aList; }

void EDA_ITEM::SetModified ( )

inherited

Definition at line 101 of file base_struct.cpp.

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

Referenced by SCH_COMPONENT::ClearAnnotation(), EDA_ITEM::ClearBrightened(), SCH_LINE::Move(), LIB_PIN::Move(), SCH_COMPONENT::Move(), 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().

{
    SetFlags( IS_CHANGED );

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

void EDA_ITEM::SetNext ( EDA_ITEM *  aNext )

inlineinherited

Definition at line 222 of file base_struct.h.

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

{ Pnext = aNext; }

void LIB_BEZIER::SetOffset ( 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.

References i, m_BezierPoints, and m_PolyPoints.

Referenced by AddPoint(), and Move().

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

void EDA_ITEM::SetParent ( EDA_ITEM *  aParent )

inlineinherited

Definition at line 224 of file base_struct.h.

Referenced by MODULE::Add(), BOARD::Add(), BOARD_NETLIST_UPDATER::addNewComponent(), LIB_FIELD::Copy(), SCH_EDIT_FRAME::copyBlockItems(), CopyMarkedItems(), SCH_EDIT_FRAME::CreateSheet(), DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), PCB_EDIT_FRAME::Exchange_Module(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), DIALOG_FOOTPRINT_FP_EDITOR::initModeditProperties(), DIALOG_FOOTPRINT_BOARD_EDITOR::InitModeditProperties(), LIB_PART::LIB_PART(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), SCH_LEGACY_PLUGIN::loadHierarchy(), LIB_EDIT_FRAME::LoadOneSymbol(), MODULE::MODULE(), DIALOG_FOOTPRINT_BOARD_EDITOR::OnEditReference(), DIALOG_FOOTPRINT_BOARD_EDITOR::OnEditValue(), DIALOG_LIB_EDIT_PIN::OnPaintShowPanel(), MODULE::operator=(), SCH_COMPONENT::operator=(), PCB_PARSER::parseMODULE_unchecked(), LIB_EDIT_FRAME::pasteClipboard(), PCBNEW_CONTROL::PasteItemsFromClipboard(), FOOTPRINT_EDIT_FRAME::Process_Special_Functions(), BOARD_COMMIT::Push(), FOOTPRINT_PREVIEW_PANEL::renderFootprint(), BOARD_NETLIST_UPDATER::replaceComponent(), BOARD::ReplaceNetlist(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), SaveCopyOfZones(), SCH_COMPONENT::SCH_COMPONENT(), SCH_SHEET::SCH_SHEET(), SCH_SHEET_PIN::SCH_SHEET_PIN(), LIB_PART::SetFields(), SetSchItemParent(), PCB_EDIT_FRAME::StartMoveModule(), SCH_SHEET::SwapData(), SCH_COMPONENT::SwapData(), and SwapItemData().

{ m_Parent = aParent; }

void LIB_ITEM::SetPosition ( const wxPoint &  aPosition )

inlineinherited

Definition at line 302 of file lib_draw_item.h.

References LIB_ITEM::MirrorHorizontal(), LIB_ITEM::MirrorVertical(), LIB_ITEM::Move(), and LIB_ITEM::Rotate().

{ Move( aPosition ); }

void EDA_ITEM::SetSelected ( )

inlineinherited

Definition at line 238 of file base_struct.h.

References SELECTED, and EDA_ITEM::SetFlags().

Referenced by LIB_EDIT_FRAME::pasteClipboard(), GERBVIEW_SELECTION_TOOL::selectVisually(), and SELECTION_TOOL::selectVisually().

{ SetFlags( SELECTED ); }

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

inlineinherited

Definition at line 253 of file base_struct.h.

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::EraseRedundantTrack(), TRACK::GetEndSegments(), LEGACY_PLUGIN::loadTrackList(), BOARD::MarkTrace(), TRACKS_CLEANER::mergeCollinearSegmentIfPossible(), TRACKS_CLEANER::MergeCollinearTracks(), PCB_EDIT_FRAME::PlaceDraggedOrMovedTrackSegment(), PCB_BASE_FRAME::PlaceModule(), PCB_BASE_FRAME::PlacePad(), PCB_EDIT_FRAME::Remove_One_Track(), SCH_EDIT_FRAME::SetCurrentSheetHighlightFlags(), TRACK::SetLocked(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), PCB_EDIT_FRAME::StartMoveModule(), UndrawAndMarkSegmentsToDrag(), and updateConn().

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

void EDA_ITEM::SetStatus ( STATUS_FLAGS  aStatus )

inlineinherited

Definition at line 262 of file base_struct.h.

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

{ m_Status = aStatus; }

void EDA_ITEM::SetTimeStamp ( timestamp_t  aNewTimeStamp )

inlineinherited

Definition at line 214 of file base_struct.h.

Referenced by 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(), SCH_EDIT_FRAME::CreateSheet(), Diagnose(), DuplicateItemsInList(), DuplicateStruct(), EDIT_TOOL::editFootprintInFpEditor(), PCB_EDIT_FRAME::Exchange_Module(), DIALOG_FOOTPRINT_BOARD_EDITOR::GotoModuleEditor(), EDA_ITEM::initVars(), BOARD::InsertArea(), LEGACY_PLUGIN::loadMODULE(), LEGACY_PLUGIN::loadPCB_TARGET(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), 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_EDIT_FRAME::PasteListOfItems(), FOOTPRINT_EDIT_FRAME::Process_Special_Functions(), PCB_EDIT_FRAME::Process_Special_Functions(), SCH_SCREENS::ReplaceDuplicateTimeStamps(), BOARD::ReplaceNetlist(), SCH_SHEET::SCH_SHEET(), SCH_COMPONENT::SetTimeStamp(), SimilarLabelsDiagnose(), SwapItemData(), TestDuplicateSheetNames(), and DIALOG_ERC::TestErc().

{ m_TimeStamp = aNewTimeStamp; }

void LIB_ITEM::SetUnit ( int  aUnit )

inlineinherited

Definition at line 375 of file lib_draw_item.h.

Referenced by LIB_EDIT_FRAME::CreateGraphicItem(), LIB_EDIT_FRAME::CreateImagePins(), LIB_EDIT_FRAME::CreatePin(), LIB_EDIT_FRAME::EditGraphicSymbol(), DIALOG_LIB_EDIT_TEXT::OnOkClick(), LIB_EDIT_FRAME::OnRotateItem(), and LIB_EDIT_FRAME::pasteClipboard().

{ m_Unit = aUnit; }

void LIB_BEZIER::SetWidth ( int  aWidth )

inlineoverridevirtual

Set the width of the draw item to aWidth.

Implements LIB_ITEM.

Definition at line 103 of file lib_bezier.h.

References Clone(), compare(), GetMsgPanelInfo(), and GetPenSize().

{ m_Width = aWidth; }

void EDA_ITEM::SetWireImage ( )

inlineinherited

Definition at line 237 of file base_struct.h.

References IS_WIRE_IMAGE, and EDA_ITEM::SetFlags().

Referenced by moveItemWithMouseCursor().

{ SetFlags( IS_WIRE_IMAGE ); }

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 474 of file base_struct.h.

References EDA_ITEM::Matches(), EDA_ITEM::operator=(), EDA_ITEM::ViewBBox(), and EDA_ITEM::ViewGetLayers().

Referenced by PART_LIB::GetEntryTypePowerNames().

{ return *aLeft < *aRight; }

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 209 of file base_struct.h.

References EDA_ITEM::m_StructType.

Referenced by Abort_Move_ModuleOutline(), abortMoveBitmap(), abortMoveItem(), AbortPinMove(), MODULE::Add(), CN_CLUSTER::Add(), BOARD::Add(), CN_CONNECTIVITY_ALGO::Add(), PCB_EDIT_FRAME::Add45DegreeSegment(), SCH_SCREEN::addConnectedItemsToBlock(), POINT_EDITOR::addCorner(), POINT_EDITOR::addCornerCondition(), SCH_EDIT_FRAME::addCurrentItemToList(), AddMenusForComponent(), AddMenusForEditComponent(), SCH_SHEET::AddPin(), ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), PCB_EDIT_FRAME::Attribut_Track(), PCB_EDIT_FRAME::Autoroute(), PCB_EDIT_FRAME::Begin_Route(), SCH_EDIT_FRAME::BeginSegment(), 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(), HIERARCHY_NAVIG_DLG::buildHierarchyTree(), SCH_SCREENS::buildScreenList(), SCH_SHEET_LIST::BuildSheetList(), calcArea(), calcMaxArea(), SCH_NO_CONNECT::CanConnect(), SCH_JUNCTION::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(), DIALOG_EXCHANGE_FOOTPRINTS::changeSameFootprints(), SCH_SCREENS::ChangeSymbolLibNickname(), SCH_EDIT_FRAME::CheckListConnections(), EDGE_MODULE::ClassOf(), BOARD_CONNECTED_ITEM::ClassOf(), TEXTE_PCB::ClassOf(), TEXTE_MODULE::ClassOf(), DRAWSEGMENT::ClassOf(), TRACK::ClassOf(), NETINFO_ITEM::ClassOf(), MODULE::ClassOf(), D_PAD::ClassOf(), BOARD::ClassOf(), VIA::ClassOf(), SCH_SHEET::CleanupSheet(), Collect_TrackSegmentsToDrag(), compare(), LIB_CIRCLE::compare(), LIB_RECTANGLE::compare(), LIB_POLYLINE::compare(), LIB_TEXT::compare(), LIB_ARC::compare(), LIB_FIELD::compare(), LIB_PIN::compare(), SCH_SHEET::ComponentCount(), GRID_HELPER::computeAnchors(), SCH_SCREEN::CountConnectedItems(), SCH_SHEET::CountSheets(), MODULE::CoverageRatio(), LIB_EDIT_FRAME::CreateGraphicItem(), 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(), PCB_EDIT_FRAME::Delete_Segment_Edge(), SCH_SCREENS::DeleteAllMarkers(), SCH_SCREEN::DeleteItem(), LIB_EDIT_FRAME::deleteItem(), SCH_EDIT_FRAME::DeleteItem(), DeleteNullTrackSegments(), PYTHON_ACTION_PLUGINS::deregister_action(), DIALOG_SCH_EDIT_ONE_FIELD::DIALOG_SCH_EDIT_ONE_FIELD(), DIALOG_ERC::DisplayERC_MarkersList(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), DRC::doTrackDrc(), DRC::doTrackKeepoutDrc(), KIGFX::GERBVIEW_PAINTER::Draw(), KIGFX::PCB_PAINTER::Draw(), KIGFX::PCB_PAINTER::draw(), DrawMovePin(), DrawMovingBlockOutlines(), drawPickedItems(), CN_ITEM::Dump(), BOARD::Duplicate(), MODULE::Duplicate(), PCB_EDIT_FRAME::duplicateItems(), DuplicateItemsInList(), SCH_EDIT_FRAME::EditComponent(), SCH_EDIT_FRAME::EditComponentFieldText(), LIB_EDIT_FRAME::EditSymbolText(), SCH_EDIT_FRAME::EndSegment(), PCB_EDIT_FRAME::EraseRedundantTrack(), ExitSheet(), SCH_SCREEN::ExtractWires(), DRC::fillMarker(), 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(), PCB_IO::Format(), PCB_IO::format(), FormatProbeItem(), POINT_EDITOR::get45DegConstrainer(), getAnchorPoint(), TRACK::GetBestInsertPoint(), BOARD_ITEM::GetBoard(), TRACK::GetBoundingBox(), BOARD_CONNECTED_ITEM::GetClearance(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), NETLIST_OBJECT::GetComponentParent(), SCH_SCREEN::GetConnection(), SCH_TEXT::GetConnectionPoints(), SCH_TEXT::GetEndPoints(), SCH_SHEET::GetEndPoints(), GetFirstTrack(), GetFirstVia(), SCH_SCREEN::GetHierarchicalItems(), SCH_SCREENS::GetLibNicknames(), TEXTE_PCB::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), BOARD_CONNECTED_ITEM::GetNetClass(), CONNECTIVITY_DATA::GetNetItems(), LIB_PART::GetNextDrawItem(), DRAWSEGMENT::GetParentModule(), SCH_SCREEN::GetPin(), LIB_PART::GetPin(), SCH_COMPONENT::GetPinPhysicalPosition(), getRect(), SELECTION::GetTopLeftItem(), LIB_EDIT_FRAME::GlobalSetPins(), SELECTION_TOOL::guessSelectionCandidates(), hash_eda(), SCH_SCREENS::HasNoFullyDefinedLibIds(), SCH_SHEET::HasUndefinedPins(), SCH_EDIT_FRAME::ImportSheetPin(), DIALOG_LABEL_EDITOR::InitDialog(), ROUTER_TOOL::InlineDrag(), SCH_COLLECTOR::Inspect(), GENERAL_COLLECTOR::Inspect(), SCH_FIND_COLLECTOR::Inspect(), PCB_LAYER_COLLECTOR::Inspect(), ARRAY_CREATOR::Invoke(), CN_ANCHOR::IsDangling(), SCH_TEXT::IsDanglingStateChanged(), SCH_COLLECTOR::IsNode(), TRACK::IsNull(), SCH_LINE::IsParallel(), SCH_SCREEN::IsTerminalPoint(), BOARD_ITEM::IsTrack(), itemIsIncludedByFilter(), CLIPBOARD_IO::Load(), PNS_PCBNEW_RULE_RESOLVER::localPadClearance(), SCH_EDIT_FRAME::LocateAndShowItem(), SCH_EDIT_FRAME::LocateItem(), SCH_SHEET::LocatePathOfScreen(), Magnetize(), EDIT_POINTS_FACTORY::Make(), SCH_SCREEN::MarkConnections(), CONNECTIVITY_DATA::MarkItemNetAsDirty(), CN_CONNECTIVITY_ALGO::markItemNetAsDirty(), MarkItemsInBloc(), BOARD::MarkTrace(), TRACKS_CLEANER::mergeCollinearSegmentIfPossible(), TRACKS_CLEANER::MergeCollinearTracks(), SCH_LINE::MergeOverlap(), FOOTPRINT_EDIT_FRAME::ModeditLocateAndDisplay(), moveItemWithMouseCursor(), MoveMarkedItems(), MoveMarkedItemsExactly(), ROUTER_TOOL::NeighboringSegmentFilter(), SCH_EDIT_FRAME::OnConvertTextType(), SCH_EDIT_FRAME::OnCopySchematicItemRequest(), SCH_EDIT_FRAME::OnDragItem(), SCH_EDIT_FRAME::OnEditItem(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), PCB_EDIT_FRAME::OnEditItemRequest(), SCH_EDIT_FRAME::OnHotKey(), 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(), LIB_EDIT_FRAME::OnLeftClick(), SCH_EDIT_FRAME::OnLeftClick(), PCB_EDIT_FRAME::OnLeftClick(), LIB_EDIT_FRAME::OnLeftDClick(), SCH_EDIT_FRAME::OnLeftDClick(), PCB_EDIT_FRAME::OnLeftDClick(), SCH_EDIT_FRAME::OnMoveItem(), SCH_EDIT_FRAME::OnOpenLibraryEditor(), SCH_EDIT_FRAME::OnOrient(), FOOTPRINT_EDIT_FRAME::OnRightClick(), LIB_EDIT_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRightClick(), PCB_EDIT_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRotate(), SCH_EDIT_FRAME::OnSelectUnit(), 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(), SCH_EDIT_FRAME::OrientComponent(), BOARD_COMMIT::parentObject(), PCBNEW_CONTROL::PasteItemsFromClipboard(), SCH_EDIT_FRAME::PasteListOfItems(), PCB_BASE_FRAME::PcbGeneralLocateAndDisplay(), LIB_EDIT_FRAME::PlacePin(), SCH_FIELD::Plot(), BRDITEMS_PLOTTER::Plot_1_EdgeModule(), SCH_EDIT_FRAME::PrepareMoveItem(), GAL_ARRAY_CREATOR::prePushAction(), PCB_EDIT_FRAME::PrintPage(), FOOTPRINT_EDIT_FRAME::Process_Special_Functions(), LIB_EDIT_FRAME::Process_Special_Functions(), SCH_EDIT_FRAME::Process_Special_Functions(), PCB_EDIT_FRAME::Process_Special_Functions(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), RedrawWhileMovingCursor(), DIALOG_SYMBOL_REMAP::remapSymbolsToLibTable(), MODULE::Remove(), BOARD::Remove(), CN_CONNECTIVITY_ALGO::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_FRAME::RepeatDrawItem(), LIB_EDIT_FRAME::RepeatPinItem(), SCH_SCREENS::ReplaceDuplicateTimeStamps(), SCH_SCREEN::ReplaceWires(), GERBVIEW_SELECTION_TOOL::RequestSelection(), SELECTION_TOOL::RequestSelection(), PCB_EDIT_FRAME::Reset_All_Tracks_And_Vias_To_Netclass_Values(), PCB_BASE_FRAME::ResetTextSize(), SCH_EDIT_FRAME::ReSizeSheet(), BOARD_COMMIT::Revert(), SCH_EDIT_FRAME::RotateField(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), SCH_LEGACY_PLUGIN_CACHE::saveBezier(), SCH_LEGACY_PLUGIN_CACHE::saveCircle(), PCB_BASE_EDIT_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(), CN_CONNECTIVITY_ALGO::searchConnections(), SCH_SHEET::SearchHierarchy(), SELECTION_TOOL::select(), SELECTION_TOOL::selectable(), SCH_SCREEN::SelectBlockItems(), PCB_EDIT_FRAME::SelectHighLight(), SELECTION_TOOL::selectVisually(), ITEM_PICKER::SetItem(), SetSchItemParent(), DIALOG_LABEL_EDITOR::SetTitle(), PCB_EDIT_FRAME::SetTrackSegmentWidth(), PCB_EDIT_FRAME::Show_1_Ratsnest(), Show_MoveNode(), ShowClearance(), ShowNewTrackWhenMovingCursor(), SortByTimeStamp(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), LIB_EDIT_FRAME::StartMoveDrawSymbol(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), SCH_NO_CONNECT::SwapData(), SCH_JUNCTION::SwapData(), SCH_BITMAP::SwapData(), PCB_TARGET::SwapData(), SCH_FIELD::SwapData(), SCH_SHEET_PIN::SwapData(), TEXTE_PCB::SwapData(), DIMENSION::SwapData(), DRAWSEGMENT::SwapData(), TRACK::SwapData(), SCH_SHEET::SwapData(), SCH_COMPONENT::SwapData(), VIA::SwapData(), ZONE_CONTAINER::SwapData(), MODULE::SwapData(), D_PAD::SwapData(), SwapItemData(), PCB_EDIT_FRAME::SwitchLayer(), TestDuplicateSheetNames(), TRACKS_CLEANER::testTrackEndpointDangling(), TEXTE_MODULE::TEXTE_MODULE(), DIALOG_LABEL_EDITOR::TextPropertiesAccept(), TraceSegmentPcb(), SELECTION_TOOL::unselectVisually(), SCH_SHEET_PATH::UpdateAllScreenReferences(), DIALOG_SCH_EDIT_ONE_FIELD::UpdateField(), POINT_EDITOR::updateItem(), POINT_EDITOR::updatePoints(), PCB_BRIGHT_BOX::ViewDraw(), TRACK::Visit(), GERBER_DRAW_ITEM::Visit(), EDA_ITEM::Visit(), SCH_SHEET::Visit(), and SCH_COMPONENT::Visit().

    {
        return m_StructType;
    }

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, DRAWSEGMENT, DIMENSION, TEXTE_MODULE, MARKER_PCB, KIGFX::WORKSHEET_VIEWITEM, 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 266 of file base_struct.cpp.

References EDA_ITEM::GetBoundingBox().

Referenced by SELECTION_TOOL::selectable(), SELECTION_TOOL::selectMultiple(), EDA_ITEM::Sort(), BRIGHT_BOX::ViewBBox(), DIMENSION::ViewBBox(), DRAWSEGMENT::ViewBBox(), BRIGHT_BOX::ViewDraw(), and COMMON_TOOLS::ZoomFitScreen().

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

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::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.

References KIGFX::VIEW_ITEM::ViewGetLayers().

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

    {}

void EDA_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[]

Implements KIGFX::VIEW_ITEM.

Reimplemented in D_PAD, MODULE, EDIT_POINTS, VIA, BOARD_ITEM, GERBER_DRAW_ITEM, TRACK, TEXTE_MODULE, ZONE_CONTAINER, MARKER_PCB, KIGFX::WORKSHEET_VIEWITEM, ROUTER_PREVIEW_ITEM, KIGFX::ORIGIN_VIEWITEM, KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM, BRIGHT_BOX, KIGFX::RATSNEST_VIEWITEM, and KIGFX::PREVIEW::RULER_ITEM.

Definition at line 274 of file base_struct.cpp.

Referenced by EDA_ITEM::Sort().

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

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.

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

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

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

inlineinherited

Definition at line 148 of file view_item.h.

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().

    {
        return m_viewPrivData;
    }

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, MODULE, SCH_COMPONENT, SCH_SHEET, GERBER_FILE_IMAGE, GERBER_DRAW_ITEM, TRACK, and GBR_LAYOUT.

Definition at line 150 of file base_struct.cpp.

References EOT, EDA_ITEM::GetClass(), SEARCH_CONTINUE, SEARCH_QUIT, and EDA_ITEM::Type().

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

{
    KICAD_T stype;

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

    for( const KICAD_T* p = scanTypes;  (stype = *p) != EOT;   ++p )
    {
        // If caller wants to inspect my type
        if( stype == Type() )
        {
            if( SEARCH_QUIT == inspector( this, testData ) )
                return SEARCH_QUIT;

            break;
        }
    }

    return SEARCH_CONTINUE;
}

Member Data Documentation

std::vector<wxPoint> LIB_BEZIER::m_BezierPoints

private

Definition at line 42 of file lib_bezier.h.

Referenced by compare(), drawGraphic(), GetPoints(), MirrorHorizontal(), MirrorVertical(), Rotate(), and SetOffset().

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 123 of file lib_draw_item.h.

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

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 129 of file lib_draw_item.h.

Referenced by LIB_ITEM::Draw(), 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(), Plot(), LIB_RECTANGLE::Plot(), LIB_POLYLINE::Plot(), and LIB_ARC::Plot().

STATUS_FLAGS EDA_ITEM::m_Flags

protectedinherited

Flag bits for editing and other uses.

Definition at line 186 of file base_struct.h.

Referenced by LIB_CIRCLE::BeginEdit(), LIB_RECTANGLE::BeginEdit(), LIB_POLYLINE::BeginEdit(), LIB_TEXT::BeginEdit(), LIB_ARC::BeginEdit(), LIB_FIELD::BeginEdit(), LIB_CIRCLE::calcEdit(), LIB_POLYLINE::calcEdit(), LIB_RECTANGLE::calcEdit(), LIB_TEXT::calcEdit(), LIB_ARC::calcEdit(), LIB_FIELD::calcEdit(), LIB_TEXT::Clone(), LIB_CIRCLE::ContinueEdit(), LIB_RECTANGLE::ContinueEdit(), LIB_POLYLINE::ContinueEdit(), LIB_TEXT::ContinueEdit(), LIB_ARC::ContinueEdit(), LIB_FIELD::ContinueEdit(), SCH_LINE::Draw(), TRACK::Draw(), DRAWSEGMENT::Draw(), MODULE::Draw(), SEGZONE::Draw(), LIB_CIRCLE::drawGraphic(), LIB_POLYLINE::drawGraphic(), LIB_RECTANGLE::drawGraphic(), drawGraphic(), LIB_ARC::drawGraphic(), DRAWSEGMENT::DRAWSEGMENT(), LIB_CIRCLE::EndEdit(), LIB_RECTANGLE::EndEdit(), LIB_POLYLINE::EndEdit(), LIB_TEXT::EndEdit(), LIB_ARC::EndEdit(), LIB_ITEM::EndEdit(), LIB_FIELD::EndEdit(), EDA_ITEM::GetFlags(), TRACK::GetMsgPanelInfoBase_Common(), SCH_JUNCTION::HitTest(), SCH_LINE::HitTest(), GERBER_DRAW_ITEM::HitTest(), SCH_COMPONENT::HitTest(), LIB_ITEM::InEditMode(), EDA_ITEM::initVars(), SCH_ITEM::IsConnected(), SCH_LINE::Move(), EDA_ITEM::operator=(), SCH_COMPONENT::SCH_COMPONENT(), 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(), and LIB_PIN::SetVisible().

bool EDA_ITEM::m_forceVisible

protectedinherited

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

Definition at line 183 of file base_struct.h.

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

wxPoint LIB_ITEM::m_initialCursorPos

protectedinherited

Initial cursor position at the beginning of a move.

Definition at line 132 of file lib_draw_item.h.

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

wxPoint LIB_ITEM::m_initialPos

protectedinherited

Temporary position when moving an existing item.

Definition at line 131 of file lib_draw_item.h.

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

bool LIB_ITEM::m_isFillable

protectedinherited

Flag to indicate if draw item is fillable.

Default is false.

Definition at line 135 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().

DHEAD* EDA_ITEM::m_List

protectedinherited

which DLIST I am on.

Definition at line 177 of file base_struct.h.

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

EDA_ITEM* EDA_ITEM::m_Parent

protectedinherited

Linked list: Link (parent struct)

Definition at line 179 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(), 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(), LIB_FIELD::SetText(), and TEXTE_MODULE::TEXTE_MODULE().

std::vector<wxPoint> LIB_BEZIER::m_PolyPoints

private

Definition at line 43 of file lib_bezier.h.

Referenced by drawGraphic(), GetBoundingBox(), HitTest(), Inside(), MirrorHorizontal(), MirrorVertical(), Move(), Plot(), Rotate(), and SetOffset().

timestamp_t EDA_ITEM::m_TimeStamp

protectedinherited

Time stamp used for logical links.

Definition at line 180 of file base_struct.h.

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

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 116 of file lib_draw_item.h.

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

int LIB_BEZIER::m_Width

private

Definition at line 41 of file lib_bezier.h.

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

EDA_ITEM* EDA_ITEM::Pback

protectedinherited

previous in linked list

Definition at line 176 of file base_struct.h.

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

EDA_ITEM* EDA_ITEM::Pnext

protectedinherited

next in linked list

Definition at line 175 of file base_struct.h.

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

---

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

• lib_bezier.h
• lib_bezier.cpp