KiCad PCB EDA Suite
PCB_DIM_LEADER Class Reference

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

#include <pcb_dimension.h>

Inheritance diagram for PCB_DIM_LEADER:
PCB_DIMENSION_BASE BOARD_ITEM EDA_ITEM KIGFX::VIEW_ITEM INSPECTABLE

Public Member Functions

 PCB_DIM_LEADER (BOARD_ITEM *aParent)
 
EDA_ITEMClone () const override
 Create a duplicate of this item with linked list members set to NULL. More...
 
virtual void SwapData (BOARD_ITEM *aImage) override
 Swap data between aItem and aImage. More...
 
BITMAPS GetMenuImage () const override
 Return a pointer to an image to be used in menus. More...
 
wxString GetClass () const override
 Return the class name. More...
 
void SetTextFrame (DIM_TEXT_FRAME aFrame)
 
DIM_TEXT_FRAME GetTextFrame () const
 
void GetMsgPanelInfo (EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList) override
 Populate aList of MSG_PANEL_ITEM objects with it's internal state for display purposes. More...
 
bool IsType (const KICAD_T aScanTypes[]) const override
 Check whether the item is one of the listed types. More...
 
void SetParent (EDA_ITEM *aParent) override
 
virtual const wxPoint & GetStart () const
 The dimension's origin is the first feature point for the dimension. More...
 
virtual void SetStart (const wxPoint &aPoint)
 
virtual const wxPoint & GetEnd () const
 
virtual void SetEnd (const wxPoint &aPoint)
 
wxPoint GetPosition () const override
 
void SetPosition (const wxPoint &aPos) override
 
bool GetOverrideTextEnabled () const
 
void SetOverrideTextEnabled (bool aOverride)
 
wxString GetOverrideText () const
 
void SetOverrideText (const wxString &aValue)
 
int GetMeasuredValue () const
 
void SetMeasuredValue (int aValue)
 
wxString GetValueText () const
 
void Update ()
 Update the dimension's cached text and geometry. More...
 
wxString GetPrefix () const
 
void SetPrefix (const wxString &aPrefix)
 
wxString GetSuffix () const
 
void SetSuffix (const wxString &aSuffix)
 
void GetUnits (EDA_UNITS &aUnits) const
 
void SetUnits (EDA_UNITS aUnits)
 
DIM_UNITS_MODE GetUnitsMode () const
 
void SetUnitsMode (DIM_UNITS_MODE aMode)
 
void SetAutoUnits (bool aAuto=true)
 
DIM_UNITS_FORMAT GetUnitsFormat () const
 
void SetUnitsFormat (const DIM_UNITS_FORMAT aFormat)
 
int GetPrecision () const
 
void SetPrecision (int aPrecision)
 
bool GetSuppressZeroes () const
 
void SetSuppressZeroes (bool aSuppress)
 
bool GetKeepTextAligned () const
 
void SetKeepTextAligned (bool aKeepAligned)
 
void SetTextPositionMode (DIM_TEXT_POSITION aMode)
 
DIM_TEXT_POSITION GetTextPositionMode () const
 
int GetArrowLength () const
 
void SetArrowLength (int aLength)
 
void SetExtensionOffset (int aOffset)
 
int GetExtensionOffset () const
 
int GetLineThickness () const
 
void SetLineThickness (int aWidth)
 
void SetLayer (PCB_LAYER_ID aLayer) override
 Set the layer this item is on. More...
 
void SetTextSize (const wxSize &aTextSize)
 
void SetText (const wxString &aNewText)
 Set the override text - has no effect if m_overrideValue == false. More...
 
const wxString GetText () const
 Retrieve the value text or override text, not including prefix or suffix. More...
 
PCB_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 Move (const VECTOR2I &aMoveVector)
 
void Rotate (const wxPoint &aRotCentre, double aAngle) override
 Rotate this object. More...
 
void Rotate (const VECTOR2I &aRotCentre, double aAngle)
 
void Flip (const wxPoint &aCentre, bool aFlipLeftRight) override
 Flip this object, i.e. More...
 
void Flip (const VECTOR2I &aCentre, bool aFlipLeftRight)
 
void Mirror (const wxPoint &axis_pos, bool aMirrorLeftRight=false)
 Mirror the dimension relative to a given horizontal axis. More...
 
bool HitTest (const wxPoint &aPosition, int aAccuracy) const override
 Test if aPosition is contained within or on the bounding box of an item. More...
 
bool HitTest (const EDA_RECT &aRect, bool aContained, int aAccuracy=0) const override
 Test if aRect intersects or is contained within the bounding box of an item. More...
 
const EDA_RECT GetBoundingBox () const override
 Return the orthogonal bounding box of this object for display purposes. More...
 
std::shared_ptr< 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 bool IsOnLayer (PCB_LAYER_ID aLayer) const
 Test to see if this object is on the given layer. More...
 
bool IsTrack () const
 Test to see if this object is a track or via (or microvia). More...
 
virtual bool IsLocked () const
 
virtual void SetLocked (bool aLocked)
 Modify the 'lock' status for of the item. More...
 
void DeleteStructure ()
 Delete this object after removing from its parent if it has one. More...
 
virtual const BOARDGetBoard () const
 Return the BOARD in which this BOARD_ITEM resides, or NULL if none. More...
 
virtual BOARDGetBoard ()
 
wxString GetLayerName () const
 Return the name of the PCB layer on which the item resides. More...
 
virtual void ViewGetLayers (int aLayers[], int &aCount) const override
 Return the all the layers within the VIEW the object is painted on. More...
 
KICAD_T Type () const
 Returns the type of object. More...
 
bool IsModified () const
 
bool IsNew () const
 
bool IsMoving () const
 
bool IsDragging () const
 
bool IsWireImage () const
 
bool IsSelected () const
 
bool IsEntered () const
 
bool IsResized () const
 
bool IsBrightened () const
 
void SetWireImage ()
 
void SetSelected ()
 
void SetBrightened ()
 
void ClearSelected ()
 
void ClearBrightened ()
 
void SetModified ()
 
int GetState (EDA_ITEM_FLAGS type) const
 
void SetState (EDA_ITEM_FLAGS type, bool state)
 
EDA_ITEM_FLAGS GetStatus () const
 
void SetStatus (EDA_ITEM_FLAGS aStatus)
 
void SetFlags (EDA_ITEM_FLAGS aMask)
 
void ClearFlags (EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
 
EDA_ITEM_FLAGS GetFlags () const
 
bool HasFlag (EDA_ITEM_FLAGS aFlag) const
 
EDA_ITEM_FLAGS GetEditFlags () const
 
void ClearTempFlags ()
 
void ClearEditFlags ()
 
void SetForceVisible (bool aEnable)
 Set and clear force visible flag used to force the item to be drawn even if it's draw attribute is set to not visible. More...
 
bool IsForceVisible () const
 
virtual const wxPoint GetFocusPosition () const
 Similar to GetPosition, but allows items to return their visual center rather than their anchor. More...
 
virtual SEARCH_RESULT Visit (INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
 May be re-implemented for each derived class in order to handle all the types given by its member data. More...
 
virtual bool Matches (const wxFindReplaceData &aSearchData, void *aAuxData) const
 Compare the item against the search criteria in aSearchData. More...
 
virtual bool Replace (const wxFindReplaceData &aSearchData, void *aAuxData=nullptr)
 Perform a text replace using the find and replace criteria in aSearchData on items that support text find and replace. More...
 
virtual bool IsReplaceable () const
 Override this method in any derived object that supports test find and replace. More...
 
bool operator< (const EDA_ITEM &aItem) const
 Test if another item is less than this object. More...
 
virtual void ViewDraw (int aLayer, VIEW *aView) const
 Draw the parts of the object belonging to layer aLayer. More...
 
virtual double ViewGetLOD (int aLayer, VIEW *aView) const
 Return the level of detail (LOD) of the item. More...
 
VIEW_ITEM_DATA * viewPrivData () const
 
void ClearViewPrivData ()
 
bool Set (PROPERTY_BASE *aProperty, wxAny &aValue)
 
template<typename T >
bool Set (PROPERTY_BASE *aProperty, T aValue)
 
template<typename T >
bool Set (const wxString &aProperty, T aValue)
 
wxAny Get (PROPERTY_BASE *aProperty)
 
template<typename T >
Get (PROPERTY_BASE *aProperty)
 
template<typename T >
boost::optional< T > Get (const wxString &aProperty)
 

Static Public Member Functions

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

Public Attributes

const KIID m_Uuid
 

Static Public Attributes

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

Protected Member Functions

void updateGeometry () override
 Update the cached geometry of the dimension after changing any of its properties. More...
 
virtual void updateText ()
 Update the text field value from the current geometry (called by updateGeometry normally). More...
 
template<typename ShapeType >
void addShape (const ShapeType &aShape)
 
virtual wxString layerMaskDescribe () const
 Return a string (to be shown to the user) describing a layer mask. More...
 
bool Matches (const wxString &aText, const wxFindReplaceData &aSearchData) const
 Compare aText against search criteria in aSearchData. More...
 

Static Protected Member Functions

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

Protected Attributes

bool m_overrideTextEnabled
 Manually specify the displayed measurement value. More...
 
wxString m_valueString
 Displayed value when m_overrideValue = true. More...
 
wxString m_prefix
 String prepended to the value. More...
 
wxString m_suffix
 String appended to the value. More...
 
EDA_UNITS m_units
 0 = inches, 1 = mm More...
 
bool m_autoUnits
 If true, follow the currently selected UI units. More...
 
DIM_UNITS_FORMAT m_unitsFormat
 How to render the units suffix. More...
 
int m_precision
 Number of digits to display after decimal. More...
 
bool m_suppressZeroes
 Suppress trailing zeroes. More...
 
int m_lineThickness
 Thickness used for all graphics in the dimension. More...
 
int m_arrowLength
 Length of arrow shapes. More...
 
int m_extensionOffset
 Distance from feature points to extension line start. More...
 
DIM_TEXT_POSITION m_textPosition
 How to position the text. More...
 
bool m_keepTextAligned
 Calculate text orientation to match dimension. More...
 
PCB_TEXT m_text
 The actual text object. More...
 
int m_measuredValue
 value of PCB dimensions More...
 
wxPoint m_start
 
wxPoint m_end
 Internal cache of drawn shapes. More...
 
std::vector< std::shared_ptr< SHAPE > > m_shapes
 
PCB_LAYER_ID m_layer
 
PCB_GROUPm_group
 
EDA_ITEM_FLAGS m_status
 
EDA_ITEMm_parent
 Linked list: Link (parent struct) More...
 
bool m_forceVisible
 
EDA_ITEM_FLAGS m_flags
 

Static Protected Attributes

static constexpr float s_arrowAngle = 27.5
 

Private Attributes

DIM_TEXT_FRAME m_textFrame
 

Detailed Description

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

A guide to the geometry of a leader:

a
   _
  |\
     \
       b---c TEXT

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

Definition at line 489 of file pcb_dimension.h.

Constructor & Destructor Documentation

◆ PCB_DIM_LEADER()

PCB_DIM_LEADER::PCB_DIM_LEADER ( BOARD_ITEM aParent)

Definition at line 953 of file pcb_dimension.cpp.

953  :
956 {
958  m_overrideTextEnabled = true;
959  m_keepTextAligned = false;
960 }
class PCB_DIM_LEADER, a leader dimension (graphic item)
Definition: typeinfo.h:101
PCB_DIMENSION_BASE(BOARD_ITEM *aParent, KICAD_T aType=PCB_DIMENSION_T)
bool m_keepTextAligned
Calculate text orientation to match dimension.
DIM_UNITS_FORMAT m_unitsFormat
How to render the units suffix.
bool m_overrideTextEnabled
Manually specify the displayed measurement value.
DIM_TEXT_FRAME m_textFrame

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

Referenced by Clone().

Member Function Documentation

◆ addShape()

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

Definition at line 99 of file pcb_dimension.cpp.

100 {
101  m_shapes.push_back( std::make_shared<ShapeType>( aShape ) );
102 }
std::vector< std::shared_ptr< SHAPE > > m_shapes

References PCB_DIMENSION_BASE::m_shapes.

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

◆ ClassOf()

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

Definition at line 494 of file pcb_dimension.h.

495  {
496  return aItem && PCB_DIM_LEADER_T == aItem->Type();
497  }
class PCB_DIM_LEADER, a leader dimension (graphic item)
Definition: typeinfo.h:101
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:113

References PCB_DIM_LEADER_T, and EDA_ITEM::Type().

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )
inlineinherited

◆ ClearEditFlags()

◆ ClearFlags()

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

Definition at line 154 of file eda_item.h.

154 { m_flags &= ~aMask; }
EDA_ITEM_FLAGS m_flags
Definition: eda_item.h:481

References EDA_ITEM::m_flags.

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

◆ ClearSelected()

◆ ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )
inlineinherited

Definition at line 166 of file eda_item.h.

167  {
169  DO_NOT_DRAW );
170  }
#define DO_NOT_DRAW
Used to disable draw function.
#define STARTPOINT
When a line is selected, these flags indicate which.
#define ENDPOINT
ends. (Used to support dragging.)
#define IS_LINKED
Used in calculation to mark linked items (temporary use)
#define CANDIDATE
flag indicating that the structure is connected
void ClearFlags(EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: eda_item.h:154
#define SKIP_STRUCT
flag indicating that the structure should be ignored
#define TEMP_SELECTED
flag indicating that the structure has already selected

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

Referenced by SCH_EDIT_FRAME::PutDataInPreviousState().

◆ ClearViewPrivData()

void KIGFX::VIEW_ITEM::ClearViewPrivData ( )
inlineinherited

Definition at line 143 of file view_item.h.

144  {
145  m_viewPrivData = nullptr;
146  }
VIEW_ITEM_DATA * m_viewPrivData
Definition: view_item.h:151

References KIGFX::VIEW_ITEM::m_viewPrivData.

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

◆ Clone()

EDA_ITEM * PCB_DIM_LEADER::Clone ( ) const
overridevirtual

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

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

Returns
A clone of the item.

Reimplemented from EDA_ITEM.

Definition at line 963 of file pcb_dimension.cpp.

964 {
965  return new PCB_DIM_LEADER( *this );
966 }
PCB_DIM_LEADER(BOARD_ITEM *aParent)

References PCB_DIM_LEADER().

◆ DeleteStructure()

void BOARD_ITEM::DeleteStructure ( )
inherited

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

Definition at line 126 of file board_item.cpp.

127 {
128  BOARD_ITEM_CONTAINER* parent = GetParent();
129 
130  if( parent )
131  parent->Remove( this );
132 
133  delete this;
134 }
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:135

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

170  {
171  EDA_ITEM* dupe = Clone();
172  const_cast<KIID&>( dupe->m_Uuid ) = KIID();
173 
174  return static_cast<BOARD_ITEM*>( dupe );
175  }
virtual EDA_ITEM * Clone() const
Create a duplicate of this item with linked list members set to NULL.
Definition: eda_item.cpp:83
Definition: kiid.h:44
const KIID m_Uuid
Definition: eda_item.h:475
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:100

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

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

◆ Flip() [1/2]

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

Flip this object, i.e.

change the board side for this object.

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

Reimplemented from BOARD_ITEM.

Definition at line 252 of file pcb_dimension.cpp.

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

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

◆ Flip() [2/2]

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

Definition at line 267 of file board_item.h.

268  {
269  Flip( wxPoint( aCentre.x, aCentre.y ), aFlipLeftRight );
270  }
virtual void Flip(const wxPoint &aCentre, bool aFlipLeftRight)
Flip this object, i.e.
Definition: board_item.cpp:183

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 = T();
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 PCB_DIMENSION_BASE::GetArrowLength ( ) const
inlineinherited

Definition at line 184 of file pcb_dimension.h.

184 { return m_arrowLength; }
int m_arrowLength
Length of arrow shapes.

References PCB_DIMENSION_BASE::m_arrowLength.

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

◆ GetBoard() [1/2]

const BOARD * BOARD_ITEM::GetBoard ( ) const
virtualinherited

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

Definition at line 36 of file board_item.cpp.

37 {
38  if( Type() == PCB_T )
39  return static_cast<const BOARD*>( this );
40 
41  BOARD_ITEM* parent = GetParent();
42 
43  if( parent )
44  return parent->GetBoard();
45 
46  return nullptr;
47 }
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:49
virtual const BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
Definition: board_item.cpp:36
BOARD_ITEM_CONTAINER * GetParent() const
Definition: board_item.h:135
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:113

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

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

◆ GetBoard() [2/2]

BOARD * BOARD_ITEM::GetBoard ( )
virtualinherited

Definition at line 50 of file board_item.cpp.

51 {
52  if( Type() == PCB_T )
53  return static_cast<BOARD*>( this );
54 
55  BOARD_ITEM* parent = GetParent();
56 
57  if( parent )
58  return parent->GetBoard();
59 
60  return nullptr;
61 }
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:49
virtual const BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
Definition: board_item.cpp:36
BOARD_ITEM_CONTAINER * GetParent() const
Definition: board_item.h:135
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:113

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

◆ GetBoundingBox()

const EDA_RECT PCB_DIMENSION_BASE::GetBoundingBox ( ) const
overridevirtualinherited

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

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

Reimplemented from EDA_ITEM.

Reimplemented in PCB_DIM_CENTER.

Definition at line 406 of file pcb_dimension.cpp.

407 {
408  EDA_RECT bBox;
409  int xmin, xmax, ymin, ymax;
410 
411  bBox = m_text.GetTextBox();
412  xmin = bBox.GetX();
413  xmax = bBox.GetRight();
414  ymin = bBox.GetY();
415  ymax = bBox.GetBottom();
416 
417  for( const std::shared_ptr<SHAPE>& shape : GetShapes() )
418  {
419  BOX2I shapeBox = shape->BBox();
420  shapeBox.Inflate( m_lineThickness / 2 );
421 
422  xmin = std::min( xmin, shapeBox.GetOrigin().x );
423  xmax = std::max( xmax, shapeBox.GetEnd().x );
424  ymin = std::min( ymin, shapeBox.GetOrigin().y );
425  ymax = std::max( ymax, shapeBox.GetEnd().y );
426  }
427 
428  bBox.SetX( xmin );
429  bBox.SetY( ymin );
430  bBox.SetWidth( xmax - xmin + 1 );
431  bBox.SetHeight( ymax - ymin + 1 );
432 
433  bBox.Normalize();
434 
435  return bBox;
436 }
const Vec GetEnd() const
Definition: box2.h:178
int GetX() const
Definition: eda_rect.h:98
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:239
const std::vector< std::shared_ptr< SHAPE > > & GetShapes() const
A 2D bounding box built on top of an origin point and size vector.
Definition: box2.h:41
PCB_TEXT m_text
The actual text object.
int GetBottom() const
Definition: eda_rect.h:114
void SetHeight(int val)
Definition: eda_rect.h:176
int GetRight() const
Definition: eda_rect.h:111
void SetX(int val)
Definition: eda_rect.h:158
void SetWidth(int val)
Definition: eda_rect.h:170
void SetY(int val)
Definition: eda_rect.h:164
void Normalize()
Ensures that the height ant width are positive.
Definition: eda_rect.cpp:35
BOX2< Vec > & Inflate(coord_type dx, coord_type dy)
Inflates the rectangle horizontally by dx and vertically by dy.
Definition: box2.h:281
Handle the component boundary box.
Definition: eda_rect.h:42
int GetY() const
Definition: eda_rect.h:99
int m_lineThickness
Thickness used for all graphics in the dimension.
const Vec & GetOrigin() const
Definition: box2.h:176

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

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

◆ GetCenter()

virtual wxPoint BOARD_ITEM::GetCenter ( ) const
inlinevirtualinherited

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

Returns
center point of the item

Reimplemented in PCB_ARC, PAD, PCB_SHAPE, and PCB_MARKER.

Definition at line 81 of file board_item.h.

82  {
83  return GetBoundingBox().GetCenter();
84  }
virtual const EDA_RECT GetBoundingBox() const
Return the orthogonal bounding box of this object for display purposes.
Definition: eda_item.cpp:75
const wxPoint GetCenter() const
Definition: eda_rect.h:104

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

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

◆ GetClass()

wxString PCB_DIM_LEADER::GetClass ( ) const
inlineoverridevirtual

Return the class name.

Implements EDA_ITEM.

Definition at line 505 of file pcb_dimension.h.

506  {
507  return wxT( "PCB_DIM_LEADER" );
508  }

◆ GetEditFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetEditFlags ( ) const
inlineinherited

Definition at line 158 of file eda_item.h.

159  {
160  constexpr int mask = ( IS_NEW | IS_PASTED | IS_MOVING | IS_RESIZING | IS_DRAGGING
162 
163  return m_flags & mask;
164  }
#define IS_NEW
New item, just created.
#define IS_RESIZING
Item being resized.
#define IS_DRAGGING
Item being dragged.
EDA_ITEM_FLAGS m_flags
Definition: eda_item.h:481
#define IS_PASTED
Modifier on IS_NEW which indicates it came from clipboard.
#define IS_MOVING
Item being moved.
#define STRUCT_DELETED
flag indication structures to be erased
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.

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

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

◆ GetEffectiveShape()

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

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

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

Note
This list can contain a SHAPE_SIMPLE (a simple single-outline non-intersecting polygon), but should never contain a SHAPE_POLY_SET (a complex polygon consisting of multiple outlines and/or holes).
Parameters
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 357 of file pcb_dimension.cpp.

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

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

◆ GetEnd()

virtual const wxPoint& PCB_DIMENSION_BASE::GetEnd ( ) const
inlinevirtualinherited

◆ GetExtensionOffset()

int PCB_DIMENSION_BASE::GetExtensionOffset ( ) const
inlineinherited

Definition at line 188 of file pcb_dimension.h.

188 { return m_extensionOffset; }
int m_extensionOffset
Distance from feature points to extension line start.

References PCB_DIMENSION_BASE::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_TRACK, and PCB_SHAPE.

Definition at line 259 of file eda_item.h.

259 { return GetPosition(); }
virtual wxPoint GetPosition() const
Definition: eda_item.h:252

References EDA_ITEM::GetPosition().

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

◆ GetKeepTextAligned()

bool PCB_DIMENSION_BASE::GetKeepTextAligned ( ) const
inlineinherited

Definition at line 178 of file pcb_dimension.h.

178 { return m_keepTextAligned; }
bool m_keepTextAligned
Calculate text orientation to match dimension.

References PCB_DIMENSION_BASE::m_keepTextAligned.

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

◆ GetLayer()

virtual PCB_LAYER_ID BOARD_ITEM::GetLayer ( ) const
inlinevirtualinherited

Return the primary layer this item is on.

Reimplemented in ZONE.

Definition at line 140 of file board_item.h.

140 { return m_layer; }
PCB_LAYER_ID m_layer
Definition: board_item.h:316

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(), PCB_TRACK::Flip(), FP_SHAPE::Flip(), PCB_SHAPE::Flip(), FP_TEXT::Flip(), PCB_DIMENSION_BASE::Flip(), FOOTPRINT::Flip(), PCB_ARC::Flip(), PCB_BASE_FRAME::FocusOnItem(), 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(), PCB_TRACK::GetMsgPanelInfo(), PCB_VIA::GetMsgPanelInfo(), PAD::GetMsgPanelInfo(), AR_AUTOPLACER::getOptimalFPPlacement(), BOARD::GetPad(), PCB_TRACK::GetWidthConstraints(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), idf_export_footprint(), GENERAL_COLLECTOR::Inspect(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), BOARD_INSPECTION_TOOL::InspectDRCError(), isEdge(), PAD::IsFlipped(), FOOTPRINT::IsFlipped(), PNS_KICAD_IFACE::IsItemVisible(), BOARD_ITEM::IsOnCopperLayer(), FP_SHAPE::IsParentFlipped(), FP_TEXT::IsParentFlipped(), itemIsIncludedByFilter(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromShapes(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnAddField(), DIALOG_FOOTPRINT_PROPERTIES::OnAddField(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), PCB_SHAPE::cmp_drawings::operator()(), PCB_TRACK::cmp_tracks::operator()(), BOARD_ITEM::ptr_cmp::operator()(), FOOTPRINT::cmp_drawings::operator()(), BOARD::cmp_items::operator()(), BOARD::cmp_drawings::operator()(), EAGLE_PLUGIN::packagePad(), BRDITEMS_PLOTTER::PlotDimension(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), BRDITEMS_PLOTTER::PlotFootprintGraphicItems(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotFootprintTextItems(), BRDITEMS_PLOTTER::PlotPcbShape(), BRDITEMS_PLOTTER::PlotPcbTarget(), BRDITEMS_PLOTTER::PlotPcbText(), 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(), CONNECTIVITY_DATA::TestTrackEndpointDangling(), TRACK_VIA_DESC::TRACK_VIA_DESC(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow(), BOARD_ADAPTER::transformFPShapesToPolygon(), FOOTPRINT::TransformFPShapesWithClearanceToPolygon(), PCB_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 73 of file board_item.cpp.

74 {
75  const BOARD* board = GetBoard();
76 
77  if( board )
78  return board->GetLayerName( m_layer );
79 
80  // If no parent, return standard name
82 }
const wxString GetLayerName(PCB_LAYER_ID aLayer) const
Return the name of a aLayer.
Definition: board.cpp:362
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:190
PCB_LAYER_ID m_layer
Definition: board_item.h:316
virtual const BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
Definition: board_item.cpp:36
static wxString GetStandardLayerName(PCB_LAYER_ID aLayerId)
Return an "English Standard" name of a PCB layer when given aLayerNumber.
Definition: board.h:605

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

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

◆ GetLayerSet()

◆ GetLineThickness()

int PCB_DIMENSION_BASE::GetLineThickness ( ) const
inlineinherited

◆ GetMeasuredValue()

int PCB_DIMENSION_BASE::GetMeasuredValue ( ) const
inlineinherited

Definition at line 136 of file pcb_dimension.h.

136 { return m_measuredValue; }
int m_measuredValue
value of PCB dimensions

References PCB_DIMENSION_BASE::m_measuredValue.

Referenced by PCB_DIMENSION_BASE::GetValueText().

◆ GetMenuImage()

BITMAPS PCB_DIM_LEADER::GetMenuImage ( ) const
overridevirtual

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

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

Returns
The menu image associated with the item.

Reimplemented from EDA_ITEM.

Definition at line 977 of file pcb_dimension.cpp.

978 {
979  return BITMAPS::add_leader;
980 }

References add_leader.

◆ GetMsgPanelInfo()

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

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

Parameters
aListis the list to populate.

Reimplemented from PCB_DIMENSION_BASE.

Definition at line 1074 of file pcb_dimension.cpp.

1075 {
1076  wxString msg;
1077 
1078  aList.emplace_back( _( "Leader" ), m_text.GetShownText() );
1079 
1080  ORIGIN_TRANSFORMS originTransforms = aFrame->GetOriginTransforms();
1081  EDA_UNITS units = aFrame->GetUserUnits();
1082 
1083  wxPoint startCoord = originTransforms.ToDisplayAbs( GetStart() );
1084  wxString start = wxString::Format( "@(%s, %s)",
1085  MessageTextFromValue( units, startCoord.x ),
1086  MessageTextFromValue( units, startCoord.y ) );
1087 
1088  aList.emplace_back( start, wxEmptyString );
1089 
1090  aList.emplace_back( _( "Layer" ), GetLayerName() );
1091 }
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:104
virtual ORIGIN_TRANSFORMS & GetOriginTransforms()
Return a reference to the default ORIGIN_TRANSFORMS object.
T ToDisplayAbs(const T &aValue) const
PCB_TEXT m_text
The actual text object.
wxString GetShownText(int aDepth=0) const override
Return the string actually shown after processing of the base text.
Definition: pcb_text.cpp:56
virtual const wxPoint & GetStart() const
The dimension's origin is the first feature point for the dimension.
#define _(s)
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
A class to perform either relative or absolute display origin transforms for a single axis of a point...
wxString GetLayerName() const
Return the name of the PCB layer on which the item resides.
Definition: board_item.cpp:73
EDA_UNITS GetUserUnits() const
Return the user units currently in use.

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

◆ GetOverrideText()

wxString PCB_DIMENSION_BASE::GetOverrideText ( ) const
inlineinherited

Definition at line 133 of file pcb_dimension.h.

133 { return m_valueString; }
wxString m_valueString
Displayed value when m_overrideValue = true.

References PCB_DIMENSION_BASE::m_valueString.

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

◆ GetOverrideTextEnabled()

bool PCB_DIMENSION_BASE::GetOverrideTextEnabled ( ) const
inlineinherited

Definition at line 130 of file pcb_dimension.h.

130 { return m_overrideTextEnabled; }
bool m_overrideTextEnabled
Manually specify the displayed measurement value.

References PCB_DIMENSION_BASE::m_overrideTextEnabled.

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

◆ GetParent()

BOARD_ITEM_CONTAINER* BOARD_ITEM::GetParent ( void  ) const
inlineinherited

Definition at line 135 of file board_item.h.

135 { return (BOARD_ITEM_CONTAINER*) m_parent; }
EDA_ITEM * m_parent
Linked list: Link (parent struct)
Definition: eda_item.h:479
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(), GENERAL_COLLECTOR::Inspect(), ARRAY_CREATOR::Invoke(), isInsideArea(), DRC_ENGINE::IsNetTie(), FP_SHAPE::IsParentFlipped(), FP_TEXT::IsParentFlipped(), PCB_SELECTION_TOOL::itemPassesFilter(), 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 PCB_DIMENSION_BASE::GetPosition ( ) const
inlineoverridevirtualinherited

Reimplemented from EDA_ITEM.

Definition at line 127 of file pcb_dimension.h.

127 { return m_start; }

References PCB_DIMENSION_BASE::m_start.

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

◆ GetPrecision()

int PCB_DIMENSION_BASE::GetPrecision ( ) const
inlineinherited

Definition at line 172 of file pcb_dimension.h.

172 { return m_precision; }
int m_precision
Number of digits to display after decimal.

References PCB_DIMENSION_BASE::m_precision.

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

◆ GetPrefix()

wxString PCB_DIMENSION_BASE::GetPrefix ( ) const
inlineinherited

Definition at line 155 of file pcb_dimension.h.

155 { return m_prefix; }
wxString m_prefix
String prepended to the value.

References PCB_DIMENSION_BASE::m_prefix.

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

◆ GetSelectMenuText()

wxString PCB_DIMENSION_BASE::GetSelectMenuText ( EDA_UNITS  aUnits) const
overridevirtualinherited

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

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

Returns
The menu text string.

Reimplemented from EDA_ITEM.

Definition at line 439 of file pcb_dimension.cpp.

440 {
441  return wxString::Format( _( "Dimension '%s' on %s" ), GetText(), GetLayerName() );
442 }
const wxString GetText() const
Retrieve the value text or override text, not including prefix or suffix.
#define _(s)
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
wxString GetLayerName() const
Return the name of the PCB layer on which the item resides.
Definition: board_item.cpp:73

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

◆ GetShapes()

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

Definition at line 220 of file pcb_dimension.h.

220 { return m_shapes; }
std::vector< std::shared_ptr< SHAPE > > m_shapes

References PCB_DIMENSION_BASE::m_shapes.

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

◆ GetStart()

virtual const wxPoint& PCB_DIMENSION_BASE::GetStart ( ) const
inlinevirtualinherited

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

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

Returns
the origin point of this dimension

Definition at line 121 of file pcb_dimension.h.

121 { return m_start; }

References PCB_DIMENSION_BASE::m_start.

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

◆ GetState()

int EDA_ITEM::GetState ( EDA_ITEM_FLAGS  type) const
inlineinherited

Definition at line 137 of file eda_item.h.

138  {
139  return m_status & type;
140  }
EDA_ITEM_FLAGS m_status
Definition: eda_item.h:478

References EDA_ITEM::m_status.

Referenced by BOARD_ITEM::IsLocked().

◆ GetStatus()

EDA_ITEM_FLAGS EDA_ITEM::GetStatus ( ) const
inlineinherited

Definition at line 150 of file eda_item.h.

150 { return m_status; }
EDA_ITEM_FLAGS m_status
Definition: eda_item.h:478

References EDA_ITEM::m_status.

◆ GetSuffix()

wxString PCB_DIMENSION_BASE::GetSuffix ( ) const
inlineinherited

Definition at line 158 of file pcb_dimension.h.

158 { return m_suffix; }
wxString m_suffix
String appended to the value.

References PCB_DIMENSION_BASE::m_suffix.

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

◆ GetSuppressZeroes()

bool PCB_DIMENSION_BASE::GetSuppressZeroes ( ) const
inlineinherited

Definition at line 175 of file pcb_dimension.h.

175 { return m_suppressZeroes; }
bool m_suppressZeroes
Suppress trailing zeroes.

References PCB_DIMENSION_BASE::m_suppressZeroes.

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

◆ GetText()

const wxString PCB_DIMENSION_BASE::GetText ( ) const
inherited

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

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

Definition at line 208 of file pcb_dimension.cpp.

209 {
210  return m_text.GetText();
211 }
PCB_TEXT m_text
The actual text object.
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition: eda_text.h:154

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

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

◆ GetTextFrame()

DIM_TEXT_FRAME PCB_DIM_LEADER::GetTextFrame ( ) const
inline

Definition at line 511 of file pcb_dimension.h.

511 { return m_textFrame; }
DIM_TEXT_FRAME m_textFrame

References m_textFrame.

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

◆ GetTextPositionMode()

DIM_TEXT_POSITION PCB_DIMENSION_BASE::GetTextPositionMode ( ) const
inlineinherited

Definition at line 182 of file pcb_dimension.h.

182 { return m_textPosition; }
DIM_TEXT_POSITION m_textPosition
How to position the text.

References PCB_DIMENSION_BASE::m_textPosition.

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

◆ GetUnits()

void PCB_DIMENSION_BASE::GetUnits ( EDA_UNITS aUnits) const
inlineinherited

Definition at line 161 of file pcb_dimension.h.

161 { aUnits = m_units; }
EDA_UNITS m_units
0 = inches, 1 = mm

References PCB_DIMENSION_BASE::m_units.

Referenced by PCB_DIMENSION_BASE::GetMsgPanelInfo().

◆ GetUnitsFormat()

DIM_UNITS_FORMAT PCB_DIMENSION_BASE::GetUnitsFormat ( ) const
inlineinherited

Definition at line 169 of file pcb_dimension.h.

169 { return m_unitsFormat; }
DIM_UNITS_FORMAT m_unitsFormat
How to render the units suffix.

References PCB_DIMENSION_BASE::m_unitsFormat.

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

◆ GetUnitsMode()

DIM_UNITS_MODE PCB_DIMENSION_BASE::GetUnitsMode ( ) const
inherited

Definition at line 152 of file pcb_dimension.cpp.

153 {
154  if( m_autoUnits )
155  {
157  }
158  else
159  {
160  switch( m_units )
161  {
164 
165  case EDA_UNITS::MILS:
166  return DIM_UNITS_MODE::MILS;
167 
168  default:
169  case EDA_UNITS::INCHES:
170  return DIM_UNITS_MODE::INCHES;
171  }
172  }
173 }
bool m_autoUnits
If true, follow the currently selected UI units.
EDA_UNITS m_units
0 = inches, 1 = mm

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

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

◆ GetValueText()

wxString PCB_DIMENSION_BASE::GetValueText ( ) const
inherited
Returns
the dimension value, rendered with precision / zero suppression but no units, etc

Definition at line 105 of file pcb_dimension.cpp.

106 {
107  struct lconv* lc = localeconv();
108  wxChar sep = lc->decimal_point[0];
109 
110  int val = GetMeasuredValue();
111  wxString text;
112  wxString format = wxT( "%." ) + wxString::Format( "%i", m_precision ) + wxT( "f" );
113 
114  text.Printf( format, To_User_Unit( m_units, val ) );
115 
116  if( m_suppressZeroes )
117  {
118  while( text.Last() == '0' )
119  {
120  text.RemoveLast();
121 
122  if( text.Last() == '.' || text.Last() == sep )
123  {
124  text.RemoveLast();
125  break;
126  }
127  }
128  }
129 
130  return text;
131 }
int m_precision
Number of digits to display after decimal.
EDA_UNITS m_units
0 = inches, 1 = mm
int GetMeasuredValue() const
bool m_suppressZeroes
Suppress trailing zeroes.
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
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:68

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

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

◆ GetX()

int BOARD_ITEM::GetX ( ) const
inlineinherited

◆ GetY()

int BOARD_ITEM::GetY ( ) const
inlineinherited

◆ HasFlag()

◆ HitTest() [1/2]

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

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

Parameters
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 370 of file pcb_dimension.cpp.

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

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

Referenced by GENERAL_COLLECTOR::Inspect().

◆ HitTest() [2/2]

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

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

Parameters
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 389 of file pcb_dimension.cpp.

390 {
391  EDA_RECT arect = aRect;
392  arect.Inflate( aAccuracy );
393 
394  EDA_RECT rect = GetBoundingBox();
395 
396  if( aAccuracy )
397  rect.Inflate( aAccuracy );
398 
399  if( aContained )
400  return arect.Contains( rect );
401 
402  return arect.Intersects( rect );
403 }
const EDA_RECT GetBoundingBox() const override
Return the orthogonal bounding box of this object for display purposes.
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:364

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

◆ IsBrightened()

◆ IsConnected()

◆ IsDragging()

bool EDA_ITEM::IsDragging ( ) const
inlineinherited

Definition at line 121 of file eda_item.h.

121 { return m_flags & IS_DRAGGING; }
#define IS_DRAGGING
Item being dragged.
EDA_ITEM_FLAGS m_flags
Definition: eda_item.h:481

References IS_DRAGGING, and EDA_ITEM::m_flags.

Referenced by DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES().

◆ IsEntered()

bool EDA_ITEM::IsEntered ( ) const
inlineinherited

Definition at line 124 of file eda_item.h.

124 { return m_flags & ENTERED; }
EDA_ITEM_FLAGS m_flags
Definition: eda_item.h:481
#define ENTERED
indicates a group has been entered

References ENTERED, and EDA_ITEM::m_flags.

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

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const
inlineinherited

Definition at line 206 of file eda_item.h.

206 { return m_forceVisible; }
bool m_forceVisible
Definition: eda_item.h:480

References EDA_ITEM::m_forceVisible.

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

◆ IsLocked()

bool BOARD_ITEM::IsLocked ( ) const
virtualinherited
Returns
true if the object is locked, else false.

Reimplemented in FOOTPRINT, and PAD.

Definition at line 64 of file board_item.cpp.

65 {
66  if( GetParentGroup() )
67  return GetParentGroup()->IsLocked();
68 
69  return GetState( LOCKED );
70 }
PCB_GROUP * GetParentGroup() const
Definition: board_item.h:60
virtual bool IsLocked() const
Definition: board_item.cpp:64
#define LOCKED
Pcbnew: locked from movement and deletion.
int GetState(EDA_ITEM_FLAGS type) const
Definition: eda_item.h:137

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

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

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const
inlineinherited

Definition at line 118 of file eda_item.h.

118 { return m_flags & IS_CHANGED; }
#define IS_CHANGED
Item was edited, and modified.
EDA_ITEM_FLAGS m_flags
Definition: eda_item.h:481

References IS_CHANGED, and EDA_ITEM::m_flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMoving()

◆ IsNew()

◆ IsOnCopperLayer()

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

Reimplemented in PAD, PCB_TRACK, and ZONE.

Definition at line 111 of file board_item.h.

112  {
113  return IsCopperLayer( GetLayer() );
114  }
bool IsCopperLayer(LAYER_NUM aLayerId)
Tests whether a layer is a copper layer.
Definition: layer_ids.h:796
virtual PCB_LAYER_ID GetLayer() const
Return the primary layer this item is on.
Definition: board_item.h:140

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, PCB_VIA, FOOTPRINT, ZONE, and PCB_GROUP.

Definition at line 198 of file board_item.h.

199  {
200  return m_layer == aLayer;
201  }
PCB_LAYER_ID m_layer
Definition: board_item.h:316

References BOARD_ITEM::m_layer.

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

◆ IsReplaceable()

virtual bool EDA_ITEM::IsReplaceable ( ) const
inlinevirtualinherited

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

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

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

Definition at line 403 of file eda_item.h.

403 { return false; }

Referenced by EDA_ITEM::Matches().

◆ IsResized()

bool EDA_ITEM::IsResized ( ) const
inlineinherited

Definition at line 125 of file eda_item.h.

125 { return m_flags & IS_RESIZING; }
#define IS_RESIZING
Item being resized.
EDA_ITEM_FLAGS m_flags
Definition: eda_item.h:481

References IS_RESIZING, and EDA_ITEM::m_flags.

◆ IsSelected()

bool EDA_ITEM::IsSelected ( ) const
inlineinherited

Definition at line 123 of file eda_item.h.

123 { return m_flags & SELECTED; }
EDA_ITEM_FLAGS m_flags
Definition: eda_item.h:481
#define SELECTED

References EDA_ITEM::m_flags, and SELECTED.

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

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

209  {
210  return ( Type() == PCB_TRACE_T ) || ( Type() == PCB_VIA_T );
211  }
class PCB_TRACK, a track segment (segment on a copper layer)
Definition: typeinfo.h:95
class PCB_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:113

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

◆ IsType()

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

Check whether the item is one of the listed types.

Parameters
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 pcb_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:183

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

◆ IsWireImage()

bool EDA_ITEM::IsWireImage ( ) const
inlineinherited

Definition at line 122 of file eda_item.h.

122 { return m_flags & IS_WIRE_IMAGE; }
EDA_ITEM_FLAGS m_flags
Definition: eda_item.h:481
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.

References IS_WIRE_IMAGE, and EDA_ITEM::m_flags.

◆ IterateForward() [1/2]

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

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

Definition at line 295 of file eda_item.h.

299  {
300  for( auto it : aList )
301  {
302  if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
304  return SEARCH_RESULT::QUIT;
305  }
306 
308  }
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:93

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

Referenced by GERBER_FILE_IMAGE::Visit().

◆ IterateForward() [2/2]

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

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

Definition at line 314 of file eda_item.h.

316  {
317  for( auto it : aList )
318  {
319  if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
321  return SEARCH_RESULT::QUIT;
322  }
323 
325  }
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:93

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

◆ layerMaskDescribe()

wxString BOARD_ITEM::layerMaskDescribe ( ) const
protectedvirtualinherited

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

The BOARD is needed because layer names are customizable.

Reimplemented in PCB_VIA.

Definition at line 85 of file board_item.cpp.

86 {
87  const BOARD* board = GetBoard();
88  LSET layers = GetLayerSet();
89 
90  // Try to be smart and useful. Check all copper first.
91  if( layers[F_Cu] && layers[B_Cu] )
92  return _( "all copper layers" );
93 
94  LSET copperLayers = layers & board->GetEnabledLayers().AllCuMask();
95  LSET techLayers = layers & board->GetEnabledLayers().AllTechMask();
96 
97  for( LSET testLayers : { copperLayers, techLayers, layers } )
98  {
99  for( int bit = PCBNEW_LAYER_ID_START; bit < PCB_LAYER_ID_COUNT; ++bit )
100  {
101  if( testLayers[ bit ] )
102  {
103  wxString layerInfo = board->GetLayerName( static_cast<PCB_LAYER_ID>( bit ) );
104 
105  if( testLayers.count() > 1 )
106  layerInfo << wxS( " " ) + _( "and others" );
107 
108  return layerInfo;
109  }
110  }
111  }
112 
113  // No copper, no technicals: no layer
114  return _( "no layers" );
115 }
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:362
LSET GetEnabledLayers() const
A proxy function that calls the corresponding function in m_BoardSettings.
Definition: board.cpp:467
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.
Definition: layer_ids.h:504
#define _(s)
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:190
Definition: layer_ids.h:71
virtual const BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
Definition: board_item.cpp:36
virtual LSET GetLayerSet() const
Return a std::bitset of all layers on which the item physically resides.
Definition: board_item.h:145

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

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

◆ Matches() [1/2]

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

Compare the item against the search criteria in aSearchData.

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

Parameters
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_SYMBOL, SCH_SHEET, SCH_TEXT, SCH_FIELD, SCH_SHEET_PIN, ZONE, SCH_PIN, SCH_MARKER, PCB_MARKER, FP_TEXT, and PCB_TEXT.

Definition at line 365 of file eda_item.h.

366  {
367  return false;
368  }

Referenced by SCH_EDITOR_CONTROL::HasMatch(), inDiffPair(), 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 118 of file eda_item.cpp.

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

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

◆ Mirror()

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

Mirror the dimension relative to a given horizontal axis.

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

Parameters
axis_posis the vertical axis position to mirror around.

Definition at line 260 of file pcb_dimension.cpp.

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

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

Referenced by PCB_DIMENSION_BASE::Flip().

◆ Move() [1/2]

void PCB_DIMENSION_BASE::Move ( const wxPoint &  aMoveVector)
overridevirtualinherited

Move this object.

Parameters
aMoveVectorthe move vector for this object.

Reimplemented from BOARD_ITEM.

Definition at line 221 of file pcb_dimension.cpp.

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

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

◆ Move() [2/2]

void BOARD_ITEM::Move ( const VECTOR2I aMoveVector)
inlineinherited

Definition at line 241 of file board_item.h.

242  {
243  Move( wxPoint( aMoveVector.x, aMoveVector.y ) );
244  }
virtual void Move(const wxPoint &aMoveVector)
Move this object.
Definition: board_item.h:236

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

◆ operator<()

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

Test if another item is less than this object.

Parameters
aItem- Item to compare against.
Returns
- True if aItem is less than the item.

Definition at line 171 of file eda_item.cpp.

172 {
173  wxFAIL_MSG( wxString::Format( wxT( "Less than operator not defined for item type %s." ),
174  GetClass() ) );
175 
176  return false;
177 }
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 145 of file eda_item.cpp.

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

References traceFindReplace.

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

◆ Replace() [2/2]

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

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

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

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

393  {
394  return false;
395  }

◆ Rotate() [1/2]

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

Rotate this object.

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

Reimplemented from BOARD_ITEM.

Reimplemented in PCB_DIM_ORTHOGONAL.

Definition at line 232 of file pcb_dimension.cpp.

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

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

Referenced by PCB_DIM_ORTHOGONAL::Rotate().

◆ Rotate() [2/2]

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

Definition at line 254 of file board_item.h.

255  {
256  Rotate( wxPoint( aRotCentre.x, aRotCentre.y ), aAngle );
257  }
virtual void Rotate(const wxPoint &aRotCentre, double aAngle)
Rotate this object.
Definition: board_item.cpp:177

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

◆ segCircleIntersection()

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

Definition at line 482 of file pcb_dimension.cpp.

483 {
484  VECTOR2I start( aStart ? aSeg.A : aSeg.B );
485  VECTOR2I endpoint( aStart ? aSeg.B : aSeg.A );
486 
487  if( aCircle.Contains( start ) )
488  return NULLOPT;
489 
490  std::vector<VECTOR2I> intersections = aCircle.Intersect( aSeg );
491 
492  for( VECTOR2I& intersection : aCircle.Intersect( aSeg ) )
493  {
494  if( ( intersection - start ).SquaredEuclideanNorm() <
495  ( endpoint - start ).SquaredEuclideanNorm() )
496  endpoint = intersection;
497  }
498 
499  if( start == endpoint )
500  return NULLOPT;
501 
502  return OPT_VECTOR2I( endpoint );
503 }
const auto NULLOPT
Definition: optional.h:9
OPT< VECTOR2I > OPT_VECTOR2I
Definition: seg.h:38
std::vector< VECTOR2I > Intersect(const CIRCLE &aCircle) const
Compute the intersection points between this circle and aCircle.
Definition: circle.cpp:209
bool Contains(const VECTOR2I &aP) const
Return true if aP is on the circumference of this circle.
Definition: circle.cpp:188
VECTOR2I A
Definition: seg.h:48
VECTOR2I B
Definition: seg.h:49

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

Referenced by updateGeometry().

◆ segPolyIntersection()

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

Find the intersection between a given segment and polygon outline.

Parameters
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 456 of file pcb_dimension.cpp.

458 {
459  VECTOR2I start( aStart ? aSeg.A : aSeg.B );
460  VECTOR2I endpoint( aStart ? aSeg.B : aSeg.A );
461 
462  if( aPoly.Contains( start ) )
463  return NULLOPT;
464 
465  for( SHAPE_POLY_SET::CONST_SEGMENT_ITERATOR seg = aPoly.CIterateSegments(); seg; ++seg )
466  {
467  if( OPT_VECTOR2I intersection = ( *seg ).Intersect( aSeg ) )
468  {
469  if( ( *intersection - start ).SquaredEuclideanNorm() <
470  ( endpoint - start ).SquaredEuclideanNorm() )
471  endpoint = *intersection;
472  }
473  }
474 
475  if( start == endpoint )
476  return NULLOPT;
477 
478  return OPT_VECTOR2I( endpoint );
479 }
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:38
VECTOR2I A
Definition: seg.h:48
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:49

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

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

◆ Set() [1/3]

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

Definition at line 42 of file inspectable.h.

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

◆ 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 PCB_DIMENSION_BASE::SetArrowLength ( int  aLength)
inlineinherited

Definition at line 185 of file pcb_dimension.h.

185 { m_arrowLength = aLength; }
int m_arrowLength
Length of arrow shapes.

References PCB_DIMENSION_BASE::m_arrowLength.

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

◆ SetAutoUnits()

void PCB_DIMENSION_BASE::SetAutoUnits ( bool  aAuto = true)
inlineinherited

Definition at line 167 of file pcb_dimension.h.

167 { m_autoUnits = aAuto; }
bool m_autoUnits
If true, follow the currently selected UI units.

References PCB_DIMENSION_BASE::m_autoUnits.

◆ SetBrightened()

◆ SetEnd()

◆ SetExtensionOffset()

void PCB_DIMENSION_BASE::SetExtensionOffset ( int  aOffset)
inlineinherited

◆ SetFlags()

void EDA_ITEM::SetFlags ( EDA_ITEM_FLAGS  aMask)
inlineinherited

Definition at line 153 of file eda_item.h.

153 { m_flags |= aMask; }
EDA_ITEM_FLAGS m_flags
Definition: eda_item.h:481

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(), 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::ParseLabel(), 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_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_SYMBOL_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 204 of file eda_item.h.

204 { m_forceVisible = aEnable; }
bool m_forceVisible
Definition: eda_item.h:480

References EDA_ITEM::m_forceVisible.

Referenced by SCH_EDITOR_CONTROL::UpdateFind().

◆ SetKeepTextAligned()

void PCB_DIMENSION_BASE::SetKeepTextAligned ( bool  aKeepAligned)
inlineinherited

Definition at line 179 of file pcb_dimension.h.

179 { m_keepTextAligned = aKeepAligned; }
bool m_keepTextAligned
Calculate text orientation to match dimension.

References PCB_DIMENSION_BASE::m_keepTextAligned.

Referenced by DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ SetLayer()

void PCB_DIMENSION_BASE::SetLayer ( PCB_LAYER_ID  aLayer)
overridevirtualinherited

Set the layer this item is on.

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

Parameters
aLayerThe layer number.

Reimplemented from BOARD_ITEM.

Definition at line 214 of file pcb_dimension.cpp.

215 {
216  m_layer = aLayer;
217  m_text.SetLayer( aLayer );
218 }
virtual void SetLayer(PCB_LAYER_ID aLayer)
Set the layer this item is on.
Definition: board_item.h:161
PCB_TEXT m_text
The actual text object.
PCB_LAYER_ID m_layer
Definition: board_item.h:316

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

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

◆ SetLayerSet()

virtual void BOARD_ITEM::SetLayerSet ( LSET  aLayers)
inlinevirtualinherited

Reimplemented in PAD, PCB_VIA, and ZONE.

Definition at line 146 of file board_item.h.

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

Referenced by PANEL_SETUP_LAYERS::TransferDataFromWindow().

◆ SetLineThickness()

◆ SetLocked()

◆ SetMeasuredValue()

void PCB_DIMENSION_BASE::SetMeasuredValue ( int  aValue)
inlineinherited

Definition at line 139 of file pcb_dimension.h.

139 { m_measuredValue = aValue; }
int m_measuredValue
value of PCB dimensions

References PCB_DIMENSION_BASE::m_measuredValue.

◆ SetModified()

void EDA_ITEM::SetModified ( )
inherited

◆ SetOverrideText()

void PCB_DIMENSION_BASE::SetOverrideText ( const wxString &  aValue)
inlineinherited

Definition at line 134 of file pcb_dimension.h.

134 { m_valueString = aValue; }
wxString m_valueString
Displayed value when m_overrideValue = true.

References PCB_DIMENSION_BASE::m_valueString.

Referenced by DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ SetOverrideTextEnabled()

void PCB_DIMENSION_BASE::SetOverrideTextEnabled ( bool  aOverride)
inlineinherited

Definition at line 131 of file pcb_dimension.h.

131 { m_overrideTextEnabled = aOverride; }
bool m_overrideTextEnabled
Manually specify the displayed measurement value.

References PCB_DIMENSION_BASE::m_overrideTextEnabled.

Referenced by DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ SetParent()

void PCB_DIMENSION_BASE::SetParent ( EDA_ITEM aParent)
overridevirtualinherited

Reimplemented from EDA_ITEM.

Definition at line 63 of file pcb_dimension.cpp.

64 {
65  BOARD_ITEM::SetParent( aParent );
66  m_text.SetParent( aParent );
67 }
PCB_TEXT m_text
The actual text object.
virtual void SetParent(EDA_ITEM *aParent)
Definition: eda_item.h:116

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

Referenced by DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES().

◆ SetParentGroup()

void BOARD_ITEM::SetParentGroup ( PCB_GROUP aGroup)
inlineinherited

Definition at line 59 of file board_item.h.

59 { m_group = aGroup; }
PCB_GROUP * m_group
Definition: board_item.h:317

References BOARD_ITEM::m_group.

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

◆ SetPosition()

void PCB_DIMENSION_BASE::SetPosition ( const wxPoint &  aPos)
inlineoverridevirtualinherited

Reimplemented from EDA_ITEM.

Definition at line 128 of file pcb_dimension.h.

128 { m_start = aPos; }

References PCB_DIMENSION_BASE::m_start.

◆ SetPrecision()

void PCB_DIMENSION_BASE::SetPrecision ( int  aPrecision)
inlineinherited

◆ SetPrefix()

void PCB_DIMENSION_BASE::SetPrefix ( const wxString &  aPrefix)
inherited

◆ SetSelected()

◆ SetStart()

◆ SetState()

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

Definition at line 142 of file eda_item.h.

143  {
144  if( state )
145  m_status |= type; // state = ON or OFF
146  else
147  m_status &= ~type;
148  }
EDA_ITEM_FLAGS m_status
Definition: eda_item.h:478

References EDA_ITEM::m_status.

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

◆ SetStatus()

void EDA_ITEM::SetStatus ( EDA_ITEM_FLAGS  aStatus)
inlineinherited

Definition at line 151 of file eda_item.h.

151 { m_status = aStatus; }
EDA_ITEM_FLAGS m_status
Definition: eda_item.h:478

References EDA_ITEM::m_status.

Referenced by BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ SetSuffix()

void PCB_DIMENSION_BASE::SetSuffix ( const wxString &  aSuffix)
inherited

◆ SetSuppressZeroes()

void PCB_DIMENSION_BASE::SetSuppressZeroes ( bool  aSuppress)
inlineinherited

Definition at line 176 of file pcb_dimension.h.

176 { m_suppressZeroes = aSuppress; }
bool m_suppressZeroes
Suppress trailing zeroes.

References PCB_DIMENSION_BASE::m_suppressZeroes.

Referenced by DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ SetText()

void PCB_DIMENSION_BASE::SetText ( const wxString &  aNewText)
inherited

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

Parameters
aNewTextis the text to use as the value.

Definition at line 201 of file pcb_dimension.cpp.

202 {
203  m_valueString = aNewText;
204  updateText();
205 }
wxString m_valueString
Displayed value when m_overrideValue = true.
virtual void updateText()
Update the text field value from the current geometry (called by updateGeometry normally).

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

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

◆ SetTextFrame()

void PCB_DIM_LEADER::SetTextFrame ( DIM_TEXT_FRAME  aFrame)
inline

Definition at line 510 of file pcb_dimension.h.

510 { m_textFrame = aFrame; }
DIM_TEXT_FRAME m_textFrame

References m_textFrame.

Referenced by DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ SetTextPositionMode()

void PCB_DIMENSION_BASE::SetTextPositionMode ( DIM_TEXT_POSITION  aMode)
inlineinherited

Definition at line 181 of file pcb_dimension.h.

181 { m_textPosition = aMode; }
DIM_TEXT_POSITION m_textPosition
How to position the text.

References PCB_DIMENSION_BASE::m_textPosition.

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

◆ SetTextSize()

void PCB_DIMENSION_BASE::SetTextSize ( const wxSize &  aTextSize)
inlineinherited

Definition at line 195 of file pcb_dimension.h.

196  {
197  m_text.SetTextSize( aTextSize );
198  }
void SetTextSize(const wxSize &aNewSize)
Definition: eda_text.h:258
PCB_TEXT m_text
The actual text object.

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

◆ SetUnits()

◆ SetUnitsFormat()

◆ SetUnitsMode()

void PCB_DIMENSION_BASE::SetUnitsMode ( DIM_UNITS_MODE  aMode)
inherited

Definition at line 176 of file pcb_dimension.cpp.

177 {
178  m_autoUnits = false;
179 
180  switch( aMode )
181  {
184  break;
185 
188  break;
189 
192  break;
193 
195  m_autoUnits = true;
196  break;
197  }
198 }
bool m_autoUnits
If true, follow the currently selected UI units.
EDA_UNITS m_units
0 = inches, 1 = mm

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

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

◆ SetWireImage()

void EDA_ITEM::SetWireImage ( )
inlineinherited

Definition at line 128 of file eda_item.h.

128 { SetFlags( IS_WIRE_IMAGE ); }
void SetFlags(EDA_ITEM_FLAGS aMask)
Definition: eda_item.h:153
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.

References IS_WIRE_IMAGE, and EDA_ITEM::SetFlags().

◆ SetX()

void BOARD_ITEM::SetX ( int  aX)
inlineinherited

Definition at line 86 of file board_item.h.

87  {
88  wxPoint p( aX, GetY() );
89  SetPosition( p );
90  }
virtual void SetPosition(const wxPoint &aPos)
Definition: eda_item.h:253
int GetY() const
Definition: board_item.h:70

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

93  {
94  wxPoint p( GetX(), aY );
95  SetPosition( p );
96  }
virtual void SetPosition(const wxPoint &aPos)
Definition: eda_item.h:253
int GetX() const
Definition: board_item.h:64

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

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

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

421 { return *aLeft < *aRight; }

◆ SwapData()

void PCB_DIM_LEADER::SwapData ( BOARD_ITEM aImage)
overridevirtual

Swap data between aItem and aImage.

aItem and aImage should have the same type.

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

Parameters
aImagethe item image which contains data to swap.

Reimplemented from BOARD_ITEM.

Definition at line 969 of file pcb_dimension.cpp.

970 {
971  assert( aImage->Type() == PCB_DIM_LEADER_T );
972 
973  std::swap( *static_cast<PCB_DIM_LEADER*>( this ), *static_cast<PCB_DIM_LEADER*>( aImage ) );
974 }
class PCB_DIM_LEADER, a leader dimension (graphic item)
Definition: typeinfo.h:101
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:113

References PCB_DIM_LEADER_T, and EDA_ITEM::Type().

◆ Text() [1/2]

◆ Text() [2/2]

const PCB_TEXT& PCB_DIMENSION_BASE::Text ( ) const
inlineinherited

Definition at line 215 of file pcb_dimension.h.

215 { return m_text; }
PCB_TEXT m_text
The actual text object.

References PCB_DIMENSION_BASE::m_text.

◆ TransformShapeWithClearanceToPolygon()

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

Convert the item shape to a closed polygon.

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

Parameters
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 506 of file pcb_dimension.cpp.

510 {
511  wxASSERT_MSG( !aIgnoreLineWidth, "IgnoreLineWidth has no meaning for dimensions." );
512 
513  for( const std::shared_ptr<SHAPE>& shape : m_shapes )
514  {
515  const SHAPE_CIRCLE* circle = dynamic_cast<const SHAPE_CIRCLE*>( shape.get() );
516  const SHAPE_SEGMENT* seg = dynamic_cast<const SHAPE_SEGMENT*>( shape.get() );
517 
518  if( circle )
519  {
520  TransformCircleToPolygon( aCornerBuffer, (wxPoint) circle->GetCenter(),
521  circle->GetRadius() + m_lineThickness / 2 + aClearance,
522  aError, aErrorLoc );
523  }
524  else if( seg )
525  {
526  TransformOvalToPolygon( aCornerBuffer, (wxPoint) seg->GetSeg().A,
527  (wxPoint) seg->GetSeg().B, m_lineThickness + 2 * aClearance,
528  aError, aErrorLoc );
529  }
530  else
531  {
532  wxFAIL_MSG( "PCB_DIMENSION_BASE::TransformShapeWithClearanceToPolygon unexpected "
533  "shape type." );
534  }
535  }
536 }
int GetRadius() const
Definition: shape_circle.h:107
std::vector< std::shared_ptr< SHAPE > > m_shapes
const VECTOR2I GetCenter() const
Definition: shape_circle.h:112
void TransformCircleToPolygon(SHAPE_LINE_CHAIN &aCornerBuffer, const wxPoint &aCenter, int aRadius, int aError, ERROR_LOC aErrorLoc, int aMinSegCount=0)
Convert a circle to a polygon, using multiple straight lines.
void TransformOvalToPolygon(SHAPE_POLY_SET &aCornerBuffer, const wxPoint &aStart, const wxPoint &aEnd, int aWidth, int aError, ERROR_LOC aErrorLoc, int aMinSegCount=0)
Convert a oblong shape to a polygon, using multiple segments.
int m_lineThickness
Thickness used for all graphics in the dimension.

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

◆ Type()

KICAD_T EDA_ITEM::Type ( ) const
inlineinherited

Returns the type of object.

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

Returns
the type of object.

Definition at line 113 of file eda_item.h.

113 { return m_structType; }
KICAD_T m_structType
Run time identification, keep private so it can never be changed after a ctor sets it.
Definition: eda_item.h:488

References EDA_ITEM::m_structType.

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(), calcIsInsideArea(), calcIsInsideCourtyard(), 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_LABEL::CanConnect(), SCH_SHEET::CanConnect(), SCH_GLOBALLABEL::CanConnect(), SCH_HIERLABEL::CanConnect(), SCH_SYMBOL::CanConnect(), CN_VISITOR::checkZoneItemConnection(), SCH_MARKER::ClassOf(), SCH_JUNCTION::ClassOf(), PCB_TEXT::ClassOf(), SCH_NO_CONNECT::ClassOf(), SCH_PIN::ClassOf(), PCB_MARKER::ClassOf(), BOARD_CONNECTED_ITEM::ClassOf(), FP_SHAPE::ClassOf(), PCB_SHAPE::ClassOf(), PCB_TARGET::ClassOf(), SCH_LINE::ClassOf(), PCB_GROUP::ClassOf(), SCH_FIELD::ClassOf(), FP_TEXT::ClassOf(), SCH_SHEET::ClassOf(), NETINFO_ITEM::ClassOf(), ZONE::ClassOf(), SCH_SHEET_PIN::ClassOf(), SCH_BITMAP::ClassOf(), PCB_TRACK::ClassOf(), PAD::ClassOf(), SCH_SYMBOL::ClassOf(), FOOTPRINT::ClassOf(), SCH_SCREEN::ClassOf(), SCH_TEXT::ClassOf(), SCH_BUS_WIRE_ENTRY::ClassOf(), SCH_BUS_BUS_ENTRY::ClassOf(), BOARD::ClassOf(), PCB_ARC::ClassOf(), SCH_LABEL::ClassOf(), PCB_VIA::ClassOf(), SCH_GLOBALLABEL::ClassOf(), PCB_DIM_ALIGNED::ClassOf(), PCB_DIM_ORTHOGONAL::ClassOf(), SCH_HIERLABEL::ClassOf(), ClassOf(), PCB_DIM_CENTER::ClassOf(), TRACKS_CLEANER::cleanup(), LIB_TEXT::compare(), LIB_FIELD::compare(), LIB_PIN::compare(), LIB_ITEM::compare(), LIB_SYMBOL::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(), CONVERT_TOOL::CreateLines(), PCB_BASE_FRAME::CreateNewFootprint(), SCH_DRAWING_TOOLS::createNewText(), ZONE_CREATE_HELPER::createNewZone(), CONVERT_TOOL::CreatePolys(), BOARD_ADAPTER::createTrack(), DRC_TOOL::CrossProbe(), SCH_SCREEN::DeleteItem(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), DIALOG_SCH_FIELD_PROPERTIES::DIALOG_SCH_FIELD_PROPERTIES(), DIALOG_TEXT_AND_LABEL_PROPERTIES::DIALOG_TEXT_AND_LABEL_PROPERTIES(), 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(), PCB_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(), getMinDist(), PCB_TRACK::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_FIELD::GetName(), CONNECTIVITY_DATA::GetNetItems(), LIB_SYMBOL::GetNextDrawItem(), PCB_SHAPE::GetParentFootprint(), LIB_SYMBOL::GetPin(), SCH_SYMBOL::GetPinPhysicalPosition(), SCH_FIELD::GetPosition(), KIGFX::SCH_PAINTER::getRenderColor(), ALIGN_DISTRIBUTE_TOOL::GetSelections(), PCB_TRACK::GetSelectMenuText(), DRC_ENGINE::GetShape(), PCB_TEXT::GetShownText(), SCH_FIELD::GetShownText(), SCH_TEXT::GetShownText(), CONVERT_TOOL::getStartEndPoints(), getTopLevelGroup(), PCB_EXPR_TYPE_REF::GetValue(), GROUP_TOOL::Group(), PCB_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(), insideFrontCourtyard(), EE_COLLECTOR::Inspect(), GENERAL_COLLECTOR::Inspect(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), BOARD_INSPECTION_TOOL::InspectDRCError(), 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(), PCB_TRACK::IsNull(), SCH_LINE::IsParallel(), isPlated(), SCH_FIELD::IsReplaceable(), PNS::ROUTER::isStartingPointRoutable(), BOARD_ITEM::IsTrack(), itemIsIncludedByFilter(), PCB_SELECTION_TOOL::itemPassesFilter(), CLIPBOARD_IO::Load(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), CADSTAR_SCH_ARCHIVE_LOADER::loadHierarchicalSheetPins(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), 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(), CONVERT_TOOL::makePolysFromSegs(), 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(), PCB_POINT_EDITOR::OnSelectionChange(), PCB_SHAPE::cmp_drawings::operator()(), PCB_TRACK::cmp_tracks::operator()(), CN_VISITOR::operator()(), BOARD_ITEM::ptr_cmp::operator()(), FOOTPRINT::cmp_drawings::operator()(), BOARD::cmp_items::operator()(), BOARD::cmp_drawings::operator()(), SCH_BUS_ENTRY_BASE::operator<(), SCH_JUNCTION::operator<(), SCH_TEXT::operator<(), SCH_FIELD::operator<(), SCH_LINE::operator<(), SCH_SHEET::operator<(), SCH_ITEM::operator<(), SCH_SYMBOL::operator<(), SCH_BITMAP::operator=(), SCH_SHEET::operator=(), SCH_SYMBOL::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(), 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(), 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_SYMBOL::RemoveDrawItem(), SCH_SHEET::RemovePin(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_FIELD::Replace(), SCH_EDITOR_CONTROL::ReplaceAll(), 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(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList(), SCH_SEXPR_PLUGIN::saveField(), SCH_SEXPR_PLUGIN_CACHE::saveField(), SCH_SEXPR_PLUGIN_CACHE::savePin(), CLIPBOARD_IO::SaveSelection(), SCH_SEXPR_PLUGIN_CACHE::saveSymbolDrawItem(), SCH_SEXPR_PLUGIN::saveText(), SCH_SEXPR_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(), PCB_POINT_EDITOR::setAltConstraint(), SCH_FIELD::SetId(), ITEM_PICKER::SetItem(), SCH_FIELD::SetPosition(), DIALOG_TEXT_AND_LABEL_PROPERTIES::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(), PCB_TRACK::SwapData(), SCH_SHEET::SwapData(), PCB_ARC::SwapData(), PCB_DIM_ALIGNED::SwapData(), PCB_DIM_ORTHOGONAL::SwapData(), SCH_SYMBOL::SwapData(), PCB_VIA::SwapData(), SwapData(), PCB_DIM_CENTER::SwapData(), PAD::SwapData(), FOOTPRINT::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_TEXT_AND_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), DIALOG_SYMBOL_FIELDS_TABLE::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_AND_LABEL_PROPERTIES::TransferDataToWindow(), PCB_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_FIELD_PROPERTIES::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(), PCB_TRACK::Visit(), GERBER_DRAW_ITEM::Visit(), SCH_GLOBALLABEL::Visit(), SCH_SHEET::Visit(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem(), and NETLIST_EXPORTER_CADSTAR::writeListOfNets().

◆ Update()

void PCB_DIMENSION_BASE::Update ( )
inlineinherited

Update the dimension's cached text and geometry.

Definition at line 149 of file pcb_dimension.h.

150  {
151  updateGeometry();
152  updateText();
153  }
virtual void updateGeometry()=0
Update the cached geometry of the dimension after changing any of its properties.
virtual void updateText()
Update the text field value from the current geometry (called by updateGeometry normally).

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

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

◆ updateGeometry()

void PCB_DIM_LEADER::updateGeometry ( )
overrideprotectedvirtual

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

Implements PCB_DIMENSION_BASE.

Definition at line 983 of file pcb_dimension.cpp.

984 {
985  m_shapes.clear();
986 
987  updateText();
988 
989  // Now that we have the text updated, we can determine how to draw the second line
990  // First we need to create an appropriate bounding polygon to collide with
993 
994  SHAPE_POLY_SET polyBox;
995  polyBox.NewOutline();
996  polyBox.Append( textBox.GetOrigin() );
997  polyBox.Append( textBox.GetOrigin().x, textBox.GetEnd().y );
998  polyBox.Append( textBox.GetEnd() );
999  polyBox.Append( textBox.GetEnd().x, textBox.GetOrigin().y );
1000  polyBox.Rotate( -m_text.GetTextAngleRadians(), textBox.GetCenter() );
1001 
1002  VECTOR2I firstLine( m_end - m_start );
1003  VECTOR2I start( m_start );
1004  start += firstLine.Resize( m_extensionOffset );
1005 
1006  SEG arrowSeg( m_start, m_end );
1007  SEG textSeg( m_end, m_text.GetPosition() );
1008  OPT_VECTOR2I arrowSegEnd = boost::make_optional( false, VECTOR2I() );;
1009  OPT_VECTOR2I textSegEnd = boost::make_optional( false, VECTOR2I() );
1010 
1012  {
1013  double penWidth = m_text.GetEffectiveTextPenWidth() / 2.0;
1014  double radius = ( textBox.GetWidth() / 2.0 ) - penWidth;
1015  CIRCLE circle( textBox.GetCenter(), radius );
1016 
1017  arrowSegEnd = segCircleIntersection( circle, arrowSeg );
1018  textSegEnd = segCircleIntersection( circle, textSeg );
1019  }
1020  else
1021  {
1022  arrowSegEnd = segPolyIntersection( polyBox, arrowSeg );
1023  textSegEnd = segPolyIntersection( polyBox, textSeg );
1024  }
1025 
1026  if( !arrowSegEnd )
1027  arrowSegEnd = m_end;
1028 
1029  m_shapes.emplace_back( new SHAPE_SEGMENT( start, *arrowSegEnd ) );
1030 
1031  // Add arrows
1032  VECTOR2I arrowEnd( m_arrowLength, 0 );
1033 
1034  double arrowRotPos = firstLine.Angle() + DEG2RAD( s_arrowAngle );
1035  double arrowRotNeg = firstLine.Angle() - DEG2RAD( s_arrowAngle );
1036 
1037  m_shapes.emplace_back( new SHAPE_SEGMENT( start,
1038  start + wxPoint( arrowEnd.Rotate( arrowRotPos ) ) ) );
1039  m_shapes.emplace_back( new SHAPE_SEGMENT( start,
1040  start + wxPoint( arrowEnd.Rotate( arrowRotNeg ) ) ) );
1041 
1042 
1043  if( !GetText().IsEmpty() )
1044  {
1045  switch( m_textFrame )
1046  {
1048  {
1049  for( SHAPE_POLY_SET::SEGMENT_ITERATOR seg = polyBox.IterateSegments(); seg; seg++ )
1050  m_shapes.emplace_back( new SHAPE_SEGMENT( *seg ) );
1051 
1052  break;
1053  }
1054 
1056  {
1057  double penWidth = m_text.GetEffectiveTextPenWidth() / 2.0;
1058  double radius = ( textBox.GetWidth() / 2.0 ) - penWidth;
1059  m_shapes.emplace_back( new SHAPE_CIRCLE( textBox.GetCenter(), radius ) );
1060 
1061  break;
1062  }
1063 
1064  default:
1065  break;
1066  }
1067  }
1068 
1069  if( textSegEnd && *arrowSegEnd == m_end )
1070  m_shapes.emplace_back( new SHAPE_SEGMENT( m_end, *textSegEnd ) );
1071 }
static OPT_VECTOR2I segCircleIntersection(CIRCLE &aCircle, SEG &aSeg, bool aStart=true)
std::vector< std::shared_ptr< SHAPE > > m_shapes
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:239
const wxString GetText() const
Retrieve the value text or override text, not including prefix or suffix.
int GetWidth() const
Definition: eda_rect.h:109
Base class for iterating over all segments in a given SHAPE_POLY_SET.
void Rotate(double aAngle, const VECTOR2I &aCenter={ 0, 0 }) override
Rotate all vertices by a given angle.
wxPoint m_end
Internal cache of drawn shapes.
VECTOR2< int > VECTOR2I
Definition: vector2d.h:623
PCB_TEXT m_text
The actual text object.
int GetEffectiveTextPenWidth(int aDefaultWidth=0) const
The EffectiveTextPenWidth uses the text thickness if > 1 or aDefaultWidth.
Definition: eda_text.cpp:159
const wxPoint GetEnd() const
Definition: eda_rect.h:103
OPT< VECTOR2I > OPT_VECTOR2I
Definition: seg.h:38
virtual wxPoint GetPosition() const override
Definition: pcb_text.h:76
Represent a set of closed polygons.
const wxPoint GetOrigin() const
Definition: eda_rect.h:101
Represent basic circle geometry with utility geometry functions.
Definition: circle.h:32
int NewOutline()
Creates a new hole in a given outline.
static constexpr float s_arrowAngle
Definition: seg.h:40
double GetTextAngleRadians() const
Definition: eda_text.h:198
int GetTextWidth() const
Definition: eda_text.h:262
double DEG2RAD(double deg)
Definition: trigo.h:229
Handle the component boundary box.
Definition: eda_rect.h:42
DIM_TEXT_FRAME m_textFrame
static OPT_VECTOR2I segPolyIntersection(const SHAPE_POLY_SET &aPoly, const SEG &aSeg, bool aStart=true)
Find the intersection between a given segment and polygon outline.
int m_extensionOffset
Distance from feature points to extension line start.
const wxPoint GetCenter() const
Definition: eda_rect.h:104
EDA_RECT & Inflate(wxCoord dx, wxCoord dy)
Inflate the rectangle horizontally by dx and vertically by dy.
Definition: eda_rect.cpp:364
SEGMENT_ITERATOR IterateSegments(int aFirst, int aLast, bool aIterateHoles=false)
Return an iterator object, for iterating between aFirst and aLast outline, with or without holes (def...
virtual void updateText()
Update the text field value from the current geometry (called by updateGeometry normally).
int Append(int x, int y, int aOutline=-1, int aHole=-1, bool aAllowDuplication=false)
Add a new vertex to the contour indexed by aOutline and aHole (defaults to the outline of the last po...
int m_arrowLength
Length of arrow shapes.

References VECTOR2< T >::Angle(), SHAPE_POLY_SET::Append(), CIRCLE, DEG2RAD(), EDA_RECT::GetCenter(), EDA_TEXT::GetEffectiveTextPenWidth(), EDA_RECT::GetEnd(), EDA_RECT::GetOrigin(), PCB_TEXT::GetPosition(), PCB_DIMENSION_BASE::GetText(), EDA_TEXT::GetTextAngleRadians(), EDA_TEXT::GetTextBox(), EDA_TEXT::GetTextWidth(), EDA_RECT::GetWidth(), EDA_RECT::Inflate(), SHAPE_POLY_SET::IterateSegments(), PCB_DIMENSION_BASE::m_arrowLength, PCB_DIMENSION_BASE::m_end, PCB_DIMENSION_BASE::m_extensionOffset, PCB_DIMENSION_BASE::m_shapes, PCB_DIMENSION_BASE::m_start, PCB_DIMENSION_BASE::m_text, m_textFrame, SHAPE_POLY_SET::NewOutline(), RECTANGLE, VECTOR2< T >::Resize(), VECTOR2< T >::Rotate(), SHAPE_POLY_SET::Rotate(), PCB_DIMENSION_BASE::s_arrowAngle, PCB_DIMENSION_BASE::segCircleIntersection(), PCB_DIMENSION_BASE::segPolyIntersection(), and PCB_DIMENSION_BASE::updateText().

◆ updateText()

void PCB_DIMENSION_BASE::updateText ( )
protectedvirtualinherited

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

Reimplemented in PCB_DIM_ORTHOGONAL, and PCB_DIM_ALIGNED.

Definition at line 70 of file pcb_dimension.cpp.

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

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

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

◆ ViewBBox()

const BOX2I PCB_DIMENSION_BASE::ViewBBox ( ) const
overridevirtualinherited

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

Returns
the current bounding box.

Reimplemented from EDA_ITEM.

Reimplemented in PCB_DIM_CENTER.

Definition at line 446 of file pcb_dimension.cpp.

447 {
448  BOX2I dimBBox = BOX2I( VECTOR2I( GetBoundingBox().GetPosition() ),
449  VECTOR2I( GetBoundingBox().GetSize() ) );
450  dimBBox.Merge( m_text.ViewBBox() );
451 
452  return dimBBox;
453 }
BOX2< VECTOR2I > BOX2I
Definition: box2.h:506
const EDA_RECT GetBoundingBox() const override
Return the orthogonal bounding box of this object for display purposes.
VECTOR2< int > VECTOR2I
Definition: vector2d.h:623
A 2D bounding box built on top of an origin point and size vector.
Definition: box2.h:41
PCB_TEXT m_text
The actual text object.
wxPoint GetPosition() const override
BOX2< Vec > & Merge(const BOX2< Vec > &aRect)
Modify the position and size of the rectangle in order to contain aRect.
Definition: box2.h:363
virtual const BOX2I ViewBBox() const override
Return the bounding box of the item covering all its layers.
Definition: eda_item.cpp:194

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

◆ ViewDraw()

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

Draw the parts of the object belonging to layer aLayer.

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

Parameters
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::PREVIEW::SELECTION_AREA, KIGFX::VIEW_GROUP, 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 106 of file view_item.h.

107  {}

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, PCB_VIA, FP_TEXT, PCB_TRACK, ZONE, PCB_GROUP, and PCB_MARKER.

Definition at line 118 of file board_item.cpp.

119 {
120  // Basic fallback
121  aCount = 1;
122  aLayers[0] = m_layer;
123 }
PCB_LAYER_ID m_layer
Definition: board_item.h:316

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, PCB_VIA, GERBER_DRAW_ITEM, FP_TEXT, PCB_TRACK, ZONE, PCB_GROUP, and FP_SHAPE.

Definition at line 132 of file view_item.h.

133  {
134  // By default always show the item
135  return 0.0;
136  }

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

Definition at line 93 of file eda_item.cpp.

94 {
95 #if 0 && defined(DEBUG)
96  std::cout << GetClass().mb_str() << ' ';
97 #endif
98 
99  if( IsType( scanTypes ) )
100  {
101  if( SEARCH_RESULT::QUIT == inspector( this, testData ) )
102  return SEARCH_RESULT::QUIT;
103  }
104 
106 }
virtual bool IsType(const KICAD_T aScanTypes[]) const
Check whether the item is one of the listed types.
Definition: eda_item.h:183
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 PCB_DIMENSION_BASE::m_autoUnits
protectedinherited

If true, follow the currently selected UI units.

Definition at line 292 of file pcb_dimension.h.

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

◆ m_end

◆ m_extensionOffset

int PCB_DIMENSION_BASE::m_extensionOffset
protectedinherited

◆ m_flags

◆ m_forceVisible

bool EDA_ITEM::m_forceVisible
protectedinherited

◆ m_group

PCB_GROUP* BOARD_ITEM::m_group
protectedinherited

Definition at line 317 of file board_item.h.

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

◆ m_keepTextAligned

bool PCB_DIMENSION_BASE::m_keepTextAligned
protectedinherited

◆ m_layer

◆ m_lineThickness

int PCB_DIMENSION_BASE::m_lineThickness
protectedinherited

◆ m_measuredValue

int PCB_DIMENSION_BASE::m_measuredValue
protectedinherited

◆ m_overrideTextEnabled

bool PCB_DIMENSION_BASE::m_overrideTextEnabled
protectedinherited

◆ m_parent

◆ m_precision

int PCB_DIMENSION_BASE::m_precision
protectedinherited

Number of digits to display after decimal.

Definition at line 294 of file pcb_dimension.h.

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

◆ m_prefix

wxString PCB_DIMENSION_BASE::m_prefix
protectedinherited

String prepended to the value.

Definition at line 289 of file pcb_dimension.h.

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

◆ m_shapes

◆ m_start

◆ m_status

◆ m_suffix

wxString PCB_DIMENSION_BASE::m_suffix
protectedinherited

String appended to the value.

Definition at line 290 of file pcb_dimension.h.

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

◆ m_suppressZeroes

bool PCB_DIMENSION_BASE::m_suppressZeroes
protectedinherited

◆ m_text

◆ m_textFrame

DIM_TEXT_FRAME PCB_DIM_LEADER::m_textFrame
private

Definition at line 519 of file pcb_dimension.h.

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

◆ m_textPosition

DIM_TEXT_POSITION PCB_DIMENSION_BASE::m_textPosition
protectedinherited

◆ m_units

◆ m_unitsFormat

DIM_UNITS_FORMAT PCB_DIMENSION_BASE::m_unitsFormat
protectedinherited

◆ m_Uuid

const KIID EDA_ITEM::m_Uuid
inherited

Definition at line 475 of file eda_item.h.

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

◆ m_valueString

wxString PCB_DIMENSION_BASE::m_valueString
protectedinherited

Displayed value when m_overrideValue = true.

Definition at line 288 of file pcb_dimension.h.

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

◆ s_arrowAngle

constexpr float PCB_DIMENSION_BASE::s_arrowAngle = 27.5
staticprotectedinherited

◆ ZeroOffset

wxPoint BOARD_ITEM::ZeroOffset
staticinherited

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

Definition at line 119 of file board_item.h.

Referenced by BOARD::GetPosition().


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