KiCad PCB EDA Suite
DIMENSION_BASE Class Referenceabstract

Abstract dimension API. More...

#include <dimension.h>

Inheritance diagram for DIMENSION_BASE:
BOARD_ITEM EDA_ITEM KIGFX::VIEW_ITEM INSPECTABLE ALIGNED_DIMENSION CENTER_DIMENSION LEADER ORTHOGONAL_DIMENSION

Public Member Functions

 DIMENSION_BASE (BOARD_ITEM *aParent, KICAD_T aType=PCB_DIMENSION_T)
 
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 ()
 Updates 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)
 Sets the override text - has no effect if m_overrideValue == false. More...
 
const wxString GetText () const
 Retrieves the value text or override text, not including prefix or suffix. More...
 
PCB_TEXTText ()
 
const PCB_TEXTText () const
 
const std::vector< std::shared_ptr< SHAPE > > & GetShapes () const
 
void Move (const wxPoint &offset) override
 Move this object. More...
 
void Rotate (const wxPoint &aRotCentre, double aAngle) override
 Rotate this object. More...
 
void Flip (const wxPoint &aCentre, bool aFlipLeftRight) override
 Flip this object, i.e. More...
 
void Mirror (const wxPoint &axis_pos, bool aMirrorLeftRight=false)
 Mirror the Dimension , relative to a given horizontal axis the text is not mirrored. More...
 
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 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< SHAPEGetEffectiveShape (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_GROUPGetParentGroup () 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_CONTAINERGetParent () 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_ITEMDuplicate () const
 Create a copy of this BOARD_ITEM. More...
 
virtual void SwapData (BOARD_ITEM *aImage)
 Swap data between aItem and aImage. 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...
 
void Move (const VECTOR2I &aMoveVector)
 
void Rotate (const VECTOR2I &aRotCentre, double aAngle)
 
void Flip (const VECTOR2I &aCentre, bool aFlipLeftRight)
 
virtual BOARDGetBoard () 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 (int type) const
 
void SetState (int type, bool state)
 
STATUS_FLAGS GetStatus () const
 
void SetStatus (STATUS_FLAGS aStatus)
 
void SetFlags (STATUS_FLAGS aMask)
 
void ClearFlags (STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
 
STATUS_FLAGS GetFlags () const
 
bool HasFlag (STATUS_FLAGS aFlag) const
 
STATUS_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 EDA_ITEMClone () const
 Create a duplicate of this item with linked list members set to NULL. 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 wxString GetClass () const =0
 Return the class name. More...
 
virtual BITMAPS GetMenuImage () const
 Return a pointer to an image to be used in menus. 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 >
Get (PROPERTY_BASE *aProperty)
 
template<typename T >
boost::optional< T > Get (const wxString &aProperty)
 

Static Public Member Functions

static wxString ShowShape (PCB_SHAPE_TYPE 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

virtual void updateGeometry ()=0
 Updates the cached geometry of the dimension after changing any of its properties. More...
 
virtual void updateText ()
 Updates 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)
 Finds 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_GROUPm_group
 
STATUS_FLAGS m_status
 
EDA_ITEMm_parent
 Linked list: Link (parent struct) More...
 
bool m_forceVisible
 
STATUS_FLAGS m_flags
 

Static Protected Attributes

static constexpr float s_arrowAngle = 27.5
 

Detailed Description

Abstract dimension API.

Some notes about dimension nomenclature:

  • "feature points" are the points being measured by the dimension. For an example, the start and end points of a line to be measured. These are the first points picked when drawing a new dimension. Dimensions can have one or more feature points: linear dimensions (the only type supported in KiCad 5 and earlier) have two feature points; leader dimensions have one; and ordinate dimensions can have in theory an unlimited number of feature points.
  • "feature lines" are lines that coincide with feature points. Not all dimension types have feature lines. The actual start and end of feature lines is calculated from dimension style properties (offset from feature point to start of feature line, height of crossbar, and height of feature line past crossbar, for example in linear dimensions)
  • "crossbar" refers to the perpendicular line (usually with arrows at each end) between feature lines on linear dimensions

Definition at line 95 of file dimension.h.

Constructor & Destructor Documentation

◆ DIMENSION_BASE()

DIMENSION_BASE::DIMENSION_BASE ( BOARD_ITEM aParent,
KICAD_T  aType = PCB_DIMENSION_T 
)

Definition at line 41 of file dimension.cpp.

41  :
42  BOARD_ITEM( aParent, aType ),
43  m_overrideTextEnabled( false ),
45  m_autoUnits( false ),
47  m_precision( 4 ),
48  m_suppressZeroes( false ),
50  m_arrowLength( Mils2iu( 50 ) ),
51  m_extensionOffset( 0 ),
53  m_keepTextAligned( true ),
54  m_text( aParent ),
55  m_measuredValue( 0 )
56 {
58 }
bool m_suppressZeroes
Suppress trailing zeroes.
Definition: dimension.h:286
int m_precision
Number of digits to display after decimal.
Definition: dimension.h:285
bool m_autoUnits
If true, follow the currently selected UI units.
Definition: dimension.h:283
bool m_overrideTextEnabled
Manually specify the displayed measurement value.
Definition: dimension.h:278
int m_extensionOffset
Distance from feature points to extension line start.
Definition: dimension.h:291
int m_arrowLength
Length of arrow shapes.
Definition: dimension.h:290
bool m_keepTextAligned
Calculate text orientation to match dimension.
Definition: dimension.h:293
EDA_UNITS m_units
0 = inches, 1 = mm
Definition: dimension.h:282
PCB_TEXT m_text
The actual text object.
Definition: dimension.h:296
Text appears outside the dimension line (default)
int m_measuredValue
value of PCB dimensions
Definition: dimension.h:297
BOARD_ITEM(BOARD_ITEM *aParent, KICAD_T idtype)
Definition: board_item.h:85
PCB_LAYER_ID m_layer
Definition: board_item.h:363
int m_lineThickness
Thickness used for all graphics in the dimension.
Definition: dimension.h:289
DIM_UNITS_FORMAT m_unitsFormat
How to render the units suffix.
Definition: dimension.h:284
static constexpr int Millimeter2iu(double mm)
DIM_TEXT_POSITION m_textPosition
How to position the text.
Definition: dimension.h:292

References BARE_SUFFIX, Dwgs_User, INCHES, BOARD_ITEM::m_layer, and OUTSIDE.

Member Function Documentation

◆ addShape()

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

Definition at line 97 of file dimension.cpp.

98 {
99  m_shapes.push_back( std::make_shared<ShapeType>( aShape ) );
100 }
std::vector< std::shared_ptr< SHAPE > > m_shapes
Definition: dimension.h:302

References m_shapes.

Referenced by ALIGNED_DIMENSION::updateGeometry(), and ORTHOGONAL_DIMENSION::updateGeometry().

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )
inlineinherited

◆ ClearEditFlags()

◆ ClearFlags()

void EDA_ITEM::ClearFlags ( STATUS_FLAGS  aMask = EDA_ITEM_ALL_FLAGS)
inlineinherited

Definition at line 204 of file eda_item.h.

204 { m_flags &= ~aMask; }
STATUS_FLAGS m_flags
Definition: eda_item.h:531

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

◆ ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )
inlineinherited

Definition at line 216 of file eda_item.h.

217  {
219  DO_NOT_DRAW );
220  }
#define TEMP_SELECTED
flag indicating that the structure has already selected
Definition: eda_item.h:115
#define IS_LINKED
Used in calculation to mark linked items (temporary use)
Definition: eda_item.h:104
#define CANDIDATE
flag indicating that the structure is connected
Definition: eda_item.h:117
#define DO_NOT_DRAW
Used to disable draw function.
Definition: eda_item.h:119
#define STARTPOINT
When a line is selected, these flags indicate which.
Definition: eda_item.h:112
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: eda_item.h:204
#define ENDPOINT
ends. (Used to support dragging.)
Definition: eda_item.h:113
#define SKIP_STRUCT
flag indicating that the structure should be ignored
Definition: eda_item.h:118

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.

149  {
150  m_viewPrivData = nullptr;
151  }
VIEW_ITEM_DATA * m_viewPrivData
Definition: view_item.h:156

References KIGFX::VIEW_ITEM::m_viewPrivData.

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

◆ Clone()

EDA_ITEM * EDA_ITEM::Clone ( ) const
virtualinherited

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 in FP_ZONE, ZONE, SCH_COMPONENT, PAD, FOOTPRINT, SCH_HIERLABEL, CENTER_DIMENSION, LEADER, ORTHOGONAL_DIMENSION, VIA, SCH_GLOBALLABEL, SCH_SHEET, SCH_LABEL, ALIGNED_DIMENSION, PCB_SHAPE, ARC, SCH_TEXT, SCH_LINE, LIB_PIN, FP_TEXT, TRACK, SCH_BUS_BUS_ENTRY, SCH_FIELD, LIB_FIELD, SCH_SHEET_PIN, SCH_BUS_WIRE_ENTRY, FP_SHAPE, SCH_BITMAP, PCB_TEXT, PCB_GROUP, LIB_ARC, LIB_TEXT, SCH_NO_CONNECT, SCH_JUNCTION, SCH_MARKER, LIB_POLYLINE, PCB_TARGET, LIB_CIRCLE, LIB_BEZIER, LIB_RECTANGLE, and KIGFX::ORIGIN_VIEWITEM.

Definition at line 81 of file eda_item.cpp.

82 {
83  wxCHECK_MSG( false, NULL, wxT( "Clone not implemented in derived class " ) + GetClass() +
84  wxT( ". Bad programmer!" ) );
85 }
#define NULL
virtual wxString GetClass() const =0
Return the class name.

References EDA_ITEM::GetClass(), and NULL.

Referenced by DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), BOARD_ITEM::Duplicate(), SCH_ITEM::Duplicate(), GetEffectiveShape(), LIB_PART::LIB_PART(), new_clone(), LIB_PART::operator=(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), SCH_SEXPR_PLUGIN_CACHE::removeSymbol(), SCH_LEGACY_PLUGIN_CACHE::removeSymbol(), SCH_EDIT_FRAME::SaveCopyForRepeatItem(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), CLIPBOARD_IO::SaveSelection(), LIB_PART::SetConversion(), LIB_PART::SetUnitCount(), SCH_DRAWING_TOOLS::SingleClickPlace(), COMMIT::Stage(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ DeleteStructure()

void BOARD_ITEM::DeleteStructure ( )
inherited

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

Definition at line 113 of file board_item.cpp.

114 {
115  BOARD_ITEM_CONTAINER* parent = GetParent();
116 
117  if( parent )
118  parent->Remove( this );
119 
120  delete this;
121 }
virtual void Remove(BOARD_ITEM *aItem, REMOVE_MODE aMode=REMOVE_MODE::NORMAL)=0
Removes an item from the container.
Abstract interface for BOARD_ITEMs capable of storing other items inside.
BOARD_ITEM_CONTAINER * GetParent() const
Definition: board_item.h:168

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 202 of file board_item.h.

203  {
204  EDA_ITEM* dupe = Clone();
205  const_cast<KIID&>( dupe->m_Uuid ) = KIID();
206 
207  return static_cast<BOARD_ITEM*>( dupe );
208  }
virtual EDA_ITEM * Clone() const
Create a duplicate of this item with linked list members set to NULL.
Definition: eda_item.cpp:81
Definition: kiid.h:44
const KIID m_Uuid
Definition: eda_item.h:525
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:150

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 DIMENSION_BASE::Flip ( const wxPoint &  aCentre,
bool  aFlipLeftRight 
)
overridevirtual

Flip this object, i.e.

change the board side for this object.

Parameters
aCentrethe rotation point.
aFlipLeftRightmirror across Y axis instead of X (the default).

Reimplemented from BOARD_ITEM.

Definition at line 250 of file dimension.cpp.

251 {
252  Mirror( aCentre );
253 
254  SetLayer( FlipLayer( GetLayer(), GetBoard()->GetCopperLayerCount() ) );
255 }
void SetLayer(PCB_LAYER_ID aLayer) override
Set the layer this item is on.
Definition: dimension.cpp:212
PCB_LAYER_ID FlipLayer(PCB_LAYER_ID aLayerId, int aCopperLayersCount)
Definition: lset.cpp:521
virtual BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
Definition: board_item.cpp:46
void Mirror(const wxPoint &axis_pos, bool aMirrorLeftRight=false)
Mirror the Dimension , relative to a given horizontal axis the text is not mirrored.
Definition: dimension.cpp:258
virtual PCB_LAYER_ID GetLayer() const
Return the primary layer this item is on.
Definition: board_item.h:173

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

◆ Flip() [2/2]

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

Definition at line 315 of file board_item.h.

316  {
317  Flip( wxPoint( aCentre.x, aCentre.y ), aFlipLeftRight );
318  }
virtual void Flip(const wxPoint &aCentre, bool aFlipLeftRight)
Flip this object, i.e.
Definition: board_item.h:310

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.

87  {
89  TYPE_ID thisType = TYPE_HASH( *this );
90  void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
91  return object ? aProperty->getter( object ) : wxAny();
92  }
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:65
#define TYPE_HASH(x)
Definition: property.h:59
size_t TYPE_ID
Unique type identifier.
Definition: property_mgr.h:42
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Cast a type to another type.
virtual wxAny getter(void *aObject) const =0
Provide class metadata.Helper macro to map type hashes to names.
Definition: property_mgr.h:62
virtual size_t OwnerHash() const =0
Return type-id of the Owner class.

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.

96  {
98  TYPE_ID thisType = TYPE_HASH( *this );
99  void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
100  return object ? aProperty->get<T>( object ) : T();
101  }
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:65
#define TYPE_HASH(x)
Definition: property.h:59
size_t TYPE_ID
Unique type identifier.
Definition: property_mgr.h:42
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Cast a type to another type.
Provide class metadata.Helper macro to map type hashes to names.
Definition: property_mgr.h:62
T get(void *aObject)
Definition: property.h:268
virtual size_t OwnerHash() const =0
Return type-id of the Owner class.

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.

105  {
107  TYPE_ID thisType = TYPE_HASH( *this );
108  PROPERTY_BASE* prop = propMgr.GetProperty( thisType, aProperty );
109  boost::optional<T> ret;
110 
111  if( prop )
112  {
113  void* object = propMgr.TypeCast( this, thisType, prop->OwnerHash() );
114 
115  if( object )
116  ret = prop->get<T>( object );
117  }
118 
119  return ret;
120  }
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:65
#define TYPE_HASH(x)
Definition: property.h:59
size_t TYPE_ID
Unique type identifier.
Definition: property_mgr.h:42
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Cast a type to another type.
PROPERTY_BASE * GetProperty(TYPE_ID aType, const wxString &aProperty) const
Return a property for a specific type.
Provide class metadata.Helper macro to map type hashes to names.
Definition: property_mgr.h:62
T get(void *aObject)
Definition: property.h:268
virtual size_t OwnerHash() const =0
Return type-id of the Owner class.

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

◆ GetArrowLength()

int DIMENSION_BASE::GetArrowLength ( ) const
inline

Definition at line 181 of file dimension.h.

181 { return m_arrowLength; }
int m_arrowLength
Length of arrow shapes.
Definition: dimension.h:290

References 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 46 of file board_item.cpp.

47 {
48  if( Type() == PCB_T )
49  return (BOARD*) this;
50 
51  BOARD_ITEM* parent = GetParent();
52 
53  if( parent )
54  return parent->GetBoard();
55 
56  return NULL;
57 }
Definition: typeinfo.h:84
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:82
#define NULL
virtual BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
Definition: board_item.cpp:46
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:190
BOARD_ITEM_CONTAINER * GetParent() const
Definition: board_item.h:168
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:163

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

Referenced by PAD::BuildEffectivePolygon(), PAD::BuildEffectiveShapes(), ZONE::BuildSmoothedPoly(), KIGFX::PCB_PAINTER::draw(), exprFromTo(), VIA::FlashLayer(), PAD::FlashLayer(), PCB_TARGET::Flip(), PCB_TEXT::Flip(), TRACK::Flip(), FP_SHAPE::Flip(), FP_TEXT::Flip(), Flip(), ARC::Flip(), PCB_SHAPE::Flip(), VIA::Flip(), ZONE::Flip(), BOARD_ITEM::GetBoard(), FOOTPRINT::GetBoundingBox(), FOOTPRINT::GetBoundingHull(), BOARD_CONNECTED_ITEM::GetEffectiveNetclass(), ZONE::GetInteractingZones(), BOARD_ITEM::GetLayerName(), VIA::GetMinAnnulus(), PCB_DRAW_PANEL_GAL::GetMsgPanelInfo(), ZONE::GetMsgPanelInfo(), NETINFO_ITEM::GetMsgPanelInfo(), TRACK::GetMsgPanelInfo(), 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(), TRACK::GetWidthConstraints(), inDiffPair(), insideArea(), insideBackCourtyard(), insideCourtyard(), insideFrontCourtyard(), BOARD_ITEM::layerMaskDescribe(), 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(), TRACK::ViewBBox(), FOOTPRINT::ViewBBox(), VIA::ViewGetLOD(), and PAD::ViewGetLOD().

◆ GetBoundingBox()

const EDA_RECT DIMENSION_BASE::GetBoundingBox ( ) const
overridevirtual

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

Definition at line 403 of file dimension.cpp.

404 {
405  EDA_RECT bBox;
406  int xmin, xmax, ymin, ymax;
407 
408  bBox = m_text.GetTextBox();
409  xmin = bBox.GetX();
410  xmax = bBox.GetRight();
411  ymin = bBox.GetY();
412  ymax = bBox.GetBottom();
413 
414  for( const std::shared_ptr<SHAPE>& shape : GetShapes() )
415  {
416  BOX2I shapeBox = shape->BBox();
417  shapeBox.Inflate( m_lineThickness / 2 );
418 
419  xmin = std::min( xmin, shapeBox.GetOrigin().x );
420  xmax = std::max( xmax, shapeBox.GetEnd().x );
421  ymin = std::min( ymin, shapeBox.GetOrigin().y );
422  ymax = std::max( ymax, shapeBox.GetEnd().y );
423  }
424 
425  bBox.SetX( xmin );
426  bBox.SetY( ymin );
427  bBox.SetWidth( xmax - xmin + 1 );
428  bBox.SetHeight( ymax - ymin + 1 );
429 
430  bBox.Normalize();
431 
432  return bBox;
433 }
const Vec GetEnd() const
Definition: box2.h:195
int GetX() const
Definition: eda_rect.h:103
EDA_RECT GetTextBox(int aLine=-1, bool aInvertY=false) const
Useful in multiline texts to calculate the full text or a line area (for zones filling,...
Definition: eda_text.cpp:223
int GetBottom() const
Definition: eda_rect.h:119
const std::vector< std::shared_ptr< SHAPE > > & GetShapes() const
Definition: dimension.h:215
void SetHeight(int val)
Definition: eda_rect.h:181
int GetRight() const
Definition: eda_rect.h:116
PCB_TEXT m_text
The actual text object.
Definition: dimension.h:296
void SetX(int val)
Definition: eda_rect.h:163
void SetWidth(int val)
Definition: eda_rect.h:175
void SetY(int val)
Definition: eda_rect.h:169
void Normalize()
Ensures that the height ant width are positive.
Definition: eda_rect.cpp:35
BOX2< Vec > & Inflate(coord_type dx, coord_type dy)
Function Inflate inflates the rectangle horizontally by dx and vertically by dy.
Definition: box2.h:302
Handle the component boundary box.
Definition: eda_rect.h:42
int GetY() const
Definition: eda_rect.h:104
int m_lineThickness
Thickness used for all graphics in the dimension.
Definition: dimension.h:289
const Vec & GetOrigin() const
Definition: box2.h:193

References EDA_RECT::GetBottom(), BOX2< Vec >::GetEnd(), BOX2< Vec >::GetOrigin(), EDA_RECT::GetRight(), GetShapes(), EDA_TEXT::GetTextBox(), EDA_RECT::GetX(), EDA_RECT::GetY(), BOX2< Vec >::Inflate(), m_lineThickness, 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 HitTest(), and 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 ARC, PAD, PCB_SHAPE, and PCB_MARKER.

Definition at line 114 of file board_item.h.

115  {
116  return GetBoundingBox().GetCenter();
117  }
virtual const EDA_RECT GetBoundingBox() const
Return the orthogonal bounding box of this object for display purposes.
Definition: eda_item.cpp:73
const wxPoint GetCenter() const
Definition: eda_rect.h:109

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

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

◆ GetClass()

◆ GetEditFlags()

STATUS_FLAGS EDA_ITEM::GetEditFlags ( ) const
inlineinherited

Definition at line 208 of file eda_item.h.

209  {
210  constexpr int mask = ( IS_NEW | IS_PASTED | IS_MOVED | IS_RESIZED | IS_DRAGGED |
212 
213  return m_flags & mask;
214  }
#define IS_RESIZED
Item being resized.
Definition: eda_item.h:108
#define STRUCT_DELETED
flag indication structures to be erased
Definition: eda_item.h:116
#define IS_MOVED
Item being moved.
Definition: eda_item.h:106
#define IS_DRAGGED
Item being dragged.
Definition: eda_item.h:109
#define IS_PASTED
Modifier on IS_NEW which indicates it came from clipboard.
Definition: eda_item.h:120
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: eda_item.h:111
STATUS_FLAGS m_flags
Definition: eda_item.h:531
#define IS_NEW
New item, just created.
Definition: eda_item.h:107

References IS_DRAGGED, IS_MOVED, IS_NEW, IS_PASTED, IS_RESIZED, 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_COMPONENT::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_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), and DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow().

◆ GetEffectiveShape()

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

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
aLayerin 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 354 of file dimension.cpp.

355 {
356  std::shared_ptr<SHAPE_COMPOUND> effectiveShape = std::make_shared<SHAPE_COMPOUND>();
357 
358  effectiveShape->AddShape( Text().GetEffectiveTextShape()->Clone() );
359 
360  for( const std::shared_ptr<SHAPE>& shape : GetShapes() )
361  effectiveShape->AddShape( shape->Clone() );
362 
363  return effectiveShape;
364 }
virtual EDA_ITEM * Clone() const
Create a duplicate of this item with linked list members set to NULL.
Definition: eda_item.cpp:81
const std::vector< std::shared_ptr< SHAPE > > & GetShapes() const
Definition: dimension.h:215
PCB_TEXT & Text()
Definition: dimension.h:209

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

◆ GetEnd()

virtual const wxPoint& DIMENSION_BASE::GetEnd ( ) const
inlinevirtual

◆ GetExtensionOffset()

int DIMENSION_BASE::GetExtensionOffset ( ) const
inline

Definition at line 185 of file dimension.h.

185 { return m_extensionOffset; }
int m_extensionOffset
Distance from feature points to extension line start.
Definition: dimension.h:291

References m_extensionOffset.

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

◆ GetFlags()

◆ 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 TRACK.

Definition at line 309 of file eda_item.h.

309 { return GetPosition(); }
virtual wxPoint GetPosition() const
Definition: eda_item.h:302

References EDA_ITEM::GetPosition().

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

◆ GetKeepTextAligned()

bool DIMENSION_BASE::GetKeepTextAligned ( ) const
inline

Definition at line 175 of file dimension.h.

175 { return m_keepTextAligned; }
bool m_keepTextAligned
Calculate text orientation to match dimension.
Definition: dimension.h:293

References 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 173 of file board_item.h.

173 { return m_layer; }
PCB_LAYER_ID m_layer
Definition: board_item.h:363

References BOARD_ITEM::m_layer.

Referenced by CN_LIST::Add(), BOARD_ADAPTER::addFootprintShapesWithClearance(), GRAPHICS_CLEANER::areEquivalent(), BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), BOARD_ITEM_DESC::BOARD_ITEM_DESC(), AR_AUTOPLACER::buildFpAreas(), TRACKS_CLEANER::cleanup(), CreateBoardSection(), MICROWAVE_TOOL::createMicrowaveInductor(), PCB_BASE_FRAME::CreateNewFootprint(), CreateRoutesSection(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), DIALOG_GRAPHIC_ITEM_PROPERTIES::DIALOG_GRAPHIC_ITEM_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), EDIT_TOOL::DragArcTrack(), KIGFX::PCB_PAINTER::draw(), PCB_EDIT_FRAME::ExchangeFootprint(), EXPORTER_PCB_VRML::ExportVrmlFootprint(), extractDiffPairCoupledItems(), EDIT_TOOL::FilletTracks(), PCB_TARGET::Flip(), PCB_TEXT::Flip(), TRACK::Flip(), FP_SHAPE::Flip(), FP_TEXT::Flip(), Flip(), FOOTPRINT::Flip(), ARC::Flip(), PCB_SHAPE::Flip(), FOOTPRINT_DESC::FOOTPRINT_DESC(), PCB_IO::FootprintSave(), FootprintWriteShape(), PCB_IO::format(), PCB_IO::formatLayer(), FP_TEXT::FP_TEXT(), DSN::SPECCTRA_DB::FromBOARD(), AR_AUTOPLACER::genModuleOnRoutingMatrix(), FOOTPRINT::GetBoundingBox(), ZONE::GetLayer(), getMatchingTextItem(), TRACK::GetMsgPanelInfo(), VIA::GetMsgPanelInfo(), PAD::GetMsgPanelInfo(), AR_AUTOPLACER::getOptimalFPPlacement(), BOARD::GetPad(), TRACK::GetWidthConstraints(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), idf_export_footprint(), GENERAL_COLLECTOR::Inspect(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), isEdge(), PAD::IsFlipped(), PNS_KICAD_IFACE::IsItemVisible(), BOARD_ITEM::IsOnCopperLayer(), FP_SHAPE::IsParentFlipped(), FP_TEXT::IsParentFlipped(), itemIsIncludedByFilter(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromDrawsegments(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnAddField(), DIALOG_FOOTPRINT_PROPERTIES::OnAddField(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), TRACK::cmp_tracks::operator()(), BOARD_ITEM::ptr_cmp::operator()(), PCB_SHAPE::cmp_drawings::operator()(), FOOTPRINT::cmp_drawings::operator()(), EAGLE_PLUGIN::packagePad(), BRDITEMS_PLOTTER::PlotBoardGraphicItems(), BRDITEMS_PLOTTER::PlotDimension(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), BRDITEMS_PLOTTER::PlotFootprintGraphicItems(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotFootprintTextItems(), BRDITEMS_PLOTTER::PlotPcbShape(), BRDITEMS_PLOTTER::PlotPcbTarget(), BRDITEMS_PLOTTER::PlotPcbText(), CONVERT_TOOL::PolyToLines(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), processTextItem(), PAD_TOOL::recombinePad(), CLIPBOARD_IO::SaveSelection(), CONVERT_TOOL::SegmentToArc(), PCB_SELECTION_TOOL::Selectable(), GLOBAL_EDIT_TOOL::swapBoardItem(), PNS_KICAD_IFACE_BASE::syncArc(), PNS_KICAD_IFACE_BASE::syncGraphicalItem(), PNS_KICAD_IFACE_BASE::syncTrack(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::testAgainstEdge(), AR_AUTOPLACER::testFootprintOnBoard(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackAgainstItem(), TRACK_VIA_DESC::TRACK_VIA_DESC(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow(), BOARD_ADAPTER::transformFPShapesToPolygon(), FOOTPRINT::TransformFPShapesWithClearanceToPolygon(), TRACK::ViewGetLayers(), FP_TEXT::ViewGetLayers(), FP_TEXT::ViewGetLOD(), FP_ZONE::ViewGetLOD(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ 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 60 of file board_item.cpp.

61 {
62  BOARD* board = GetBoard();
63 
64  if( board )
65  return board->GetLayerName( m_layer );
66 
67  // If no parent, return standard name
69 }
const wxString GetLayerName(PCB_LAYER_ID aLayer) const
Return the name of a aLayer.
Definition: board.cpp:342
virtual BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
Definition: board_item.cpp:46
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:190
PCB_LAYER_ID m_layer
Definition: board_item.h:363
static wxString GetStandardLayerName(PCB_LAYER_ID aLayerId)
Return an "English Standard" name of a PCB layer when given aLayerNumber.
Definition: board.h:676

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

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

◆ GetLayerSet()

◆ GetLineThickness()

int DIMENSION_BASE::GetLineThickness ( ) const
inline

◆ GetMeasuredValue()

int DIMENSION_BASE::GetMeasuredValue ( ) const
inline

Definition at line 136 of file dimension.h.

136 { return m_measuredValue; }
int m_measuredValue
value of PCB dimensions
Definition: dimension.h:297

References m_measuredValue.

Referenced by GetValueText().

◆ GetMenuImage()

BITMAPS EDA_ITEM::GetMenuImage ( ) const
virtualinherited

◆ GetMsgPanelInfo()

void DIMENSION_BASE::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
aListis the list to populate.

Reimplemented from EDA_ITEM.

Reimplemented in LEADER, and ALIGNED_DIMENSION.

Definition at line 291 of file dimension.cpp.

292 {
293  // for now, display only the text within the DIMENSION using class PCB_TEXT.
294  wxString msg;
295 
296  wxCHECK_RET( m_parent != NULL, wxT( "PCB_TEXT::GetMsgPanelInfo() m_Parent is NULL." ) );
297 
298  aList.emplace_back( _( "Dimension" ), m_text.GetShownText() );
299 
300  aList.emplace_back( _( "Prefix" ), GetPrefix() );
301 
302  if( GetOverrideTextEnabled() )
303  {
304  aList.emplace_back( _( "Override Text" ), GetOverrideText() );
305  }
306  else
307  {
308  aList.emplace_back( _( "Value" ), GetValueText() );
309 
310  msg = "%" + wxString::Format( "1.%df", GetPrecision() );
311  aList.emplace_back( _( "Precision" ), wxString::Format( msg, 0.0 ) );
312  }
313 
314  aList.emplace_back( _( "Suffix" ), GetSuffix() );
315 
316  EDA_UNITS units;
317 
318  GetUnits( units );
319  aList.emplace_back( _( "Units" ), GetAbbreviatedUnitsLabel( units ) );
320 
321  ORIGIN_TRANSFORMS originTransforms = aFrame->GetOriginTransforms();
322  units = aFrame->GetUserUnits();
323 
324  if( Type() == PCB_DIM_CENTER_T )
325  {
326  wxPoint startCoord = originTransforms.ToDisplayAbs( GetStart() );
327  wxString start = wxString::Format( "@(%s, %s)",
328  MessageTextFromValue( units, startCoord.x ),
329  MessageTextFromValue( units, startCoord.y ) );
330 
331  aList.emplace_back( start, wxEmptyString );
332  }
333  else
334  {
335  wxPoint startCoord = originTransforms.ToDisplayAbs( GetStart() );
336  wxString start = wxString::Format( "@(%s, %s)",
337  MessageTextFromValue( units, startCoord.x ),
338  MessageTextFromValue( units, startCoord.y ) );
339  wxPoint endCoord = originTransforms.ToDisplayAbs( GetEnd() );
340  wxString end = wxString::Format( "@(%s, %s)",
341  MessageTextFromValue( units, endCoord.x ),
342  MessageTextFromValue( units, endCoord.y ) );
343 
344  aList.emplace_back( start, end );
345  }
346 
347  if( IsLocked() )
348  aList.emplace_back( _( "Status" ), _( "Locked" ) );
349 
350  aList.emplace_back( _( "Layer" ), GetLayerName() );
351 }
EDA_ITEM * m_parent
Linked list: Link (parent struct)
Definition: eda_item.h:529
wxString MessageTextFromValue(EDA_UNITS aUnits, int aValue, bool aAddUnitLabel, EDA_DATA_TYPE aType)
Convert a value to a string using double notation.
Definition: base_units.cpp:90
bool GetOverrideTextEnabled() const
Definition: dimension.h:130
class CENTER_DIMENSION, a center point marking (graphic item)
Definition: typeinfo.h:102
virtual const wxPoint & GetStart() const
The dimension's origin is the first feature point for the dimension.
Definition: dimension.h:121
virtual ORIGIN_TRANSFORMS & GetOriginTransforms()
Return a reference to the default ORIGIN_TRANSFORMS object.
wxString GetOverrideText() const
Definition: dimension.h:133
wxString GetAbbreviatedUnitsLabel(EDA_UNITS aUnit, EDA_DATA_TYPE aType)
Get the units string for a given units type.
Definition: base_units.cpp:410
T ToDisplayAbs(const T &aValue) const
int GetPrecision() const
Definition: dimension.h:169
wxString GetShownText(int aDepth=0) const override
Return the string actually shown after processing of the base text.
Definition: pcb_text.cpp:53
wxString GetSuffix() const
Definition: dimension.h:155
wxString GetPrefix() const
Definition: dimension.h:152
#define NULL
void GetUnits(EDA_UNITS &aUnits) const
Definition: dimension.h:158
PCB_TEXT m_text
The actual text object.
Definition: dimension.h:296
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
EDA_UNITS
Definition: eda_units.h:38
virtual bool IsLocked() const
Definition: board_item.h:249
A class to perform either relative or absolute display origin transforms for a single axis of a point...
#define _(s)
Definition: 3d_actions.cpp:33
wxString GetLayerName() const
Return the name of the PCB layer on which the item resides.
Definition: board_item.cpp:60
virtual const wxPoint & GetEnd() const
Definition: dimension.h:124
EDA_UNITS GetUserUnits() const
Return the user units currently in use.
wxString GetValueText() const
Definition: dimension.cpp:103
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:163

References _, Format(), GetAbbreviatedUnitsLabel(), GetEnd(), BOARD_ITEM::GetLayerName(), EDA_DRAW_FRAME::GetOriginTransforms(), GetOverrideText(), GetOverrideTextEnabled(), GetPrecision(), GetPrefix(), PCB_TEXT::GetShownText(), GetStart(), GetSuffix(), GetUnits(), EDA_BASE_FRAME::GetUserUnits(), GetValueText(), BOARD_ITEM::IsLocked(), EDA_ITEM::m_parent, m_text, MessageTextFromValue(), NULL, PCB_DIM_CENTER_T, ORIGIN_TRANSFORMS::ToDisplayAbs(), and EDA_ITEM::Type().

Referenced by ALIGNED_DIMENSION::GetMsgPanelInfo().

◆ GetOverrideText()

wxString DIMENSION_BASE::GetOverrideText ( ) const
inline

Definition at line 133 of file dimension.h.

133 { return m_valueString; }
wxString m_valueString
Displayed value when m_overrideValue = true.
Definition: dimension.h:279

References m_valueString.

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

◆ GetOverrideTextEnabled()

bool DIMENSION_BASE::GetOverrideTextEnabled ( ) const
inline

Definition at line 130 of file dimension.h.

130 { return m_overrideTextEnabled; }
bool m_overrideTextEnabled
Manually specify the displayed measurement value.
Definition: dimension.h:278

References m_overrideTextEnabled.

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

◆ GetParent()

BOARD_ITEM_CONTAINER* BOARD_ITEM::GetParent ( void  ) const
inlineinherited

Definition at line 168 of file board_item.h.

168 { return (BOARD_ITEM_CONTAINER*) m_parent; }
EDA_ITEM * m_parent
Linked list: Link (parent struct)
Definition: eda_item.h:529
Abstract interface for BOARD_ITEMs capable of storing other items inside.

References EDA_ITEM::m_parent.

Referenced by PCB_POINT_EDITOR::addCorner(), ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), PNS_KICAD_IFACE::Commit(), EDIT_TOOL::copyToClipboard(), FOOTPRINT::CoverageRatio(), BOARD_ITEM::DeleteStructure(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), EDIT_TOOL::doMoveSelection(), EDIT_TOOL::Drag(), EDIT_TOOL::DragArcTrack(), KIGFX::PCB_PAINTER::draw(), EDIT_TOOL::Duplicate(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), PCB_IO::format(), FormatProbeItem(), BOARD_ITEM::GetBoard(), PCB_MARKER::GetColorLayer(), ALIGN_DISTRIBUTE_TOOL::GetSelections(), FP_TEXT::GetSelectMenuText(), PCB_TEXT::GetShownText(), FP_TEXT::GetShownText(), getTopLevelGroup(), insideArea(), GENERAL_COLLECTOR::Inspect(), ARRAY_CREATOR::Invoke(), DRC_ENGINE::IsNetTie(), FP_SHAPE::IsParentFlipped(), FP_TEXT::IsParentFlipped(), LEGACY_PLUGIN::loadMODULE_TEXT(), memberOf(), EDIT_TOOL::MoveExact(), ALTIUM_PCB::ParseTexts6Data(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), POSITION_RELATIVE_TOOL::PositionRelative(), BOARD_COMMIT::Push(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), CLIPBOARD_IO::SaveSelection(), PCB_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::Selectable(), SwapItemData(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), PCB_MARKER::ViewGetLayers(), FP_ZONE::ViewGetLOD(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ GetParentGroup()

◆ GetPosition()

wxPoint DIMENSION_BASE::GetPosition ( ) const
inlineoverridevirtual

Reimplemented from EDA_ITEM.

Definition at line 127 of file dimension.h.

127 { return m_start; }
wxPoint m_start
Definition: dimension.h:298

References m_start.

Referenced by DRAWING_TOOL::DrawDimension(), ViewBBox(), and CENTER_DIMENSION::ViewBBox().

◆ GetPrecision()

int DIMENSION_BASE::GetPrecision ( ) const
inline

Definition at line 169 of file dimension.h.

169 { return m_precision; }
int m_precision
Number of digits to display after decimal.
Definition: dimension.h:285

References m_precision.

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

◆ GetPrefix()

wxString DIMENSION_BASE::GetPrefix ( ) const
inline

Definition at line 152 of file dimension.h.

152 { return m_prefix; }
wxString m_prefix
String prepended to the value.
Definition: dimension.h:280

References m_prefix.

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

◆ GetSelectMenuText()

wxString DIMENSION_BASE::GetSelectMenuText ( EDA_UNITS  aUnits) const
overridevirtual

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

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

Returns
The menu text string.

Reimplemented from EDA_ITEM.

Definition at line 436 of file dimension.cpp.

437 {
438  return wxString::Format( _( "Dimension '%s' on %s" ),
439  GetText(),
440  GetLayerName() );
441 }
const wxString GetText() const
Retrieves the value text or override text, not including prefix or suffix.
Definition: dimension.cpp:206
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
#define _(s)
Definition: 3d_actions.cpp:33
wxString GetLayerName() const
Return the name of the PCB layer on which the item resides.
Definition: board_item.cpp:60

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

◆ GetShapes()

const std::vector<std::shared_ptr<SHAPE> >& DIMENSION_BASE::GetShapes ( ) const
inline
Returns
a list of line segments that make up this dimension (for drawing, plotting, etc)

Definition at line 215 of file dimension.h.

215 { return m_shapes; }
std::vector< std::shared_ptr< SHAPE > > m_shapes
Definition: dimension.h:302

References m_shapes.

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

◆ GetStart()

virtual const wxPoint& DIMENSION_BASE::GetStart ( ) const
inlinevirtual

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 dimension.h.

121 { return m_start; }
wxPoint m_start
Definition: dimension.h:298

References m_start.

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

◆ GetState()

int EDA_ITEM::GetState ( int  type) const
inlineinherited

Definition at line 187 of file eda_item.h.

188  {
189  return m_status & type;
190  }
STATUS_FLAGS m_status
Definition: eda_item.h:528

References EDA_ITEM::m_status.

Referenced by BOARD_ITEM::IsLocked().

◆ GetStatus()

STATUS_FLAGS EDA_ITEM::GetStatus ( ) const
inlineinherited

Definition at line 200 of file eda_item.h.

200 { return m_status; }
STATUS_FLAGS m_status
Definition: eda_item.h:528

References EDA_ITEM::m_status.

◆ GetSuffix()

wxString DIMENSION_BASE::GetSuffix ( ) const
inline

Definition at line 155 of file dimension.h.

155 { return m_suffix; }
wxString m_suffix
String appended to the value.
Definition: dimension.h:281

References m_suffix.

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

◆ GetSuppressZeroes()

bool DIMENSION_BASE::GetSuppressZeroes ( ) const
inline

Definition at line 172 of file dimension.h.

172 { return m_suppressZeroes; }
bool m_suppressZeroes
Suppress trailing zeroes.
Definition: dimension.h:286

References m_suppressZeroes.

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

◆ GetText()

const wxString DIMENSION_BASE::GetText ( ) const

Retrieves 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 206 of file dimension.cpp.

207 {
208  return m_text.GetText();
209 }
PCB_TEXT m_text
The actual text object.
Definition: dimension.h:296
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition: eda_text.h:133

References EDA_TEXT::GetText(), and m_text.

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

◆ GetTextPositionMode()

DIM_TEXT_POSITION DIMENSION_BASE::GetTextPositionMode ( ) const
inline

Definition at line 179 of file dimension.h.

179 { return m_textPosition; }
DIM_TEXT_POSITION m_textPosition
How to position the text.
Definition: dimension.h:292

References m_textPosition.

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

◆ GetUnits()

void DIMENSION_BASE::GetUnits ( EDA_UNITS aUnits) const
inline

Definition at line 158 of file dimension.h.

158 { aUnits = m_units; }
EDA_UNITS m_units
0 = inches, 1 = mm
Definition: dimension.h:282

References m_units.

Referenced by GetMsgPanelInfo().

◆ GetUnitsFormat()

DIM_UNITS_FORMAT DIMENSION_BASE::GetUnitsFormat ( ) const
inline

Definition at line 166 of file dimension.h.

166 { return m_unitsFormat; }
DIM_UNITS_FORMAT m_unitsFormat
How to render the units suffix.
Definition: dimension.h:284

References m_unitsFormat.

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

◆ GetUnitsMode()

DIM_UNITS_MODE DIMENSION_BASE::GetUnitsMode ( ) const

Definition at line 150 of file dimension.cpp.

151 {
152  if( m_autoUnits )
153  {
155  }
156  else
157  {
158  switch( m_units )
159  {
162 
163  case EDA_UNITS::MILS:
164  return DIM_UNITS_MODE::MILS;
165 
166  default:
167  case EDA_UNITS::INCHES:
168  return DIM_UNITS_MODE::INCHES;
169  }
170  }
171 }
bool m_autoUnits
If true, follow the currently selected UI units.
Definition: dimension.h:283
EDA_UNITS m_units
0 = inches, 1 = mm
Definition: dimension.h:282

References AUTOMATIC, INCHES, m_autoUnits, 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 DIMENSION_BASE::GetValueText ( ) const
Returns
the dimension value, rendered with precision / zero suppression but no units, etc

Definition at line 103 of file dimension.cpp.

104 {
105  struct lconv* lc = localeconv();
106  wxChar sep = lc->decimal_point[0];
107 
108  int val = GetMeasuredValue();
109  wxString text;
110  wxString format = wxT( "%." ) + wxString::Format( "%i", m_precision ) + wxT( "f" );
111 
112  text.Printf( format, To_User_Unit( m_units, val ) );
113 
114  if( m_suppressZeroes )
115  {
116  while( text.Last() == '0' )
117  {
118  text.RemoveLast();
119 
120  if( text.Last() == '.' || text.Last() == sep )
121  {
122  text.RemoveLast();
123  break;
124  }
125  }
126  }
127 
128  return text;
129 }
bool m_suppressZeroes
Suppress trailing zeroes.
Definition: dimension.h:286
int m_precision
Number of digits to display after decimal.
Definition: dimension.h:285
EDA_UNITS m_units
0 = inches, 1 = mm
Definition: dimension.h:282
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
int GetMeasuredValue() const
Definition: dimension.h:136
double To_User_Unit(EDA_UNITS aUnit, double aValue)
Function To_User_Unit convert aValue in internal units to the appropriate user units defined by aUnit...
Definition: base_units.cpp:56

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

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

◆ GetX()

int BOARD_ITEM::GetX ( ) const
inlineinherited

◆ GetY()

int BOARD_ITEM::GetY ( ) const
inlineinherited

◆ HasFlag()

◆ HitTest() [1/2]

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

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

Parameters
aPositionA reference to a wxPoint object containing the coordinates to test.
aAccuracyIncrease the item bounding box by this amount.
Returns
True if aPosition is within the item bounding box.

Reimplemented from EDA_ITEM.

Definition at line 367 of file dimension.cpp.

368 {
369  if( m_text.TextHitTest( aPosition ) )
370  return true;
371 
372  int dist_max = aAccuracy + ( m_lineThickness / 2 );
373 
374  // Locate SEGMENTS
375 
376  for( const std::shared_ptr<SHAPE>& shape : GetShapes() )
377  {
378  if( shape->Collide( aPosition, dist_max ) )
379  return true;
380  }
381 
382  return false;
383 }
bool TextHitTest(const wxPoint &aPoint, int aAccuracy=0) const override
Test if aPoint is within the bounds of this object.
Definition: pcb_text.cpp:141
const std::vector< std::shared_ptr< SHAPE > > & GetShapes() const
Definition: dimension.h:215
PCB_TEXT m_text
The actual text object.
Definition: dimension.h:296
int m_lineThickness
Thickness used for all graphics in the dimension.
Definition: dimension.h:289

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

Referenced by GENERAL_COLLECTOR::Inspect().

◆ HitTest() [2/2]

bool DIMENSION_BASE::HitTest ( const EDA_RECT aRect,
bool  aContained,
int  aAccuracy = 0 
) const
overridevirtual

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

Parameters
aRectA reference to a EDA_RECT object containing the rectangle to test.
aContainedSet to true to test for containment instead of an intersection.
aAccuracyIncrease aRect by this amount.
Returns
True if aRect contains or intersects the item bounding box.

Reimplemented from EDA_ITEM.

Definition at line 386 of file dimension.cpp.

387 {
388  EDA_RECT arect = aRect;
389  arect.Inflate( aAccuracy );
390 
391  EDA_RECT rect = GetBoundingBox();
392 
393  if( aAccuracy )
394  rect.Inflate( aAccuracy );
395 
396  if( aContained )
397  return arect.Contains( rect );
398 
399  return arect.Intersects( rect );
400 }
const EDA_RECT GetBoundingBox() const override
Return the orthogonal bounding box of this object for display purposes.
Definition: dimension.cpp:403
bool Contains(const wxPoint &aPoint) const
Definition: eda_rect.cpp:57
Handle the component boundary box.
Definition: eda_rect.h:42
bool Intersects(const EDA_RECT &aRect) const
Test for a common area between rectangles.
Definition: eda_rect.cpp:150
EDA_RECT & Inflate(wxCoord dx, wxCoord dy)
Inflate the rectangle horizontally by dx and vertically by dy.
Definition: eda_rect.cpp:363

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

◆ IsBrightened()

◆ IsConnected()

◆ IsDragging()

bool EDA_ITEM::IsDragging ( ) const
inlineinherited

Definition at line 171 of file eda_item.h.

171 { return m_flags & IS_DRAGGED; }
#define IS_DRAGGED
Item being dragged.
Definition: eda_item.h:109
STATUS_FLAGS m_flags
Definition: eda_item.h:531

References IS_DRAGGED, and EDA_ITEM::m_flags.

Referenced by DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES().

◆ IsEntered()

bool EDA_ITEM::IsEntered ( ) const
inlineinherited

Definition at line 174 of file eda_item.h.

174 { return m_flags & ENTERED; }
#define ENTERED
indicates a group has been entered
Definition: eda_item.h:138
STATUS_FLAGS m_flags
Definition: eda_item.h:531

References ENTERED, and EDA_ITEM::m_flags.

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

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const
inlineinherited

Definition at line 256 of file eda_item.h.

256 { return m_forceVisible; }
bool m_forceVisible
Definition: eda_item.h:530

References EDA_ITEM::m_forceVisible.

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

◆ IsLocked()

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const
inlineinherited

Definition at line 168 of file eda_item.h.

168 { return m_flags & IS_CHANGED; }
#define IS_CHANGED
Item was edited, and modified.
Definition: eda_item.h:103
STATUS_FLAGS m_flags
Definition: eda_item.h:531

References IS_CHANGED, and EDA_ITEM::m_flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMoving()

◆ IsNew()

◆ IsOnCopperLayer()

virtual bool BOARD_ITEM::IsOnCopperLayer ( ) const
inlinevirtualinherited
Returns
true if the object is on any copper layer, false otherwise.

Reimplemented in TRACK, PAD, and ZONE.

Definition at line 144 of file board_item.h.

145  {
146  return IsCopperLayer( GetLayer() );
147  }
bool IsCopperLayer(LAYER_NUM aLayerId)
Tests whether a layer is a copper layer.
virtual PCB_LAYER_ID GetLayer() const
Return the primary layer this item is on.
Definition: board_item.h:173

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
aLayerThe layer to test for.
Returns
true if on given layer, else false.

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

Definition at line 231 of file board_item.h.

232  {
233  return m_layer == aLayer;
234  }
PCB_LAYER_ID m_layer
Definition: board_item.h:363

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

Definition at line 453 of file eda_item.h.

453 { return false; }

Referenced by EDA_ITEM::Matches().

◆ IsResized()

bool EDA_ITEM::IsResized ( ) const
inlineinherited

Definition at line 175 of file eda_item.h.

175 { return m_flags & IS_RESIZED; }
#define IS_RESIZED
Item being resized.
Definition: eda_item.h:108
STATUS_FLAGS m_flags
Definition: eda_item.h:531

References IS_RESIZED, and EDA_ITEM::m_flags.

◆ IsSelected()

bool EDA_ITEM::IsSelected ( ) const
inlineinherited

Definition at line 173 of file eda_item.h.

173 { return m_flags & SELECTED; }
#define SELECTED
Definition: eda_item.h:114
STATUS_FLAGS m_flags
Definition: eda_item.h:531

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(), 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 241 of file board_item.h.

242  {
243  return ( Type() == PCB_TRACE_T ) || ( Type() == PCB_VIA_T );
244  }
class TRACK, a track segment (segment on a copper layer)
Definition: typeinfo.h:95
class VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:96
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:163

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

◆ IsType()

bool DIMENSION_BASE::IsType ( const KICAD_T  aScanTypes[]) const
inlineoverridevirtual

Check whether the item is one of the listed types.

Parameters
aScanTypesList 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 dimension.h.

101  {
102  if( BOARD_ITEM::IsType( aScanTypes ) )
103  return true;
104 
105  for( const KICAD_T* p = aScanTypes; *p != EOT; ++p )
106  {
107  if( *p == PCB_LOCATE_GRAPHIC_T )
108  return true;
109  }
110 
111  return false;
112  }
search types array terminator (End Of Types)
Definition: typeinfo.h:81
KICAD_T
The set of class identification values stored in EDA_ITEM::m_structType.
Definition: typeinfo.h:77
virtual bool IsType(const KICAD_T aScanTypes[]) const
Check whether the item is one of the listed types.
Definition: eda_item.h:233

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

◆ IsWireImage()

bool EDA_ITEM::IsWireImage ( ) const
inlineinherited

Definition at line 172 of file eda_item.h.

172 { return m_flags & IS_WIRE_IMAGE; }
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: eda_item.h:111
STATUS_FLAGS m_flags
Definition: eda_item.h:531

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

349  {
350  for( auto it : aList )
351  {
352  if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
354  return SEARCH_RESULT::QUIT;
355  }
356 
358  }
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 dat...
Definition: eda_item.cpp:91

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

366  {
367  for( auto it : aList )
368  {
369  if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
371  return SEARCH_RESULT::QUIT;
372  }
373 
375  }
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 dat...
Definition: eda_item.cpp:91

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

Definition at line 72 of file board_item.cpp.

73 {
74  BOARD* board = GetBoard();
75  LSET layers = GetLayerSet();
76 
77  // Try to be smart and useful. Check all copper first.
78  if( layers[F_Cu] && layers[B_Cu] )
79  return _( "all copper layers" );
80 
81  LSET copperLayers = layers & board->GetEnabledLayers().AllCuMask();
82  LSET techLayers = layers & board->GetEnabledLayers().AllTechMask();
83 
84  for( LSET testLayers : { copperLayers, techLayers, layers } )
85  {
86  for( int bit = PCBNEW_LAYER_ID_START; bit < PCB_LAYER_ID_COUNT; ++bit )
87  {
88  if( testLayers[ bit ] )
89  {
90  wxString layerInfo = board->GetLayerName( static_cast<PCB_LAYER_ID>( bit ) );
91 
92  if( testLayers.count() > 1 )
93  layerInfo << wxS( " " ) + _( "and others" );
94 
95  return layerInfo;
96  }
97  }
98  }
99 
100  // No copper, no technicals: no layer
101  return _( "no layers" );
102 }
static LSET AllCuMask(int aCuLayerCount=MAX_CU_LAYERS)
Return a mask holding the requested number of Cu PCB_LAYER_IDs.
Definition: lset.cpp:750
const wxString GetLayerName(PCB_LAYER_ID aLayer) const
Return the name of a aLayer.
Definition: board.cpp:342
LSET GetEnabledLayers() const
A proxy function that calls the corresponding function in m_BoardSettings Returns a bit-mask of all t...
Definition: board.cpp:447
static LSET AllTechMask()
Return a mask holding all technical layers (no CU layer) on both side.
Definition: lset.cpp:820
LSET is a set of PCB_LAYER_IDs.
virtual BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
Definition: board_item.cpp:46
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:190
#define _(s)
Definition: 3d_actions.cpp:33
virtual LSET GetLayerSet() const
Return a std::bitset of all layers on which the item physically resides.
Definition: board_item.h:178

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 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
aSearchDataA reference to a wxFindReplaceData object containing the search criteria.
aAuxDataA 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_COMPONENT, SCH_SHEET, SCH_TEXT, SCH_FIELD, SCH_SHEET_PIN, ZONE, SCH_PIN, SCH_MARKER, PCB_MARKER, FP_TEXT, and PCB_TEXT.

Definition at line 415 of file eda_item.h.

416  {
417  return false;
418  }

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
aTextA reference to a wxString object containing the string to test.
aSearchDataThe criteria to search against.
Returns
True if aText matches the search criteria in aSearchData.

Definition at line 116 of file eda_item.cpp.

117 {
118  wxString text = aText;
119  wxString searchText = aSearchData.GetFindString();
120 
121  // Don't match if searching for replaceable item and the item doesn't support text replace.
122  if( (aSearchData.GetFlags() & FR_SEARCH_REPLACE) && !IsReplaceable() )
123  return false;
124 
125  if( aSearchData.GetFlags() & wxFR_WHOLEWORD )
126  return aText.IsSameAs( searchText, aSearchData.GetFlags() & wxFR_MATCHCASE );
127 
128  if( aSearchData.GetFlags() & FR_MATCH_WILDCARD )
129  {
130  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
131  return text.Matches( searchText );
132 
133  return text.MakeUpper().Matches( searchText.MakeUpper() );
134  }
135 
136  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
137  return aText.Find( searchText ) != wxNOT_FOUND;
138 
139  return text.MakeUpper().Find( searchText.MakeUpper() ) != wxNOT_FOUND;
140 }
virtual bool IsReplaceable() const
Override this method in any derived object that supports test find and replace.
Definition: eda_item.h:453

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

◆ Mirror()

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

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: vertical axis position

Definition at line 258 of file dimension.cpp.

259 {
260  int axis = aMirrorLeftRight ? axis_pos.x : axis_pos.y;
261  wxPoint newPos = m_text.GetTextPos();
262 
263 #define INVERT( pos ) ( ( pos ) = axis - ( ( pos ) - axis ) )
264  if( aMirrorLeftRight )
265  INVERT( newPos.x );
266  else
267  INVERT( newPos.y );
268 
269  m_text.SetTextPos( newPos );
270 
271  // invert angle
273 
274  if( aMirrorLeftRight )
275  {
276  INVERT( m_start.x );
277  INVERT( m_end.x );
278  }
279  else
280  {
281  INVERT( m_start.y );
282  INVERT( m_end.y );
283  }
284 
286 
287  Update();
288 }
void SetMirrored(bool isMirrored)
Definition: eda_text.h:195
bool IsMirrored() const
Definition: eda_text.h:196
void SetTextAngle(double aAngle) override
Definition: pcb_text.cpp:102
void SetTextPos(const wxPoint &aPoint)
Definition: eda_text.h:253
double GetTextAngle() const
Definition: eda_text.h:181
wxPoint m_start
Definition: dimension.h:298
void Update()
Updates the dimension's cached text and geometry.
Definition: dimension.h:146
#define INVERT(pos)
PCB_TEXT m_text
The actual text object.
Definition: dimension.h:296
const wxPoint & GetTextPos() const
Definition: eda_text.h:254
wxPoint m_end
Internal cache of drawn shapes.
Definition: dimension.h:299

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

Referenced by Flip().

◆ Move() [1/2]

void DIMENSION_BASE::Move ( const wxPoint &  aMoveVector)
overridevirtual

Move this object.

Parameters
aMoveVectorthe move vector for this object.

Reimplemented from BOARD_ITEM.

Definition at line 219 of file dimension.cpp.

220 {
221  m_text.Offset( offset );
222 
223  m_start += offset;
224  m_end += offset;
225 
226  Update();
227 }
void Offset(const wxPoint &aOffset)
Definition: eda_text.h:259
wxPoint m_start
Definition: dimension.h:298
void Update()
Updates the dimension's cached text and geometry.
Definition: dimension.h:146
PCB_TEXT m_text
The actual text object.
Definition: dimension.h:296
wxPoint m_end
Internal cache of drawn shapes.
Definition: dimension.h:299

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

◆ Move() [2/2]

void BOARD_ITEM::Move ( const VECTOR2I aMoveVector)
inlineinherited

Definition at line 283 of file board_item.h.

284  {
285  Move( wxPoint( aMoveVector.x, aMoveVector.y ) );
286  }
virtual void Move(const wxPoint &aMoveVector)
Move this object.
Definition: board_item.h:277

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

170 {
171  wxFAIL_MSG( wxString::Format( wxT( "Less than operator not defined for item type %s." ),
172  GetClass() ) );
173 
174  return false;
175 }
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
virtual wxString GetClass() const =0
Return the class name.

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
aSearchDataA reference to a wxFindReplaceData object containing the search and replace criteria.
aTextA reference to a wxString object containing the text to be replaced.
Returns
True if aText was modified, otherwise false.

Definition at line 143 of file eda_item.cpp.

144 {
145  wxString searchString = (aSearchData.GetFlags() & wxFR_MATCHCASE) ? aText : aText.Upper();
146 
147  int result = searchString.Find( (aSearchData.GetFlags() & wxFR_MATCHCASE) ?
148  aSearchData.GetFindString() :
149  aSearchData.GetFindString().Upper() );
150 
151  if( result == wxNOT_FOUND )
152  return false;
153 
154  wxString prefix = aText.Left( result );
155  wxString suffix;
156 
157  if( aSearchData.GetFindString().length() + result < aText.length() )
158  suffix = aText.Right( aText.length() - ( aSearchData.GetFindString().length() + result ) );
159 
160  wxLogTrace( traceFindReplace, wxT( "Replacing '%s', prefix '%s', replace '%s', suffix '%s'." ),
161  aText, prefix, aSearchData.GetReplaceString(), suffix );
162 
163  aText = prefix + aSearchData.GetReplaceString() + suffix;
164 
165  return true;
166 }
const wxChar *const traceFindReplace
Flag to enable find and replace debug tracing.

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
aSearchDataA reference to a wxFindReplaceData object containing the search and replace criteria.
aAuxDataA 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 442 of file eda_item.h.

443  {
444  return false;
445  }

◆ Rotate() [1/2]

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

Rotate this object.

Parameters
aRotCentrethe rotation point.
aAnglethe rotation angle in 0.1 degree.

Reimplemented from BOARD_ITEM.

Reimplemented in ORTHOGONAL_DIMENSION.

Definition at line 230 of file dimension.cpp.

231 {
232  double newAngle = m_text.GetTextAngle() + aAngle;
233 
234  if( newAngle >= 3600 )
235  newAngle -= 3600;
236 
237  m_text.SetTextAngle( newAngle );
238 
239  wxPoint pt = m_text.GetTextPos();
240  RotatePoint( &pt, aRotCentre, aAngle );
241  m_text.SetTextPos( pt );
242 
243  RotatePoint( &m_start, aRotCentre, aAngle );
244  RotatePoint( &m_end, aRotCentre, aAngle );
245 
246  Update();
247 }
void SetTextAngle(double aAngle) override
Definition: pcb_text.cpp:102
void SetTextPos(const wxPoint &aPoint)
Definition: eda_text.h:253
double GetTextAngle() const
Definition: eda_text.h:181
wxPoint m_start
Definition: dimension.h:298
void Update()
Updates the dimension's cached text and geometry.
Definition: dimension.h:146
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:228
PCB_TEXT m_text
The actual text object.
Definition: dimension.h:296
const wxPoint & GetTextPos() const
Definition: eda_text.h:254
wxPoint m_end
Internal cache of drawn shapes.
Definition: dimension.h:299

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

Referenced by ORTHOGONAL_DIMENSION::Rotate().

◆ Rotate() [2/2]

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

Definition at line 299 of file board_item.h.

300  {
301  Rotate( wxPoint( aRotCentre.x, aRotCentre.y ), aAngle );
302  }
virtual void Rotate(const wxPoint &aRotCentre, double aAngle)
Rotate this object.
Definition: board_item.h:294

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

◆ segCircleIntersection()

OPT_VECTOR2I DIMENSION_BASE::segCircleIntersection ( CIRCLE aCircle,
SEG aSeg,
bool  aStart = true 
)
staticprotected

Definition at line 479 of file dimension.cpp.

480 {
481  VECTOR2I start( aStart ? aSeg.A : aSeg.B );
482  VECTOR2I endpoint( aStart ? aSeg.B : aSeg.A );
483 
484  if( aCircle.Contains( start ) )
485  return NULLOPT;
486 
487  std::vector<VECTOR2I> intersections = aCircle.Intersect( aSeg );
488 
489  for( VECTOR2I& intersection : aCircle.Intersect( aSeg ) )
490  {
491  if( ( intersection - start ).SquaredEuclideanNorm() <
492  ( endpoint - start ).SquaredEuclideanNorm() )
493  endpoint = intersection;
494  }
495 
496  if( start == endpoint )
497  return NULLOPT;
498 
499  return OPT_VECTOR2I( endpoint );
500 }
const auto NULLOPT
Definition: optional.h:9
OPT< VECTOR2I > OPT_VECTOR2I
Definition: seg.h:39
bool Contains(const VECTOR2I &aP)
Function Contains()
Definition: circle.cpp:341
std::vector< VECTOR2I > Intersect(const CIRCLE &aCircle) const
Function Intersect()
Definition: circle.cpp:200
VECTOR2I A
Definition: seg.h:49
VECTOR2I B
Definition: seg.h:50

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

Referenced by LEADER::updateGeometry().

◆ segPolyIntersection()

OPT_VECTOR2I DIMENSION_BASE::segPolyIntersection ( const SHAPE_POLY_SET aPoly,
const SEG aSeg,
bool  aStart = true 
)
staticprotected

Finds the intersection between a given segment and polygon outline.

Parameters
aPolyis the polygon to collide
aSegis the segment to collide
aStartif 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 dimension.cpp.

456 {
457  VECTOR2I start( aStart ? aSeg.A : aSeg.B );
458  VECTOR2I endpoint( aStart ? aSeg.B : aSeg.A );
459 
460  if( aPoly.Contains( start ) )
461  return NULLOPT;
462 
463  for( SHAPE_POLY_SET::CONST_SEGMENT_ITERATOR seg = aPoly.CIterateSegments(); seg; ++seg )
464  {
465  if( OPT_VECTOR2I intersection = ( *seg ).Intersect( aSeg ) )
466  {
467  if( ( *intersection - start ).SquaredEuclideanNorm() <
468  ( endpoint - start ).SquaredEuclideanNorm() )
469  endpoint = *intersection;
470  }
471  }
472  if( start == endpoint )
473  return NULLOPT;
474 
475  return OPT_VECTOR2I( endpoint );
476 }
Base class for iterating over all segments in a given SHAPE_POLY_SET.
bool Contains(const VECTOR2I &aP, int aSubpolyIndex=-1, int aAccuracy=0, bool aUseBBoxCaches=false) const
Return true if a given subpolygon contains the point aP.
const auto NULLOPT
Definition: optional.h:9
OPT< VECTOR2I > OPT_VECTOR2I
Definition: seg.h:39
VECTOR2I A
Definition: seg.h:49
CONST_SEGMENT_ITERATOR CIterateSegments(int aFirst, int aLast, bool aIterateHoles=false) const
Return an iterator object, for iterating aPolygonIdx-th polygon edges.
VECTOR2I B
Definition: seg.h:50

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

Referenced by ALIGNED_DIMENSION::updateGeometry(), ORTHOGONAL_DIMENSION::updateGeometry(), and LEADER::updateGeometry().

◆ Set() [1/3]

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

Definition at line 42 of file inspectable.h.

43  {
45  TYPE_ID thisType = TYPE_HASH( *this );
46  void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
47 
48  if( object )
49  aProperty->setter( object, aValue );
50 
51  return object != nullptr;
52  }
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:65
#define TYPE_HASH(x)
Definition: property.h:59
size_t TYPE_ID
Unique type identifier.
Definition: property_mgr.h:42
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Cast a type to another type.
virtual void setter(void *aObject, wxAny &aValue)=0
Provide class metadata.Helper macro to map type hashes to names.
Definition: property_mgr.h:62
virtual size_t OwnerHash() const =0
Return type-id of the Owner class.

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,
aValue 
)
inlineinherited

Definition at line 55 of file inspectable.h.

56  {
58  TYPE_ID thisType = TYPE_HASH( *this );
59  void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
60 
61  if( object )
62  aProperty->set<T>( object, aValue );
63 
64  return object != nullptr;
65  }
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:65
#define TYPE_HASH(x)
Definition: property.h:59
size_t TYPE_ID
Unique type identifier.
Definition: property_mgr.h:42
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Cast a type to another type.
Provide class metadata.Helper macro to map type hashes to names.
Definition: property_mgr.h:62
void set(void *aObject, T aValue)
Definition: property.h:261
virtual size_t OwnerHash() const =0
Return type-id of the Owner class.

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,
aValue 
)
inlineinherited

Definition at line 68 of file inspectable.h.

69  {
71  TYPE_ID thisType = TYPE_HASH( *this );
72  PROPERTY_BASE* prop = propMgr.GetProperty( thisType, aProperty );
73  void* object = nullptr;
74 
75  if( prop )
76  {
77  object = propMgr.TypeCast( this, thisType, prop->OwnerHash() );
78 
79  if( object )
80  prop->set<T>( object, aValue );
81  }
82 
83  return object != nullptr;
84  }
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:65
#define TYPE_HASH(x)
Definition: property.h:59
size_t TYPE_ID
Unique type identifier.
Definition: property_mgr.h:42
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Cast a type to another type.
PROPERTY_BASE * GetProperty(TYPE_ID aType, const wxString &aProperty) const
Return a property for a specific type.
Provide class metadata.Helper macro to map type hashes to names.
Definition: property_mgr.h:62
void set(void *aObject, T aValue)
Definition: property.h:261
virtual size_t OwnerHash() const =0
Return type-id of the Owner class.

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

◆ SetArrowLength()

void DIMENSION_BASE::SetArrowLength ( int  aLength)
inline

Definition at line 182 of file dimension.h.

182 { m_arrowLength = aLength; }
int m_arrowLength
Length of arrow shapes.
Definition: dimension.h:290

References m_arrowLength.

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

◆ SetAutoUnits()

void DIMENSION_BASE::SetAutoUnits ( bool  aAuto = true)
inline

Definition at line 164 of file dimension.h.

164 { m_autoUnits = aAuto; }
bool m_autoUnits
If true, follow the currently selected UI units.
Definition: dimension.h:283

References m_autoUnits.

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )
inlineinherited

◆ SetEnd()

◆ SetExtensionOffset()

void DIMENSION_BASE::SetExtensionOffset ( int  aOffset)
inline

◆ SetFlags()

void EDA_ITEM::SetFlags ( STATUS_FLAGS  aMask)
inlineinherited

Definition at line 203 of file eda_item.h.

203 { m_flags |= aMask; }
STATUS_FLAGS m_flags
Definition: eda_item.h:531

References EDA_ITEM::m_flags.

Referenced by SCH_EAGLE_PLUGIN::addBusEntries(), PCB_BASE_FRAME::AddFootprintToBoard(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), SCH_MOVE_TOOL::AlignElements(), PCB_CONTROL::AppendBoard(), FOOTPRINT::BuildPolyCourtyards(), SCH_EDIT_TOOL::ChangeTextType(), GRAPHICS_CLEANER::cleanupSegments(), ConvertOutlineToPolygon(), SCH_EDIT_FRAME::ConvertPart(), SCH_DRAWING_TOOLS::createNewText(), SCH_DRAWING_TOOLS::createSheetPin(), SCH_EDIT_TOOL::DoDelete(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), EDIT_TOOL::DragArcTrack(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_EDIT_TOOL::Duplicate(), PCB_SELECTION_TOOL::EnterGroup(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), SCH_MOVE_TOOL::getConnectedDragItems(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), EE_SELECTION_TOOL::Main(), TRACKS_CLEANER::mergeCollinearSegments(), SYMBOL_EDITOR_MOVE_TOOL::moveItem(), SCH_MOVE_TOOL::moveItem(), EE_SELECTION_TOOL::narrowSelection(), KIGFX::ORIGIN_VIEWITEM::ORIGIN_VIEWITEM(), SCH_ALTIUM_PLUGIN::ParseBezier(), SCH_ALTIUM_PLUGIN::ParseBus(), SCH_ALTIUM_PLUGIN::ParseBusEntry(), SCH_ALTIUM_PLUGIN::ParseJunction(), SCH_ALTIUM_PLUGIN::ParseLine(), SCH_ALTIUM_PLUGIN::ParseNetLabel(), SCH_ALTIUM_PLUGIN::ParseNoERC(), SCH_ALTIUM_PLUGIN::ParsePolygon(), SCH_ALTIUM_PLUGIN::ParsePolyline(), SCH_ALTIUM_PLUGIN::ParsePort(), SCH_ALTIUM_PLUGIN::ParseRectangle(), SCH_ALTIUM_PLUGIN::ParseRoundRectangle(), SCH_ALTIUM_PLUGIN::ParseSheetSymbol(), SCH_ALTIUM_PLUGIN::ParseWire(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), SCH_EDITOR_CONTROL::Paste(), BOARD_EDITOR_CONTROL::PlaceFootprint(), PL_DRAWING_TOOLS::PlaceItem(), DRAWING_TOOL::PlaceText(), BACK_ANNOTATE::processNetNameChange(), SCH_EDIT_FRAME::PutDataInPreviousState(), PCB_SELECTION_TOOL::RebuildSelection(), FOOTPRINT::Remove(), BOARD::Remove(), SCH_EDIT_TOOL::RepeatDrawItem(), SYMBOL_EDIT_FRAME::SaveCopyInUndoList(), EE_SELECTION_TOOL::selectMultiple(), SCH_EDIT_FRAME::SelectUnit(), EDA_ITEM::SetBrightened(), EDA_ITEM::SetModified(), EDA_ITEM::SetSelected(), EDA_ITEM::SetWireImage(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), DS_DATA_ITEM::SyncDrawItems(), DS_DATA_ITEM_BITMAP::SyncDrawItems(), DIALOG_DIMENSION_PROPERTIES::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ 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
aEnableTrue 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 254 of file eda_item.h.

254 { m_forceVisible = aEnable; }
bool m_forceVisible
Definition: eda_item.h:530

References EDA_ITEM::m_forceVisible.

Referenced by SCH_EDITOR_CONTROL::UpdateFind().

◆ SetKeepTextAligned()

void DIMENSION_BASE::SetKeepTextAligned ( bool  aKeepAligned)
inline

Definition at line 176 of file dimension.h.

176 { m_keepTextAligned = aKeepAligned; }
bool m_keepTextAligned
Calculate text orientation to match dimension.
Definition: dimension.h:293

References m_keepTextAligned.

Referenced by DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ SetLayer()

void DIMENSION_BASE::SetLayer ( PCB_LAYER_ID  aLayer)
overridevirtual

Set the layer this item is on.

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

Parameters
aLayerThe layer number.

Reimplemented from BOARD_ITEM.

Definition at line 212 of file dimension.cpp.

213 {
214  m_layer = aLayer;
215  m_text.SetLayer( aLayer );
216 }
virtual void SetLayer(PCB_LAYER_ID aLayer)
Set the layer this item is on.
Definition: board_item.h:194
PCB_TEXT m_text
The actual text object.
Definition: dimension.h:296
PCB_LAYER_ID m_layer
Definition: board_item.h:363

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

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::applyDimensionSettings(), DRAWING_TOOL::DrawDimension(), 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 VIA, PAD, and ZONE.

Definition at line 179 of file board_item.h.

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

Referenced by PANEL_SETUP_LAYERS::TransferDataFromWindow().

◆ SetLineThickness()

◆ SetLocked()

◆ SetModified()

void EDA_ITEM::SetModified ( )
inherited

◆ SetOverrideText()

void DIMENSION_BASE::SetOverrideText ( const wxString &  aValue)
inline

Definition at line 134 of file dimension.h.

134 { m_valueString = aValue; }
wxString m_valueString
Displayed value when m_overrideValue = true.
Definition: dimension.h:279

References m_valueString.

Referenced by DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ SetOverrideTextEnabled()

void DIMENSION_BASE::SetOverrideTextEnabled ( bool  aOverride)
inline

Definition at line 131 of file dimension.h.

131 { m_overrideTextEnabled = aOverride; }
bool m_overrideTextEnabled
Manually specify the displayed measurement value.
Definition: dimension.h:278

References m_overrideTextEnabled.

Referenced by DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ SetParent()

void DIMENSION_BASE::SetParent ( EDA_ITEM aParent)
overridevirtual

Reimplemented from EDA_ITEM.

Definition at line 61 of file dimension.cpp.

62 {
63  BOARD_ITEM::SetParent( aParent );
64  m_text.SetParent( aParent );
65 }
virtual void SetParent(EDA_ITEM *aParent)
Definition: eda_item.h:166
PCB_TEXT m_text
The actual text object.
Definition: dimension.h:296

References 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 92 of file board_item.h.

92 { m_group = aGroup; }
PCB_GROUP * m_group
Definition: board_item.h:364

References BOARD_ITEM::m_group.

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

◆ SetPosition()

void DIMENSION_BASE::SetPosition ( const wxPoint &  aPos)
inlineoverridevirtual

Reimplemented from EDA_ITEM.

Definition at line 128 of file dimension.h.

128 { m_start = aPos; }
wxPoint m_start
Definition: dimension.h:298

References m_start.

◆ SetPrecision()

void DIMENSION_BASE::SetPrecision ( int  aPrecision)
inline

◆ SetPrefix()

void DIMENSION_BASE::SetPrefix ( const wxString &  aPrefix)

Definition at line 132 of file dimension.cpp.

133 {
134  m_prefix = aPrefix;
135 }
wxString m_prefix
String prepended to the value.
Definition: dimension.h:280

References m_prefix.

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

◆ SetSelected()

◆ SetStart()

◆ SetState()

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

Definition at line 192 of file eda_item.h.

193  {
194  if( state )
195  m_status |= type; // state = ON or OFF
196  else
197  m_status &= ~type;
198  }
STATUS_FLAGS m_status
Definition: eda_item.h:528

References EDA_ITEM::m_status.

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

◆ SetStatus()

void EDA_ITEM::SetStatus ( STATUS_FLAGS  aStatus)
inlineinherited

Definition at line 201 of file eda_item.h.

201 { m_status = aStatus; }
STATUS_FLAGS m_status
Definition: eda_item.h:528

References EDA_ITEM::m_status.

Referenced by BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ SetSuffix()

void DIMENSION_BASE::SetSuffix ( const wxString &  aSuffix)

Definition at line 138 of file dimension.cpp.

139 {
140  m_suffix = aSuffix;
141 }
wxString m_suffix
String appended to the value.
Definition: dimension.h:281

References m_suffix.

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

◆ SetSuppressZeroes()

void DIMENSION_BASE::SetSuppressZeroes ( bool  aSuppress)
inline

Definition at line 173 of file dimension.h.

173 { m_suppressZeroes = aSuppress; }
bool m_suppressZeroes
Suppress trailing zeroes.
Definition: dimension.h:286

References m_suppressZeroes.

Referenced by DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ SetText()

void DIMENSION_BASE::SetText ( const wxString &  aNewText)

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

Parameters
aNewTextis the text to use as the value

Definition at line 199 of file dimension.cpp.

200 {
201  m_valueString = aNewText;
202  updateText();
203 }
wxString m_valueString
Displayed value when m_overrideValue = true.
Definition: dimension.h:279
virtual void updateText()
Updates the text field value from the current geometry (called by updateGeometry normally)
Definition: dimension.cpp:68

References m_valueString, and updateText().

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

◆ SetTextPositionMode()

void DIMENSION_BASE::SetTextPositionMode ( DIM_TEXT_POSITION  aMode)
inline

Definition at line 178 of file dimension.h.

178 { m_textPosition = aMode; }
DIM_TEXT_POSITION m_textPosition
How to position the text.
Definition: dimension.h:292

References m_textPosition.

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

◆ SetTextSize()

void DIMENSION_BASE::SetTextSize ( const wxSize &  aTextSize)
inline

Definition at line 192 of file dimension.h.

193  {
194  m_text.SetTextSize( aTextSize );
195  }
void SetTextSize(const wxSize &aNewSize)
Definition: eda_text.h:244
PCB_TEXT m_text
The actual text object.
Definition: dimension.h:296

References m_text, and EDA_TEXT::SetTextSize().

◆ SetUnits()

void DIMENSION_BASE::SetUnits ( EDA_UNITS  aUnits)

◆ SetUnitsFormat()

void DIMENSION_BASE::SetUnitsFormat ( const DIM_UNITS_FORMAT  aFormat)
inline

Definition at line 167 of file dimension.h.

167 { m_unitsFormat = aFormat; }
DIM_UNITS_FORMAT m_unitsFormat
How to render the units suffix.
Definition: dimension.h:284

References m_unitsFormat.

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

◆ SetUnitsMode()

void DIMENSION_BASE::SetUnitsMode ( DIM_UNITS_MODE  aMode)

Definition at line 174 of file dimension.cpp.

175 {
176  m_autoUnits = false;
177 
178  switch( aMode )
179  {
182  break;
183 
186  break;
187 
190  break;
191 
193  m_autoUnits = true;
194  break;
195  }
196 }
bool m_autoUnits
If true, follow the currently selected UI units.
Definition: dimension.h:283
EDA_UNITS m_units
0 = inches, 1 = mm
Definition: dimension.h:282

References AUTOMATIC, INCHES, m_autoUnits, 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 178 of file eda_item.h.

178 { SetFlags( IS_WIRE_IMAGE ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: eda_item.h:203
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: eda_item.h:111

References IS_WIRE_IMAGE, and EDA_ITEM::SetFlags().

◆ SetX()

void BOARD_ITEM::SetX ( int  aX)
inlineinherited

Definition at line 119 of file board_item.h.

120  {
121  wxPoint p( aX, GetY() );
122  SetPosition( p );
123  }
virtual void SetPosition(const wxPoint &aPos)
Definition: eda_item.h:303
int GetY() const
Definition: board_item.h:103

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 125 of file board_item.h.

126  {
127  wxPoint p( GetX(), aY );
128  SetPosition( p );
129  }
virtual void SetPosition(const wxPoint &aPos)
Definition: eda_item.h:303
int GetX() const
Definition: board_item.h:97

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 ( PCB_SHAPE_TYPE  aShape)
staticinherited

Convert the enum #PCB_SHAPE_TYPE_T integer value to a wxString.

Definition at line 31 of file board_item.cpp.

32 {
33  switch( aShape )
34  {
35  case PCB_SHAPE_TYPE::SEGMENT: return _( "Line" );
36  case PCB_SHAPE_TYPE::RECT: return _( "Rect" );
37  case PCB_SHAPE_TYPE::ARC: return _( "Arc" );
38  case PCB_SHAPE_TYPE::CIRCLE: return _( "Circle" );
39  case PCB_SHAPE_TYPE::CURVE: return _( "Bezier Curve" );
40  case PCB_SHAPE_TYPE::POLYGON: return _( "Polygon" );
41  default: return wxT( "??" );
42  }
43 }
polygon (not yet used for tracks, but could be in microwave apps)
segment with non rounded ends
#define _(s)
Definition: 3d_actions.cpp:33
usual segment : line with rounded ends
Arcs (with rounded ends)

References _, ARC, CIRCLE, CURVE, POLYGON, 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
aLeftThe left hand item to compare.
aRightThe right hand item to compare.
Returns
True if aLeft is less than aRight.

Definition at line 471 of file eda_item.h.

471 { return *aLeft < *aRight; }

◆ SwapData()

void BOARD_ITEM::SwapData ( BOARD_ITEM aImage)
virtualinherited

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
aImagethe item image which contains data to swap.

Reimplemented in ZONE, PAD, FOOTPRINT, CENTER_DIMENSION, VIA, LEADER, ORTHOGONAL_DIMENSION, ALIGNED_DIMENSION, PCB_SHAPE, ARC, TRACK, PCB_GROUP, PCB_TEXT, and PCB_TARGET.

Definition at line 124 of file board_item.cpp.

125 {
126 }

Referenced by BOARD_COMMIT::Revert(), and SwapItemData().

◆ Text() [1/2]

◆ Text() [2/2]

const PCB_TEXT& DIMENSION_BASE::Text ( ) const
inline

Definition at line 210 of file dimension.h.

210 { return m_text; }
PCB_TEXT m_text
The actual text object.
Definition: dimension.h:296

References m_text.

◆ TransformShapeWithClearanceToPolygon()

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

Convert the item shape to a closed polygon.

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

Parameters
aCornerBuffera buffer to store the polygon.
aClearanceValuethe clearance around the pad.
aErrorthe maximum deviation from true circle.
aErrorLocshould the approximation error be placed outside or inside the polygon?
ignoreLineWidthused for edge cut items where the line width is only for visualization.

Reimplemented from BOARD_ITEM.

Definition at line 776 of file board_items_to_polygon_shape_transform.cpp.

780 {
781  wxASSERT_MSG( !aIgnoreLineWidth, "IgnoreLineWidth has no meaning for dimensions." );
782 
783  for( const std::shared_ptr<SHAPE>& shape : m_shapes )
784  {
785  const SHAPE_CIRCLE* circle = dynamic_cast<const SHAPE_CIRCLE*>( shape.get() );
786  const SHAPE_SEGMENT* seg = dynamic_cast<const SHAPE_SEGMENT*>( shape.get() );
787 
788  if( circle )
789  {
790  TransformCircleToPolygon( aCornerBuffer, (wxPoint) circle->GetCenter(),
791  circle->GetRadius() + m_lineThickness / 2 + aClearance,
792  aError, aErrorLoc );
793  }
794  else if( seg )
795  {
796  TransformOvalToPolygon( aCornerBuffer, (wxPoint) seg->GetSeg().A,
797  (wxPoint) seg->GetSeg().B, m_lineThickness + 2 * aClearance,
798  aError, aErrorLoc );
799  }
800  else
801  {
802  wxFAIL_MSG( "DIMENSION::TransformShapeWithClearanceToPolygon unexpected shape type." );
803  }
804  }
805 }
int GetRadius() const
Definition: shape_circle.h:107
const VECTOR2I GetCenter() const
Definition: shape_circle.h:112
void TransformOvalToPolygon(SHAPE_POLY_SET &aCornerBuffer, wxPoint aStart, wxPoint aEnd, int aWidth, int aError, ERROR_LOC aErrorLoc)
convert a oblong shape to a polygon, using multiple segments It is similar to TransformRoundedEndsSeg...
std::vector< std::shared_ptr< SHAPE > > m_shapes
Definition: dimension.h:302
void TransformCircleToPolygon(SHAPE_LINE_CHAIN &aCornerBuffer, wxPoint aCenter, int aRadius, int aError, ERROR_LOC aErrorLoc)
Function TransformCircleToPolygon convert a circle to a polygon, using multiple straight lines.
int m_lineThickness
Thickness used for all graphics in the dimension.
Definition: dimension.h:289

References SHAPE_CIRCLE::GetCenter(), SHAPE_CIRCLE::GetRadius(), m_lineThickness, 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 163 of file eda_item.h.

163 { return 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:538

References EDA_ITEM::m_structType.

Referenced by KIGFX::PCB_VIEW::Add(), FOOTPRINT::Add(), CN_CONNECTIVITY_ALGO::Add(), BOARD::Add(), CN_CLUSTER::Add(), PCB_POINT_EDITOR::addCorner(), CONNECTION_SUBGRAPH::AddItem(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_LINE_WIRE_BUS_TOOL::AddJunctionsIfNeeded(), ZONE_FILLER::addKnockout(), SCH_SHEET::AddPin(), ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), CN_ITEM::AnchorCount(), SCH_SCREEN::Append(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), PNS::TOPOLOGY::AssembleTuningPath(), CONNECTION_GRAPH::buildConnectionGraph(), DIALOG_NET_INSPECTOR::buildNewItem(), SCH_SCREENS::buildScreenList(), BOARD_INSPECTION_TOOL::calculateSelectionRatsnest(), PCB_POINT_EDITOR::canAddCorner(), SCH_JUNCTION::CanConnect(), SCH_NO_CONNECT::CanConnect(), SCH_BUS_WIRE_ENTRY::CanConnect(), SCH_BUS_BUS_ENTRY::CanConnect(), SCH_LINE::CanConnect(), SCH_SHEET::CanConnect(), SCH_LABEL::CanConnect(), SCH_GLOBALLABEL::CanConnect(), SCH_HIERLABEL::CanConnect(), SCH_COMPONENT::CanConnect(), CN_VISITOR::checkZoneItemConnection(), SCH_MARKER::ClassOf(), SCH_JUNCTION::ClassOf(), SCH_PIN::ClassOf(), PCB_TEXT::ClassOf(), PCB_MARKER::ClassOf(), SCH_NO_CONNECT::ClassOf(), BOARD_CONNECTED_ITEM::ClassOf(), FP_SHAPE::ClassOf(), SCH_LINE::ClassOf(), PCB_GROUP::ClassOf(), PCB_TARGET::ClassOf(), SCH_FIELD::ClassOf(), FP_TEXT::ClassOf(), SCH_SHEET::ClassOf(), NETINFO_ITEM::ClassOf(), PCB_SHAPE::ClassOf(), SCH_SHEET_PIN::ClassOf(), ZONE::ClassOf(), SCH_BITMAP::ClassOf(), PAD::ClassOf(), TRACK::ClassOf(), SCH_COMPONENT::ClassOf(), SCH_SCREEN::ClassOf(), FOOTPRINT::ClassOf(), SCH_BUS_WIRE_ENTRY::ClassOf(), SCH_TEXT::ClassOf(), SCH_BUS_BUS_ENTRY::ClassOf(), BOARD::ClassOf(), ARC::ClassOf(), SCH_LABEL::ClassOf(), VIA::ClassOf(), ALIGNED_DIMENSION::ClassOf(), SCH_GLOBALLABEL::ClassOf(), ORTHOGONAL_DIMENSION::ClassOf(), LEADER::ClassOf(), SCH_HIERLABEL::ClassOf(), CENTER_DIMENSION::ClassOf(), TRACKS_CLEANER::cleanup(), LIB_BEZIER::compare(), LIB_RECTANGLE::compare(), LIB_CIRCLE::compare(), LIB_POLYLINE::compare(), LIB_TEXT::compare(), LIB_ARC::compare(), LIB_FIELD::compare(), LIB_PIN::compare(), LIB_ITEM::compare(), LIB_PART::Compare(), EE_GRID_HELPER::computeAnchors(), PCB_GRID_HELPER::computeAnchors(), SCH_BUS_WIRE_ENTRY::ConnectionPropagatesTo(), EE_RTREE::contains(), BOARD::ConvertKIIDsToCrossReferences(), SCHEMATIC::ConvertKIIDsToRefs(), PAD_TOOL::copyPadSettings(), EDIT_TOOL::copyToClipboard(), FOOTPRINT::CoverageRatio(), BOARD_ADAPTER::createLayers(), PCB_BASE_FRAME::CreateNewFootprint(), SCH_DRAWING_TOOLS::createNewText(), ZONE_CREATE_HELPER::createNewZone(), BOARD_ADAPTER::createTrack(), SCH_SCREEN::DeleteItem(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_SCH_EDIT_ONE_FIELD::DIALOG_SCH_EDIT_ONE_FIELD(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), ALIGN_DISTRIBUTE_TOOL::DistributeHorizontally(), ALIGN_DISTRIBUTE_TOOL::DistributeVertically(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), SCH_EDITOR_CONTROL::doCopy(), SCH_EDIT_TOOL::DoDelete(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), APPEARANCE_CONTROLS::doesBoardItemNeedRebuild(), EDIT_TOOL::doMoveSelection(), EDIT_TOOL::Drag(), EDIT_TOOL::DragArcTrack(), KIGFX::SCH_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::Draw(), KIGFX::PCB_PAINTER::Draw(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawVia(), CONNECTION_SUBGRAPH::driverName(), CN_ITEM::Dump(), EDIT_TOOL::Duplicate(), FOOTPRINT::DuplicateItem(), EDA_ITEM_DESC::EDA_ITEM_DESC(), SCH_EDIT_TOOL::EditField(), SCH_EDIT_TOOL::editFieldText(), SYMBOL_EDITOR_EDIT_TOOL::editTextProperties(), CONNECTION_GRAPH::ercCheckBusToBusEntryConflicts(), CONNECTION_GRAPH::ercCheckBusToNetConflicts(), CONNECTION_GRAPH::ercCheckFloatingWires(), CONNECTION_GRAPH::ercCheckMultipleDrivers(), CONNECTION_GRAPH::ercCheckNoConnects(), DRC_ENGINE::EvalRules(), EDIT_TOOL::FilletTracks(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), NETLIST_EXPORTER_BASE::findNextSymbol(), CADSTAR_ARCHIVE_PARSER::FixTextPositionNoAlignment(), PCB_BASE_FRAME::FocusOnItem(), EDIT_TOOL::FootprintFilter(), SCH_SEXPR_PLUGIN::Format(), SCH_LEGACY_PLUGIN::Format(), PCB_IO::Format(), PCB_IO::format(), FormatProbeItem(), FP_TEXT::FP_TEXT(), PCB_POINT_EDITOR::get45DegConstrainer(), CN_ITEM::GetAnchor(), BOARD_ITEM::GetBoard(), SCH_FIELD::GetBoundingBox(), TRACK::GetBoundingBox(), SCH_FIELD::GetCanonicalName(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_TEXT::GetConnectionPoints(), SCH_TEXT::GetContextualTextVars(), FOOTPRINT::GetCoverageArea(), CONNECTION_GRAPH::getDefaultConnection(), getDrilledHoleShape(), CONNECTION_SUBGRAPH::GetDriverPriority(), SCH_TEXT::GetEndPoints(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), SCH_FIELD::GetMenuImage(), TRACK::GetMsgPanelInfo(), GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_FIELD::GetName(), CONNECTIVITY_DATA::GetNetItems(), LIB_PART::GetNextDrawItem(), PCB_SHAPE::GetParentFootprint(), LIB_PART::GetPin(), SCH_COMPONENT::GetPinPhysicalPosition(), SCH_FIELD::GetPosition(), KIGFX::SCH_PAINTER::getRenderColor(), ALIGN_DISTRIBUTE_TOOL::GetSelections(), TRACK::GetSelectMenuText(), DRC_ENGINE::GetShape(), PCB_TEXT::GetShownText(), SCH_FIELD::GetShownText(), SCH_TEXT::GetShownText(), CONVERT_TOOL::getStartEndPoints(), getTopLevelGroup(), GROUP_TOOL::Group(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), EE_SELECTION_TOOL::GuessSelectionCandidates(), hash_fp_item(), EE_SELECTION_TOOL::highlight(), PCB_SELECTION_TOOL::highlightInternal(), BOARD_INSPECTION_TOOL::HighlightItem(), BOARD_INSPECTION_TOOL::highlightNet(), highlightNet(), PCB_SELECTION_TOOL::hitTestDistance(), SCH_EDIT_TOOL::Init(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), EE_RTREE::insert(), DRC_RTREE::Insert(), insideArea(), insideBackCourtyard(), insideCourtyard(), insideFootprintCourtyard(), insideFrontCourtyard(), EE_COLLECTOR::Inspect(), GENERAL_COLLECTOR::Inspect(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), ARRAY_CREATOR::Invoke(), isCopper(), CN_ANCHOR::IsDangling(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus(), PNS_KICAD_IFACE::IsFlashedOnLayer(), CADSTAR_PCB_ARCHIVE_LOADER::isFootprint(), SCH_FIELD::IsHypertext(), isKeepoutZone(), DRC_ENGINE::IsNetTie(), TRACK::IsNull(), SCH_LINE::IsParallel(), isPlated(), SCH_FIELD::IsReplaceable(), PNS::ROUTER::isStartingPointRoutable(), BOARD_ITEM::IsTrack(), itemIsIncludedByFilter(), PCB_SELECTION_TOOL::itemPassesFilter(), CONVERT_TOOL::LinesToPoly(), CLIPBOARD_IO::Load(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), CADSTAR_SCH_ARCHIVE_LOADER::loadHierarchicalSheetPins(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), EE_POINT_EDITOR::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), SCH_MOVE_TOOL::Main(), EE_SELECTION_TOOL::Main(), EDIT_POINTS_FACTORY::Make(), NETLIST_EXPORTER_XML::makeListOfNets(), PCB_POINT_EDITOR::makePoints(), SCH_SCREEN::MarkConnections(), CN_CONNECTIVITY_ALGO::markItemNetAsDirty(), CONNECTIVITY_DATA::MarkItemNetAsDirty(), SCH_FIELD::Matches(), memberOf(), SCH_LINE::MergeOverlap(), SCH_EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), SCH_MOVE_TOOL::moveItem(), SCH_EDITOR_CONTROL::nextMatch(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), PCB_EDIT_FRAME::OnEditItemRequest(), EDA_3D_CANVAS::OnMouseMove(), TRACK::cmp_tracks::operator()(), CN_VISITOR::operator()(), BOARD_ITEM::ptr_cmp::operator()(), PCB_SHAPE::cmp_drawings::operator()(), FOOTPRINT::cmp_drawings::operator()(), SCH_BUS_ENTRY_BASE::operator<(), SCH_JUNCTION::operator<(), SCH_FIELD::operator<(), SCH_LINE::operator<(), SCH_TEXT::operator<(), SCH_SHEET::operator<(), SCH_ITEM::operator<(), SCH_COMPONENT::operator<(), SCH_BITMAP::operator=(), SCH_SHEET::operator=(), SCH_COMPONENT::operator=(), PAD::PAD(), EDIT_TOOL::PadFilter(), BOARD_COMMIT::parentObject(), PCB_CONTROL::Paste(), SCH_EDITOR_CONTROL::Paste(), DRAWING_TOOL::PlaceImportedGraphics(), SCH_FIELD::Plot(), SCH_SCREEN::Plot(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), CONVERT_TOOL::PolyToLines(), POSITION_RELATIVE_TOOL::PositionRelative(), SCH_FIELD::Print(), SCH_SCREEN::Print(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::processItem(), BACK_ANNOTATE::processNetNameChange(), SYMBOL_EDITOR_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Properties(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_FRAME::PutDataInPreviousState(), PCB_GRID_HELPER::queryVisible(), SCH_CONNECTION::recacheName(), SCH_BASE_FRAME::RefreshSelection(), KIGFX::PCB_VIEW::Remove(), EE_RTREE::remove(), FOOTPRINT::Remove(), CN_CONNECTIVITY_ALGO::Remove(), SCH_SCREEN::Remove(), BOARD::Remove(), PCB_POINT_EDITOR::removeCorner(), PCB_POINT_EDITOR::removeCornerCondition(), LIB_PART::RemoveDrawItem(), SCH_SHEET::RemovePin(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_FIELD::Replace(), PCB_SELECTION_TOOL::RequestSelection(), SCHEMATIC::ResolveCrossReference(), PCB_PARSER::resolveGroups(), DS_PROXY_UNDO_ITEM::Restore(), PL_EDITOR_FRAME::RollbackFromUndo(), SCH_EDIT_TOOL::Rotate(), DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal(), SCH_SEXPR_PLUGIN_CACHE::saveArc(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), SCH_SEXPR_PLUGIN_CACHE::saveBezier(), SCH_LEGACY_PLUGIN_CACHE::saveBezier(), SCH_SEXPR_PLUGIN_CACHE::saveCircle(), SCH_LEGACY_PLUGIN_CACHE::saveCircle(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList(), SCH_SEXPR_PLUGIN::saveField(), SCH_SEXPR_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_SEXPR_PLUGIN_CACHE::savePin(), SCH_LEGACY_PLUGIN_CACHE::savePin(), SCH_SEXPR_PLUGIN_CACHE::savePolyLine(), SCH_LEGACY_PLUGIN_CACHE::savePolyLine(), SCH_SEXPR_PLUGIN_CACHE::saveRectangle(), SCH_LEGACY_PLUGIN_CACHE::saveRectangle(), CLIPBOARD_IO::SaveSelection(), SCH_SEXPR_PLUGIN_CACHE::saveSymbolDrawItem(), SCH_SEXPR_PLUGIN::saveText(), SCH_SEXPR_PLUGIN_CACHE::saveText(), SCH_LEGACY_PLUGIN_CACHE::saveText(), SCH_SCREEN::Schematic(), SCH_ITEM::Schematic(), CONVERT_TOOL::SegmentToArc(), PCB_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::Selectable(), EE_SELECTION_TOOL::Selectable(), PCB_SELECTION_TOOL::selectConnectedTracks(), SCH_FIELD::SetId(), ITEM_PICKER::SetItem(), SCH_FIELD::SetPosition(), DIALOG_LABEL_EDITOR::SetTitle(), PCB_EDIT_FRAME::SetTrackSegmentWidth(), BOARD_COMMIT::Stage(), SCH_JUNCTION::SwapData(), SCH_NO_CONNECT::SwapData(), SCH_BITMAP::SwapData(), PCB_TARGET::SwapData(), SCH_SHEET_PIN::SwapData(), SCH_FIELD::SwapData(), PCB_TEXT::SwapData(), PCB_GROUP::SwapData(), TRACK::SwapData(), SCH_SHEET::SwapData(), ARC::SwapData(), ALIGNED_DIMENSION::SwapData(), ORTHOGONAL_DIMENSION::SwapData(), SCH_COMPONENT::SwapData(), LEADER::SwapData(), VIA::SwapData(), CENTER_DIMENSION::SwapData(), FOOTPRINT::SwapData(), PAD::SwapData(), ZONE::SwapData(), SwapItemData(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZones(), ERC_TESTER::TestMultUnitPinConflicts(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), ERC_TESTER::TestPinToPin(), ERC_TESTER::TestSimilarLabels(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackAgainstItem(), CONNECTIVITY_DATA::TestTrackEndpointDangling(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_FIELDS_EDITOR_GLOBAL::TransferDataToWindow(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LABEL_EDITOR::TransferDataToWindow(), TRACK::TransformShapeWithClearanceToPolygon(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), EE_SELECTION_TOOL::unhighlight(), PCB_SELECTION_TOOL::unhighlightInternal(), KIGFX::PCB_VIEW::Update(), SCH_TEXT::UpdateDanglingState(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), DIALOG_SCH_EDIT_ONE_FIELD::UpdateField(), PL_POINT_EDITOR::updateItem(), PCB_POINT_EDITOR::updateItem(), EE_TOOL_BASE< SCH_BASE_FRAME >::updateItem(), SCH_BASE_FRAME::UpdateItem(), CONNECTION_GRAPH::updateItemConnectivity(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), EE_POINT_EDITOR::updateParentItem(), SCH_EDITOR_CONTROL::updatePastedSheet(), EE_POINT_EDITOR::updatePoints(), PL_POINT_EDITOR::updatePoints(), PCB_POINT_EDITOR::updatePoints(), SCH_BUS_ENTRY_BASE::ViewGetLayers(), PCB_GROUP::Visit(), TRACK::Visit(), GERBER_DRAW_ITEM::Visit(), SCH_SHEET::Visit(), SCH_GLOBALLABEL::Visit(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem(), and NETLIST_EXPORTER_CADSTAR::writeListOfNets().

◆ Update()

void DIMENSION_BASE::Update ( )
inline

Updates the dimension's cached text and geometry.

Definition at line 146 of file dimension.h.

147  {
148  updateGeometry();
149  updateText();
150  }
virtual void updateGeometry()=0
Updates the cached geometry of the dimension after changing any of its properties.
virtual void updateText()
Updates the text field value from the current geometry (called by updateGeometry normally)
Definition: dimension.cpp:68

References updateGeometry(), and updateText().

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

◆ updateGeometry()

virtual void DIMENSION_BASE::updateGeometry ( )
protectedpure virtual

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

Implemented in CENTER_DIMENSION, LEADER, ORTHOGONAL_DIMENSION, and ALIGNED_DIMENSION.

Referenced by Update().

◆ updateText()

void DIMENSION_BASE::updateText ( )
protectedvirtual

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

Reimplemented in ORTHOGONAL_DIMENSION, and ALIGNED_DIMENSION.

Definition at line 68 of file dimension.cpp.

69 {
71 
72  switch( m_unitsFormat )
73  {
74  case DIM_UNITS_FORMAT::NO_SUFFIX: // no units
75  break;
76 
77  case DIM_UNITS_FORMAT::BARE_SUFFIX: // normal
78  text += " ";
80  break;
81 
82  case DIM_UNITS_FORMAT::PAREN_SUFFIX: // parenthetical
83  text += " (";
85  text += ")";
86  break;
87  }
88 
89  text.Prepend( m_prefix );
90  text.Append( m_suffix );
91 
92  m_text.SetText( text );
93 }
wxString m_prefix
String prepended to the value.
Definition: dimension.h:280
bool m_overrideTextEnabled
Manually specify the displayed measurement value.
Definition: dimension.h:278
wxString GetAbbreviatedUnitsLabel(EDA_UNITS aUnit, EDA_DATA_TYPE aType)
Get the units string for a given units type.
Definition: base_units.cpp:410
wxString m_suffix
String appended to the value.
Definition: dimension.h:281
virtual void SetText(const wxString &aText)
Definition: eda_text.cpp:121
EDA_UNITS m_units
0 = inches, 1 = mm
Definition: dimension.h:282
PCB_TEXT m_text
The actual text object.
Definition: dimension.h:296
wxString m_valueString
Displayed value when m_overrideValue = true.
Definition: dimension.h:279
DIM_UNITS_FORMAT m_unitsFormat
How to render the units suffix.
Definition: dimension.h:284
wxString GetValueText() const
Definition: dimension.cpp:103

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

Referenced by SetText(), Update(), LEADER::updateGeometry(), ALIGNED_DIMENSION::updateText(), and ORTHOGONAL_DIMENSION::updateText().

◆ ViewBBox()

const BOX2I DIMENSION_BASE::ViewBBox ( ) const
overridevirtual

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

Returns
the current bounding box.

Reimplemented from EDA_ITEM.

Reimplemented in CENTER_DIMENSION.

Definition at line 445 of file dimension.cpp.

446 {
447  BOX2I dimBBox = BOX2I( VECTOR2I( GetBoundingBox().GetPosition() ),
448  VECTOR2I( GetBoundingBox().GetSize() ) );
449  dimBBox.Merge( m_text.ViewBBox() );
450 
451  return dimBBox;
452 }
BOX2< VECTOR2I > BOX2I
Definition: box2.h:522
VECTOR2< int > VECTOR2I
Definition: vector2d.h:623
const EDA_RECT GetBoundingBox() const override
Return the orthogonal bounding box of this object for display purposes.
Definition: dimension.cpp:403
PCB_TEXT m_text
The actual text object.
Definition: dimension.h:296
BOX2< Vec > & Merge(const BOX2< Vec > &aRect)
Function Merge modifies the position and size of the rectangle in order to contain aRect.
Definition: box2.h:386
wxPoint GetPosition() const override
Definition: dimension.h:127
virtual const BOX2I ViewBBox() const override
Return the bounding box of the item covering all its layers.
Definition: eda_item.cpp:190

References GetBoundingBox(), GetPosition(), 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
aLayeris the current drawing layer.
aViewis 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.
aCountis the number of layer indices in aLayers[].

Reimplemented from EDA_ITEM.

Reimplemented in PAD, FOOTPRINT, VIA, FP_TEXT, TRACK, ZONE, PCB_GROUP, and PCB_MARKER.

Definition at line 105 of file board_item.cpp.

106 {
107  // Basic fallback
108  aCount = 1;
109  aLayers[0] = m_layer;
110 }
PCB_LAYER_ID m_layer
Definition: board_item.h:363

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
aLayeris the current drawing layer.
aViewis 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, VIA, GERBER_DRAW_ITEM, FP_TEXT, TRACK, ZONE, PCB_GROUP, and FP_SHAPE.

Definition at line 137 of file view_item.h.

138  {
139  // By default always show the item
140  return 0.0;
141  }

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

◆ 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
inspectorAn INSPECTOR instance to use in the inspection.
testDataArbitrary data used by the inspector.
scanTypesWhich# 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_COMPONENT, FOOTPRINT, LIB_PART, SCH_GLOBALLABEL, SCH_SHEET, GERBER_FILE_IMAGE, GERBER_DRAW_ITEM, TRACK, PCB_GROUP, and GBR_LAYOUT.

Definition at line 91 of file eda_item.cpp.

92 {
93 #if 0 && defined(DEBUG)
94  std::cout << GetClass().mb_str() << ' ';
95 #endif
96 
97  if( IsType( scanTypes ) )
98  {
99  if( SEARCH_RESULT::QUIT == inspector( this, testData ) )
100  return SEARCH_RESULT::QUIT;
101  }
102 
104 }
virtual bool IsType(const KICAD_T aScanTypes[]) const
Check whether the item is one of the listed types.
Definition: eda_item.h:233
virtual wxString GetClass() const =0
Return the class name.

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

◆ m_autoUnits

bool DIMENSION_BASE::m_autoUnits
protected

If true, follow the currently selected UI units.

Definition at line 283 of file dimension.h.

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

◆ m_end

◆ m_extensionOffset

int DIMENSION_BASE::m_extensionOffset
protected

Distance from feature points to extension line start.

Definition at line 291 of file dimension.h.

Referenced by GetExtensionOffset(), SetExtensionOffset(), ALIGNED_DIMENSION::updateGeometry(), ORTHOGONAL_DIMENSION::updateGeometry(), and LEADER::updateGeometry().

◆ m_flags

◆ m_forceVisible

bool EDA_ITEM::m_forceVisible
protectedinherited

◆ m_group

PCB_GROUP* BOARD_ITEM::m_group
protectedinherited

Definition at line 364 of file board_item.h.

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

◆ m_keepTextAligned

bool DIMENSION_BASE::m_keepTextAligned
protected

Calculate text orientation to match dimension.

Definition at line 293 of file dimension.h.

Referenced by GetKeepTextAligned(), LEADER::LEADER(), SetKeepTextAligned(), ALIGNED_DIMENSION::updateText(), and ORTHOGONAL_DIMENSION::updateText().

◆ m_layer

◆ m_lineThickness

int DIMENSION_BASE::m_lineThickness
protected

Thickness used for all graphics in the dimension.

Definition at line 289 of file dimension.h.

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

◆ m_measuredValue

int DIMENSION_BASE::m_measuredValue
protected

value of PCB dimensions

Definition at line 297 of file dimension.h.

Referenced by GetMeasuredValue(), ALIGNED_DIMENSION::updateGeometry(), and ORTHOGONAL_DIMENSION::updateGeometry().

◆ m_overrideTextEnabled

bool DIMENSION_BASE::m_overrideTextEnabled
protected

Manually specify the displayed measurement value.

Definition at line 278 of file dimension.h.

Referenced by CENTER_DIMENSION::CENTER_DIMENSION(), GetOverrideTextEnabled(), LEADER::LEADER(), SetOverrideTextEnabled(), and updateText().

◆ m_parent

◆ m_precision

int DIMENSION_BASE::m_precision
protected

Number of digits to display after decimal.

Definition at line 285 of file dimension.h.

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

◆ m_prefix

wxString DIMENSION_BASE::m_prefix
protected

String prepended to the value.

Definition at line 280 of file dimension.h.

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

◆ m_shapes

◆ m_start

◆ m_status

STATUS_FLAGS EDA_ITEM::m_status
protectedinherited

◆ m_suffix

wxString DIMENSION_BASE::m_suffix
protected

String appended to the value.

Definition at line 281 of file dimension.h.

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

◆ m_suppressZeroes

bool DIMENSION_BASE::m_suppressZeroes
protected

Suppress trailing zeroes.

Definition at line 286 of file dimension.h.

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

◆ m_text

◆ m_textPosition

DIM_TEXT_POSITION DIMENSION_BASE::m_textPosition
protected

How to position the text.

Definition at line 292 of file dimension.h.

Referenced by GetTextPositionMode(), SetTextPositionMode(), ALIGNED_DIMENSION::updateText(), and ORTHOGONAL_DIMENSION::updateText().

◆ m_units

EDA_UNITS DIMENSION_BASE::m_units
protected

0 = inches, 1 = mm

Definition at line 282 of file dimension.h.

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

◆ m_unitsFormat

DIM_UNITS_FORMAT DIMENSION_BASE::m_unitsFormat
protected

How to render the units suffix.

Definition at line 284 of file dimension.h.

Referenced by CENTER_DIMENSION::CENTER_DIMENSION(), GetUnitsFormat(), LEADER::LEADER(), SetUnitsFormat(), and updateText().

◆ m_Uuid

const KIID EDA_ITEM::m_Uuid
inherited

Definition at line 525 of file eda_item.h.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::AddColumn(), SCH_COMPONENT::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_PART::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(), NETLIST_EXPORTER_XML::makeSymbols(), SCH_EDIT_FRAME::mapExistingAnnotation(), TRACK::cmp_tracks::operator()(), BOARD_ITEM::ptr_cmp::operator()(), PCB_SHAPE::cmp_drawings::operator()(), FOOTPRINT::cmp_drawings::operator()(), FOOTPRINT::cmp_pads::operator()(), SCH_ITEM::operator<(), SCH_COMPONENT::operator<(), PAD::PAD(), SCH_SEXPR_PARSER::parseSchSheetInstances(), SCH_EDITOR_CONTROL::Paste(), SCH_SHEET_PATH::PathAsString(), BOARD_REANNOTATE_TOOL::ReannotateDuplicatesInSelection(), SCH_SCREENS::ReplaceDuplicateTimeStamps(), SCH_COMPONENT::ReplaceInstanceSheetPath(), PCB_PARSER::resolveGroups(), SCH_SEXPR_PLUGIN::saveBitmap(), SCH_SEXPR_PLUGIN::saveBusEntry(), SCH_LEGACY_PLUGIN::saveComponent(), 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_SEXPR_PLUGIN::saveText(), SCH_COMPONENT::SCH_COMPONENT(), SCH_REFERENCE::SCH_REFERENCE(), SCH_SHEET::SCH_SHEET(), 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 DIMENSION_BASE::m_valueString
protected

Displayed value when m_overrideValue = true.

Definition at line 279 of file dimension.h.

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

◆ s_arrowAngle

◆ ZeroOffset

wxPoint BOARD_ITEM::ZeroOffset
staticinherited

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

Definition at line 152 of file board_item.h.

Referenced by BOARD::GetPosition().


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