A leader is a dimension-like object pointing to a specific point. More...

#include <pcb_dimension.h>

Inheritance diagram for PCB_DIM_LEADER:

Public Member Functions
	PCB_DIM_LEADER (BOARD_ITEM *aParent)

EDA_ITEM *	Clone () const override
	Create a duplicate of this item with linked list members set to NULL. More...

virtual void	SwapData (BOARD_ITEM *aImage) override
	Swap data between aItem and aImage. More...

BITMAPS	GetMenuImage () const override
	Return a pointer to an image to be used in menus. More...

wxString	GetClass () const override
	Return the class name. More...

void	SetTextFrame (DIM_TEXT_FRAME aFrame)

DIM_TEXT_FRAME	GetTextFrame () const

void	GetMsgPanelInfo (EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList) override
	Populate aList of MSG_PANEL_ITEM objects with it's internal state for display purposes. More...

bool	IsType (const KICAD_T aScanTypes[]) const override
	Check whether the item is one of the listed types. More...

void	SetParent (EDA_ITEM *aParent) override

virtual const wxPoint &	GetStart () const
	The dimension's origin is the first feature point for the dimension. More...

virtual void	SetStart (const wxPoint &aPoint)

virtual const wxPoint &	GetEnd () const

virtual void	SetEnd (const wxPoint &aPoint)

wxPoint	GetPosition () const override

void	SetPosition (const wxPoint &aPos) override

bool	GetOverrideTextEnabled () const

void	SetOverrideTextEnabled (bool aOverride)

wxString	GetOverrideText () const

void	SetOverrideText (const wxString &aValue)

int	GetMeasuredValue () const

wxString	GetValueText () const

void	Update ()
	Update the dimension's cached text and geometry. More...

wxString	GetPrefix () const

void	SetPrefix (const wxString &aPrefix)

wxString	GetSuffix () const

void	SetSuffix (const wxString &aSuffix)

void	GetUnits (EDA_UNITS &aUnits) const

void	SetUnits (EDA_UNITS aUnits)

DIM_UNITS_MODE	GetUnitsMode () const

void	SetUnitsMode (DIM_UNITS_MODE aMode)

void	SetAutoUnits (bool aAuto=true)

DIM_UNITS_FORMAT	GetUnitsFormat () const

void	SetUnitsFormat (const DIM_UNITS_FORMAT aFormat)

int	GetPrecision () const

void	SetPrecision (int aPrecision)

bool	GetSuppressZeroes () const

void	SetSuppressZeroes (bool aSuppress)

bool	GetKeepTextAligned () const

void	SetKeepTextAligned (bool aKeepAligned)

void	SetTextPositionMode (DIM_TEXT_POSITION aMode)

DIM_TEXT_POSITION	GetTextPositionMode () const

int	GetArrowLength () const

void	SetArrowLength (int aLength)

void	SetExtensionOffset (int aOffset)

int	GetExtensionOffset () const

int	GetLineThickness () const

void	SetLineThickness (int aWidth)

void	SetLayer (PCB_LAYER_ID aLayer) override
	Set the layer this item is on. More...

void	SetTextSize (const wxSize &aTextSize)

void	SetText (const wxString &aNewText)
	Set the override text - has no effect if m_overrideValue == false. More...

const wxString	GetText () const
	Retrieve the value text or override text, not including prefix or suffix. More...

PCB_TEXT &	Text ()

const PCB_TEXT &	Text () const

const std::vector< std::shared_ptr< SHAPE > > &	GetShapes () const

void	Move (const wxPoint &offset) override
	Move this object. More...

void	Move (const VECTOR2I &aMoveVector)

void	Rotate (const wxPoint &aRotCentre, double aAngle) override
	Rotate this object. More...

void	Rotate (const VECTOR2I &aRotCentre, double aAngle)

void	Flip (const wxPoint &aCentre, bool aFlipLeftRight) override
	Flip this object, i.e. More...

void	Flip (const VECTOR2I &aCentre, bool aFlipLeftRight)

void	Mirror (const wxPoint &axis_pos, bool aMirrorLeftRight=false)
	Mirror the dimension relative to a given horizontal axis. More...

bool	HitTest (const wxPoint &aPosition, int aAccuracy) const override
	Test if aPosition is contained within or on the bounding box of an item. More...

bool	HitTest (const EDA_RECT &aRect, bool aContained, int aAccuracy=0) const override
	Test if aRect intersects or is contained within the bounding box of an item. More...

const EDA_RECT	GetBoundingBox () const override
	Return the orthogonal bounding box of this object for display purposes. More...

std::shared_ptr< SHAPE >	GetEffectiveShape (PCB_LAYER_ID aLayer) const override
	Some pad shapes can be complex (rounded/chamfered rectangle), even without considering custom shapes. More...

wxString	GetSelectMenuText (EDA_UNITS aUnits) const override
	Return the text to display to be used in the selection clarification context menu when multiple items are found at the current cursor position. More...

const BOX2I	ViewBBox () const override
	Return the bounding box of the item covering all its layers. More...

void	TransformShapeWithClearanceToPolygon (SHAPE_POLY_SET &aCornerBuffer, PCB_LAYER_ID aLayer, int aClearance, int aError, ERROR_LOC aErrorLoc, bool aIgnoreLineWidth) const override
	Convert the item shape to a closed polygon. More...

void	SetParentGroup (PCB_GROUP *aGroup)

PCB_GROUP *	GetParentGroup () const

int	GetX () const

int	GetY () const

virtual wxPoint	GetCenter () const
	This defaults to the center of the bounding box if not overridden. More...

void	SetX (int aX)

void	SetY (int aY)

virtual bool	IsConnected () const
	Returns information if the object is derived from BOARD_CONNECTED_ITEM. More...

virtual bool	IsOnCopperLayer () const

BOARD_ITEM_CONTAINER *	GetParent () const

virtual PCB_LAYER_ID	GetLayer () const
	Return the primary layer this item is on. More...

virtual LSET	GetLayerSet () const
	Return a std::bitset of all layers on which the item physically resides. More...

virtual void	SetLayerSet (LSET aLayers)

virtual BOARD_ITEM *	Duplicate () const
	Create a copy of this BOARD_ITEM. More...

virtual bool	IsOnLayer (PCB_LAYER_ID aLayer) const
	Test to see if this object is on the given layer. More...

bool	IsTrack () const
	Test to see if this object is a track or via (or microvia). More...

virtual bool	IsLocked () const

virtual void	SetLocked (bool aLocked)
	Modify the 'lock' status for of the item. More...

void	DeleteStructure ()
	Delete this object after removing from its parent if it has one. More...

virtual BOARD *	GetBoard () const
	Return the BOARD in which this BOARD_ITEM resides, or NULL if none. More...

wxString	GetLayerName () const
	Return the name of the PCB layer on which the item resides. More...

virtual void	ViewGetLayers (int aLayers[], int &aCount) const override
	Return the all the layers within the VIEW the object is painted on. More...

KICAD_T	Type () const
	Returns the type of object. More...

bool	IsModified () const

bool	IsNew () const

bool	IsMoving () const

bool	IsDragging () const

bool	IsWireImage () const

bool	IsSelected () const

bool	IsEntered () const

bool	IsResized () const

bool	IsBrightened () const

void	SetWireImage ()

void	SetSelected ()

void	SetBrightened ()

void	ClearSelected ()

void	ClearBrightened ()

void	SetModified ()

int	GetState (EDA_ITEM_FLAGS type) const

void	SetState (EDA_ITEM_FLAGS type, bool state)

EDA_ITEM_FLAGS	GetStatus () const

void	SetStatus (EDA_ITEM_FLAGS aStatus)

void	SetFlags (EDA_ITEM_FLAGS aMask)

void	ClearFlags (EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

EDA_ITEM_FLAGS	GetFlags () const

bool	HasFlag (EDA_ITEM_FLAGS aFlag) const

EDA_ITEM_FLAGS	GetEditFlags () const

void	ClearTempFlags ()

void	ClearEditFlags ()

void	SetForceVisible (bool aEnable)
	Set and clear force visible flag used to force the item to be drawn even if it's draw attribute is set to not visible. More...

bool	IsForceVisible () const

virtual const wxPoint	GetFocusPosition () const
	Similar to GetPosition, but allows items to return their visual center rather than their anchor. More...

virtual SEARCH_RESULT	Visit (INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
	May be re-implemented for each derived class in order to handle all the types given by its member data. More...

virtual bool	Matches (const wxFindReplaceData &aSearchData, void *aAuxData) const
	Compare the item against the search criteria in aSearchData. More...

virtual bool	Replace (const wxFindReplaceData &aSearchData, void *aAuxData=nullptr)
	Perform a text replace using the find and replace criteria in aSearchData on items that support text find and replace. More...

virtual bool	IsReplaceable () const
	Override this method in any derived object that supports test find and replace. More...

bool	operator< (const EDA_ITEM &aItem) const
	Test if another item is less than this object. More...

virtual void	ViewDraw (int aLayer, VIEW *aView) const
	Draw the parts of the object belonging to layer aLayer. More...

virtual double	ViewGetLOD (int aLayer, VIEW *aView) const
	Return the level of detail (LOD) of the item. More...

VIEW_ITEM_DATA *	viewPrivData () const

void	ClearViewPrivData ()

bool	Set (PROPERTY_BASE *aProperty, wxAny &aValue)

template<typename T >
bool	Set (PROPERTY_BASE *aProperty, T aValue)

template<typename T >
bool	Set (const wxString &aProperty, T aValue)

wxAny	Get (PROPERTY_BASE *aProperty)

template<typename T >
T	Get (PROPERTY_BASE *aProperty)

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

Static Public Member Functions
static bool	ClassOf (const EDA_ITEM *aItem)

static wxString	ShowShape (SHAPE_T aShape)
	Convert the enum #PCB_SHAPE_TYPE_T integer value to a wxString. More...

template<class T >
static SEARCH_RESULT	IterateForward (std::deque< T > &aList, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
	This changes first parameter to avoid the DList and use the main queue instead. More...

template<class T >
static SEARCH_RESULT	IterateForward (std::vector< T > &aList, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
	Change first parameter to avoid the DList and use std::vector instead. More...

static bool	Replace (const wxFindReplaceData &aSearchData, wxString &aText)
	Perform a text replace on aText using the find and replace criteria in aSearchData on items that support text find and replace. More...

static bool	Sort (const EDA_ITEM aLeft, const EDA_ITEM aRight)
	Helper function to be used by the C++ STL sort algorithm for sorting a STL container of EDA_ITEM pointers. More...

Public Attributes
const KIID	m_Uuid

Static Public Attributes
static wxPoint	ZeroOffset
	A value of wxPoint(0,0) which can be passed to the Draw() functions. More...

Protected Member Functions
void	updateGeometry () override
	Update the cached geometry of the dimension after changing any of its properties. More...

virtual void	updateText ()
	Update the text field value from the current geometry (called by updateGeometry normally). More...

template<typename ShapeType >
void	addShape (const ShapeType &aShape)

virtual wxString	layerMaskDescribe () const
	Return a string (to be shown to the user) describing a layer mask. More...

bool	Matches (const wxString &aText, const wxFindReplaceData &aSearchData) const
	Compare aText against search criteria in aSearchData. More...

Static Protected Member Functions
static OPT_VECTOR2I	segPolyIntersection (const SHAPE_POLY_SET &aPoly, const SEG &aSeg, bool aStart=true)
	Find the intersection between a given segment and polygon outline. More...

static OPT_VECTOR2I	segCircleIntersection (CIRCLE &aCircle, SEG &aSeg, bool aStart=true)

Protected Attributes
bool	m_overrideTextEnabled
	Manually specify the displayed measurement value. More...

wxString	m_valueString
	Displayed value when m_overrideValue = true. More...

wxString	m_prefix
	String prepended to the value. More...

wxString	m_suffix
	String appended to the value. More...

EDA_UNITS	m_units
	0 = inches, 1 = mm More...

bool	m_autoUnits
	If true, follow the currently selected UI units. More...

DIM_UNITS_FORMAT	m_unitsFormat
	How to render the units suffix. More...

int	m_precision
	Number of digits to display after decimal. More...

bool	m_suppressZeroes
	Suppress trailing zeroes. More...

int	m_lineThickness
	Thickness used for all graphics in the dimension. More...

int	m_arrowLength
	Length of arrow shapes. More...

int	m_extensionOffset
	Distance from feature points to extension line start. More...

DIM_TEXT_POSITION	m_textPosition
	How to position the text. More...

bool	m_keepTextAligned
	Calculate text orientation to match dimension. More...

PCB_TEXT	m_text
	The actual text object. More...

int	m_measuredValue
	value of PCB dimensions More...

wxPoint	m_start

wxPoint	m_end
	Internal cache of drawn shapes. More...

std::vector< std::shared_ptr< SHAPE > >	m_shapes

PCB_LAYER_ID	m_layer

PCB_GROUP *	m_group

EDA_ITEM_FLAGS	m_status

EDA_ITEM *	m_parent
	Linked list: Link (parent struct) More...

bool	m_forceVisible

EDA_ITEM_FLAGS	m_flags

Static Protected Attributes
static constexpr float	s_arrowAngle = 27.5

Private Attributes
DIM_TEXT_FRAME	m_textFrame

Detailed Description

A leader is a dimension-like object pointing to a specific point.

A guide to the geometry of a leader:

a
   _
  |\
     \
       b---c TEXT

Point (a) is m_start, point (b) is m_end, point (c) is the end of the "text line" The b-c line is drawn from b to the text center, and clipped on the text bounding box.

Definition at line 486 of file pcb_dimension.h.

Constructor & Destructor Documentation

◆ PCB_DIM_LEADER()

PCB_DIM_LEADER::PCB_DIM_LEADER ( BOARD_ITEM * aParent )

Definition at line 919 of file pcb_dimension.cpp.

                                                     :
         PCB_DIMENSION_BASE( aParent, PCB_DIM_LEADER_T ),
         m_textFrame( DIM_TEXT_FRAME::NONE )
 {
     m_unitsFormat         = DIM_UNITS_FORMAT::NO_SUFFIX;
     m_overrideTextEnabled = true;
     m_keepTextAligned     = false;
 }

References PCB_DIMENSION_BASE::m_keepTextAligned, PCB_DIMENSION_BASE::m_overrideTextEnabled, PCB_DIMENSION_BASE::m_unitsFormat, and NO_SUFFIX.

Referenced by Clone().

Member Function Documentation

◆ addShape()

template<typename ShapeType >

void PCB_DIMENSION_BASE::addShape ( const ShapeType & aShape )

protectedinherited

Definition at line 98 of file pcb_dimension.cpp.

 {
     m_shapes.push_back( std::make_shared<ShapeType>( aShape ) );
 }

References PCB_DIMENSION_BASE::m_shapes.

Referenced by PCB_DIM_ALIGNED::updateGeometry(), and PCB_DIM_ORTHOGONAL::updateGeometry().

◆ ClassOf()

static bool PCB_DIM_LEADER::ClassOf ( const EDA_ITEM * aItem )

inlinestatic

Definition at line 491 of file pcb_dimension.h.

     {
         return aItem && PCB_DIM_LEADER_T == aItem->Type();
     }

References PCB_DIM_LEADER_T, and EDA_ITEM::Type().

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )

inlineinherited

Definition at line 133 of file eda_item.h.

133 { ClearFlags( BRIGHTENED ); }

EDA_ITEM::ClearFlags

void ClearFlags(EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

Definition: eda_item.h:154

BRIGHTENED

#define BRIGHTENED

item is drawn with a bright contour

Definition: eda_item_flags.h:65

References BRIGHTENED, and EDA_ITEM::ClearFlags().

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

◆ ClearEditFlags()

void EDA_ITEM::ClearEditFlags ( )

inlineinherited

Definition at line 172 of file eda_item.h.

     {
         ClearFlags( GetEditFlags() );
     }

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

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

◆ ClearFlags()

void EDA_ITEM::ClearFlags ( EDA_ITEM_FLAGS aMask = EDA_ITEM_ALL_FLAGS )

inlineinherited

Definition at line 154 of file eda_item.h.

154 { m_flags &= ~aMask; }

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

References EDA_ITEM::m_flags.

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

◆ ClearSelected()

void EDA_ITEM::ClearSelected ( )

inlineinherited

Definition at line 132 of file eda_item.h.

132 { ClearFlags( SELECTED ); }

EDA_ITEM::ClearFlags

void ClearFlags(EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

Definition: eda_item.h:154

SELECTED

#define SELECTED

Definition: eda_item_flags.h:48

References EDA_ITEM::ClearFlags(), and SELECTED.

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

◆ ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )

inlineinherited

Definition at line 166 of file eda_item.h.

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

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

Referenced by SCH_EDIT_FRAME::PutDataInPreviousState().

◆ ClearViewPrivData()

void KIGFX::VIEW_ITEM::ClearViewPrivData ( )

inlineinherited

Definition at line 148 of file view_item.h.

     {
         m_viewPrivData = nullptr;
     }

References KIGFX::VIEW_ITEM::m_viewPrivData.

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

◆ Clone()

EDA_ITEM * PCB_DIM_LEADER::Clone ( ) const

overridevirtual

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

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

Returns: A clone of the item.

Reimplemented from EDA_ITEM.

Definition at line 929 of file pcb_dimension.cpp.

 {
     return new PCB_DIM_LEADER( *this );
 }

References PCB_DIM_LEADER().

◆ DeleteStructure()

void BOARD_ITEM::DeleteStructure ( )

inherited

Delete this object after removing from its parent if it has one.

Definition at line 127 of file board_item.cpp.

 {
     BOARD_ITEM_CONTAINER* parent = GetParent();
 
     if( parent )
         parent->Remove( this );
 
     delete this;
 }

References BOARD_ITEM::GetParent(), and BOARD_ITEM_CONTAINER::Remove().

Referenced by BOARD::PadDelete(), and DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow().

◆ Duplicate()

virtual BOARD_ITEM* BOARD_ITEM::Duplicate ( ) const

inlinevirtualinherited

Create a copy of this BOARD_ITEM.

Reimplemented in FOOTPRINT.

Definition at line 200 of file board_item.h.

     {
         EDA_ITEM* dupe = Clone();
         const_cast<KIID&>( dupe->m_Uuid ) = KIID();
 
         return static_cast<BOARD_ITEM*>( dupe );
     }

References EDA_ITEM::Clone(), and EDA_ITEM::m_Uuid.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), PCB_GROUP::DeepDuplicate(), KIGFX::PCB_PAINTER::draw(), DRAWING_TOOL::DrawBoardCharacteristics(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), DRAWING_TOOL::DrawSpecificationStackup(), EDIT_TOOL::Duplicate(), and ARRAY_CREATOR::Invoke().

◆ Flip() [1/2]

void PCB_DIMENSION_BASE::Flip	(	const wxPoint &	aCentre,
		bool	aFlipLeftRight
	)

overridevirtualinherited

Flip this object, i.e.

change the board side for this object.

Parameters

aCentre	the rotation point.
aFlipLeftRight	mirror across Y axis instead of X (the default).

Reimplemented from BOARD_ITEM.

Definition at line 251 of file pcb_dimension.cpp.

 {
     Mirror( aCentre );
 
     SetLayer( FlipLayer( GetLayer(), GetBoard()->GetCopperLayerCount() ) );
 }

References FlipLayer(), BOARD_ITEM::GetBoard(), BOARD_ITEM::GetLayer(), PCB_DIMENSION_BASE::Mirror(), and PCB_DIMENSION_BASE::SetLayer().

◆ Flip() [2/2]

void BOARD_ITEM::Flip	(	const VECTOR2I &	aCentre,
		bool	aFlipLeftRight
	)

inlineinherited

Definition at line 304 of file board_item.h.

     {
         Flip( wxPoint( aCentre.x, aCentre.y ), aFlipLeftRight );
     }

References BOARD_ITEM::Flip(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ Get() [1/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE * aProperty )

inlineinherited

Definition at line 86 of file inspectable.h.

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

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

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

◆ Get() [2/3]

template<typename T >

T INSPECTABLE::Get ( PROPERTY_BASE * aProperty )

inlineinherited

Definition at line 95 of file inspectable.h.

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

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

◆ Get() [3/3]

template<typename T >

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

inlineinherited

Definition at line 104 of file inspectable.h.

     {
         PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
         TYPE_ID thisType = TYPE_HASH( *this );
         PROPERTY_BASE* prop = propMgr.GetProperty( thisType, aProperty );
         boost::optional<T> ret = T();
 
         if( prop )
         {
             void* object = propMgr.TypeCast( this, thisType, prop->OwnerHash() );
 
             if( object )
                 ret = prop->get<T>( object );
         }
 
         return ret;
     }

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

◆ GetArrowLength()

int PCB_DIMENSION_BASE::GetArrowLength ( ) const

inlineinherited

Definition at line 181 of file pcb_dimension.h.

181 { return m_arrowLength; }

PCB_DIMENSION_BASE::m_arrowLength

int m_arrowLength

Length of arrow shapes.

Definition: pcb_dimension.h:296

References PCB_DIMENSION_BASE::m_arrowLength.

Referenced by PCB_IO::format(), and DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow().

◆ GetBoard()

BOARD * BOARD_ITEM::GetBoard ( ) const

virtualinherited

Return the BOARD in which this BOARD_ITEM resides, or NULL if none.

Definition at line 51 of file board_item.cpp.

 {
     if( Type() == PCB_T )
         return (BOARD*) this;
 
     BOARD_ITEM* parent = GetParent();
 
     if( parent )
         return parent->GetBoard();
 
     return nullptr;
 }

References BOARD_ITEM::GetBoard(), BOARD_ITEM::GetParent(), PCB_T, and EDA_ITEM::Type().

Referenced by PAD::BuildEffectivePolygon(), PAD::BuildEffectiveShapes(), ZONE::BuildSmoothedPoly(), KIGFX::PCB_PAINTER::draw(), exprFromTo(), PCB_VIA::FlashLayer(), PAD::FlashLayer(), PCB_TARGET::Flip(), PCB_TEXT::Flip(), PCB_TRACK::Flip(), FP_SHAPE::Flip(), FP_TEXT::Flip(), PCB_DIMENSION_BASE::Flip(), PCB_ARC::Flip(), PCB_SHAPE::Flip(), PCB_VIA::Flip(), ZONE::Flip(), BOARD_ITEM::GetBoard(), FOOTPRINT::GetBoundingBox(), FOOTPRINT::GetBoundingHull(), BOARD_CONNECTED_ITEM::GetEffectiveNetclass(), ZONE::GetInteractingZones(), BOARD_ITEM::GetLayerName(), PCB_VIA::GetMinAnnulus(), PCB_DRAW_PANEL_GAL::GetMsgPanelInfo(), ZONE::GetMsgPanelInfo(), NETINFO_ITEM::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfoBase_Common(), BOARD_CONNECTED_ITEM::GetNetClass(), BOARD_CONNECTED_ITEM::GetNetnameMsg(), BOARD_CONNECTED_ITEM::GetOwnClearance(), ZONE::GetSelectMenuText(), DRC_ENGINE::GetShape(), FP_TEXT::GetShownText(), PAD::GetSolderMaskMargin(), PAD::GetSolderPasteMargin(), BOARD::GetTrackLength(), PCB_TRACK::GetWidthConstraints(), inDiffPair(), insideArea(), insideBackCourtyard(), insideCourtyard(), insideFrontCourtyard(), BOARD_ITEM::layerMaskDescribe(), PCB_VIA::layerMaskDescribe(), CONVERT_TOOL::makePolysFromCircles(), PAD::MergePrimitivesAsPolygon(), EAGLE_PLUGIN::packageWire(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), BOARD::ResolveDRCExclusions(), BOARD_CONNECTED_ITEM::SetNetCode(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow(), ZONE::TransformSmoothedOutlineToPolygon(), ZONE::TransformSolidAreasShapesToPolygon(), PCB_TRACK::ViewBBox(), FOOTPRINT::ViewBBox(), PCB_VIA::ViewGetLOD(), and PAD::ViewGetLOD().

◆ GetBoundingBox()

const EDA_RECT PCB_DIMENSION_BASE::GetBoundingBox ( ) const

overridevirtualinherited

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

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

Reimplemented from EDA_ITEM.

Reimplemented in PCB_DIM_CENTER.

Definition at line 405 of file pcb_dimension.cpp.

 {
     EDA_RECT    bBox;
     int         xmin, xmax, ymin, ymax;
 
     bBox    = m_text.GetTextBox();
     xmin    = bBox.GetX();
     xmax    = bBox.GetRight();
     ymin    = bBox.GetY();
     ymax    = bBox.GetBottom();
 
     for( const std::shared_ptr<SHAPE>& shape : GetShapes() )
     {
         BOX2I shapeBox = shape->BBox();
         shapeBox.Inflate( m_lineThickness / 2 );
 
         xmin = std::min( xmin, shapeBox.GetOrigin().x );
         xmax = std::max( xmax, shapeBox.GetEnd().x );
         ymin = std::min( ymin, shapeBox.GetOrigin().y );
         ymax = std::max( ymax, shapeBox.GetEnd().y );
     }
 
     bBox.SetX( xmin );
     bBox.SetY( ymin );
     bBox.SetWidth( xmax - xmin + 1 );
     bBox.SetHeight( ymax - ymin + 1 );
 
     bBox.Normalize();
 
     return bBox;
 }

References EDA_RECT::GetBottom(), BOX2< Vec >::GetEnd(), BOX2< Vec >::GetOrigin(), EDA_RECT::GetRight(), PCB_DIMENSION_BASE::GetShapes(), EDA_TEXT::GetTextBox(), EDA_RECT::GetX(), EDA_RECT::GetY(), BOX2< Vec >::Inflate(), PCB_DIMENSION_BASE::m_lineThickness, PCB_DIMENSION_BASE::m_text, EDA_RECT::Normalize(), EDA_RECT::SetHeight(), EDA_RECT::SetWidth(), EDA_RECT::SetX(), EDA_RECT::SetY(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by PCB_DIMENSION_BASE::HitTest(), and PCB_DIMENSION_BASE::ViewBBox().

◆ GetCenter()

virtual wxPoint BOARD_ITEM::GetCenter ( ) const

inlinevirtualinherited

This defaults to the center of the bounding box if not overridden.

Returns: center point of the item

Reimplemented in PCB_ARC, PAD, PCB_SHAPE, and PCB_MARKER.

Definition at line 112 of file board_item.h.

     {
         return GetBoundingBox().GetCenter();
     }

References EDA_ITEM::GetBoundingBox(), and EDA_RECT::GetCenter().

Referenced by PCB_GRID_HELPER::computeAnchors(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), and ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically().

◆ GetClass()

wxString PCB_DIM_LEADER::GetClass ( ) const

inlineoverridevirtual

Return the class name.

Implements EDA_ITEM.

Definition at line 502 of file pcb_dimension.h.

     {
         return wxT( "PCB_DIM_LEADER" );
     }

◆ GetEditFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetEditFlags ( ) const

inlineinherited

Definition at line 158 of file eda_item.h.

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

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

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

◆ GetEffectiveShape()

std::shared_ptr< SHAPE > PCB_DIMENSION_BASE::GetEffectiveShape ( PCB_LAYER_ID aLayer ) const

overridevirtualinherited

Some pad shapes can be complex (rounded/chamfered rectangle), even without considering custom shapes.

This routine returns a COMPOUND shape (set of simple shapes which make up the pad for use with routing, collision determination, etc).

Note: This list can contain a SHAPE_SIMPLE (a simple single-outline non-intersecting polygon), but should never contain a SHAPE_POLY_SET (a complex polygon consisting of multiple outlines and/or holes).

Parameters

aLayer in case of items spanning multiple layers, only the shapes belonging to aLayer will be returned. Pass UNDEFINED_LAYER to return shapes for all layers.

Reimplemented from BOARD_ITEM.

Definition at line 356 of file pcb_dimension.cpp.

 {
     std::shared_ptr<SHAPE_COMPOUND> effectiveShape = std::make_shared<SHAPE_COMPOUND>();
 
     effectiveShape->AddShape( Text().GetEffectiveTextShape()->Clone() );
 
     for( const std::shared_ptr<SHAPE>& shape : GetShapes() )
         effectiveShape->AddShape( shape->Clone() );
 
     return effectiveShape;
 }

References EDA_ITEM::Clone(), PCB_DIMENSION_BASE::GetShapes(), and PCB_DIMENSION_BASE::Text().

◆ GetEnd()

virtual const wxPoint& PCB_DIMENSION_BASE::GetEnd ( ) const

inlinevirtualinherited

Definition at line 124 of file pcb_dimension.h.

124 { return m_end; }

PCB_DIMENSION_BASE::m_end

wxPoint m_end

Internal cache of drawn shapes.

Definition: pcb_dimension.h:305

References PCB_DIMENSION_BASE::m_end.

Referenced by PCB_GRID_HELPER::computeAnchors(), DRAWING_TOOL::constrainDimension(), DRAWING_TOOL::DrawDimension(), PCB_IO::format(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_POINT_EDITOR::makePoints(), PCB_POINT_EDITOR::updateItem(), and PCB_POINT_EDITOR::updatePoints().

◆ GetExtensionOffset()

int PCB_DIMENSION_BASE::GetExtensionOffset ( ) const

inlineinherited

Definition at line 185 of file pcb_dimension.h.

185 { return m_extensionOffset; }

PCB_DIMENSION_BASE::m_extensionOffset

int m_extensionOffset

Distance from feature points to extension line start.

Definition: pcb_dimension.h:297

References PCB_DIMENSION_BASE::m_extensionOffset.

Referenced by PCB_IO::format(), and DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow().

◆ GetFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetFlags ( ) const

inlineinherited

Definition at line 155 of file eda_item.h.

155 { return m_flags; }

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

References EDA_ITEM::m_flags.

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

◆ GetFocusPosition()

virtual const wxPoint EDA_ITEM::GetFocusPosition ( ) const

inlinevirtualinherited

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

Reimplemented in BOARD, PCB_SHAPE, and PCB_TRACK.

Definition at line 259 of file eda_item.h.

259 { return GetPosition(); }

EDA_ITEM::GetPosition

virtual wxPoint GetPosition() const

Definition: eda_item.h:252

References EDA_ITEM::GetPosition().

Referenced by PCB_BASE_FRAME::FocusOnItem(), and SCH_EDIT_FRAME::FocusOnItem().

◆ GetKeepTextAligned()

bool PCB_DIMENSION_BASE::GetKeepTextAligned ( ) const

inlineinherited

Definition at line 175 of file pcb_dimension.h.

175 { return m_keepTextAligned; }

PCB_DIMENSION_BASE::m_keepTextAligned

bool m_keepTextAligned

Calculate text orientation to match dimension.

Definition: pcb_dimension.h:299

References PCB_DIMENSION_BASE::m_keepTextAligned.

Referenced by PCB_IO::format(), and DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow().

◆ GetLayer()

virtual PCB_LAYER_ID BOARD_ITEM::GetLayer ( ) const

inlinevirtualinherited

Return the primary layer this item is on.

Reimplemented in ZONE.

Definition at line 171 of file board_item.h.

171 { return m_layer; }

BOARD_ITEM::m_layer

PCB_LAYER_ID m_layer

Definition: board_item.h:352

References BOARD_ITEM::m_layer.

◆ GetLayerName()

wxString BOARD_ITEM::GetLayerName ( ) const

inherited

Return the name of the PCB layer on which the item resides.

Returns: the layer name associated with this item.

Definition at line 74 of file board_item.cpp.

 {
     BOARD*  board = GetBoard();
 
     if( board )
         return board->GetLayerName( m_layer );
 
     // If no parent, return standard name
     return BOARD::GetStandardLayerName( m_layer );
 }

References BOARD_ITEM::GetBoard(), BOARD::GetLayerName(), BOARD::GetStandardLayerName(), and BOARD_ITEM::m_layer.

Referenced by PCB_TARGET::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_SHAPE::GetMsgPanelInfo(), GetMsgPanelInfo(), PCB_TEXT::GetSelectMenuText(), FP_SHAPE::GetSelectMenuText(), PCB_TRACK::GetSelectMenuText(), PCB_DIMENSION_BASE::GetSelectMenuText(), PCB_SHAPE::GetSelectMenuText(), PCB_TEXT::GetShownText(), and FOOTPRINT::ResolveTextVar().

◆ GetLayerSet()

virtual LSET BOARD_ITEM::GetLayerSet ( ) const

inlinevirtualinherited

Return a std::bitset of all layers on which the item physically resides.

Reimplemented in PAD, PCB_VIA, ZONE, and PCB_GROUP.

Definition at line 176 of file board_item.h.

176 { return LSET( m_layer ); }

LSET

LSET is a set of PCB_LAYER_IDs.

Definition: layers_id_colors_and_visibility.h:506

BOARD_ITEM::m_layer

PCB_LAYER_ID m_layer

Definition: board_item.h:352

References BOARD_ITEM::m_layer.

Referenced by PCB_GRID_HELPER::BestSnapAnchor(), APPEARANCE_CONTROLS::doApplyLayerPreset(), DRAWING_TOOL::DrawVia(), DRC_ENGINE::EvalRules(), extractDiffPairCoupledItems(), hash_board_item(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_ITEM::layerMaskDescribe(), FABMASTER::loadZone(), PCB_GRID_HELPER::nearestAnchor(), PCB_POINT_EDITOR::OnSelectionChange(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), CN_VISITOR::operator()(), and PANEL_SETUP_LAYERS::TransferDataFromWindow().

◆ GetLineThickness()

int PCB_DIMENSION_BASE::GetLineThickness ( ) const

inlineinherited

Definition at line 187 of file pcb_dimension.h.

187 { return m_lineThickness; }

PCB_DIMENSION_BASE::m_lineThickness

int m_lineThickness

Thickness used for all graphics in the dimension.

Definition: pcb_dimension.h:295

References PCB_DIMENSION_BASE::m_lineThickness.

Referenced by BOARD_ADAPTER::addShapeWithClearance(), KIGFX::PCB_PAINTER::draw(), DRAWING_TOOL::DrawDimension(), PCB_IO::format(), BRDITEMS_PLOTTER::PlotDimension(), and DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow().

◆ GetMeasuredValue()

int PCB_DIMENSION_BASE::GetMeasuredValue ( ) const

inlineinherited

Definition at line 136 of file pcb_dimension.h.

136 { return m_measuredValue; }

PCB_DIMENSION_BASE::m_measuredValue

int m_measuredValue

value of PCB dimensions

Definition: pcb_dimension.h:303

References PCB_DIMENSION_BASE::m_measuredValue.

Referenced by PCB_DIMENSION_BASE::GetValueText().

◆ GetMenuImage()

BITMAPS PCB_DIM_LEADER::GetMenuImage ( ) const

overridevirtual

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

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

Returns: The menu image associated with the item.

Reimplemented from EDA_ITEM.

Definition at line 943 of file pcb_dimension.cpp.

 {
     return BITMAPS::add_leader;
 }

References add_leader.

◆ GetMsgPanelInfo()

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

overridevirtual

Populate aList of MSG_PANEL_ITEM objects with it's internal state for display purposes.

Parameters

aList is the list to populate.

Reimplemented from PCB_DIMENSION_BASE.

Definition at line 1040 of file pcb_dimension.cpp.

 {
     wxString    msg;
 
     aList.emplace_back( _( "Leader" ), m_text.GetShownText() );
 
     ORIGIN_TRANSFORMS originTransforms = aFrame->GetOriginTransforms();
     EDA_UNITS         units = aFrame->GetUserUnits();
 
     wxPoint startCoord = originTransforms.ToDisplayAbs( GetStart() );
     wxString start = wxString::Format( "@(%s, %s)",
                                        MessageTextFromValue( units, startCoord.x ),
                                        MessageTextFromValue( units, startCoord.y ) );
 
     aList.emplace_back( start, wxEmptyString );
 
     aList.emplace_back( _( "Layer" ), GetLayerName() );
 }

References _, Format(), BOARD_ITEM::GetLayerName(), EDA_DRAW_FRAME::GetOriginTransforms(), PCB_TEXT::GetShownText(), PCB_DIMENSION_BASE::GetStart(), EDA_BASE_FRAME::GetUserUnits(), PCB_DIMENSION_BASE::m_text, MessageTextFromValue(), and ORIGIN_TRANSFORMS::ToDisplayAbs().

◆ GetOverrideText()

wxString PCB_DIMENSION_BASE::GetOverrideText ( ) const

inlineinherited

Definition at line 133 of file pcb_dimension.h.

133 { return m_valueString; }

PCB_DIMENSION_BASE::m_valueString

wxString m_valueString

Displayed value when m_overrideValue = true.

Definition: pcb_dimension.h:285

References PCB_DIMENSION_BASE::m_valueString.

Referenced by PCB_IO::format(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), and DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow().

◆ GetOverrideTextEnabled()

bool PCB_DIMENSION_BASE::GetOverrideTextEnabled ( ) const

inlineinherited

Definition at line 130 of file pcb_dimension.h.

130 { return m_overrideTextEnabled; }

PCB_DIMENSION_BASE::m_overrideTextEnabled

bool m_overrideTextEnabled

Manually specify the displayed measurement value.

Definition: pcb_dimension.h:284

References PCB_DIMENSION_BASE::m_overrideTextEnabled.

Referenced by PCB_IO::format(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), and DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow().

◆ GetParent()

BOARD_ITEM_CONTAINER* BOARD_ITEM::GetParent ( void ) const

inlineinherited

Definition at line 166 of file board_item.h.

166 { return (BOARD_ITEM_CONTAINER*) m_parent; }

EDA_ITEM::m_parent

EDA_ITEM * m_parent

Linked list: Link (parent struct)

Definition: eda_item.h:479

BOARD_ITEM_CONTAINER

Abstract interface for BOARD_ITEMs capable of storing other items inside.

Definition: board_item_container.h:52

References EDA_ITEM::m_parent.

◆ GetParentGroup()

PCB_GROUP* BOARD_ITEM::GetParentGroup ( ) const

inlineinherited

Definition at line 91 of file board_item.h.

91 { return m_group; }

BOARD_ITEM::m_group

PCB_GROUP * m_group

Definition: board_item.h:353

References BOARD_ITEM::m_group.

Referenced by PCB_GROUP::AddItem(), PCB_EDIT_FRAME::ExchangeFootprint(), getTopLevelGroup(), BOARD_ITEM::IsLocked(), memberOf(), PCB_CONTROL::placeBoardItems(), BOARD_COMMIT::Push(), EDIT_TOOL::Remove(), FOOTPRINT::Remove(), BOARD::Remove(), GROUP_TOOL::RemoveFromGroup(), and DIALOG_GROUP_PROPERTIES::TransferDataFromWindow().

◆ GetPosition()

wxPoint PCB_DIMENSION_BASE::GetPosition ( ) const

inlineoverridevirtualinherited

Reimplemented from EDA_ITEM.

Definition at line 127 of file pcb_dimension.h.

127 { return m_start; }

PCB_DIMENSION_BASE::m_start

wxPoint m_start

Definition: pcb_dimension.h:304

References PCB_DIMENSION_BASE::m_start.

Referenced by DRAWING_TOOL::DrawDimension(), PCB_DIMENSION_BASE::ViewBBox(), and PCB_DIM_CENTER::ViewBBox().

◆ GetPrecision()

int PCB_DIMENSION_BASE::GetPrecision ( ) const

inlineinherited

Definition at line 169 of file pcb_dimension.h.

169 { return m_precision; }

PCB_DIMENSION_BASE::m_precision

int m_precision

Number of digits to display after decimal.

Definition: pcb_dimension.h:291

References PCB_DIMENSION_BASE::m_precision.

Referenced by PCB_IO::format(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), and DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow().

◆ GetPrefix()

wxString PCB_DIMENSION_BASE::GetPrefix ( ) const

inlineinherited

Definition at line 152 of file pcb_dimension.h.

152 { return m_prefix; }

PCB_DIMENSION_BASE::m_prefix

wxString m_prefix

String prepended to the value.

Definition: pcb_dimension.h:286

References PCB_DIMENSION_BASE::m_prefix.

Referenced by PCB_IO::format(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), and DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow().

◆ GetSelectMenuText()

wxString PCB_DIMENSION_BASE::GetSelectMenuText ( EDA_UNITS aUnits ) const

overridevirtualinherited

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

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

Returns: The menu text string.

Reimplemented from EDA_ITEM.

Definition at line 438 of file pcb_dimension.cpp.

 {
     return wxString::Format( _( "Dimension '%s' on %s" ), GetText(), GetLayerName() );
 }

References _, Format(), BOARD_ITEM::GetLayerName(), and PCB_DIMENSION_BASE::GetText().

◆ GetShapes()

const std::vector<std::shared_ptr<SHAPE> >& PCB_DIMENSION_BASE::GetShapes ( ) const

inlineinherited

Returns: a list of line segments that make up this dimension (for drawing, plotting, etc).

Definition at line 217 of file pcb_dimension.h.

217 { return m_shapes; }

PCB_DIMENSION_BASE::m_shapes

std::vector< std::shared_ptr< SHAPE > > m_shapes

Definition: pcb_dimension.h:308

References PCB_DIMENSION_BASE::m_shapes.

Referenced by BOARD_ADAPTER::addShapeWithClearance(), KIGFX::PCB_PAINTER::draw(), PCB_DIMENSION_BASE::GetBoundingBox(), PCB_DIMENSION_BASE::GetEffectiveShape(), PCB_DIMENSION_BASE::HitTest(), and BRDITEMS_PLOTTER::PlotDimension().

◆ GetStart()

virtual const wxPoint& PCB_DIMENSION_BASE::GetStart ( ) const

inlinevirtualinherited

The dimension's origin is the first feature point for the dimension.

Every dimension has one or more feature points, so every dimension has at least an origin.

Returns: the origin point of this dimension

Definition at line 121 of file pcb_dimension.h.

121 { return m_start; }

PCB_DIMENSION_BASE::m_start

wxPoint m_start

Definition: pcb_dimension.h:304

References PCB_DIMENSION_BASE::m_start.

Referenced by PCB_GRID_HELPER::computeAnchors(), DRAWING_TOOL::constrainDimension(), DRAWING_TOOL::DrawDimension(), PCB_IO::format(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), GetMsgPanelInfo(), CADSTAR_PCB_ARCHIVE_LOADER::loadDimensions(), PCB_POINT_EDITOR::makePoints(), PCB_DIM_ALIGNED::UpdateHeight(), PCB_POINT_EDITOR::updateItem(), and PCB_POINT_EDITOR::updatePoints().

◆ GetState()

int EDA_ITEM::GetState ( EDA_ITEM_FLAGS type ) const

inlineinherited

Definition at line 137 of file eda_item.h.

     {
         return m_status & type;
     }

References EDA_ITEM::m_status.

Referenced by BOARD_ITEM::IsLocked().

◆ GetStatus()

EDA_ITEM_FLAGS EDA_ITEM::GetStatus ( ) const

inlineinherited

Definition at line 150 of file eda_item.h.

150 { return m_status; }

EDA_ITEM::m_status

EDA_ITEM_FLAGS m_status

Definition: eda_item.h:478

References EDA_ITEM::m_status.

◆ GetSuffix()

wxString PCB_DIMENSION_BASE::GetSuffix ( ) const

inlineinherited

Definition at line 155 of file pcb_dimension.h.

155 { return m_suffix; }

PCB_DIMENSION_BASE::m_suffix

wxString m_suffix

String appended to the value.

Definition: pcb_dimension.h:287

References PCB_DIMENSION_BASE::m_suffix.

Referenced by PCB_IO::format(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), and DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow().

◆ GetSuppressZeroes()

bool PCB_DIMENSION_BASE::GetSuppressZeroes ( ) const

inlineinherited

Definition at line 172 of file pcb_dimension.h.

172 { return m_suppressZeroes; }

PCB_DIMENSION_BASE::m_suppressZeroes

bool m_suppressZeroes

Suppress trailing zeroes.

Definition: pcb_dimension.h:292

References PCB_DIMENSION_BASE::m_suppressZeroes.

Referenced by PCB_IO::format(), and DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow().

◆ GetText()

const wxString PCB_DIMENSION_BASE::GetText ( ) const

inherited

Retrieve the value text or override text, not including prefix or suffix.

Returns: the value portion of the dimension text (either overridden or not).

Definition at line 207 of file pcb_dimension.cpp.

 {
     return m_text.GetText();
 }

References EDA_TEXT::GetText(), and PCB_DIMENSION_BASE::m_text.

Referenced by PCB_DIMENSION_BASE::GetSelectMenuText(), and updateGeometry().

◆ GetTextFrame()

DIM_TEXT_FRAME PCB_DIM_LEADER::GetTextFrame ( ) const

inline

Definition at line 508 of file pcb_dimension.h.

508 { return m_textFrame; }

PCB_DIM_LEADER::m_textFrame

DIM_TEXT_FRAME m_textFrame

Definition: pcb_dimension.h:516

References m_textFrame.

Referenced by PCB_IO::format(), and DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow().

◆ GetTextPositionMode()

DIM_TEXT_POSITION PCB_DIMENSION_BASE::GetTextPositionMode ( ) const

inlineinherited

Definition at line 179 of file pcb_dimension.h.

179 { return m_textPosition; }

PCB_DIMENSION_BASE::m_textPosition

DIM_TEXT_POSITION m_textPosition

How to position the text.

Definition: pcb_dimension.h:298

References PCB_DIMENSION_BASE::m_textPosition.

Referenced by PCB_IO::format(), and DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow().

◆ GetUnits()

void PCB_DIMENSION_BASE::GetUnits ( EDA_UNITS & aUnits ) const

inlineinherited

Definition at line 158 of file pcb_dimension.h.

158 { aUnits = m_units; }

PCB_DIMENSION_BASE::m_units

EDA_UNITS m_units

0 = inches, 1 = mm

Definition: pcb_dimension.h:288

References PCB_DIMENSION_BASE::m_units.

Referenced by PCB_DIMENSION_BASE::GetMsgPanelInfo().

◆ GetUnitsFormat()

DIM_UNITS_FORMAT PCB_DIMENSION_BASE::GetUnitsFormat ( ) const

inlineinherited

Definition at line 166 of file pcb_dimension.h.

166 { return m_unitsFormat; }

PCB_DIMENSION_BASE::m_unitsFormat

DIM_UNITS_FORMAT m_unitsFormat

How to render the units suffix.

Definition: pcb_dimension.h:290

References PCB_DIMENSION_BASE::m_unitsFormat.

Referenced by PCB_IO::format(), and DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow().

◆ GetUnitsMode()

DIM_UNITS_MODE PCB_DIMENSION_BASE::GetUnitsMode ( ) const

inherited

Definition at line 151 of file pcb_dimension.cpp.

 {
     if( m_autoUnits )
     {
         return DIM_UNITS_MODE::AUTOMATIC;
     }
     else
     {
         switch( m_units )
         {
         case EDA_UNITS::MILLIMETRES:
             return DIM_UNITS_MODE::MILLIMETRES;
 
         case EDA_UNITS::MILS:
             return DIM_UNITS_MODE::MILS;
 
         default:
         case EDA_UNITS::INCHES:
             return DIM_UNITS_MODE::INCHES;
         }
     }
 }

References AUTOMATIC, INCHES, PCB_DIMENSION_BASE::m_autoUnits, PCB_DIMENSION_BASE::m_units, MILLIMETRES, and MILS.

Referenced by PCB_IO::format(), PCB_CONTROL::placeBoardItems(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), and PCB_BASE_EDIT_FRAME::unitsChangeRefresh().

◆ GetValueText()

wxString PCB_DIMENSION_BASE::GetValueText ( ) const

inherited

Returns: the dimension value, rendered with precision / zero suppression but no units, etc

Definition at line 104 of file pcb_dimension.cpp.

 {
     struct lconv* lc = localeconv();
     wxChar sep = lc->decimal_point[0];
 
     int      val = GetMeasuredValue();
     wxString text;
     wxString format = wxT( "%." ) + wxString::Format( "%i", m_precision ) + wxT( "f" );
 
     text.Printf( format, To_User_Unit( m_units, val ) );
 
     if( m_suppressZeroes )
     {
         while( text.Last() == '0' )
         {
             text.RemoveLast();
 
             if( text.Last() == '.' || text.Last() == sep )
             {
                 text.RemoveLast();
                 break;
             }
         }
     }
 
     return text;
 }

References Format(), PCB_DIMENSION_BASE::GetMeasuredValue(), PCB_DIMENSION_BASE::m_precision, PCB_DIMENSION_BASE::m_suppressZeroes, PCB_DIMENSION_BASE::m_units, text, and To_User_Unit().

Referenced by DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), and PCB_DIMENSION_BASE::updateText().

◆ GetX()

int BOARD_ITEM::GetX ( ) const

inlineinherited

Definition at line 95 of file board_item.h.

     {
         wxPoint p = GetPosition();
         return p.x;
     }

References EDA_ITEM::GetPosition().

Referenced by BOARD_ITEM_DESC::BOARD_ITEM_DESC(), ALIGN_DISTRIBUTE_TOOL::DistributeHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), BOARD_ITEM::SetY(), and TRACK_VIA_DESC::TRACK_VIA_DESC().

◆ GetY()

int BOARD_ITEM::GetY ( ) const

inlineinherited

Definition at line 101 of file board_item.h.

     {
         wxPoint p = GetPosition();
         return p.y;
     }

References EDA_ITEM::GetPosition().

Referenced by BOARD_ITEM_DESC::BOARD_ITEM_DESC(), ALIGN_DISTRIBUTE_TOOL::DistributeVertically(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), BOARD_ITEM::SetX(), and TRACK_VIA_DESC::TRACK_VIA_DESC().

◆ HasFlag()

bool EDA_ITEM::HasFlag ( EDA_ITEM_FLAGS aFlag ) const

inlineinherited

Definition at line 156 of file eda_item.h.

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

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

References EDA_ITEM::m_flags.

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

◆ HitTest() [1/2]

bool PCB_DIMENSION_BASE::HitTest	(	const wxPoint &	aPosition,
		int	aAccuracy
	)		const

overridevirtualinherited

Test if aPosition is contained within or on the bounding box of an item.

Parameters

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

Returns: True if aPosition is within the item bounding box.

Reimplemented from EDA_ITEM.

Definition at line 369 of file pcb_dimension.cpp.

 {
     if( m_text.TextHitTest( aPosition ) )
         return true;
 
     int dist_max = aAccuracy + ( m_lineThickness / 2 );
 
     // Locate SEGMENTS
 
     for( const std::shared_ptr<SHAPE>& shape : GetShapes() )
     {
         if( shape->Collide( aPosition, dist_max ) )
             return true;
     }
 
     return false;
 }

References PCB_DIMENSION_BASE::GetShapes(), PCB_DIMENSION_BASE::m_lineThickness, PCB_DIMENSION_BASE::m_text, and PCB_TEXT::TextHitTest().

Referenced by GENERAL_COLLECTOR::Inspect().

◆ HitTest() [2/2]

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

overridevirtualinherited

Test if aRect intersects or is contained within the bounding box of an item.

Parameters

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

Returns: True if aRect contains or intersects the item bounding box.

Reimplemented from EDA_ITEM.

Definition at line 388 of file pcb_dimension.cpp.

 {
     EDA_RECT arect = aRect;
     arect.Inflate( aAccuracy );
 
     EDA_RECT rect = GetBoundingBox();
 
     if( aAccuracy )
         rect.Inflate( aAccuracy );
 
     if( aContained )
         return arect.Contains( rect );
 
     return arect.Intersects( rect );
 }

References EDA_RECT::Contains(), PCB_DIMENSION_BASE::GetBoundingBox(), EDA_RECT::Inflate(), and EDA_RECT::Intersects().

◆ IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const

inlineinherited

Definition at line 126 of file eda_item.h.

126 { return m_flags & BRIGHTENED; }

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

BRIGHTENED

#define BRIGHTENED

item is drawn with a bright contour

Definition: eda_item_flags.h:65

References BRIGHTENED, and EDA_ITEM::m_flags.

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

◆ IsConnected()

virtual bool BOARD_ITEM::IsConnected ( ) const

inlinevirtualinherited

Returns information if the object is derived from BOARD_CONNECTED_ITEM.

Returns: True if the object is of BOARD_CONNECTED_ITEM type, false otherwise.

Reimplemented in ZONE, and BOARD_CONNECTED_ITEM.

Definition at line 134 of file board_item.h.

     {
         return false;
     }

Referenced by PNS_PCBNEW_RULE_RESOLVER::DpNetPair(), DRC_ENGINE::EvalRules(), PNS::NODE::FindItemByParent(), BOARD_INSPECTION_TOOL::getItemDescription(), PCB_EXPR_NETCLASS_REF::GetValue(), PCB_EXPR_NETNAME_REF::GetValue(), inDiffPair(), BOARD_INSPECTION_TOOL::InspectClearance(), CN_CONNECTIVITY_ALGO::markItemNetAsDirty(), CONNECTIVITY_DATA::MarkItemNetAsDirty(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZones().

◆ IsDragging()

bool EDA_ITEM::IsDragging ( ) const

inlineinherited

Definition at line 121 of file eda_item.h.

121 { return m_flags & IS_DRAGGING; }

IS_DRAGGING

#define IS_DRAGGING

Item being dragged.

Definition: eda_item_flags.h:43

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

References IS_DRAGGING, and EDA_ITEM::m_flags.

Referenced by DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES().

◆ IsEntered()

bool EDA_ITEM::IsEntered ( ) const

inlineinherited

Definition at line 124 of file eda_item.h.

124 { return m_flags & ENTERED; }

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

ENTERED

#define ENTERED

indicates a group has been entered

Definition: eda_item_flags.h:72

References ENTERED, and EDA_ITEM::m_flags.

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

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const

inlineinherited

Definition at line 206 of file eda_item.h.

206 { return m_forceVisible; }

EDA_ITEM::m_forceVisible

bool m_forceVisible

Definition: eda_item.h:480

References EDA_ITEM::m_forceVisible.

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

◆ IsLocked()

bool BOARD_ITEM::IsLocked ( ) const

virtualinherited

Returns: true if the object is locked, else false.

Reimplemented in FOOTPRINT, and PAD.

Definition at line 65 of file board_item.cpp.

 {
     if( GetParentGroup() )
         return GetParentGroup()->IsLocked();
 
     return GetState( LOCKED );
 }

References BOARD_ITEM::GetParentGroup(), EDA_ITEM::GetState(), BOARD_ITEM::IsLocked(), and LOCKED.

Referenced by BOARD_ITEM_DESC::BOARD_ITEM_DESC(), PCB_CONTROL::DeleteItemCursor(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), EDIT_TOOL::doMoveSelection(), EDIT_TOOL::DragArcTrack(), EDIT_TOOL::FilletTracks(), PCB_IO::format(), PCB_TEXT::GetMsgPanelInfo(), ZONE::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), PCB_GROUP::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_SHAPE::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfoBase_Common(), ALIGN_DISTRIBUTE_TOOL::GetSelections(), GENERAL_COLLECTOR::Inspect(), PAD::IsLocked(), BOARD_ITEM::IsLocked(), PCB_SELECTION_TOOL::itemPassesFilter(), CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromShapes(), TRACKS_CLEANER::mergeCollinearSegments(), BOARD_EDITOR_CONTROL::modifyLockSelected(), PCB_POINT_EDITOR::OnSelectionChange(), ZONE_SETTINGS::operator<<(), POSITION_RELATIVE_TOOL::PositionRelative(), processTextItem(), PCB_SELECTION_TOOL::RequestSelection(), PNS_KICAD_IFACE_BASE::syncArc(), PNS_KICAD_IFACE_BASE::syncTrack(), PNS_KICAD_IFACE_BASE::syncVia(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), and DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow().

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const

inlineinherited

Definition at line 118 of file eda_item.h.

118 { return m_flags & IS_CHANGED; }

IS_CHANGED

#define IS_CHANGED

Item was edited, and modified.

Definition: eda_item_flags.h:37

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

References IS_CHANGED, and EDA_ITEM::m_flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMoving()

bool EDA_ITEM::IsMoving ( ) const

inlineinherited

Definition at line 120 of file eda_item.h.

120 { return m_flags & IS_MOVING; }

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

IS_MOVING

#define IS_MOVING

Item being moved.

Definition: eda_item_flags.h:40

References IS_MOVING, and EDA_ITEM::m_flags.

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

◆ IsNew()

bool EDA_ITEM::IsNew ( ) const

inlineinherited

Definition at line 119 of file eda_item.h.

119 { return m_flags & IS_NEW; }

IS_NEW

#define IS_NEW

New item, just created.

Definition: eda_item_flags.h:41

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

References IS_NEW, and EDA_ITEM::m_flags.

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

◆ IsOnCopperLayer()

virtual bool BOARD_ITEM::IsOnCopperLayer ( ) const

inlinevirtualinherited

Returns: true if the object is on any copper layer, false otherwise.

Reimplemented in PAD, PCB_TRACK, and ZONE.

Definition at line 142 of file board_item.h.

     {
         return IsCopperLayer( GetLayer() );
     }

References BOARD_ITEM::GetLayer(), and IsCopperLayer().

Referenced by CN_CONNECTIVITY_ALGO::Add(), DRC_ENGINE::EvalRules(), and BOARD_CONNECTED_ITEM::SetNetCode().

◆ IsOnLayer()

virtual bool BOARD_ITEM::IsOnLayer ( PCB_LAYER_ID aLayer ) const

inlinevirtualinherited

Test to see if this object is on the given layer.

Virtual so objects like PAD, which reside on multiple layers can do their own form of testing.

Parameters

aLayer The layer to test for.

Returns: true if on given layer, else false.

Reimplemented in PAD, PCB_VIA, FOOTPRINT, ZONE, and PCB_GROUP.

Definition at line 229 of file board_item.h.

     {
         return m_layer == aLayer;
     }

References BOARD_ITEM::m_layer.

Referenced by BOARD_ADAPTER::createLayers(), existsOnLayer(), GENERAL_COLLECTOR::Inspect(), PCB_LAYER_COLLECTOR::Inspect(), and PNS_KICAD_IFACE::IsItemVisible().

◆ IsReplaceable()

virtual bool EDA_ITEM::IsReplaceable ( ) const

inlinevirtualinherited

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

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

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

Definition at line 403 of file eda_item.h.

403 { return false; }

Referenced by EDA_ITEM::Matches().

◆ IsResized()

bool EDA_ITEM::IsResized ( ) const

inlineinherited

Definition at line 125 of file eda_item.h.

125 { return m_flags & IS_RESIZING; }

IS_RESIZING

#define IS_RESIZING

Item being resized.

Definition: eda_item_flags.h:42

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

References IS_RESIZING, and EDA_ITEM::m_flags.

◆ IsSelected()

bool EDA_ITEM::IsSelected ( ) const

inlineinherited

Definition at line 123 of file eda_item.h.

123 { return m_flags & SELECTED; }

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

SELECTED

#define SELECTED

Definition: eda_item_flags.h:48

References EDA_ITEM::m_flags, and SELECTED.

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

◆ IsTrack()

bool BOARD_ITEM::IsTrack ( ) const

inlineinherited

Test to see if this object is a track or via (or microvia).

Returns: true if a track or via, else false.

Definition at line 239 of file board_item.h.

     {
         return ( Type() == PCB_TRACE_T ) || ( Type() == PCB_VIA_T );
     }

References PCB_TRACE_T, PCB_VIA_T, and EDA_ITEM::Type().

◆ IsType()

bool PCB_DIMENSION_BASE::IsType ( const KICAD_T aScanTypes[] ) const

inlineoverridevirtualinherited

Check whether the item is one of the listed types.

Parameters

aScanTypes List of item types

Returns: true if the item type is contained in the list aScanTypes

Reimplemented from EDA_ITEM.

Definition at line 100 of file pcb_dimension.h.

     {
         if( BOARD_ITEM::IsType( aScanTypes ) )
             return true;
 
         for( const KICAD_T* p = aScanTypes; *p != EOT; ++p )
         {
             if( *p == PCB_LOCATE_GRAPHIC_T )
                 return true;
         }
 
         return false;
     }

References EOT, EDA_ITEM::IsType(), and PCB_LOCATE_GRAPHIC_T.

◆ IsWireImage()

bool EDA_ITEM::IsWireImage ( ) const

inlineinherited

Definition at line 122 of file eda_item.h.

122 { return m_flags & IS_WIRE_IMAGE; }

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

IS_WIRE_IMAGE

#define IS_WIRE_IMAGE

Item to be drawn as wireframe while editing.

Definition: eda_item_flags.h:45

References IS_WIRE_IMAGE, and EDA_ITEM::m_flags.

◆ IterateForward() [1/2]

template<class T >

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

inlinestaticinherited

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

Definition at line 295 of file eda_item.h.

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

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

Referenced by GERBER_FILE_IMAGE::Visit().

◆ IterateForward() [2/2]

template<class T >

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

inlinestaticinherited

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

Definition at line 314 of file eda_item.h.

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

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

◆ layerMaskDescribe()

wxString BOARD_ITEM::layerMaskDescribe ( ) const

protectedvirtualinherited

Return a string (to be shown to the user) describing a layer mask.

The BOARD is needed because layer names are customizable.

Reimplemented in PCB_VIA.

Definition at line 86 of file board_item.cpp.

 {
     BOARD* board = GetBoard();
     LSET   layers = GetLayerSet();
 
     // Try to be smart and useful.  Check all copper first.
     if( layers[F_Cu] && layers[B_Cu] )
         return _( "all copper layers" );
 
     LSET copperLayers = layers & board->GetEnabledLayers().AllCuMask();
     LSET techLayers = layers & board->GetEnabledLayers().AllTechMask();
 
     for( LSET testLayers : { copperLayers, techLayers, layers } )
     {
         for( int bit = PCBNEW_LAYER_ID_START; bit < PCB_LAYER_ID_COUNT; ++bit )
         {
             if( testLayers[ bit ] )
             {
                 wxString layerInfo = board->GetLayerName( static_cast<PCB_LAYER_ID>( bit ) );
 
                 if( testLayers.count() > 1 )
                     layerInfo << wxS( " " ) + _( "and others" );
 
                 return layerInfo;
             }
         }
     }
 
     // No copper, no technicals: no layer
     return _( "no layers" );
 }

References _, LSET::AllCuMask(), LSET::AllTechMask(), B_Cu, F_Cu, BOARD_ITEM::GetBoard(), BOARD::GetEnabledLayers(), BOARD::GetLayerName(), BOARD_ITEM::GetLayerSet(), PCB_LAYER_ID_COUNT, and PCBNEW_LAYER_ID_START.

Referenced by PCB_TRACK::GetMsgPanelInfo(), PAD::GetMsgPanelInfo(), and PAD::GetSelectMenuText().

◆ Matches() [1/2]

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

inlinevirtualinherited

Compare the item against the search criteria in aSearchData.

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

Parameters

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

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

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

Definition at line 365 of file eda_item.h.

     {
         return false;
     }

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

◆ Matches() [2/2]

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

protectedinherited

Compare aText against search criteria in aSearchData.

This is a helper function for simplify derived class logic.

Parameters

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

Returns: True if aText matches the search criteria in aSearchData.

Definition at line 118 of file eda_item.cpp.

 {
     wxString text = aText;
     wxString searchText = aSearchData.GetFindString();
 
     // Don't match if searching for replaceable item and the item doesn't support text replace.
     if( (aSearchData.GetFlags() & FR_SEARCH_REPLACE) && !IsReplaceable() )
         return false;
 
     if( aSearchData.GetFlags() & wxFR_WHOLEWORD )
         return aText.IsSameAs( searchText, aSearchData.GetFlags() & wxFR_MATCHCASE );
 
     if( aSearchData.GetFlags() & FR_MATCH_WILDCARD )
     {
         if( aSearchData.GetFlags() & wxFR_MATCHCASE )
             return text.Matches( searchText );
 
         return text.MakeUpper().Matches( searchText.MakeUpper() );
     }
 
     if( aSearchData.GetFlags() & wxFR_MATCHCASE )
         return aText.Find( searchText ) != wxNOT_FOUND;
 
     return text.MakeUpper().Find( searchText.MakeUpper() ) != wxNOT_FOUND;
 }

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

◆ Mirror()

void PCB_DIMENSION_BASE::Mirror	(	const wxPoint &	axis_pos,
		bool	aMirrorLeftRight = `false`
	)

inherited

Mirror the dimension relative to a given horizontal axis.

The text is not mirrored. Only its position (and angle) is mirrored. The layer is not changed.

Parameters

axis_pos is the vertical axis position to mirror around.

Definition at line 259 of file pcb_dimension.cpp.

 {
     int axis = aMirrorLeftRight ? axis_pos.x : axis_pos.y;
     wxPoint newPos = m_text.GetTextPos();
 
 #define INVERT( pos ) ( ( pos ) = axis - ( ( pos ) - axis ) )
     if( aMirrorLeftRight )
         INVERT( newPos.x );
     else
         INVERT( newPos.y );
 
     m_text.SetTextPos( newPos );
 
     // invert angle
     m_text.SetTextAngle( -m_text.GetTextAngle() );
 
     if( aMirrorLeftRight )
     {
         INVERT( m_start.x );
         INVERT( m_end.x );
     }
     else
     {
         INVERT( m_start.y );
         INVERT( m_end.y );
     }
 
     m_text.SetMirrored( !m_text.IsMirrored() );
 
     Update();
 }

References EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextPos(), INVERT, EDA_TEXT::IsMirrored(), PCB_DIMENSION_BASE::m_end, PCB_DIMENSION_BASE::m_start, PCB_DIMENSION_BASE::m_text, EDA_TEXT::SetMirrored(), PCB_TEXT::SetTextAngle(), EDA_TEXT::SetTextPos(), and PCB_DIMENSION_BASE::Update().

Referenced by PCB_DIMENSION_BASE::Flip().

◆ Move() [1/2]

void PCB_DIMENSION_BASE::Move ( const wxPoint & aMoveVector )

overridevirtualinherited

Move this object.

Parameters

aMoveVector the move vector for this object.

Reimplemented from BOARD_ITEM.

Definition at line 220 of file pcb_dimension.cpp.

 {
     m_text.Offset( offset );
 
     m_start += offset;
     m_end   += offset;
 
     Update();
 }

References PCB_DIMENSION_BASE::m_end, PCB_DIMENSION_BASE::m_start, PCB_DIMENSION_BASE::m_text, EDA_TEXT::Offset(), and PCB_DIMENSION_BASE::Update().

◆ Move() [2/2]

void BOARD_ITEM::Move ( const VECTOR2I & aMoveVector )

inlineinherited

Definition at line 278 of file board_item.h.

     {
         Move( wxPoint( aMoveVector.x, aMoveVector.y ) );
     }

References BOARD_ITEM::Move(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ operator<()

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 171 of file eda_item.cpp.

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

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

◆ Replace() [1/2]

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

staticinherited

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

Parameters

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

Returns: True if aText was modified, otherwise false.

Definition at line 145 of file eda_item.cpp.

 {
     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'." ),
                 aText, prefix, aSearchData.GetReplaceString(), suffix );
 
     aText = prefix + aSearchData.GetReplaceString() + suffix;
 
     return true;
 }

References traceFindReplace.

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

◆ Replace() [2/2]

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

inlinevirtualinherited

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

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

Parameters

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

Returns: True if the item text was modified, otherwise false.

Reimplemented in SCH_TEXT, SCH_FIELD, SCH_SHEET_PIN, and SCH_PIN.

Definition at line 392 of file eda_item.h.

     {
         return false;
     }

◆ Rotate() [1/2]

void PCB_DIMENSION_BASE::Rotate	(	const wxPoint &	aRotCentre,
		double	aAngle
	)

overridevirtualinherited

Rotate this object.

Parameters

aRotCentre	the rotation point.
aAngle	the rotation angle in 0.1 degree.

Reimplemented from BOARD_ITEM.

Reimplemented in PCB_DIM_ORTHOGONAL.

Definition at line 231 of file pcb_dimension.cpp.

 {
     double newAngle = m_text.GetTextAngle() + aAngle;
 
     if( newAngle >= 3600 )
         newAngle -= 3600;
 
     m_text.SetTextAngle( newAngle );
 
     wxPoint pt = m_text.GetTextPos();
     RotatePoint( &pt, aRotCentre, aAngle );
     m_text.SetTextPos( pt );
 
     RotatePoint( &m_start, aRotCentre, aAngle );
     RotatePoint( &m_end, aRotCentre, aAngle );
 
     Update();
 }

References EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextPos(), PCB_DIMENSION_BASE::m_end, PCB_DIMENSION_BASE::m_start, PCB_DIMENSION_BASE::m_text, RotatePoint(), PCB_TEXT::SetTextAngle(), EDA_TEXT::SetTextPos(), and PCB_DIMENSION_BASE::Update().

Referenced by PCB_DIM_ORTHOGONAL::Rotate().

◆ Rotate() [2/2]

void BOARD_ITEM::Rotate	(	const VECTOR2I &	aRotCentre,
		double	aAngle
	)

inlineinherited

Definition at line 291 of file board_item.h.

     {
         Rotate( wxPoint( aRotCentre.x, aRotCentre.y ), aAngle );
     }

References BOARD_ITEM::Rotate(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ segCircleIntersection()

OPT_VECTOR2I PCB_DIMENSION_BASE::segCircleIntersection	(	CIRCLE &	aCircle,
		SEG &	aSeg,
		bool	aStart = `true`
	)

staticprotectedinherited

Definition at line 481 of file pcb_dimension.cpp.

 {
     VECTOR2I start( aStart ? aSeg.A : aSeg.B );
     VECTOR2I endpoint( aStart ? aSeg.B : aSeg.A );
 
     if( aCircle.Contains( start ) )
         return NULLOPT;
 
     std::vector<VECTOR2I> intersections = aCircle.Intersect( aSeg );
 
     for( VECTOR2I& intersection : aCircle.Intersect( aSeg ) )
     {
         if( ( intersection - start ).SquaredEuclideanNorm() <
             ( endpoint - start ).SquaredEuclideanNorm() )
             endpoint = intersection;
     }
 
     if( start == endpoint )
         return NULLOPT;
 
     return OPT_VECTOR2I( endpoint );
 }

References SEG::A, SEG::B, CIRCLE::Contains(), CIRCLE::Intersect(), and NULLOPT.

Referenced by updateGeometry().

◆ segPolyIntersection()

OPT_VECTOR2I PCB_DIMENSION_BASE::segPolyIntersection	(	const SHAPE_POLY_SET &	aPoly,
		const SEG &	aSeg,
		bool	aStart = `true`
	)

staticprotectedinherited

Find the intersection between a given segment and polygon outline.

Parameters

aPoly	is the polygon to collide.
aSeg	is the segment to collide.
aStart	if true will start from aSeg.A, otherwise aSeg.B.

Returns: a point on aSeg that collides with aPoly closest to the start, if one exists.

Definition at line 455 of file pcb_dimension.cpp.

 {
     VECTOR2I start( aStart ? aSeg.A : aSeg.B );
     VECTOR2I endpoint( aStart ? aSeg.B : aSeg.A );
 
     if( aPoly.Contains( start ) )
         return NULLOPT;
 
     for( SHAPE_POLY_SET::CONST_SEGMENT_ITERATOR seg = aPoly.CIterateSegments(); seg; ++seg )
     {
         if( OPT_VECTOR2I intersection = ( *seg ).Intersect( aSeg ) )
         {
             if( ( *intersection - start ).SquaredEuclideanNorm() <
                 ( endpoint - start ).SquaredEuclideanNorm() )
                 endpoint = *intersection;
         }
     }
 
     if( start == endpoint )
         return NULLOPT;
 
     return OPT_VECTOR2I( endpoint );
 }

References SEG::A, SEG::B, SHAPE_POLY_SET::CIterateSegments(), SHAPE_POLY_SET::Contains(), and NULLOPT.

Referenced by PCB_DIM_ALIGNED::updateGeometry(), PCB_DIM_ORTHOGONAL::updateGeometry(), and updateGeometry().

◆ Set() [1/3]

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

inlineinherited

Definition at line 42 of file inspectable.h.

     {
         PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
         TYPE_ID thisType = TYPE_HASH( *this );
         void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
 
         if( object )
             aProperty->setter( object, aValue );
 
         return object != nullptr;
     }

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

Referenced by isCoupledDiffPair().

◆ Set() [2/3]

template<typename T >

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

inlineinherited

Definition at line 55 of file inspectable.h.

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

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

◆ Set() [3/3]

template<typename T >

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

inlineinherited

Definition at line 68 of file inspectable.h.

     {
         PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
         TYPE_ID thisType = TYPE_HASH( *this );
         PROPERTY_BASE* prop = propMgr.GetProperty( thisType, aProperty );
         void* object = nullptr;
 
         if( prop )
         {
             object = propMgr.TypeCast( this, thisType, prop->OwnerHash() );
 
             if( object )
                 prop->set<T>( object, aValue );
         }
 
         return object != nullptr;
     }

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

◆ SetArrowLength()

void PCB_DIMENSION_BASE::SetArrowLength ( int aLength )

inlineinherited

Definition at line 182 of file pcb_dimension.h.

182 { m_arrowLength = aLength; }

PCB_DIMENSION_BASE::m_arrowLength

int m_arrowLength

Length of arrow shapes.

Definition: pcb_dimension.h:296

References PCB_DIMENSION_BASE::m_arrowLength.

Referenced by DRAWING_TOOL::DrawDimension(), and DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ SetAutoUnits()

void PCB_DIMENSION_BASE::SetAutoUnits ( bool aAuto = true )

inlineinherited

Definition at line 164 of file pcb_dimension.h.

164 { m_autoUnits = aAuto; }

PCB_DIMENSION_BASE::m_autoUnits

bool m_autoUnits

If true, follow the currently selected UI units.

Definition: pcb_dimension.h:289

References PCB_DIMENSION_BASE::m_autoUnits.

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )

inlineinherited

Definition at line 130 of file eda_item.h.

130 { SetFlags( BRIGHTENED ); }

EDA_ITEM::SetFlags

void SetFlags(EDA_ITEM_FLAGS aMask)

Definition: eda_item.h:153

BRIGHTENED

#define BRIGHTENED

item is drawn with a bright contour

Definition: eda_item_flags.h:65

References BRIGHTENED, and EDA_ITEM::SetFlags().

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

◆ SetEnd()

virtual void PCB_DIMENSION_BASE::SetEnd ( const wxPoint & aPoint )

inlinevirtualinherited

Definition at line 125 of file pcb_dimension.h.

125 { m_end = aPoint; }

PCB_DIMENSION_BASE::m_end

wxPoint m_end

Internal cache of drawn shapes.

Definition: pcb_dimension.h:305

References PCB_DIMENSION_BASE::m_end.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::applyDimensionSettings(), DRAWING_TOOL::constrainDimension(), DRAWING_TOOL::DrawDimension(), ALTIUM_PCB::HelperParseDimensions6Center(), ALTIUM_PCB::HelperParseDimensions6Linear(), CADSTAR_PCB_ARCHIVE_LOADER::loadDimensions(), EAGLE_PLUGIN::loadPlain(), and PCB_POINT_EDITOR::updateItem().

◆ SetExtensionOffset()

void PCB_DIMENSION_BASE::SetExtensionOffset ( int aOffset )

inlineinherited

Definition at line 184 of file pcb_dimension.h.

184 { m_extensionOffset = aOffset; }

PCB_DIMENSION_BASE::m_extensionOffset

int m_extensionOffset

Distance from feature points to extension line start.

Definition: pcb_dimension.h:297

References PCB_DIMENSION_BASE::m_extensionOffset.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::applyDimensionSettings(), DRAWING_TOOL::DrawDimension(), CADSTAR_PCB_ARCHIVE_LOADER::loadDimensions(), and DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ SetFlags()

void EDA_ITEM::SetFlags ( EDA_ITEM_FLAGS aMask )

inlineinherited

Definition at line 153 of file eda_item.h.

153 { m_flags |= aMask; }

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

References EDA_ITEM::m_flags.

◆ SetForceVisible()

void EDA_ITEM::SetForceVisible ( bool aEnable )

inlineinherited

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

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 204 of file eda_item.h.

204 { m_forceVisible = aEnable; }

EDA_ITEM::m_forceVisible

bool m_forceVisible

Definition: eda_item.h:480

References EDA_ITEM::m_forceVisible.

Referenced by SCH_EDITOR_CONTROL::UpdateFind().

◆ SetKeepTextAligned()

void PCB_DIMENSION_BASE::SetKeepTextAligned ( bool aKeepAligned )

inlineinherited

Definition at line 176 of file pcb_dimension.h.

176 { m_keepTextAligned = aKeepAligned; }

PCB_DIMENSION_BASE::m_keepTextAligned

bool m_keepTextAligned

Calculate text orientation to match dimension.

Definition: pcb_dimension.h:299

References PCB_DIMENSION_BASE::m_keepTextAligned.

Referenced by DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ SetLayer()

void PCB_DIMENSION_BASE::SetLayer ( PCB_LAYER_ID aLayer )

overridevirtualinherited

Set the layer this item is on.

This method is virtual because some items (in fact: class DIMENSION) have a slightly different initialization.

Parameters

aLayer The layer number.

Reimplemented from BOARD_ITEM.

Definition at line 213 of file pcb_dimension.cpp.

 {
     m_layer = aLayer;
     m_text.SetLayer( aLayer );
 }

References BOARD_ITEM::m_layer, PCB_DIMENSION_BASE::m_text, and BOARD_ITEM::SetLayer().

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::applyDimensionSettings(), DRAWING_TOOL::DrawDimension(), PCB_DIMENSION_BASE::Flip(), ALTIUM_PCB::HelperParseDimensions6Center(), ALTIUM_PCB::HelperParseDimensions6Linear(), EAGLE_PLUGIN::loadPlain(), and DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ SetLayerSet()

virtual void BOARD_ITEM::SetLayerSet ( LSET aLayers )

inlinevirtualinherited

Reimplemented in PAD, PCB_VIA, and ZONE.

Definition at line 177 of file board_item.h.

     {
         wxFAIL_MSG( "Attempted to SetLayerSet() on a single-layer object." );
 
         // Derived classes which support multiple layers must implement this
     }

Referenced by PANEL_SETUP_LAYERS::TransferDataFromWindow().

◆ SetLineThickness()

void PCB_DIMENSION_BASE::SetLineThickness ( int aWidth )

inlineinherited

Definition at line 188 of file pcb_dimension.h.

188 { m_lineThickness = aWidth; }

PCB_DIMENSION_BASE::m_lineThickness

int m_lineThickness

Thickness used for all graphics in the dimension.

Definition: pcb_dimension.h:295

References PCB_DIMENSION_BASE::m_lineThickness.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::applyDimensionSettings(), DRAWING_TOOL::DrawDimension(), ALTIUM_PCB::HelperParseDimensions6Center(), ALTIUM_PCB::HelperParseDimensions6Linear(), EAGLE_PLUGIN::loadPlain(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), and DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ SetLocked()

virtual void BOARD_ITEM::SetLocked ( bool aLocked )

inlinevirtualinherited

Modify the 'lock' status for of the item.

Reimplemented in FOOTPRINT.

Definition at line 252 of file board_item.h.

     {
         SetState( LOCKED, aLocked );
     }

References LOCKED, and EDA_ITEM::SetState().

Referenced by BOARD_ITEM_DESC::BOARD_ITEM_DESC(), EDIT_TOOL::DragArcTrack(), ZONE_SETTINGS::ExportSetting(), EDIT_TOOL::FilletTracks(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), CADSTAR_PCB_ARCHIVE_LOADER::loadGroups(), CADSTAR_PCB_ARCHIVE_LOADER::loadNetTracks(), CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromShapes(), BOARD_EDITOR_CONTROL::modifyLockSelected(), PCB_PARSER::Parse(), ALTIUM_PCB::ParsePolygons6Data(), processTextItem(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), DIALOG_GROUP_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

◆ SetModified()

void EDA_ITEM::SetModified ( )

inherited

Definition at line 65 of file eda_item.cpp.

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

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

Referenced by SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), LEGACY_PLUGIN::loadZONE_CONTAINER(), SCH_LINE::Move(), SCH_SYMBOL::Move(), SCH_LINE::MoveEnd(), SCH_LINE::MoveStart(), LIB_PIN::MoveTo(), PCB_EDIT_FRAME::OpenProjectFiles(), ALTIUM_PCB::Parse(), SCH_ALTIUM_PLUGIN::ParseFileHeader(), LIB_SYMBOL::RemoveDrawItem(), SCH_SYMBOL::SetConvert(), SCH_SYMBOL::SetLibId(), EDA_ITEM::SetModified(), LIB_FIELD::SetName(), SCH_SYMBOL::SetTransform(), and SCH_SYMBOL::SetUnit().

◆ SetOverrideText()

void PCB_DIMENSION_BASE::SetOverrideText ( const wxString & aValue )

inlineinherited

Definition at line 134 of file pcb_dimension.h.

134 { m_valueString = aValue; }

PCB_DIMENSION_BASE::m_valueString

wxString m_valueString

Displayed value when m_overrideValue = true.

Definition: pcb_dimension.h:285

References PCB_DIMENSION_BASE::m_valueString.

Referenced by DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ SetOverrideTextEnabled()

void PCB_DIMENSION_BASE::SetOverrideTextEnabled ( bool aOverride )

inlineinherited

Definition at line 131 of file pcb_dimension.h.

131 { m_overrideTextEnabled = aOverride; }

PCB_DIMENSION_BASE::m_overrideTextEnabled

bool m_overrideTextEnabled

Manually specify the displayed measurement value.

Definition: pcb_dimension.h:284

References PCB_DIMENSION_BASE::m_overrideTextEnabled.

Referenced by DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ SetParent()

void PCB_DIMENSION_BASE::SetParent ( EDA_ITEM * aParent )

overridevirtualinherited

Reimplemented from EDA_ITEM.

Definition at line 62 of file pcb_dimension.cpp.

 {
     BOARD_ITEM::SetParent( aParent );
     m_text.SetParent( aParent );
 }

References PCB_DIMENSION_BASE::m_text, and EDA_ITEM::SetParent().

Referenced by DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES().

◆ SetParentGroup()

void BOARD_ITEM::SetParentGroup ( PCB_GROUP * aGroup )

inlineinherited

Definition at line 90 of file board_item.h.

90 { m_group = aGroup; }

BOARD_ITEM::m_group

PCB_GROUP * m_group

Definition: board_item.h:353

References BOARD_ITEM::m_group.

Referenced by PCB_GROUP::AddItem(), and PCB_GROUP::RemoveItem().

◆ SetPosition()

void PCB_DIMENSION_BASE::SetPosition ( const wxPoint & aPos )

inlineoverridevirtualinherited

Reimplemented from EDA_ITEM.

Definition at line 128 of file pcb_dimension.h.

128 { m_start = aPos; }

PCB_DIMENSION_BASE::m_start

wxPoint m_start

Definition: pcb_dimension.h:304

References PCB_DIMENSION_BASE::m_start.

◆ SetPrecision()

void PCB_DIMENSION_BASE::SetPrecision ( int aPrecision )

inlineinherited

Definition at line 170 of file pcb_dimension.h.

170 { m_precision = aPrecision; }

PCB_DIMENSION_BASE::m_precision

int m_precision

Number of digits to display after decimal.

Definition: pcb_dimension.h:291

References PCB_DIMENSION_BASE::m_precision.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::applyDimensionSettings(), ALTIUM_PCB::HelperParseDimensions6Linear(), EAGLE_PLUGIN::loadPlain(), and DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ SetPrefix()

void PCB_DIMENSION_BASE::SetPrefix ( const wxString & aPrefix )

inherited

Definition at line 133 of file pcb_dimension.cpp.

 {
     m_prefix = aPrefix;
 }

References PCB_DIMENSION_BASE::m_prefix.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::applyDimensionSettings(), CADSTAR_PCB_ARCHIVE_LOADER::loadDimensions(), and DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ SetSelected()

void EDA_ITEM::SetSelected ( )

inlineinherited

Definition at line 129 of file eda_item.h.

129 { SetFlags( SELECTED ); }

EDA_ITEM::SetFlags

void SetFlags(EDA_ITEM_FLAGS aMask)

Definition: eda_item.h:153

SELECTED

#define SELECTED

Definition: eda_item_flags.h:48

References SELECTED, and EDA_ITEM::SetFlags().

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), KIGFX::SCH_PAINTER::draw(), PL_SELECTION_TOOL::highlight(), EE_SELECTION_TOOL::highlight(), PCB_SELECTION_TOOL::highlightInternal(), DS_PROXY_UNDO_ITEM::Restore(), EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList(), and GERBVIEW_SELECTION_TOOL::selectVisually().

◆ SetStart()

virtual void PCB_DIMENSION_BASE::SetStart ( const wxPoint & aPoint )

inlinevirtualinherited

Definition at line 122 of file pcb_dimension.h.

122 { m_start = aPoint; }

PCB_DIMENSION_BASE::m_start

wxPoint m_start

Definition: pcb_dimension.h:304

References PCB_DIMENSION_BASE::m_start.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::applyDimensionSettings(), DRAWING_TOOL::DrawDimension(), ALTIUM_PCB::HelperParseDimensions6Center(), ALTIUM_PCB::HelperParseDimensions6Linear(), CADSTAR_PCB_ARCHIVE_LOADER::loadDimensions(), EAGLE_PLUGIN::loadPlain(), and PCB_POINT_EDITOR::updateItem().

◆ SetState()

void EDA_ITEM::SetState	(	EDA_ITEM_FLAGS	type,
		bool	state
	)

inlineinherited

Definition at line 142 of file eda_item.h.

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

References EDA_ITEM::m_status.

Referenced by LEGACY_PLUGIN::loadTrackList(), TRACKS_CLEANER::mergeCollinearSegments(), and BOARD_ITEM::SetLocked().

◆ SetStatus()

void EDA_ITEM::SetStatus ( EDA_ITEM_FLAGS aStatus )

inlineinherited

Definition at line 151 of file eda_item.h.

151 { m_status = aStatus; }

EDA_ITEM::m_status

EDA_ITEM_FLAGS m_status

Definition: eda_item.h:478

References EDA_ITEM::m_status.

Referenced by BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ SetSuffix()

void PCB_DIMENSION_BASE::SetSuffix ( const wxString & aSuffix )

inherited

Definition at line 139 of file pcb_dimension.cpp.

 {
     m_suffix = aSuffix;
 }

References PCB_DIMENSION_BASE::m_suffix.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::applyDimensionSettings(), CADSTAR_PCB_ARCHIVE_LOADER::loadDimensions(), and DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ SetSuppressZeroes()

void PCB_DIMENSION_BASE::SetSuppressZeroes ( bool aSuppress )

inlineinherited

Definition at line 173 of file pcb_dimension.h.

173 { m_suppressZeroes = aSuppress; }

PCB_DIMENSION_BASE::m_suppressZeroes

bool m_suppressZeroes

Suppress trailing zeroes.

Definition: pcb_dimension.h:292

References PCB_DIMENSION_BASE::m_suppressZeroes.

Referenced by DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ SetText()

void PCB_DIMENSION_BASE::SetText ( const wxString & aNewText )

inherited

Set the override text - has no effect if m_overrideValue == false.

Parameters

aNewText is the text to use as the value.

Definition at line 200 of file pcb_dimension.cpp.

 {
     m_valueString = aNewText;
     updateText();
 }

References PCB_DIMENSION_BASE::m_valueString, and PCB_DIMENSION_BASE::updateText().

Referenced by DRAWING_TOOL::DrawDimension(), and CADSTAR_PCB_ARCHIVE_LOADER::loadDimensions().

◆ SetTextFrame()

void PCB_DIM_LEADER::SetTextFrame ( DIM_TEXT_FRAME aFrame )

inline

Definition at line 507 of file pcb_dimension.h.

507 { m_textFrame = aFrame; }

PCB_DIM_LEADER::m_textFrame

DIM_TEXT_FRAME m_textFrame

Definition: pcb_dimension.h:516

References m_textFrame.

Referenced by DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ SetTextPositionMode()

void PCB_DIMENSION_BASE::SetTextPositionMode ( DIM_TEXT_POSITION aMode )

inlineinherited

Definition at line 178 of file pcb_dimension.h.

178 { m_textPosition = aMode; }

PCB_DIMENSION_BASE::m_textPosition

DIM_TEXT_POSITION m_textPosition

How to position the text.

Definition: pcb_dimension.h:298

References PCB_DIMENSION_BASE::m_textPosition.

Referenced by DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), and PCB_POINT_EDITOR::updateItem().

◆ SetTextSize()

void PCB_DIMENSION_BASE::SetTextSize ( const wxSize & aTextSize )

inlineinherited

Definition at line 192 of file pcb_dimension.h.

     {
         m_text.SetTextSize( aTextSize );
     }

References PCB_DIMENSION_BASE::m_text, and EDA_TEXT::SetTextSize().

◆ SetUnits()

void PCB_DIMENSION_BASE::SetUnits ( EDA_UNITS aUnits )

inherited

Definition at line 145 of file pcb_dimension.cpp.

 {
     m_units = aUnits;
 }

References PCB_DIMENSION_BASE::m_units.

Referenced by ALTIUM_PCB::HelperParseDimensions6Linear(), EAGLE_PLUGIN::loadPlain(), PCB_CONTROL::placeBoardItems(), PCB_BASE_EDIT_FRAME::unitsChangeRefresh(), and DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ SetUnitsFormat()

void PCB_DIMENSION_BASE::SetUnitsFormat ( const DIM_UNITS_FORMAT aFormat )

inlineinherited

Definition at line 167 of file pcb_dimension.h.

167 { m_unitsFormat = aFormat; }

PCB_DIMENSION_BASE::m_unitsFormat

DIM_UNITS_FORMAT m_unitsFormat

How to render the units suffix.

Definition: pcb_dimension.h:290

References PCB_DIMENSION_BASE::m_unitsFormat.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::applyDimensionSettings(), CADSTAR_PCB_ARCHIVE_LOADER::loadDimensions(), and DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ SetUnitsMode()

void PCB_DIMENSION_BASE::SetUnitsMode ( DIM_UNITS_MODE aMode )

inherited

Definition at line 175 of file pcb_dimension.cpp.

 {
     m_autoUnits = false;
 
     switch( aMode )
     {
     case DIM_UNITS_MODE::INCHES:
         m_units = EDA_UNITS::INCHES;
         break;
 
     case DIM_UNITS_MODE::MILS:
         m_units = EDA_UNITS::MILS;
         break;
 
     case DIM_UNITS_MODE::MILLIMETRES:
         m_units = EDA_UNITS::MILLIMETRES;
         break;
 
     case DIM_UNITS_MODE::AUTOMATIC:
         m_autoUnits = true;
         break;
     }
 }

References AUTOMATIC, INCHES, PCB_DIMENSION_BASE::m_autoUnits, PCB_DIMENSION_BASE::m_units, MILLIMETRES, and MILS.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::applyDimensionSettings(), and DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ SetWireImage()

void EDA_ITEM::SetWireImage ( )

inlineinherited

Definition at line 128 of file eda_item.h.

128 { SetFlags( IS_WIRE_IMAGE ); }

EDA_ITEM::SetFlags

void SetFlags(EDA_ITEM_FLAGS aMask)

Definition: eda_item.h:153

IS_WIRE_IMAGE

#define IS_WIRE_IMAGE

Item to be drawn as wireframe while editing.

Definition: eda_item_flags.h:45

References IS_WIRE_IMAGE, and EDA_ITEM::SetFlags().

◆ SetX()

void BOARD_ITEM::SetX ( int aX )

inlineinherited

Definition at line 117 of file board_item.h.

     {
         wxPoint p( aX, GetY() );
         SetPosition( p );
     }

References BOARD_ITEM::GetY(), and EDA_ITEM::SetPosition().

Referenced by BOARD_ITEM_DESC::BOARD_ITEM_DESC(), and TRACK_VIA_DESC::TRACK_VIA_DESC().

◆ SetY()

void BOARD_ITEM::SetY ( int aY )

inlineinherited

Definition at line 123 of file board_item.h.

     {
         wxPoint p( GetX(), aY );
         SetPosition( p );
     }

References BOARD_ITEM::GetX(), and EDA_ITEM::SetPosition().

Referenced by BOARD_ITEM_DESC::BOARD_ITEM_DESC(), and TRACK_VIA_DESC::TRACK_VIA_DESC().

◆ ShowShape()

wxString BOARD_ITEM::ShowShape ( SHAPE_T aShape )

staticinherited

Convert the enum #PCB_SHAPE_TYPE_T integer value to a wxString.

Definition at line 36 of file board_item.cpp.

 {
     switch( aShape )
     {
     case SHAPE_T::SEGMENT: return _( "Line" );
     case SHAPE_T::RECT:    return _( "Rect" );
     case SHAPE_T::ARC:     return _( "Arc" );
     case SHAPE_T::CIRCLE:  return _( "Circle" );
     case SHAPE_T::BEZIER:  return _( "Bezier Curve" );
     case SHAPE_T::POLY:    return _( "Polygon" );
     default:               return wxT( "??" );
     }
 }

References _, ARC, BEZIER, CIRCLE, POLY, RECT, and SEGMENT.

Referenced by ConvertOutlineToPolygon(), PCB_SHAPE::GetLength(), FP_SHAPE::GetSelectMenuText(), PCB_SHAPE::GetSelectMenuText(), and DIALOG_GRAPHIC_ITEM_PROPERTIES::Validate().

◆ Sort()

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

inlinestaticinherited

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 421 of file eda_item.h.

421 { return *aLeft < *aRight; }

◆ SwapData()

void PCB_DIM_LEADER::SwapData ( BOARD_ITEM * aImage )

overridevirtual

Swap data between aItem and aImage.

aItem and aImage should have the same type.

Used in undo and redo commands to swap values between an item and its copy. Only values like layer, size .. which are modified by editing are swapped.

Parameters

aImage the item image which contains data to swap.

Reimplemented from BOARD_ITEM.

Definition at line 935 of file pcb_dimension.cpp.

 {
     assert( aImage->Type() == PCB_DIM_LEADER_T );
 
     std::swap( *static_cast<PCB_DIM_LEADER*>( this ), *static_cast<PCB_DIM_LEADER*>( aImage ) );
 }

References PCB_DIM_LEADER_T, and EDA_ITEM::Type().

◆ Text() [1/2]

PCB_TEXT& PCB_DIMENSION_BASE::Text ( )

inlineinherited

Definition at line 211 of file pcb_dimension.h.

211 { return m_text; }

PCB_DIMENSION_BASE::m_text

PCB_TEXT m_text

The actual text object.

Definition: pcb_dimension.h:302

References PCB_DIMENSION_BASE::m_text.

Referenced by BOARD_ADAPTER::addShapeWithClearance(), CADSTAR_PCB_ARCHIVE_LOADER::applyDimensionSettings(), PCB_GRID_HELPER::computeAnchors(), KIGFX::PCB_PAINTER::draw(), DRAWING_TOOL::DrawDimension(), PCB_IO::format(), PCB_DIMENSION_BASE::GetEffectiveShape(), ALTIUM_PCB::HelperParseDimensions6Linear(), CADSTAR_PCB_ARCHIVE_LOADER::loadDimensions(), EAGLE_PLUGIN::loadPlain(), PCB_POINT_EDITOR::makePoints(), BRDITEMS_PLOTTER::PlotDimension(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), PCB_POINT_EDITOR::updateItem(), PCB_POINT_EDITOR::updatePoints(), and DIALOG_DIMENSION_PROPERTIES::updatePreviewText().

◆ Text() [2/2]

const PCB_TEXT& PCB_DIMENSION_BASE::Text ( ) const

inlineinherited

Definition at line 212 of file pcb_dimension.h.

212 { return m_text; }

PCB_DIMENSION_BASE::m_text

PCB_TEXT m_text

The actual text object.

Definition: pcb_dimension.h:302

References PCB_DIMENSION_BASE::m_text.

◆ TransformShapeWithClearanceToPolygon()

void PCB_DIMENSION_BASE::TransformShapeWithClearanceToPolygon	(	SHAPE_POLY_SET &	aCornerBuffer,
		PCB_LAYER_ID	aLayer,
		int	aClearanceValue,
		int	aError,
		ERROR_LOC	aErrorLoc,
		bool	ignoreLineWidth
	)		const

overridevirtualinherited

Convert the item shape to a closed polygon.

Used in filling zones calculations. Circles and arcs are approximated by segments.

Parameters

aCornerBuffer	a buffer to store the polygon.
aClearanceValue	the clearance around the pad.
aError	the maximum deviation from true circle.
aErrorLoc	should the approximation error be placed outside or inside the polygon?
ignoreLineWidth	used for edge cut items where the line width is only for visualization.

Reimplemented from BOARD_ITEM.

Definition at line 723 of file board_items_to_polygon_shape_transform.cpp.

 {
     wxASSERT_MSG( !aIgnoreLineWidth, "IgnoreLineWidth has no meaning for dimensions." );
 
     for( const std::shared_ptr<SHAPE>& shape : m_shapes )
     {
         const SHAPE_CIRCLE*  circle = dynamic_cast<const SHAPE_CIRCLE*>( shape.get() );
         const SHAPE_SEGMENT* seg    = dynamic_cast<const SHAPE_SEGMENT*>( shape.get() );
 
         if( circle )
         {
             TransformCircleToPolygon( aCornerBuffer, (wxPoint) circle->GetCenter(),
                                       circle->GetRadius() + m_lineThickness / 2 + aClearance,
                                       aError, aErrorLoc );
         }
         else if( seg )
         {
             TransformOvalToPolygon( aCornerBuffer, (wxPoint) seg->GetSeg().A,
                                     (wxPoint) seg->GetSeg().B, m_lineThickness + 2 * aClearance,
                                     aError, aErrorLoc );
         }
         else
         {
             wxFAIL_MSG( "PCB_DIMENSION_BASE::TransformShapeWithClearanceToPolygon unexpected "
                         "shape type." );
         }
     }
 }

References SHAPE_CIRCLE::GetCenter(), SHAPE_CIRCLE::GetRadius(), PCB_DIMENSION_BASE::m_lineThickness, PCB_DIMENSION_BASE::m_shapes, TransformCircleToPolygon(), and TransformOvalToPolygon().

◆ Type()

KICAD_T EDA_ITEM::Type ( ) const

inlineinherited

Returns the type of object.

This attribute should never be changed after a ctor sets it, so there is no public "setter" method.

Returns: the type of object.

Definition at line 113 of file eda_item.h.

113 { return m_structType; }

EDA_ITEM::m_structType

KICAD_T m_structType

Run time identification, keep private so it can never be changed after a ctor sets it.

Definition: eda_item.h:488

References EDA_ITEM::m_structType.

◆ Update()

void PCB_DIMENSION_BASE::Update ( )

inlineinherited

Update the dimension's cached text and geometry.

Definition at line 146 of file pcb_dimension.h.

     {
         updateGeometry();
         updateText();
     }

References PCB_DIMENSION_BASE::updateGeometry(), and PCB_DIMENSION_BASE::updateText().

Referenced by DRAWING_TOOL::constrainDimension(), DRAWING_TOOL::DrawDimension(), PCB_DIMENSION_BASE::Mirror(), PCB_DIMENSION_BASE::Move(), PCB_DIMENSION_BASE::Rotate(), PCB_DIM_ALIGNED::SwapData(), PCB_DIM_ORTHOGONAL::SwapData(), PCB_BASE_EDIT_FRAME::unitsChangeRefresh(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), PCB_DIM_ALIGNED::UpdateHeight(), and PCB_POINT_EDITOR::updateItem().

◆ updateGeometry()

void PCB_DIM_LEADER::updateGeometry ( )

overrideprotectedvirtual

Update the cached geometry of the dimension after changing any of its properties.

Implements PCB_DIMENSION_BASE.

Definition at line 949 of file pcb_dimension.cpp.

 {
     m_shapes.clear();
 
     updateText();
 
     // Now that we have the text updated, we can determine how to draw the second line
     // First we need to create an appropriate bounding polygon to collide with
     EDA_RECT textBox = m_text.GetTextBox().Inflate( m_text.GetTextWidth() / 2,
                                                     m_text.GetEffectiveTextPenWidth() );
 
     SHAPE_POLY_SET polyBox;
     polyBox.NewOutline();
     polyBox.Append( textBox.GetOrigin() );
     polyBox.Append( textBox.GetOrigin().x, textBox.GetEnd().y );
     polyBox.Append( textBox.GetEnd() );
     polyBox.Append( textBox.GetEnd().x, textBox.GetOrigin().y );
     polyBox.Rotate( -m_text.GetTextAngleRadians(), textBox.GetCenter() );
 
     VECTOR2I firstLine( m_end - m_start );
     VECTOR2I start( m_start );
     start += firstLine.Resize( m_extensionOffset );
 
     SEG arrowSeg( m_start, m_end );
     SEG textSeg( m_end, m_text.GetPosition() );
     OPT_VECTOR2I arrowSegEnd = boost::make_optional( false, VECTOR2I() );;
     OPT_VECTOR2I textSegEnd = boost::make_optional( false, VECTOR2I() );
 
     if( m_textFrame == DIM_TEXT_FRAME::CIRCLE )
     {
         double penWidth = m_text.GetEffectiveTextPenWidth() / 2.0;
         double radius = ( textBox.GetWidth() / 2.0 ) - penWidth;
         CIRCLE circle( textBox.GetCenter(), radius );
 
         arrowSegEnd = segCircleIntersection( circle, arrowSeg );
         textSegEnd = segCircleIntersection( circle, textSeg );
     }
     else
     {
         arrowSegEnd = segPolyIntersection( polyBox, arrowSeg );
         textSegEnd = segPolyIntersection( polyBox, textSeg );
     }
 
     if( !arrowSegEnd )
         arrowSegEnd = m_end;
 
     m_shapes.emplace_back( new SHAPE_SEGMENT( start, *arrowSegEnd ) );
 
     // Add arrows
     VECTOR2I arrowEnd( m_arrowLength, 0 );
 
     double arrowRotPos = firstLine.Angle() + DEG2RAD( s_arrowAngle );
     double arrowRotNeg = firstLine.Angle() - DEG2RAD( s_arrowAngle );
 
     m_shapes.emplace_back( new SHAPE_SEGMENT( start,
                                               start + wxPoint( arrowEnd.Rotate( arrowRotPos ) ) ) );
     m_shapes.emplace_back( new SHAPE_SEGMENT( start,
                                               start + wxPoint( arrowEnd.Rotate( arrowRotNeg ) ) ) );
 
 
     if( !GetText().IsEmpty() )
     {
         switch( m_textFrame )
         {
         case DIM_TEXT_FRAME::RECTANGLE:
         {
             for( SHAPE_POLY_SET::SEGMENT_ITERATOR seg = polyBox.IterateSegments(); seg; seg++ )
                 m_shapes.emplace_back( new SHAPE_SEGMENT( *seg ) );
 
             break;
         }
 
         case DIM_TEXT_FRAME::CIRCLE:
         {
             double penWidth = m_text.GetEffectiveTextPenWidth() / 2.0;
             double radius   = ( textBox.GetWidth() / 2.0 ) - penWidth;
             m_shapes.emplace_back( new SHAPE_CIRCLE( textBox.GetCenter(), radius ) );
 
             break;
         }
 
         default:
             break;
         }
     }
 
     if( textSegEnd && *arrowSegEnd == m_end )
         m_shapes.emplace_back( new SHAPE_SEGMENT( m_end, *textSegEnd ) );
 }

◆ updateText()

void PCB_DIMENSION_BASE::updateText ( )

protectedvirtualinherited

Update the text field value from the current geometry (called by updateGeometry normally).

Reimplemented in PCB_DIM_ORTHOGONAL, and PCB_DIM_ALIGNED.

Definition at line 69 of file pcb_dimension.cpp.

 {
     wxString text = m_overrideTextEnabled ? m_valueString : GetValueText();
 
     switch( m_unitsFormat )
     {
     case DIM_UNITS_FORMAT::NO_SUFFIX: // no units
         break;
 
     case DIM_UNITS_FORMAT::BARE_SUFFIX: // normal
         text += " ";
         text += GetAbbreviatedUnitsLabel( m_units );
         break;
 
     case DIM_UNITS_FORMAT::PAREN_SUFFIX: // parenthetical
         text += " (";
         text += GetAbbreviatedUnitsLabel( m_units );
         text += ")";
         break;
     }
 
     text.Prepend( m_prefix );
     text.Append( m_suffix );
 
     m_text.SetText( text );
 }

References BARE_SUFFIX, GetAbbreviatedUnitsLabel(), PCB_DIMENSION_BASE::GetValueText(), PCB_DIMENSION_BASE::m_overrideTextEnabled, PCB_DIMENSION_BASE::m_prefix, PCB_DIMENSION_BASE::m_suffix, PCB_DIMENSION_BASE::m_text, PCB_DIMENSION_BASE::m_units, PCB_DIMENSION_BASE::m_unitsFormat, PCB_DIMENSION_BASE::m_valueString, NO_SUFFIX, PAREN_SUFFIX, EDA_TEXT::SetText(), and text.

Referenced by PCB_DIMENSION_BASE::SetText(), PCB_DIMENSION_BASE::Update(), updateGeometry(), PCB_DIM_ALIGNED::updateText(), and PCB_DIM_ORTHOGONAL::updateText().

◆ ViewBBox()

const BOX2I PCB_DIMENSION_BASE::ViewBBox ( ) const

overridevirtualinherited

Return the bounding box of the item covering all its layers.

Returns: the current bounding box.

Reimplemented from EDA_ITEM.

Reimplemented in PCB_DIM_CENTER.

Definition at line 445 of file pcb_dimension.cpp.

 {
     BOX2I dimBBox = BOX2I( VECTOR2I( GetBoundingBox().GetPosition() ),
                            VECTOR2I( GetBoundingBox().GetSize() ) );
     dimBBox.Merge( m_text.ViewBBox() );
 
     return dimBBox;
 }

References PCB_DIMENSION_BASE::GetBoundingBox(), PCB_DIMENSION_BASE::GetPosition(), PCB_DIMENSION_BASE::m_text, BOX2< Vec >::Merge(), and EDA_ITEM::ViewBBox().

◆ ViewDraw()

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

inlinevirtualinherited

Draw the parts of the object belonging to layer aLayer.

An alternative way for drawing objects 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	is the current drawing layer.
aView	is a pointer to the VIEW device we are drawing on.

Reimplemented in EDIT_POINTS, DS_PROXY_VIEW_ITEM, ROUTER_PREVIEW_ITEM, KIGFX::VIEW_GROUP, KIGFX::PREVIEW::SELECTION_AREA, MY_DRAWING, KIGFX::VIEW_OVERLAY, KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM, KIGFX::PREVIEW::TWO_POINT_ASSISTANT, KIGFX::ORIGIN_VIEWITEM, KIGFX::PREVIEW::ARC_ASSISTANT, KIGFX::PREVIEW::RULER_ITEM, and RATSNEST_VIEW_ITEM.

Definition at line 111 of file view_item.h.

112 {}

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

◆ ViewGetLayers()

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

overridevirtualinherited

Return the all the layers within the VIEW the object is painted on.

For instance, a 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[]	is the output layer index array.
aCount	is the number of layer indices in aLayers[].

Reimplemented from EDA_ITEM.

Reimplemented in PAD, FOOTPRINT, PCB_VIA, FP_TEXT, PCB_TRACK, ZONE, PCB_GROUP, and PCB_MARKER.

Definition at line 119 of file board_item.cpp.

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

References BOARD_ITEM::m_layer.

◆ ViewGetLOD()

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

inlinevirtualinherited

Return 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	is the current drawing layer.
aView	is a 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 FP_ZONE, PAD, FOOTPRINT, PCB_VIA, GERBER_DRAW_ITEM, FP_TEXT, PCB_TRACK, ZONE, PCB_GROUP, and FP_SHAPE.

Definition at line 137 of file view_item.h.

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

Referenced by PNS_KICAD_IFACE::IsItemVisible(), KIGFX::VIEW::DRAW_ITEM_VISITOR::operator()(), EE_GRID_HELPER::queryVisible(), PCB_GRID_HELPER::queryVisible(), and PCB_SELECTION_TOOL::Selectable().

◆ viewPrivData()

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

inlineinherited

Definition at line 143 of file view_item.h.

     {
         return m_viewPrivData;
     }

References KIGFX::VIEW_ITEM::m_viewPrivData.

Referenced by KIGFX::VIEW::Add(), KIGFX::VIEW::DRAW_ITEM_VISITOR::deferredDraw(), KIGFX::VIEW::draw(), KIGFX::VIEW::Hide(), KIGFX::VIEW::invalidateItem(), KIGFX::VIEW::IsVisible(), KIGFX::VIEW::OnDestroy(), KIGFX::QUERY_VISITOR< CONTAINER >::operator()(), KIGFX::VIEW::UPDATE_COLOR_VISITOR::operator()(), KIGFX::VIEW::UPDATE_DEPTH_VISITOR::operator()(), KIGFX::VIEW::DRAW_ITEM_VISITOR::operator()(), KIGFX::VIEW::RECACHE_ITEM_VISITOR::operator()(), KIGFX::VIEW::CLEAR_LAYER_CACHE_VISITOR::operator()(), KIGFX::VIEW::Remove(), KIGFX::VIEW::SetVisible(), KIGFX::VIEW::Update(), KIGFX::VIEW::updateItemColor(), KIGFX::VIEW::updateItemGeometry(), and KIGFX::VIEW::updateLayers().

◆ Visit()

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

virtualinherited

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, SCH_SYMBOL, FOOTPRINT, LIB_SYMBOL, SCH_SHEET, SCH_GLOBALLABEL, GERBER_FILE_IMAGE, GERBER_DRAW_ITEM, PCB_TRACK, PCB_GROUP, and GBR_LAYOUT.

Definition at line 93 of file eda_item.cpp.

 {
 #if 0 && defined(DEBUG)
     std::cout << GetClass().mb_str() << ' ';
 #endif
 
     if( IsType( scanTypes ) )
     {
         if( SEARCH_RESULT::QUIT == inspector( this, testData ) )
             return SEARCH_RESULT::QUIT;
     }
 
     return SEARCH_RESULT::CONTINUE;
 }

References CONTINUE, EDA_ITEM::GetClass(), EDA_ITEM::IsType(), and QUIT.

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

Member Data Documentation

◆ m_arrowLength

int PCB_DIMENSION_BASE::m_arrowLength

protectedinherited

Length of arrow shapes.

Definition at line 296 of file pcb_dimension.h.

Referenced by PCB_DIMENSION_BASE::GetArrowLength(), PCB_DIM_ALIGNED::PCB_DIM_ALIGNED(), PCB_DIM_ORTHOGONAL::PCB_DIM_ORTHOGONAL(), PCB_DIMENSION_BASE::SetArrowLength(), PCB_DIM_ALIGNED::updateGeometry(), PCB_DIM_ORTHOGONAL::updateGeometry(), and updateGeometry().

◆ m_autoUnits

bool PCB_DIMENSION_BASE::m_autoUnits

protectedinherited

If true, follow the currently selected UI units.

Definition at line 289 of file pcb_dimension.h.

Referenced by PCB_DIMENSION_BASE::GetUnitsMode(), PCB_DIMENSION_BASE::SetAutoUnits(), and PCB_DIMENSION_BASE::SetUnitsMode().

◆ m_end

wxPoint PCB_DIMENSION_BASE::m_end

protectedinherited

Internal cache of drawn shapes.

Definition at line 305 of file pcb_dimension.h.

Referenced by PCB_DIM_ALIGNED::GetAngle(), PCB_DIM_CENTER::GetBoundingBox(), PCB_DIMENSION_BASE::GetEnd(), PCB_DIMENSION_BASE::Mirror(), PCB_DIMENSION_BASE::Move(), PCB_DIMENSION_BASE::Rotate(), PCB_DIMENSION_BASE::SetEnd(), PCB_DIM_ALIGNED::updateGeometry(), PCB_DIM_ORTHOGONAL::updateGeometry(), updateGeometry(), and PCB_DIM_CENTER::updateGeometry().

◆ m_extensionOffset

int PCB_DIMENSION_BASE::m_extensionOffset

protectedinherited

Distance from feature points to extension line start.

Definition at line 297 of file pcb_dimension.h.

Referenced by PCB_DIMENSION_BASE::GetExtensionOffset(), PCB_DIMENSION_BASE::SetExtensionOffset(), PCB_DIM_ALIGNED::updateGeometry(), PCB_DIM_ORTHOGONAL::updateGeometry(), and updateGeometry().

◆ m_flags

EDA_ITEM_FLAGS EDA_ITEM::m_flags

protectedinherited

Definition at line 481 of file eda_item.h.

Referenced by EDA_ITEM::ClearFlags(), LIB_TEXT::Clone(), DS_DRAW_ITEM_BASE::DS_DRAW_ITEM_BASE(), EDA_ITEM::GetEditFlags(), EDA_ITEM::GetFlags(), PCB_TRACK::GetMsgPanelInfoBase_Common(), SCH_LINE::GetSelectedPoints(), EDA_ITEM::HasFlag(), LIB_CIRCLE::HitTest(), LIB_RECTANGLE::HitTest(), LIB_ARC::HitTest(), LIB_TEXT::HitTest(), LIB_BEZIER::HitTest(), LIB_POLYLINE::HitTest(), SCH_JUNCTION::HitTest(), LIB_ITEM::HitTest(), LIB_PIN::HitTest(), SCH_LINE::HitTest(), SCH_SYMBOL::HitTest(), ZONE::InitDataFromSrcInCopyCtor(), EDA_ITEM::IsBrightened(), SCH_ITEM::IsConnected(), EDA_ITEM::IsDragging(), EDA_ITEM::IsEntered(), EDA_ITEM::IsModified(), EDA_ITEM::IsMoving(), EDA_ITEM::IsNew(), EDA_ITEM::IsResized(), EDA_ITEM::IsSelected(), EDA_ITEM::IsWireImage(), EDA_ITEM::operator=(), PCB_SHAPE::PCB_SHAPE(), EDA_ITEM::SetFlags(), and PCB_SHAPE::SwapData().

◆ m_forceVisible

bool EDA_ITEM::m_forceVisible

protectedinherited

Definition at line 480 of file eda_item.h.

Referenced by ZONE::InitDataFromSrcInCopyCtor(), EDA_ITEM::IsForceVisible(), EDA_ITEM::operator=(), EDA_ITEM::SetForceVisible(), and PCB_SHAPE::SwapData().

◆ m_group

PCB_GROUP* BOARD_ITEM::m_group

protectedinherited

Definition at line 353 of file board_item.h.

Referenced by BOARD_ITEM::GetParentGroup(), and BOARD_ITEM::SetParentGroup().

◆ m_keepTextAligned

bool PCB_DIMENSION_BASE::m_keepTextAligned

protectedinherited

Calculate text orientation to match dimension.

Definition at line 299 of file pcb_dimension.h.

Referenced by PCB_DIMENSION_BASE::GetKeepTextAligned(), PCB_DIM_LEADER(), PCB_DIMENSION_BASE::SetKeepTextAligned(), PCB_DIM_ALIGNED::updateText(), and PCB_DIM_ORTHOGONAL::updateText().

◆ m_layer

PCB_LAYER_ID BOARD_ITEM::m_layer

protectedinherited

◆ m_lineThickness

int PCB_DIMENSION_BASE::m_lineThickness

protectedinherited

Thickness used for all graphics in the dimension.

Definition at line 295 of file pcb_dimension.h.

Referenced by PCB_DIMENSION_BASE::GetBoundingBox(), PCB_DIM_CENTER::GetBoundingBox(), PCB_DIMENSION_BASE::GetLineThickness(), PCB_DIMENSION_BASE::HitTest(), PCB_DIMENSION_BASE::SetLineThickness(), and PCB_DIMENSION_BASE::TransformShapeWithClearanceToPolygon().

◆ m_measuredValue

int PCB_DIMENSION_BASE::m_measuredValue

protectedinherited

value of PCB dimensions

Definition at line 303 of file pcb_dimension.h.

Referenced by PCB_DIMENSION_BASE::GetMeasuredValue(), PCB_DIM_ALIGNED::updateGeometry(), and PCB_DIM_ORTHOGONAL::updateGeometry().

◆ m_overrideTextEnabled

bool PCB_DIMENSION_BASE::m_overrideTextEnabled

protectedinherited

Manually specify the displayed measurement value.

Definition at line 284 of file pcb_dimension.h.

Referenced by PCB_DIMENSION_BASE::GetOverrideTextEnabled(), PCB_DIM_CENTER::PCB_DIM_CENTER(), PCB_DIM_LEADER(), PCB_DIMENSION_BASE::SetOverrideTextEnabled(), and PCB_DIMENSION_BASE::updateText().

◆ m_parent

EDA_ITEM* EDA_ITEM::m_parent

protectedinherited

Linked list: Link (parent struct)

Definition at line 479 of file eda_item.h.

Referenced by LIB_FIELD::Copy(), SCH_FIELD::DoHypertextMenu(), FP_TEXT::FP_TEXT(), SCH_FIELD::GetBoundingBox(), SCH_FIELD::GetCanonicalName(), SCH_TEXT::GetContextualTextVars(), FP_TEXT::GetDrawRotation(), SCH_FIELD::GetMenuImage(), FP_SHAPE::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PAD::GetMsgPanelInfo(), SCH_FIELD::GetName(), PAD::GetParent(), EDA_ITEM::GetParent(), SCH_SHEET_PIN::GetParent(), LIB_ITEM::GetParent(), BOARD_ITEM::GetParent(), FP_TEXT::GetParentAsString(), PAD::GetParentAsString(), FP_SHAPE::GetParentAsString(), PCB_SHAPE::GetParentFootprint(), SCH_FIELD::GetParentPosition(), SCH_FIELD::GetPosition(), SCH_FIELD::GetShownText(), SCH_TEXT::GetShownText(), LIB_FIELD::HitTest(), SCH_FIELD::IsHypertext(), SCH_FIELD::IsReplaceable(), LIB_ITEM::LIB_ITEM(), PCB_SHAPE::MakeEffectiveShapes(), SCH_FIELD::Matches(), LIB_FIELD::operator=(), EDA_ITEM::operator=(), PAD::PAD(), SCH_FIELD::Plot(), SCH_FIELD::Print(), SCH_FIELD::Replace(), SCH_SYMBOL::SCH_SYMBOL(), FP_SHAPE::SetDrawCoord(), FP_TEXT::SetDrawCoord(), PAD::SetDrawCoord(), SCH_FIELD::SetId(), FP_SHAPE::SetLocalCoord(), FP_TEXT::SetLocalCoord(), PAD::SetLocalCoord(), EDA_ITEM::SetModified(), EDA_ITEM::SetParent(), SCH_FIELD::SetPosition(), PCB_SHAPE::SwapData(), and FP_TEXT::TransformShapeWithClearanceToPolygon().

◆ m_precision

int PCB_DIMENSION_BASE::m_precision

protectedinherited

Number of digits to display after decimal.

Definition at line 291 of file pcb_dimension.h.

Referenced by PCB_DIMENSION_BASE::GetPrecision(), PCB_DIMENSION_BASE::GetValueText(), and PCB_DIMENSION_BASE::SetPrecision().

◆ m_prefix

wxString PCB_DIMENSION_BASE::m_prefix

protectedinherited

String prepended to the value.

Definition at line 286 of file pcb_dimension.h.

Referenced by PCB_DIMENSION_BASE::GetPrefix(), PCB_DIMENSION_BASE::SetPrefix(), and PCB_DIMENSION_BASE::updateText().

◆ m_shapes

std::vector<std::shared_ptr<SHAPE> > PCB_DIMENSION_BASE::m_shapes

protectedinherited

Definition at line 308 of file pcb_dimension.h.

Referenced by PCB_DIMENSION_BASE::addShape(), PCB_DIMENSION_BASE::GetShapes(), PCB_DIM_ALIGNED::SwapData(), PCB_DIM_ORTHOGONAL::SwapData(), PCB_DIMENSION_BASE::TransformShapeWithClearanceToPolygon(), PCB_DIM_ALIGNED::updateGeometry(), PCB_DIM_ORTHOGONAL::updateGeometry(), updateGeometry(), and PCB_DIM_CENTER::updateGeometry().

◆ m_start

wxPoint PCB_DIMENSION_BASE::m_start

protectedinherited

Definition at line 304 of file pcb_dimension.h.

Referenced by PCB_DIM_ALIGNED::GetAngle(), PCB_DIM_CENTER::GetBoundingBox(), PCB_DIMENSION_BASE::GetPosition(), PCB_DIMENSION_BASE::GetStart(), PCB_DIMENSION_BASE::Mirror(), PCB_DIMENSION_BASE::Move(), PCB_DIMENSION_BASE::Rotate(), PCB_DIMENSION_BASE::SetPosition(), PCB_DIMENSION_BASE::SetStart(), PCB_DIM_ALIGNED::updateGeometry(), PCB_DIM_ORTHOGONAL::updateGeometry(), updateGeometry(), and PCB_DIM_CENTER::updateGeometry().

◆ m_status

EDA_ITEM_FLAGS EDA_ITEM::m_status

protectedinherited

Definition at line 478 of file eda_item.h.

Referenced by EDA_ITEM::GetState(), EDA_ITEM::GetStatus(), EDA_ITEM::operator=(), EDA_ITEM::SetState(), EDA_ITEM::SetStatus(), and PCB_SHAPE::SwapData().

◆ m_suffix

wxString PCB_DIMENSION_BASE::m_suffix

protectedinherited

String appended to the value.

Definition at line 287 of file pcb_dimension.h.

Referenced by PCB_DIMENSION_BASE::GetSuffix(), PCB_DIMENSION_BASE::SetSuffix(), and PCB_DIMENSION_BASE::updateText().

◆ m_suppressZeroes

bool PCB_DIMENSION_BASE::m_suppressZeroes

protectedinherited

Suppress trailing zeroes.

Definition at line 292 of file pcb_dimension.h.

Referenced by PCB_DIMENSION_BASE::GetSuppressZeroes(), PCB_DIMENSION_BASE::GetValueText(), and PCB_DIMENSION_BASE::SetSuppressZeroes().

◆ m_text

PCB_TEXT PCB_DIMENSION_BASE::m_text

protectedinherited

◆ m_textFrame

DIM_TEXT_FRAME PCB_DIM_LEADER::m_textFrame

private

Definition at line 516 of file pcb_dimension.h.

Referenced by GetTextFrame(), SetTextFrame(), and updateGeometry().

◆ m_textPosition

DIM_TEXT_POSITION PCB_DIMENSION_BASE::m_textPosition

protectedinherited

How to position the text.

Definition at line 298 of file pcb_dimension.h.

Referenced by PCB_DIMENSION_BASE::GetTextPositionMode(), PCB_DIMENSION_BASE::SetTextPositionMode(), PCB_DIM_ALIGNED::updateText(), and PCB_DIM_ORTHOGONAL::updateText().

◆ m_units

EDA_UNITS PCB_DIMENSION_BASE::m_units

protectedinherited

0 = inches, 1 = mm

Definition at line 288 of file pcb_dimension.h.

Referenced by PCB_DIMENSION_BASE::GetUnits(), PCB_DIMENSION_BASE::GetUnitsMode(), PCB_DIMENSION_BASE::GetValueText(), PCB_DIMENSION_BASE::SetUnits(), PCB_DIMENSION_BASE::SetUnitsMode(), and PCB_DIMENSION_BASE::updateText().

◆ m_unitsFormat

DIM_UNITS_FORMAT PCB_DIMENSION_BASE::m_unitsFormat

protectedinherited

How to render the units suffix.

Definition at line 290 of file pcb_dimension.h.

Referenced by PCB_DIMENSION_BASE::GetUnitsFormat(), PCB_DIM_CENTER::PCB_DIM_CENTER(), PCB_DIM_LEADER(), PCB_DIMENSION_BASE::SetUnitsFormat(), and PCB_DIMENSION_BASE::updateText().

◆ m_Uuid

const KIID EDA_ITEM::m_Uuid

inherited

Definition at line 475 of file eda_item.h.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::AddColumn(), SCH_SYMBOL::AddHierarchicalReference(), RC_ITEM::AddItem(), SCH_EDIT_FRAME::AnnotateSymbols(), FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), SCH_SHEET_PATH::Cmp(), SCHEMATIC::ConvertRefsToKIIDs(), MICROWAVE_TOOL::createMicrowaveInductor(), DRAWING_TOOL::DrawVia(), LIB_SYMBOL::Duplicate(), BOARD_ITEM::Duplicate(), SCH_ITEM::Duplicate(), FOOTPRINT::Duplicate(), FOOTPRINT::DuplicateItem(), PCB_EDIT_FRAME::ExchangeFootprint(), PAD_TOOL::explodePad(), BOARD_EDITOR_CONTROL::ExportNetlist(), BOARD::FillItemMap(), SCH_SHEET_LIST::FillItemMap(), PCB_BASE_FRAME::FocusOnItem(), SCH_EDIT_FRAME::FocusOnItem(), PCB_IO::format(), FormatProbeItem(), SCH_PIN::GetDefaultNetName(), BOARD::GetItem(), SCH_SHEET_LIST::GetItem(), PAD::GetMsgPanelInfo(), DIALOG_BOARD_REANNOTATE::GetNewRefDes(), FP_TEXT::GetParentAsString(), PAD::GetParentAsString(), FP_SHAPE::GetParentAsString(), SCH_REFERENCE::GetPath(), SCH_MARKER::GetUUID(), PCB_MARKER::GetUUID(), FIELDS_EDITOR_GRID_DATA_MODEL::groupMatch(), SCH_SHEET_PATH::IsContainedWithin(), LEGACY_PLUGIN::loadFOOTPRINT(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), PCB_EDIT_FRAME::LoadFootprints(), LEGACY_PLUGIN::loadPCB_TARGET(), LEGACY_PLUGIN::loadPCB_TEXT(), SCH_LEGACY_PLUGIN::loadSymbol(), LEGACY_PLUGIN::loadTrackList(), PNS::LOGGER::Log(), NETLIST_EXPORTER_XML::makeSymbols(), SCH_EDIT_FRAME::mapExistingAnnotation(), PCB_TRACK::cmp_tracks::operator()(), PCB_SHAPE::cmp_drawings::operator()(), BOARD_ITEM::ptr_cmp::operator()(), FOOTPRINT::cmp_drawings::operator()(), FOOTPRINT::cmp_pads::operator()(), SCH_ITEM::operator<(), SCH_SYMBOL::operator<(), PAD::PAD(), SCH_SEXPR_PARSER::parseSchSheetInstances(), SCH_EDITOR_CONTROL::Paste(), SCH_SHEET_PATH::PathAsString(), BOARD_REANNOTATE_TOOL::ReannotateDuplicatesInSelection(), SCH_SCREENS::ReplaceDuplicateTimeStamps(), SCH_SYMBOL::ReplaceInstanceSheetPath(), PCB_PARSER::resolveGroups(), SCH_SEXPR_PLUGIN::saveBitmap(), SCH_SEXPR_PLUGIN::saveBusEntry(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SEXPR_PLUGIN::saveLine(), SCH_SEXPR_PLUGIN::saveNoConnect(), SCH_EDIT_FRAME::SaveProject(), SCH_SEXPR_PLUGIN::saveSheet(), SCH_LEGACY_PLUGIN::saveSheet(), SCH_SEXPR_PLUGIN::saveSymbol(), SCH_LEGACY_PLUGIN::saveSymbol(), SCH_SEXPR_PLUGIN::saveText(), SCH_REFERENCE::SCH_REFERENCE(), SCH_SHEET::SCH_SHEET(), SCH_SYMBOL::SCH_SYMBOL(), RC_ITEM::SetItems(), SwapItemData(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::testAgainstEdge(), testGroupEqual(), SCH_EDITOR_CONTROL::updatePastedSheet(), SCH_EDITOR_CONTROL::updatePastedSymbol(), and NETLIST_EXPORTER_ORCADPCB2::WriteNetlist().

◆ m_valueString

wxString PCB_DIMENSION_BASE::m_valueString

protectedinherited

Displayed value when m_overrideValue = true.

Definition at line 285 of file pcb_dimension.h.

Referenced by PCB_DIMENSION_BASE::GetOverrideText(), PCB_DIMENSION_BASE::SetOverrideText(), PCB_DIMENSION_BASE::SetText(), and PCB_DIMENSION_BASE::updateText().

◆ s_arrowAngle

constexpr float PCB_DIMENSION_BASE::s_arrowAngle = 27.5

staticprotectedinherited

Definition at line 310 of file pcb_dimension.h.

Referenced by PCB_DIM_ALIGNED::PCB_DIM_ALIGNED(), PCB_DIM_ORTHOGONAL::PCB_DIM_ORTHOGONAL(), PCB_DIM_ALIGNED::updateGeometry(), PCB_DIM_ORTHOGONAL::updateGeometry(), and updateGeometry().

◆ ZeroOffset

wxPoint BOARD_ITEM::ZeroOffset

staticinherited

A value of wxPoint(0,0) which can be passed to the Draw() functions.

Definition at line 150 of file board_item.h.

Referenced by BOARD::GetPosition().

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

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PCB_DIM_LEADER()

Member Function Documentation

◆ addShape()

◆ ClassOf()

◆ ClearBrightened()

◆ ClearEditFlags()

◆ ClearFlags()

◆ ClearSelected()

◆ ClearTempFlags()

◆ ClearViewPrivData()

◆ Clone()

◆ DeleteStructure()

◆ Duplicate()

◆ Flip() [1/2]

◆ Flip() [2/2]

◆ Get() [1/3]

◆ Get() [2/3]

◆ Get() [3/3]

◆ GetArrowLength()

◆ GetBoard()

◆ GetBoundingBox()

◆ GetCenter()

◆ GetClass()

◆ GetEditFlags()

◆ GetEffectiveShape()

◆ GetEnd()

◆ GetExtensionOffset()

◆ GetFlags()

◆ GetFocusPosition()

◆ GetKeepTextAligned()

◆ GetLayer()

◆ GetLayerName()

◆ GetLayerSet()

◆ GetLineThickness()

◆ GetMeasuredValue()

◆ GetMenuImage()

◆ GetMsgPanelInfo()

◆ GetOverrideText()

◆ GetOverrideTextEnabled()

◆ GetParent()

◆ GetParentGroup()

◆ GetPosition()

◆ GetPrecision()

◆ GetPrefix()

◆ GetSelectMenuText()

◆ GetShapes()

◆ GetStart()

◆ GetState()

◆ GetStatus()

◆ GetSuffix()

◆ GetSuppressZeroes()

◆ GetText()

◆ GetTextFrame()

◆ GetTextPositionMode()

◆ GetUnits()

◆ GetUnitsFormat()

◆ GetUnitsMode()

◆ GetValueText()

◆ GetX()

◆ GetY()

◆ HasFlag()

◆ HitTest() [1/2]

◆ HitTest() [2/2]

◆ IsBrightened()

◆ IsConnected()

◆ IsDragging()

◆ IsEntered()

◆ IsForceVisible()

◆ IsLocked()