KiCad PCB EDA Suite
CENTER_DIMENSION Class Reference

Marks the center of a circle or arc with a cross shape The size and orientation of the cross is adjustable. More...

#include <class_dimension.h>

Inheritance diagram for CENTER_DIMENSION:
DIMENSION BOARD_ITEM EDA_ITEM KIGFX::VIEW_ITEM INSPECTABLE

Public Member Functions

 CENTER_DIMENSION (BOARD_ITEM *aParent)
 
EDA_ITEMClone () const override
 Function Clone creates 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...
 
BITMAP_DEF GetMenuImage () const override
 Function GetMenuImage returns a pointer to an image to be used in menus. More...
 
wxString GetClass () const override
 Function GetClass returns the class name. More...
 
const EDA_RECT GetBoundingBox () const override
 Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes. More...
 
const BOX2I ViewBBox () const override
 Function ViewBBox() returns the bounding box of the item covering all its layers. More...
 
bool IsType (const KICAD_T aScanTypes[]) const override
 Function IsType Checks whether the item is one of the listed types. More...
 
void SetParent (EDA_ITEM *aParent) override
 
virtual const wxPoint & GetStart () const
 The dimension's origin is the first feature point for the dimension. More...
 
virtual void SetStart (const wxPoint &aPoint)
 
virtual const wxPoint & GetEnd () const
 
virtual void SetEnd (const wxPoint &aPoint)
 
wxPoint GetPosition () const override
 
void SetPosition (const wxPoint &aPos) override
 
bool GetOverrideTextEnabled () const
 
void SetOverrideTextEnabled (bool aOverride)
 
wxString GetOverrideText () const
 
void SetOverrideText (const wxString &aValue)
 
int GetMeasuredValue () const
 
wxString GetValueText () const
 
void Update ()
 Updates the dimension's cached text and geometry. More...
 
wxString GetPrefix () const
 
void SetPrefix (const wxString &aPrefix)
 
wxString GetSuffix () const
 
void SetSuffix (const wxString &aSuffix)
 
void GetUnits (EDA_UNITS &aUnits) const
 
void SetUnits (EDA_UNITS aUnits)
 
DIM_UNITS_MODE GetUnitsMode () const
 
void SetUnitsMode (DIM_UNITS_MODE aMode)
 
void SetAutoUnits (bool aAuto=true)
 
DIM_UNITS_FORMAT GetUnitsFormat () const
 
void SetUnitsFormat (const DIM_UNITS_FORMAT aFormat)
 
int GetPrecision () const
 
void SetPrecision (int aPrecision)
 
bool GetSuppressZeroes () const
 
void SetSuppressZeroes (bool aSuppress)
 
bool GetKeepTextAligned () const
 
void SetKeepTextAligned (bool aKeepAligned)
 
void SetTextPositionMode (DIM_TEXT_POSITION aMode)
 
DIM_TEXT_POSITION GetTextPositionMode () const
 
int GetArrowLength () const
 
void SetArrowLength (int aLength)
 
void SetExtensionOffset (int aOffset)
 
int GetExtensionOffset () const
 
int GetLineThickness () const
 
void SetLineThickness (int aWidth)
 
void SetLayer (PCB_LAYER_ID aLayer) override
 Function SetLayer sets the layer this item is on. More...
 
void SetTextSize (const wxSize &aTextSize)
 
void SetText (const wxString &aNewText)
 Sets the override text - has no effect if m_overrideValue == false. More...
 
const wxString GetText () const
 Retrieves the value text or override text, not including prefix or suffix. More...
 
PCB_TEXTText ()
 
PCB_TEXTText () const
 
const std::vector< std::shared_ptr< SHAPE > > & GetShapes () const
 
std::vector< SHAPE * > MakeEffectiveShapes () const
 
void Move (const wxPoint &offset) override
 Function Move move this object. More...
 
void Move (const VECTOR2I &aMoveVector)
 
void Rotate (const wxPoint &aRotCentre, double aAngle) override
 Function Rotate Rotate this object. More...
 
void Rotate (const VECTOR2I &aRotCentre, double aAngle)
 
void Flip (const wxPoint &aCentre, bool aFlipLeftRight) override
 Function Flip 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 the text is not mirrored. More...
 
void GetMsgPanelInfo (EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList) override
 Function GetMsgPanelInfo populates aList of MSG_PANEL_ITEM objects with it's internal state for display purposes. More...
 
bool HitTest (const wxPoint &aPosition, int aAccuracy) const override
 Function HitTest tests if aPosition is contained within or on the bounding box of an item. More...
 
bool HitTest (const EDA_RECT &aRect, bool aContained, int aAccuracy=0) const override
 Function HitTest tests if aRect intersects or is contained within the bounding box of an item. More...
 
std::shared_ptr< SHAPEGetEffectiveShape (PCB_LAYER_ID aLayer) const override
 Function GetEffectiveShape Some pad shapes can be complex (rounded/chamfered rectangle), even without considering custom shapes. More...
 
wxString GetSelectMenuText (EDA_UNITS aUnits) const override
 Function GetSelectMenuText returns the text to display to be used in the selection clarification context menu when multiple items are found at the current cursor position. More...
 
void SetParentGroup (PCB_GROUP *aGroup)
 
PCB_GROUPGetParentGroup () const
 
int GetX () const
 
int GetY () const
 
virtual wxPoint GetCenter () const
 Function GetCenter() More...
 
void SetX (int aX)
 
void SetY (int aY)
 
virtual bool IsConnected () const
 Function IsConnected() 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
 Function GetLayer returns the primary layer this item is on. More...
 
virtual LSET GetLayerSet () const
 Function GetLayerSet returns a std::bitset of all layers on which the item physically resides. More...
 
virtual void SetLayerSet (LSET aLayers)
 
virtual BOARD_ITEMDuplicate () const
 Function Duplicate creates a copy of a BOARD_ITEM. More...
 
virtual bool IsOnLayer (PCB_LAYER_ID aLayer) const
 Function IsOnLayer tests to see if this object is on the given layer. More...
 
bool IsTrack () const
 Function IsTrack tests to see if this object is a track or via (or microvia). More...
 
virtual bool IsLocked () const
 Function IsLocked. More...
 
virtual void SetLocked (bool aLocked)
 Function SetLocked modifies 'lock' status for of the item. More...
 
void DeleteStructure ()
 Function DeleteStructure deletes this object after removing from its parent if it has one. More...
 
virtual BOARDGetBoard () const
 Function GetBoard returns the BOARD in which this BOARD_ITEM resides, or NULL if none. More...
 
wxString GetLayerName () const
 Function GetLayerName returns the name of the PCB layer on which the item resides. More...
 
virtual void ViewGetLayers (int aLayers[], int &aCount) const override
 Function ViewGetLayers() Returns the all the layers within the VIEW the object is painted on. More...
 
virtual void TransformShapeWithClearanceToPolygon (SHAPE_POLY_SET &aCornerBuffer, PCB_LAYER_ID aLayer, int aClearanceValue, int aError, ERROR_LOC aErrorLoc, bool ignoreLineWidth=false) const
 Function TransformShapeWithClearanceToPolygon Convert the item shape to a closed polygon Used in filling zones calculations Circles and arcs are approximated by segments. More...
 
KICAD_T Type () const
 Function Type() More...
 
bool IsModified () const
 
bool IsNew () const
 
bool IsMoving () const
 
bool IsDragging () const
 
bool IsWireImage () const
 
bool IsSelected () const
 
bool IsResized () const
 
bool IsBrightened () const
 
void SetWireImage ()
 
void SetSelected ()
 
void SetBrightened ()
 
void ClearSelected ()
 
void ClearBrightened ()
 
void SetModified ()
 
int GetState (int type) const
 
void SetState (int type, int state)
 
STATUS_FLAGS GetStatus () const
 
void SetStatus (STATUS_FLAGS aStatus)
 
void SetFlags (STATUS_FLAGS aMask)
 
void ClearFlags (STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
 
STATUS_FLAGS GetFlags () const
 
bool HasFlag (STATUS_FLAGS aFlag)
 
STATUS_FLAGS GetEditFlags () const
 
void ClearTempFlags ()
 
void ClearEditFlags ()
 
void SetForceVisible (bool aEnable)
 Function SetForceVisible is used to set and cleag force visible flag used to force the item to be drawn even if it's draw attribute is set to not visible. More...
 
bool IsForceVisible () const
 
virtual const wxPoint GetFocusPosition () const
 Function GetFocusPosition 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[])
 Function Visit may be re-implemented for each derived class in order to handle all the types given by its member data. More...
 
virtual bool Matches (wxFindReplaceData &aSearchData, void *aAuxData)
 Function Matches compares the item against the search criteria in aSearchData. More...
 
virtual bool Replace (wxFindReplaceData &aSearchData, void *aAuxData=NULL)
 Function Replace performs a text replace using the find and replace criteria in aSearchData on items that support text find and replace. More...
 
virtual bool IsReplaceable () const
 Function IsReplaceable. More...
 
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
 Function ViewDraw() Draws the parts of the object belonging to layer aLayer. More...
 
virtual double ViewGetLOD (int aLayer, VIEW *aView) const
 Function ViewGetLOD() Returns the level of detail (LOD) of the item. More...
 
VIEW_ITEM_DATA * viewPrivData () const
 
void ClearViewPrivData ()
 
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)
 
static wxString ShowShape (PCB_SHAPE_TYPE_T aShape)
 Function ShowShape converts the enum PCB_SHAPE_TYPE_T integer value to a wxString. More...
 
template<class T >
static SEARCH_RESULT IterateForward (std::deque< T > &aList, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
 IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T ) More...
 
template<class T >
static SEARCH_RESULT IterateForward (std::vector< T > &aList, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
 IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T ) More...
 
static bool Replace (wxFindReplaceData &aSearchData, wxString &aText)
 Helper function used in search and replace dialog Function Replace performs a text replace on aText using the find and replace criteria in aSearchData on items that support text find and replace. More...
 
static bool Sort (const EDA_ITEM *aLeft, const EDA_ITEM *aRight)
 Function Sort is a helper function to be used by the C++ STL sort algorithm for sorting a STL container of EDA_ITEM pointers. More...
 

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
 Updates the cached geometry of the dimension after changing any of its properties. More...
 
virtual void updateText ()
 Updates the text field value from the current geometry (called by updateGeometry normally) More...
 
template<typename ShapeType >
void addShape (const ShapeType &aShape)
 
virtual wxString LayerMaskDescribe () const
 Helper function Return a string (to be shown to the user) describing a layer mask. More...
 
bool Matches (const wxString &aText, wxFindReplaceData &aSearchData)
 Function Matches compares aText against search criteria in aSearchData. More...
 

Static Protected Member Functions

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

Protected Attributes

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

Static Protected Attributes

static constexpr float s_arrowAngle = 27.5
 

Detailed Description

Marks the center of a circle or arc with a cross shape The size and orientation of the cross is adjustable.

m_start always marks the center being measured; m_end marks the end of one leg of the cross.

Definition at line 525 of file class_dimension.h.

Constructor & Destructor Documentation

◆ CENTER_DIMENSION()

CENTER_DIMENSION::CENTER_DIMENSION ( BOARD_ITEM aParent)

Definition at line 984 of file class_dimension.cpp.

984  :
985  DIMENSION( aParent, PCB_DIM_CENTER_T )
986 {
988  m_overrideTextEnabled = true;
989 }
class CENTER_DIMENSION, a center point marking (graphic item)
Definition: typeinfo.h:103
DIM_UNITS_FORMAT m_unitsFormat
How to render the units suffix.
bool m_overrideTextEnabled
Manually specify the displayed measurement value.
DIMENSION(BOARD_ITEM *aParent, KICAD_T aType=PCB_DIMENSION_T)

References DIMENSION::m_overrideTextEnabled, DIMENSION::m_unitsFormat, and NO_SUFFIX.

Referenced by Clone().

Member Function Documentation

◆ addShape()

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

Definition at line 109 of file class_dimension.cpp.

110 {
111  m_shapes.push_back( std::make_shared<ShapeType>( aShape ) );
112 }
std::vector< std::shared_ptr< SHAPE > > m_shapes

References DIMENSION::m_shapes.

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

◆ ClassOf()

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

Definition at line 531 of file class_dimension.h.

532  {
533  return aItem && PCB_DIM_CENTER_T == aItem->Type();
534  }
class CENTER_DIMENSION, a center point marking (graphic item)
Definition: typeinfo.h:103
KICAD_T Type() const
Function Type()
Definition: eda_item.h:182

References PCB_DIM_CENTER_T, and EDA_ITEM::Type().

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )
inlineinherited

◆ ClearEditFlags()

◆ ClearFlags()

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

Definition at line 222 of file eda_item.h.

222 { m_Flags &= ~aMask; }
STATUS_FLAGS m_Flags
Definition: eda_item.h:165

References EDA_ITEM::m_Flags.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PNS_KICAD_IFACE::AddItem(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_MOVE_TOOL::AlignElements(), MODULE::BuildPolyCourtyards(), EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearEditFlags(), clearModuleItemFlags(), EDA_ITEM::ClearSelected(), EDA_ITEM::ClearTempFlags(), ConvertOutlineToPolygon(), SCH_EDIT_FRAME::ConvertPart(), LIB_EDIT_TOOL::Copy(), LIB_PIN_TOOL::CreateImagePins(), MICROWAVE_TOOL::createMicrowaveInductor(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), KIGFX::SCH_PAINTER::draw(), LIB_EDIT_TOOL::Duplicate(), SCH_ITEM::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), LIB_EDIT_FRAME::GetComponentFromRedoList(), LIB_EDIT_FRAME::GetComponentFromUndoList(), FOOTPRINT_EDITOR_TOOLS::ImportFootprint(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), FOOTPRINT_EDIT_FRAME::LoadModuleFromLibrary(), EE_SELECTION_TOOL::Main(), EE_SELECTION_TOOL::narrowSelection(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), PCB_BASE_FRAME::PlaceModule(), LIB_PIN_TOOL::PlacePin(), DRAWING_TOOL::PlaceText(), FOOTPRINT_EDIT_FRAME::Process_Special_Functions(), BOARD_COMMIT::Push(), SCH_EDIT_FRAME::RecomputeIntersheetsRefs(), SCH_EDIT_TOOL::RepeatDrawItem(), LIB_PIN_TOOL::RepeatPin(), LIB_EDIT_FRAME::RollbackPartFromUndo(), SCH_EDIT_FRAME::SaveCopyForRepeatItem(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SEXPR_PLUGIN_CACHE::savePin(), SCH_LEGACY_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 234 of file eda_item.h.

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

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 154 of file view_item.h.

155  {
157  }
VIEW_ITEM_DATA * m_viewPrivData
Definition: view_item.h:162
#define NULL

References KIGFX::VIEW_ITEM::m_viewPrivData, and NULL.

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

◆ Clone()

EDA_ITEM * CENTER_DIMENSION::Clone ( ) const
overridevirtual

Function Clone creates a duplicate of this item with linked list members set to NULL.

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

Returns
A clone of the item.

Reimplemented from EDA_ITEM.

Definition at line 992 of file class_dimension.cpp.

993 {
994  return new CENTER_DIMENSION( *this );
995 }
CENTER_DIMENSION(BOARD_ITEM *aParent)

References CENTER_DIMENSION().

◆ DeleteStructure()

void BOARD_ITEM::DeleteStructure ( )
inherited

Function DeleteStructure deletes this object after removing from its parent if it has one.

Definition at line 113 of file class_board_item.cpp.

114 {
115  auto parent = GetParent();
116 
117  if( parent )
118  parent->Remove( this );
119 
120  delete this;
121 }
BOARD_ITEM_CONTAINER * GetParent() const

References BOARD_ITEM::GetParent().

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

◆ Duplicate()

virtual BOARD_ITEM* BOARD_ITEM::Duplicate ( ) const
inlinevirtualinherited

Function Duplicate creates a copy of a BOARD_ITEM.

Reimplemented in MODULE.

Definition at line 220 of file class_board_item.h.

221  {
222  EDA_ITEM* dupe = Clone();
223  const_cast<KIID&>( dupe->m_Uuid ) = KIID();
224 
225  return static_cast<BOARD_ITEM*>( dupe );
226  }
virtual EDA_ITEM * Clone() const
Function Clone creates a duplicate of this item with linked list members set to NULL.
Definition: eda_item.cpp:97
Definition: kiid.h:44
const KIID m_Uuid
Definition: eda_item.h:151
EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boards.
Definition: eda_item.h:148

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

Referenced by PCB_GROUP::DeepDuplicate(), EDIT_TOOL::Duplicate(), and ARRAY_CREATOR::Invoke().

◆ Flip() [1/2]

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

Function Flip Flip this object, i.e.

change the board side for this object

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

Reimplemented from BOARD_ITEM.

Definition at line 258 of file class_dimension.cpp.

259 {
260  Mirror( aCentre );
261 
262  // DIMENSION items are not usually on copper layers, so
263  // copper layers count is not taken in accoun in Flip transform
264  SetLayer( FlipLayer( GetLayer() ) );
265 }
PCB_LAYER_ID FlipLayer(PCB_LAYER_ID aLayerId, int aCopperLayersCount)
Definition: lset.cpp:520
void Mirror(const wxPoint &axis_pos, bool aMirrorLeftRight=false)
Mirror the Dimension , relative to a given horizontal axis the text is not mirrored.
void SetLayer(PCB_LAYER_ID aLayer) override
Function SetLayer sets the layer this item is on.
virtual PCB_LAYER_ID GetLayer() const
Function GetLayer returns the primary layer this item is on.

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

◆ Flip() [2/2]

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

Definition at line 336 of file class_board_item.h.

337  {
338  Flip( wxPoint( aCentre.x, aCentre.y ), aFlipLeftRight );
339  }
virtual void Flip(const wxPoint &aCentre, bool aFlipLeftRight)
Function Flip Flip this object, i.e.

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

◆ Get() [1/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE aProperty)
inlineinherited

Definition at line 84 of file inspectable.h.

85  {
87  TYPE_ID thisType = TYPE_HASH( *this );
88  void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
89  return object ? aProperty->getter( object ) : wxAny();
90  }
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:64
#define TYPE_HASH(x)
Macro to generate unique identifier for a type
Definition: property.h:55
size_t TYPE_ID
Unique type identifier
Definition: property_mgr.h:41
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Casts a type to another type.
virtual wxAny getter(void *aObject) const =0
Provides class metadata.
Definition: property_mgr.h:61
virtual size_t OwnerHash() const =0
Returns type-id of the Owner class.

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

Referenced by 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 93 of file inspectable.h.

94  {
96  TYPE_ID thisType = TYPE_HASH( *this );
97  void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
98  return object ? aProperty->get<T>( object ) : T();
99  }
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:64
#define TYPE_HASH(x)
Macro to generate unique identifier for a type
Definition: property.h:55
size_t TYPE_ID
Unique type identifier
Definition: property_mgr.h:41
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Casts a type to another type.
Provides class metadata.
Definition: property_mgr.h:61
T get(void *aObject)
Definition: property.h:275
virtual size_t OwnerHash() const =0
Returns 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 102 of file inspectable.h.

103  {
105  TYPE_ID thisType = TYPE_HASH( *this );
106  PROPERTY_BASE* prop = propMgr.GetProperty( thisType, aProperty );
107  boost::optional<T> ret;
108 
109  if( prop )
110  {
111  void* object = propMgr.TypeCast( this, thisType, prop->OwnerHash() );
112 
113  if( object )
114  ret = prop->get<T>( object );
115  }
116 
117  return ret;
118  }
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:64
#define TYPE_HASH(x)
Macro to generate unique identifier for a type
Definition: property.h:55
size_t TYPE_ID
Unique type identifier
Definition: property_mgr.h:41
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Casts a type to another type.
PROPERTY_BASE * GetProperty(TYPE_ID aType, const wxString &aProperty) const
Returns a property for a specific type.
Provides class metadata.
Definition: property_mgr.h:61
T get(void *aObject)
Definition: property.h:275
virtual size_t OwnerHash() const =0
Returns type-id of the Owner class.

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

◆ GetArrowLength()

int DIMENSION::GetArrowLength ( ) const
inlineinherited

Definition at line 191 of file class_dimension.h.

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

References DIMENSION::m_arrowLength.

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

◆ GetBoard()

BOARD * BOARD_ITEM::GetBoard ( ) const
virtualinherited

Function GetBoard returns the BOARD in which this BOARD_ITEM resides, or NULL if none.

Definition at line 46 of file class_board_item.cpp.

47 {
48  if( Type() == PCB_T )
49  return (BOARD*) this;
50 
51  BOARD_ITEM* parent = GetParent();
52 
53  if( parent )
54  return parent->GetBoard();
55 
56  return NULL;
57 }
Definition: typeinfo.h:85
BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class,...
#define NULL
virtual BOARD * GetBoard() const
Function GetBoard returns the BOARD in which this BOARD_ITEM resides, or NULL if none.
Information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:186
BOARD_ITEM_CONTAINER * GetParent() const
KICAD_T Type() const
Function Type()
Definition: eda_item.h:182

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

Referenced by D_PAD::BuildEffectiveShapes(), ZONE_CONTAINER::BuildSmoothedPoly(), KIGFX::PCB_PAINTER::draw(), exprFromTo(), VIA::FlashLayer(), D_PAD::FlashLayer(), PCB_TEXT::Flip(), TRACK::Flip(), ARC::Flip(), VIA::Flip(), ZONE_CONTAINER::Flip(), BOARD_ITEM::GetBoard(), MODULE::GetBoundingBox(), MODULE::GetBoundingPoly(), BOARD_CONNECTED_ITEM::GetEffectiveNetclass(), ZONE_CONTAINER::GetInteractingZones(), BOARD_ITEM::GetLayerName(), VIA::GetMinAnnulus(), PCB_DRAW_PANEL_GAL::GetMsgPanelInfo(), ZONE_CONTAINER::GetMsgPanelInfo(), TRACK::GetMsgPanelInfo(), NETINFO_ITEM::GetMsgPanelInfo(), D_PAD::GetMsgPanelInfo(), TRACK::GetMsgPanelInfoBase_Common(), BOARD_CONNECTED_ITEM::GetNetClass(), BOARD_CONNECTED_ITEM::GetNetnameMsg(), BOARD_CONNECTED_ITEM::GetOwnClearance(), ZONE_CONTAINER::GetSelectMenuText(), FP_TEXT::GetShownText(), D_PAD::GetSolderMaskMargin(), D_PAD::GetSolderPasteMargin(), BOARD::GetTrackLength(), TRACK::GetWidthConstraints(), insideArea(), insideCourtyard(), isDiffPair(), BOARD_ITEM::LayerMaskDescribe(), VIA::LayerMaskDescribe(), D_PAD::MergePrimitivesAsPolygon(), EAGLE_PLUGIN::packageWire(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), BOARD::ResolveDRCExclusions(), BOARD_CONNECTED_ITEM::SetNetCode(), setupDummyPadForHole(), ZONE_CONTAINER::TransformSmoothedOutlineToPolygon(), ZONE_CONTAINER::TransformSolidAreasShapesToPolygon(), MODULE::ViewBBox(), and D_PAD::ViewGetLOD().

◆ GetBoundingBox()

const EDA_RECT CENTER_DIMENSION::GetBoundingBox ( ) const
overridevirtual

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

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

Reimplemented from DIMENSION.

Definition at line 1012 of file class_dimension.cpp.

1013 {
1014  int halfWidth = VECTOR2I( m_end - m_start ).x + ( m_lineThickness / 2.0 );
1015 
1016  EDA_RECT bBox;
1017 
1018  bBox.SetX( m_start.x - halfWidth );
1019  bBox.SetY( m_start.y - halfWidth );
1020  bBox.SetWidth( halfWidth * 2 );
1021  bBox.SetHeight( halfWidth * 2 );
1022 
1023  bBox.Normalize();
1024 
1025  return bBox;
1026 }
VECTOR2< int > VECTOR2I
Definition: vector2d.h:594
void SetHeight(int val)
Definition: eda_rect.h:186
void SetX(int val)
Definition: eda_rect.h:168
void SetWidth(int val)
Definition: eda_rect.h:180
int m_lineThickness
Thickness used for all graphics in the dimension.
void SetY(int val)
Definition: eda_rect.h:174
void Normalize()
Function Normalize ensures that the height ant width are positive.
Definition: eda_rect.cpp:35
wxPoint m_end
Internal cache of drawn shapes.
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
wxPoint m_start

References DIMENSION::m_end, DIMENSION::m_lineThickness, DIMENSION::m_start, EDA_RECT::Normalize(), EDA_RECT::SetHeight(), EDA_RECT::SetWidth(), EDA_RECT::SetX(), EDA_RECT::SetY(), and VECTOR2< T >::x.

Referenced by ViewBBox().

◆ GetCenter()

virtual wxPoint BOARD_ITEM::GetCenter ( ) const
inlinevirtualinherited

Function GetCenter()

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

Returns
centre point of the item

Reimplemented in ARC, D_PAD, PCB_SHAPE, and MARKER_PCB.

Definition at line 129 of file class_board_item.h.

130  {
131  return GetBoundingBox().GetCenter();
132  }
virtual const EDA_RECT GetBoundingBox() const
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.
Definition: eda_item.cpp:89
const wxPoint GetCenter() const
Definition: eda_rect.h:117

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

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

◆ GetClass()

wxString CENTER_DIMENSION::GetClass ( ) const
inlineoverridevirtual

Function GetClass returns the class name.

Returns
wxString

Implements EDA_ITEM.

Definition at line 542 of file class_dimension.h.

543  {
544  return wxT( "CENTER_DIMENSION" );
545  }

◆ GetEditFlags()

STATUS_FLAGS EDA_ITEM::GetEditFlags ( ) const
inlineinherited

Definition at line 226 of file eda_item.h.

227  {
228  constexpr int mask = ( IS_NEW | IS_PASTED | IS_MOVED | IS_RESIZED | IS_DRAGGED |
230 
231  return m_Flags & mask;
232  }
#define IS_RESIZED
Item being resized.
Definition: eda_item.h:107
#define STRUCT_DELETED
flag indication structures to be erased
Definition: eda_item.h:115
#define IS_MOVED
Item being moved.
Definition: eda_item.h:105
#define IS_DRAGGED
Item being dragged.
Definition: eda_item.h:108
#define IS_PASTED
Modifier on IS_NEW which indicates it came from clipboard.
Definition: eda_item.h:119
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: eda_item.h:110
STATUS_FLAGS m_Flags
Definition: eda_item.h:165
#define IS_NEW
New item, just created.
Definition: eda_item.h:106

References IS_DRAGGED, IS_MOVED, IS_NEW, IS_PASTED, IS_RESIZED, IS_WIRE_IMAGE, EDA_ITEM::m_Flags, and STRUCT_DELETED.

Referenced by SCH_EDIT_TOOL::ChangeTextType(), EDA_ITEM::ClearEditFlags(), SCH_EDIT_FRAME::DeleteJunction(), SCH_EDIT_TOOL::editFieldText(), LIB_PIN_TOOL::EditPinProperties(), SCH_EDITOR_CONTROL::EditWithLibEdit(), SCH_COMPONENT::GetMsgPanelInfo(), SELECTION_CONDITIONS::Idle(), SELECTION_CONDITIONS::IdleSelection(), LIB_MOVE_TOOL::Main(), POINT_EDITOR::OnSelectionChange(), LIB_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_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), and SCH_EDIT_FRAME::TrimWire().

◆ GetEffectiveShape()

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

Function GetEffectiveShape 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 fod use with routing, collision determiniation, etc).

Note that 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 388 of file class_dimension.cpp.

389 {
390  return std::make_shared<SHAPE_COMPOUND>( MakeEffectiveShapes() );
391 }
std::vector< SHAPE * > MakeEffectiveShapes() const

References DIMENSION::MakeEffectiveShapes().

◆ GetEnd()

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

◆ GetExtensionOffset()

int DIMENSION::GetExtensionOffset ( ) const
inlineinherited

Definition at line 195 of file class_dimension.h.

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

References DIMENSION::m_extensionOffset.

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

◆ GetFlags()

◆ GetFocusPosition()

virtual const wxPoint EDA_ITEM::GetFocusPosition ( ) const
inlinevirtualinherited

Function GetFocusPosition similar to GetPosition, but allows items to return their visual center rather than their anchor.

Reimplemented in BOARD, PCB_SHAPE, and TRACK.

Definition at line 334 of file eda_item.h.

334 { return GetPosition(); }
virtual wxPoint GetPosition() const
Definition: eda_item.h:326

References EDA_ITEM::GetPosition().

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

◆ GetKeepTextAligned()

bool DIMENSION::GetKeepTextAligned ( ) const
inlineinherited

Definition at line 185 of file class_dimension.h.

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

References DIMENSION::m_keepTextAligned.

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

◆ GetLayer()

virtual PCB_LAYER_ID BOARD_ITEM::GetLayer ( ) const
inlinevirtualinherited

Function GetLayer returns the primary layer this item is on.

Reimplemented in ZONE_CONTAINER.

Definition at line 190 of file class_board_item.h.

190 { return m_Layer; }
PCB_LAYER_ID m_Layer

References BOARD_ITEM::m_Layer.

Referenced by CN_LIST::Add(), BOARD_ADAPTER::AddGraphicsShapesWithClearanceToContainer(), 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::CreateNewModule(), 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(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::doTrackDrc(), KIGFX::PCB_PAINTER::draw(), PCB_EDIT_FRAME::ExchangeFootprint(), export_vrml_drawsegment(), export_vrml_edge_module(), export_vrml_module(), export_vrml_pcbtext(), export_vrml_text_module(), export_vrml_tracks(), extractDiffPairCoupledItems(), EDIT_TOOL::FilletTracks(), PCB_TARGET::Flip(), PCB_TEXT::Flip(), FP_SHAPE::Flip(), TRACK::Flip(), FP_TEXT::Flip(), DIMENSION::Flip(), MODULE::Flip(), ARC::Flip(), PCB_SHAPE::Flip(), PCB_IO::FootprintSave(), FootprintWriteShape(), PCB_IO::format(), PCB_IO::formatLayer(), FP_TEXT::FP_TEXT(), DSN::SPECCTRA_DB::FromBOARD(), AR_AUTOPLACER::genModuleOnRoutingMatrix(), MODULE::GetBoundingBox(), ZONE_CONTAINER::GetLayer(), getMatchingTextItem(), TRACK::GetMsgPanelInfo(), VIA::GetMsgPanelInfo(), D_PAD::GetMsgPanelInfo(), AR_AUTOPLACER::getOptimalModulePlacement(), BOARD::GetPad(), TEXT_MOD_GRID_TABLE::GetValueAsLong(), TRACK::GetWidthConstraints(), SELECTION_TOOL::GuessSelectionCandidates(), idf_export_module(), GENERAL_COLLECTOR::Inspect(), PCB_INSPECTION_TOOL::InspectClearance(), D_PAD::IsFlipped(), PNS_KICAD_IFACE::IsItemVisible(), BOARD_ITEM::IsOnCopperLayer(), FP_SHAPE::IsParentFlipped(), FP_TEXT::IsParentFlipped(), itemIsIncludedByFilter(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), MODULE_DESC::MODULE_DESC(), DIALOG_FOOTPRINT_FP_EDITOR::OnAddField(), DIALOG_FOOTPRINT_PROPERTIES::OnAddField(), DIALOG_DRC::OnDRCItemSelected(), TRACK::cmp_tracks::operator()(), PCB_SHAPE::cmp_drawings::operator()(), BOARD_ITEM::ptr_cmp::operator()(), MODULE::cmp_drawings::operator()(), EAGLE_PLUGIN::packagePad(), BRDITEMS_PLOTTER::PlotBoardGraphicItems(), BRDITEMS_PLOTTER::PlotDimension(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), BRDITEMS_PLOTTER::PlotFootprintGraphicItems(), BRDITEMS_PLOTTER::PlotFootprintTextItems(), BRDITEMS_PLOTTER::PlotPcbShape(), BRDITEMS_PLOTTER::PlotPcbTarget(), BRDITEMS_PLOTTER::PlotPcbText(), CONVERT_TOOL::PolyToLines(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), processTextItem(), PAD_TOOL::recombinePad(), CLIPBOARD_IO::SaveSelection(), CONVERT_TOOL::SegmentToArc(), SELECTION_TOOL::Selectable(), TEXT_MOD_GRID_TABLE::SetValueAsLong(), GLOBAL_EDIT_TOOL::swapBoardItem(), PNS_KICAD_IFACE_BASE::syncArc(), PNS_KICAD_IFACE_BASE::syncGraphicalItem(), PNS_KICAD_IFACE_BASE::syncTrack(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testCopperDrawItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testCopperTextAndGraphics(), AR_AUTOPLACER::testModuleOnBoard(), TRACK_VIA_DESC::TRACK_VIA_DESC(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow(), BOARD_ADAPTER::transformGraphicModuleEdgeToPolygonSet(), MODULE::TransformGraphicShapesWithClearanceToPolygonSet(), TRACK::ViewBBox(), FP_TEXT::ViewGetLayers(), TRACK::ViewGetLayers(), FP_TEXT::ViewGetLOD(), MODULE_ZONE_CONTAINER::ViewGetLOD(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ GetLayerName()

wxString BOARD_ITEM::GetLayerName ( ) const
inherited

Function GetLayerName returns the name of the PCB layer on which the item resides.

Returns
wxString containing the layer name associated with this item.

Definition at line 60 of file class_board_item.cpp.

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

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

Referenced by PCB_TEXT::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), DIMENSION::GetMsgPanelInfo(), PCB_SHAPE::GetMsgPanelInfo(), LEADER::GetMsgPanelInfo(), PCB_TEXT::GetSelectMenuText(), FP_SHAPE::GetSelectMenuText(), TRACK::GetSelectMenuText(), DIMENSION::GetSelectMenuText(), PCB_SHAPE::GetSelectMenuText(), PCB_TEXT::GetShownText(), TEXT_MOD_GRID_TABLE::GetValue(), and MODULE::ResolveTextVar().

◆ GetLayerSet()

◆ GetLineThickness()

int DIMENSION::GetLineThickness ( ) const
inlineinherited

◆ GetMeasuredValue()

int DIMENSION::GetMeasuredValue ( ) const
inlineinherited

Definition at line 142 of file class_dimension.h.

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

References DIMENSION::m_measuredValue.

Referenced by DIMENSION::GetValueText().

◆ GetMenuImage()

BITMAP_DEF CENTER_DIMENSION::GetMenuImage ( ) const
overridevirtual

Function GetMenuImage returns a pointer to an image to be used in menus.

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

Returns
The menu image associated with the item.

Reimplemented from EDA_ITEM.

Definition at line 1006 of file class_dimension.cpp.

1007 {
1008  return add_center_dimension_xpm;
1009 }
const BITMAP_OPAQUE add_center_dimension_xpm[1]

References add_center_dimension_xpm.

◆ GetMsgPanelInfo()

void DIMENSION::GetMsgPanelInfo ( EDA_DRAW_FRAME aFrame,
std::vector< MSG_PANEL_ITEM > &  aList 
)
overridevirtualinherited

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

Parameters
aListis the list to populate.

Reimplemented from EDA_ITEM.

Reimplemented in LEADER.

Definition at line 314 of file class_dimension.cpp.

315 {
316  // for now, display only the text within the DIMENSION using class PCB_TEXT.
317  wxString msg;
318 
319  wxCHECK_RET( m_Parent != NULL, wxT( "PCB_TEXT::GetMsgPanelInfo() m_Parent is NULL." ) );
320 
321  aList.emplace_back( _( "Dimension" ), m_text.GetShownText(), DARKGREEN );
322 
323  aList.emplace_back( _( "Prefix" ), GetPrefix(), BLUE );
324 
325  if( GetOverrideTextEnabled() )
326  {
327  aList.emplace_back( _( "Override Text" ), GetOverrideText(), BLUE );
328  }
329  else
330  {
331  aList.emplace_back( _( "Value" ), GetValueText(), BLUE );
332 
333  msg = "%" + wxString::Format( "1.%df", GetPrecision() );
334  aList.emplace_back( _( "Precision" ), wxString::Format( msg, 0.0 ), BLUE );
335  }
336 
337  aList.emplace_back( _( "Suffix" ), GetSuffix(), BLUE );
338 
339  EDA_UNITS units;
340 
341  GetUnits( units );
342  aList.emplace_back( _( "Units" ), GetAbbreviatedUnitsLabel( units ), BLUE );
343 
344  ORIGIN_TRANSFORMS originTransforms = aFrame->GetOriginTransforms();
345  units = aFrame->GetUserUnits();
346 
347  if( Type() == PCB_DIM_CENTER_T )
348  {
349  wxPoint startCoord = originTransforms.ToDisplayAbs( GetStart() );
350  wxString start = wxString::Format( "@(%s, %s)",
351  MessageTextFromValue( units, startCoord.x ),
352  MessageTextFromValue( units, startCoord.y ) );
353 
354  aList.emplace_back( start, wxEmptyString, DARKGREEN );
355  }
356  else
357  {
358  wxPoint startCoord = originTransforms.ToDisplayAbs( GetStart() );
359  wxString start = wxString::Format( "@(%s, %s)",
360  MessageTextFromValue( units, startCoord.x ),
361  MessageTextFromValue( units, startCoord.y ) );
362  wxPoint endCoord = originTransforms.ToDisplayAbs( GetEnd() );
363  wxString end = wxString::Format( "@(%s, %s)",
364  MessageTextFromValue( units, endCoord.x ),
365  MessageTextFromValue( units, endCoord.y ) );
366 
367  aList.emplace_back( start, end, DARKGREEN );
368  }
369 
370  aList.emplace_back( _( "Layer" ), GetLayerName(), DARKBROWN );
371 }
wxString MessageTextFromValue(EDA_UNITS aUnits, int aValue, bool aAddUnitLabel, EDA_DATA_TYPE aType)
Definition: base_units.cpp:123
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: eda_item.h:163
int GetPrecision() const
class CENTER_DIMENSION, a center point marking (graphic item)
Definition: typeinfo.h:103
virtual ORIGIN_TRANSFORMS & GetOriginTransforms()
Return a reference to the default ORIGIN_TRANSFORMS object.
virtual const wxPoint & GetEnd() const
wxString GetAbbreviatedUnitsLabel(EDA_UNITS aUnit, EDA_DATA_TYPE aType)
Get the units string for a given units type.
Definition: base_units.cpp:467
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:51
#define NULL
wxString GetOverrideText() const
wxString GetPrefix() const
EDA_UNITS
Definition: eda_units.h:38
Definition: color4d.h:57
virtual const wxPoint & GetStart() const
The dimension's origin is the first feature point for the dimension.
wxString GetSuffix() const
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:201
A class to perform either relative or absolute display origin transforms for a single axis of a point...
#define _(s)
Definition: 3d_actions.cpp:33
bool GetOverrideTextEnabled() const
wxString GetValueText() const
wxString GetLayerName() const
Function GetLayerName returns the name of the PCB layer on which the item resides.
EDA_UNITS GetUserUnits() const
Return the user units currently in use.
void GetUnits(EDA_UNITS &aUnits) const
KICAD_T Type() const
Function Type()
Definition: eda_item.h:182

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

◆ GetOverrideText()

wxString DIMENSION::GetOverrideText ( ) const
inlineinherited

Definition at line 139 of file class_dimension.h.

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

References DIMENSION::m_valueString.

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

◆ GetOverrideTextEnabled()

bool DIMENSION::GetOverrideTextEnabled ( ) const
inlineinherited

Definition at line 136 of file class_dimension.h.

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

References DIMENSION::m_overrideTextEnabled.

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

◆ GetParent()

BOARD_ITEM_CONTAINER* BOARD_ITEM::GetParent ( void  ) const
inlineinherited

Definition at line 184 of file class_board_item.h.

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

References EDA_ITEM::m_Parent.

Referenced by POINT_EDITOR::addCorner(), ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), 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(), KIGFX::PCB_PAINTER::draw(), EDIT_TOOL::Duplicate(), EditToolSelectionFilter(), PCB_IO::format(), FormatProbeItem(), BOARD_ITEM::GetBoard(), MARKER_PCB::GetColorLayer(), FP_SHAPE::GetMsgPanelInfo(), FP_TEXT::GetSelectMenuText(), PCB_TEXT::GetShownText(), FP_TEXT::GetShownText(), SELECTION_TOOL::GuessSelectionCandidates(), GENERAL_COLLECTOR::Inspect(), ARRAY_CREATOR::Invoke(), FP_SHAPE::IsParentFlipped(), FP_TEXT::IsParentFlipped(), LEGACY_PLUGIN::loadMODULE_TEXT(), memberOf(), ALTIUM_PCB::ParseTexts6Data(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BOARD_COMMIT::Push(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), CLIPBOARD_IO::SaveSelection(), SELECTION_TOOL::select(), SELECTION_TOOL::Selectable(), SwapItemData(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testCopperDrawItem(), PCB_GROUP::TopLevelGroup(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), MARKER_PCB::ViewGetLayers(), MODULE_ZONE_CONTAINER::ViewGetLOD(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem(), and PCB_GROUP::WithinScope().

◆ GetParentGroup()

◆ GetPosition()

wxPoint DIMENSION::GetPosition ( ) const
overridevirtualinherited

Reimplemented from EDA_ITEM.

Definition at line 74 of file class_dimension.cpp.

75 {
76  return m_text.GetTextPos();
77 }
PCB_TEXT m_text
The actual text object.
const wxPoint & GetTextPos() const
Definition: eda_text.h:254

References EDA_TEXT::GetTextPos(), and DIMENSION::m_text.

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

◆ GetPrecision()

int DIMENSION::GetPrecision ( ) const
inlineinherited

Definition at line 179 of file class_dimension.h.

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

References DIMENSION::m_precision.

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

◆ GetPrefix()

wxString DIMENSION::GetPrefix ( ) const
inlineinherited

Definition at line 158 of file class_dimension.h.

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

References DIMENSION::m_prefix.

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

◆ GetSelectMenuText()

wxString DIMENSION::GetSelectMenuText ( EDA_UNITS  aUnits) const
overridevirtualinherited

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

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

Returns
The menu text string.

Reimplemented from EDA_ITEM.

Definition at line 463 of file class_dimension.cpp.

464 {
465  return wxString::Format( _( "Dimension '%s' on %s" ),
466  GetText(),
467  GetLayerName() );
468 }
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:201
#define _(s)
Definition: 3d_actions.cpp:33
const wxString GetText() const
Retrieves the value text or override text, not including prefix or suffix.
wxString GetLayerName() const
Function GetLayerName returns the name of the PCB layer on which the item resides.

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

◆ GetShapes()

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

Definition at line 225 of file class_dimension.h.

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

References DIMENSION::m_shapes.

Referenced by BOARD_ADAPTER::AddShapeWithClearanceToContainer(), KIGFX::PCB_PAINTER::draw(), DIMENSION::GetBoundingBox(), DIMENSION::HitTest(), DIMENSION::MakeEffectiveShapes(), and BRDITEMS_PLOTTER::PlotDimension().

◆ GetStart()

virtual const wxPoint& DIMENSION::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 126 of file class_dimension.h.

126 { return m_start; }
wxPoint m_start

References DIMENSION::m_start.

Referenced by GRID_HELPER::computeAnchors(), DRAWING_TOOL::constrainDimension(), DRAWING_TOOL::DrawDimension(), PCB_IO::format(), DIMENSION::GetMsgPanelInfo(), LEADER::GetMsgPanelInfo(), EDIT_POINTS_FACTORY::Make(), ALIGNED_DIMENSION::UpdateHeight(), POINT_EDITOR::updateItem(), and POINT_EDITOR::updatePoints().

◆ GetState()

int EDA_ITEM::GetState ( int  type) const
inlineinherited

Definition at line 205 of file eda_item.h.

206  {
207  return m_Status & type;
208  }
STATUS_FLAGS m_Status
Definition: eda_item.h:162

References EDA_ITEM::m_Status.

Referenced by TRACK::GetMsgPanelInfoBase_Common(), and TRACK::IsLocked().

◆ GetStatus()

STATUS_FLAGS EDA_ITEM::GetStatus ( ) const
inlineinherited

Definition at line 218 of file eda_item.h.

218 { return m_Status; }
STATUS_FLAGS m_Status
Definition: eda_item.h:162

References EDA_ITEM::m_Status.

◆ GetSuffix()

wxString DIMENSION::GetSuffix ( ) const
inlineinherited

Definition at line 161 of file class_dimension.h.

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

References DIMENSION::m_suffix.

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

◆ GetSuppressZeroes()

bool DIMENSION::GetSuppressZeroes ( ) const
inlineinherited

Definition at line 182 of file class_dimension.h.

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

References DIMENSION::m_suppressZeroes.

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

◆ GetText()

const wxString DIMENSION::GetText ( ) const
inherited

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

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

Definition at line 218 of file class_dimension.cpp.

219 {
220  return m_text.GetText();
221 }
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:133

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

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

◆ GetTextPositionMode()

DIM_TEXT_POSITION DIMENSION::GetTextPositionMode ( ) const
inlineinherited

Definition at line 189 of file class_dimension.h.

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

References DIMENSION::m_textPosition.

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

◆ GetUnits()

void DIMENSION::GetUnits ( EDA_UNITS aUnits) const
inlineinherited

Definition at line 164 of file class_dimension.h.

165  {
166  aUnits = m_units;
167  }
EDA_UNITS m_units
0 = inches, 1 = mm

References DIMENSION::m_units.

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

◆ GetUnitsFormat()

DIM_UNITS_FORMAT DIMENSION::GetUnitsFormat ( ) const
inlineinherited

Definition at line 176 of file class_dimension.h.

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

References DIMENSION::m_unitsFormat.

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

◆ GetUnitsMode()

DIM_UNITS_MODE DIMENSION::GetUnitsMode ( ) const
inherited

Definition at line 162 of file class_dimension.cpp.

163 {
164  if( m_autoUnits )
165  {
167  }
168  else
169  {
170  switch( m_units )
171  {
174 
175  case EDA_UNITS::MILS:
176  return DIM_UNITS_MODE::MILS;
177 
178  default:
179  case EDA_UNITS::INCHES:
180  return DIM_UNITS_MODE::INCHES;
181  }
182  }
183 }
EDA_UNITS m_units
0 = inches, 1 = mm
bool m_autoUnits
If true, follow the currently selected UI units.

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

Referenced by PCB_IO::format(), and PCB_BASE_EDIT_FRAME::unitsChangeRefresh().

◆ GetValueText()

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

Definition at line 115 of file class_dimension.cpp.

116 {
117  struct lconv* lc = localeconv();
118  wxChar sep = lc->decimal_point[0];
119 
120  int val = GetMeasuredValue();
121  wxString text;
122  wxString format = wxT( "%." ) + wxString::Format( "%i", m_precision ) + wxT( "f" );
123 
124  text.Printf( format, To_User_Unit( m_units, val ) );
125 
126  if( m_suppressZeroes )
127  {
128  while( text.Last() == '0' )
129  {
130  text.RemoveLast();
131 
132  if( text.Last() == '.' || text.Last() == sep )
133  {
134  text.RemoveLast();
135  break;
136  }
137  }
138  }
139 
140  return text;
141 }
EDA_UNITS m_units
0 = inches, 1 = mm
bool m_suppressZeroes
Suppress trailing zeroes.
int m_precision
Number of digits to display after decimal.
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:91
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:201
int GetMeasuredValue() const

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

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

◆ GetX()

int BOARD_ITEM::GetX ( ) const
inlineinherited

Definition at line 110 of file class_board_item.h.

111  {
112  wxPoint p = GetPosition();
113  return p.x;
114  }
virtual wxPoint GetPosition() const
Definition: eda_item.h:326

References EDA_ITEM::GetPosition().

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

◆ GetY()

int BOARD_ITEM::GetY ( ) const
inlineinherited

Definition at line 116 of file class_board_item.h.

117  {
118  wxPoint p = GetPosition();
119  return p.y;
120  }
virtual wxPoint GetPosition() const
Definition: eda_item.h:326

References EDA_ITEM::GetPosition().

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

◆ HasFlag()

◆ HitTest() [1/2]

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

Function HitTest tests 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 394 of file class_dimension.cpp.

395 {
396  if( m_text.TextHitTest( aPosition ) )
397  return true;
398 
399  int dist_max = aAccuracy + ( m_lineThickness / 2 );
400 
401  // Locate SEGMENTS
402 
403  for( const std::shared_ptr<SHAPE>& shape : GetShapes() )
404  {
405  if( shape->Collide( aPosition, dist_max ) )
406  return true;
407  }
408 
409  return false;
410 }
PCB_TEXT m_text
The actual text object.
const std::vector< std::shared_ptr< SHAPE > > & GetShapes() const
int m_lineThickness
Thickness used for all graphics in the dimension.
virtual bool TextHitTest(const wxPoint &aPoint, int aAccuracy=0) const
Test if aPoint is within the bounds of this object.
Definition: eda_text.cpp:375

References DIMENSION::GetShapes(), DIMENSION::m_lineThickness, DIMENSION::m_text, and EDA_TEXT::TextHitTest().

◆ HitTest() [2/2]

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

Function HitTest tests 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 413 of file class_dimension.cpp.

414 {
415  EDA_RECT arect = aRect;
416  arect.Inflate( aAccuracy );
417 
418  EDA_RECT rect = GetBoundingBox();
419 
420  if( aAccuracy )
421  rect.Inflate( aAccuracy );
422 
423  if( aContained )
424  return arect.Contains( rect );
425 
426  return arect.Intersects( rect );
427 }
bool Contains(const wxPoint &aPoint) const
Function Contains.
Definition: eda_rect.cpp:57
const EDA_RECT GetBoundingBox() const override
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
bool Intersects(const EDA_RECT &aRect) const
Function Intersects tests for a common area between rectangles.
Definition: eda_rect.cpp:150
EDA_RECT & Inflate(wxCoord dx, wxCoord dy)
Function Inflate inflates the rectangle horizontally by dx and vertically by dy.
Definition: eda_rect.cpp:363

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

◆ IsBrightened()

◆ IsConnected()

virtual bool BOARD_ITEM::IsConnected ( ) const
inlinevirtualinherited

Function IsConnected() Returns information if the object is derived from BOARD_CONNECTED_ITEM.

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

Reimplemented in BOARD_CONNECTED_ITEM.

Definition at line 151 of file class_board_item.h.

152  {
153  return false;
154  }

Referenced by PNS_PCBNEW_RULE_RESOLVER::DpNetPair(), PNS::NODE::FindItemByParent(), PCB_INSPECTION_TOOL::InspectClearance(), isDiffPair(), CN_CONNECTIVITY_ALGO::markItemNetAsDirty(), and CONNECTIVITY_DATA::MarkItemNetAsDirty().

◆ IsDragging()

bool EDA_ITEM::IsDragging ( ) const
inlineinherited

Definition at line 190 of file eda_item.h.

190 { return m_Flags & IS_DRAGGED; }
#define IS_DRAGGED
Item being dragged.
Definition: eda_item.h:108
STATUS_FLAGS m_Flags
Definition: eda_item.h:165

References IS_DRAGGED, and EDA_ITEM::m_Flags.

Referenced by DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES(), and KIGFX::SCH_PAINTER::setDeviceColors().

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const
inlineinherited

Definition at line 275 of file eda_item.h.

275 { return m_forceVisible; }
bool m_forceVisible
Definition: eda_item.h:164

References EDA_ITEM::m_forceVisible.

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

◆ IsLocked()

virtual bool BOARD_ITEM::IsLocked ( ) const
inlinevirtualinherited

Function IsLocked.

Returns
bool - true if the object is locked, else false

Reimplemented in MODULE, and TRACK.

Definition at line 265 of file class_board_item.h.

266  {
267  // only footprints & TRACKs can be locked at this time.
268  return false;
269  }

Referenced by BOARD_ITEM_DESC::BOARD_ITEM_DESC(), PCBNEW_CONTROL::DeleteItemCursor(), EditToolSelectionFilter(), GENERAL_COLLECTOR::Inspect(), SELECTION_TOOL::itemPassesFilter(), and PCB_EDITOR_CONTROL::modifyLockSelected().

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const
inlineinherited

Definition at line 187 of file eda_item.h.

187 { return m_Flags & IS_CHANGED; }
#define IS_CHANGED
std::function passed to nested users by ref, avoids copying std::function
Definition: eda_item.h:102
STATUS_FLAGS m_Flags
Definition: eda_item.h:165

References IS_CHANGED, and EDA_ITEM::m_Flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMoving()

◆ IsNew()

◆ IsOnCopperLayer()

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

Reimplemented in TRACK, D_PAD, and ZONE_CONTAINER.

Definition at line 159 of file class_board_item.h.

160  {
161  return IsCopperLayer( GetLayer() );
162  }
bool IsCopperLayer(LAYER_NUM aLayerId)
Tests whether a layer is a copper layer.
virtual PCB_LAYER_ID GetLayer() const
Function GetLayer returns the primary layer this item is on.

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

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

◆ IsOnLayer()

virtual bool BOARD_ITEM::IsOnLayer ( PCB_LAYER_ID  aLayer) const
inlinevirtualinherited

Function IsOnLayer tests to see if this object is on the given layer.

Is virtual so objects like D_PAD, which reside on multiple layers can do their own form of testing.

Parameters
aLayerThe layer to test for.
Returns
bool - true if on given layer, else false.

Reimplemented in D_PAD, VIA, ZONE_CONTAINER, and PCB_GROUP.

Definition at line 245 of file class_board_item.h.

246  {
247  return m_Layer == aLayer;
248  }
PCB_LAYER_ID m_Layer

References BOARD_ITEM::m_Layer.

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

◆ IsReplaceable()

virtual bool EDA_ITEM::IsReplaceable ( ) const
inlinevirtualinherited

Function IsReplaceable.

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

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

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

Definition at line 491 of file eda_item.h.

491 { return false; }

Referenced by EDA_ITEM::Matches().

◆ IsResized()

bool EDA_ITEM::IsResized ( ) const
inlineinherited

Definition at line 193 of file eda_item.h.

193 { return m_Flags & IS_RESIZED; }
#define IS_RESIZED
Item being resized.
Definition: eda_item.h:107
STATUS_FLAGS m_Flags
Definition: eda_item.h:165

References IS_RESIZED, and EDA_ITEM::m_Flags.

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

◆ IsSelected()

◆ IsTrack()

bool BOARD_ITEM::IsTrack ( ) const
inlineinherited

Function IsTrack tests to see if this object is a track or via (or microvia).

form of testing.

Returns
bool - true if a track or via, else false.

Definition at line 256 of file class_board_item.h.

257  {
258  return ( Type() == PCB_TRACE_T ) || ( Type() == PCB_VIA_T );
259  }
class TRACK, a track segment (segment on a copper layer)
Definition: typeinfo.h:96
class VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:97
KICAD_T Type() const
Function Type()
Definition: eda_item.h:182

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

◆ IsType()

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

Function IsType Checks 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 105 of file class_dimension.h.

106  {
107  if( BOARD_ITEM::IsType( aScanTypes ) )
108  return true;
109 
110  for( const KICAD_T* p = aScanTypes; *p != EOT; ++p )
111  {
112  if( *p == PCB_LOCATE_GRAPHIC_T )
113  return true;
114  }
115 
116  return false;
117  }
search types array terminator (End Of Types)
Definition: typeinfo.h:82
KICAD_T
Enum KICAD_T is the set of class identification values, stored in EDA_ITEM::m_StructType.
Definition: typeinfo.h:78
virtual bool IsType(const KICAD_T aScanTypes[]) const
Function IsType Checks whether the item is one of the listed types.
Definition: eda_item.h:251

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

◆ IsWireImage()

bool EDA_ITEM::IsWireImage ( ) const
inlineinherited

Definition at line 191 of file eda_item.h.

191 { return m_Flags & IS_WIRE_IMAGE; }
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: eda_item.h:110
STATUS_FLAGS m_Flags
Definition: eda_item.h:165

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

IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T )

IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T )

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

Definition at line 373 of file eda_item.h.

377  {
378  for( auto it : aList )
379  {
380  if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
382  return SEARCH_RESULT::QUIT;
383  }
384 
386  }
virtual SEARCH_RESULT Visit(INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
Function Visit may be re-implemented for each derived class in order to handle all the types given by...
Definition: eda_item.cpp:107

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

IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T )

IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T )

This changes first parameter to avoid the DList and use std::vector instead

Definition at line 394 of file eda_item.h.

396  {
397  for( auto it : aList )
398  {
399  if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
401  return SEARCH_RESULT::QUIT;
402  }
403 
405  }
virtual SEARCH_RESULT Visit(INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
Function Visit may be re-implemented for each derived class in order to handle all the types given by...
Definition: eda_item.cpp:107

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

◆ LayerMaskDescribe()

wxString BOARD_ITEM::LayerMaskDescribe ( ) const
protectedvirtualinherited

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

The BOARD is needed because layer names are (somewhat) customizable

Reimplemented in VIA.

Definition at line 72 of file class_board_item.cpp.

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

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

Referenced by TRACK::GetMsgPanelInfo(), D_PAD::GetMsgPanelInfo(), and D_PAD::GetSelectMenuText().

◆ MakeEffectiveShapes()

std::vector< SHAPE * > DIMENSION::MakeEffectiveShapes ( ) const
inherited
Returns
create a caller-owned list of all shapes (including any text). Used for collision calculations (DRC, PNS, etc.).

Definition at line 374 of file class_dimension.cpp.

375 {
376  std::vector<SHAPE*> effectiveShapes;
377 
378  for( SHAPE* shape : Text().GetEffectiveTextShape()->Shapes() )
379  effectiveShapes.emplace_back( shape->Clone() );
380 
381  for( const std::shared_ptr<SHAPE>& shape : GetShapes() )
382  effectiveShapes.emplace_back( shape->Clone() );
383 
384  return effectiveShapes;
385 }
const std::vector< std::shared_ptr< SHAPE > > & GetShapes() const
PCB_TEXT & Text()
SHAPE.
Definition: shape.h:122

References DIMENSION::GetShapes(), and DIMENSION::Text().

Referenced by DIMENSION::GetEffectiveShape().

◆ Matches() [1/2]

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

Function Matches compares the item against the search criteria in aSearchData.

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

Parameters
aSearchDataA reference to a wxFindReplaceData object containing the search criteria.
aAuxDataA pointer to optional data required for the search or NULL if not used.
Returns
True if the item's text matches the search criteria in aSearchData.

Reimplemented in SCH_COMPONENT, SCH_SHEET, SCH_TEXT, SCH_SHEET_PIN, SCH_FIELD, SCH_PIN, SCH_MARKER, MARKER_PCB, FP_TEXT, and PCB_TEXT.

Definition at line 447 of file eda_item.h.

448  {
449  return false;
450  }

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

◆ Matches() [2/2]

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

Function Matches compares aText against search criteria in aSearchData.

This is a helper function for simplify derived class logic.

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

133 {
134  wxString text = aText;
135  wxString searchText = aSearchData.GetFindString();
136 
137  // Don't match if searching for replaceable item and the item doesn't support text replace.
138  if( (aSearchData.GetFlags() & FR_SEARCH_REPLACE) && !IsReplaceable() )
139  return false;
140 
141  if( aSearchData.GetFlags() & wxFR_WHOLEWORD )
142  return aText.IsSameAs( searchText, aSearchData.GetFlags() & wxFR_MATCHCASE );
143 
144  if( aSearchData.GetFlags() & FR_MATCH_WILDCARD )
145  {
146  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
147  return text.Matches( searchText );
148 
149  return text.MakeUpper().Matches( searchText.MakeUpper() );
150  }
151 
152  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
153  return aText.Find( searchText ) != wxNOT_FOUND;
154 
155  return text.MakeUpper().Find( searchText.MakeUpper() ) != wxNOT_FOUND;
156 }
virtual bool IsReplaceable() const
Function IsReplaceable.
Definition: eda_item.h:491

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

◆ Mirror()

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

Mirror the Dimension , relative to a given horizontal axis the text is not mirrored.

only its position (and angle) is mirrored the layer is not changed

Parameters
axis_pos: vertical axis position

Definition at line 268 of file class_dimension.cpp.

269 {
270  int axis = aMirrorLeftRight ? axis_pos.x : axis_pos.y;
271  wxPoint newPos = m_text.GetTextPos();
272 
273 #define INVERT( pos ) ( ( pos ) = axis - ( ( pos ) - axis ) )
274 
275  if( aMirrorLeftRight )
276  INVERT( newPos.x );
277  else
278  INVERT( newPos.y );
279 
280  m_text.SetTextPos( newPos );
281 
282  // invert angle
284 
285  if( aMirrorLeftRight )
286  {
287  INVERT( m_start.x );
288  INVERT( m_end.x );
289  }
290  else
291  {
292  INVERT( m_start.y );
293  INVERT( m_end.y );
294  }
295 
296  Update();
297 }
void SetTextAngle(double aAngle) override
Definition: pcb_text.cpp:100
void Update()
Updates the dimension's cached text and geometry.
void SetTextPos(const wxPoint &aPoint)
Definition: eda_text.h:253
double GetTextAngle() const
Definition: eda_text.h:180
PCB_TEXT m_text
The actual text object.
#define INVERT(pos)
wxPoint m_end
Internal cache of drawn shapes.
const wxPoint & GetTextPos() const
Definition: eda_text.h:254
wxPoint m_start

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

Referenced by DIMENSION::Flip().

◆ Move() [1/2]

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

Function Move move this object.

Parameters
aMoveVector- the move vector for this object.

Reimplemented from BOARD_ITEM.

Definition at line 231 of file class_dimension.cpp.

232 {
233  m_text.Offset( offset );
234 
235  m_start += offset;
236  m_end += offset;
237 
238  Update();
239 }
void Offset(const wxPoint &aOffset)
Definition: eda_text.h:259
void Update()
Updates the dimension's cached text and geometry.
PCB_TEXT m_text
The actual text object.
wxPoint m_end
Internal cache of drawn shapes.
wxPoint m_start

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

◆ Move() [2/2]

void BOARD_ITEM::Move ( const VECTOR2I aMoveVector)
inlineinherited

Definition at line 304 of file class_board_item.h.

305  {
306  Move( wxPoint( aMoveVector.x, aMoveVector.y ) );
307  }
virtual void Move(const wxPoint &aMoveVector)
Function Move move this object.

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

186 {
187  wxFAIL_MSG( wxString::Format( wxT( "Less than operator not defined for item type %s." ),
188  GetClass() ) );
189 
190  return false;
191 }
virtual wxString GetClass() const =0
Function GetClass returns the class name.
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:201

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

◆ Replace() [1/2]

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

Helper function used in search and replace dialog Function Replace performs a text replace on aText using the find and replace criteria in aSearchData on items that support text find and replace.

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

160 {
161  wxString searchString = (aSearchData.GetFlags() & wxFR_MATCHCASE) ? aText : aText.Upper();
162 
163  int result = searchString.Find( (aSearchData.GetFlags() & wxFR_MATCHCASE) ?
164  aSearchData.GetFindString() :
165  aSearchData.GetFindString().Upper() );
166 
167  if( result == wxNOT_FOUND )
168  return false;
169 
170  wxString prefix = aText.Left( result );
171  wxString suffix;
172 
173  if( aSearchData.GetFindString().length() + result < aText.length() )
174  suffix = aText.Right( aText.length() - ( aSearchData.GetFindString().length() + result ) );
175 
176  wxLogTrace( traceFindReplace, wxT( "Replacing '%s', prefix '%s', replace '%s', suffix '%s'." ),
177  aText, prefix, aSearchData.GetReplaceString(), suffix );
178 
179  aText = prefix + aSearchData.GetReplaceString() + suffix;
180 
181  return true;
182 }
const wxChar *const traceFindReplace
Flag to enable find and replace debug tracing.

References traceFindReplace.

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

◆ Replace() [2/2]

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

Function Replace performs a text replace using the find and replace criteria in aSearchData on items that support text find and replace.

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

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

Definition at line 479 of file eda_item.h.

479 { return false; }

◆ Rotate() [1/2]

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

Function Rotate Rotate this object.

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

Reimplemented from BOARD_ITEM.

Definition at line 242 of file class_dimension.cpp.

243 {
244  if( m_keepTextAligned )
245  m_keepTextAligned = false;
246 
247  double newAngle = m_text.GetTextAngle() + aAngle;
248 
249  if( newAngle >= 3600 )
250  newAngle -= 3600;
251 
252  m_text.SetTextAngle( newAngle );
253 
254  Update();
255 }
void SetTextAngle(double aAngle) override
Definition: pcb_text.cpp:100
void Update()
Updates the dimension's cached text and geometry.
double GetTextAngle() const
Definition: eda_text.h:180
PCB_TEXT m_text
The actual text object.
bool m_keepTextAligned
Calculate text orientation to match dimension.

References EDA_TEXT::GetTextAngle(), DIMENSION::m_keepTextAligned, DIMENSION::m_text, PCB_TEXT::SetTextAngle(), and DIMENSION::Update().

◆ Rotate() [2/2]

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

Definition at line 320 of file class_board_item.h.

321  {
322  Rotate( wxPoint( aRotCentre.x, aRotCentre.y ), aAngle );
323  }
virtual void Rotate(const wxPoint &aRotCentre, double aAngle)
Function Rotate Rotate this object.

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

◆ segPolyIntersection()

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

Finds the intersection between a given segment and polygon outline.

Parameters
aPolyis the polygon to collide
aSegis the segment to collide
aStartif true will start from aSeg.A, otherwise aSeg.B
Returns
a point on aSeg that collides with aPoly closest to the start, if one exists

Definition at line 482 of file class_dimension.cpp.

483 {
484  VECTOR2I start( aStart ? aSeg.A : aSeg.B );
485  VECTOR2I endpoint( aStart ? aSeg.B : aSeg.A );
486 
487  if( aPoly.Contains( start ) )
488  return NULLOPT;
489 
490  for( SHAPE_POLY_SET::SEGMENT_ITERATOR seg = aPoly.IterateSegments(); seg; seg++ )
491  {
492  if( OPT_VECTOR2I intersection = ( *seg ).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 }
bool Contains(const VECTOR2I &aP, int aSubpolyIndex=-1, int aAccuracy=0, bool aUseBBoxCaches=false) const
Returns true if a given subpolygon contains the point aP.
const auto NULLOPT
Definition: optional.h:9
OPT< VECTOR2I > OPT_VECTOR2I
Definition: seg.h:37
VECTOR2I A
Definition: seg.h:47
SEGMENT_ITERATOR IterateSegments(int aFirst, int aLast, bool aIterateHoles=false)
Returns an iterator object, for iterating between aFirst and aLast outline, with or without holes (de...
VECTOR2I B
Definition: seg.h:48

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

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

◆ Set() [1/3]

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

Definition at line 40 of file inspectable.h.

41  {
43  TYPE_ID thisType = TYPE_HASH( *this );
44  void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
45 
46  if( object )
47  aProperty->setter( object, aValue );
48 
49  return object != nullptr;
50  }
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:64
#define TYPE_HASH(x)
Macro to generate unique identifier for a type
Definition: property.h:55
size_t TYPE_ID
Unique type identifier
Definition: property_mgr.h:41
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Casts a type to another type.
virtual void setter(void *aObject, wxAny &aValue)=0
Provides class metadata.
Definition: property_mgr.h:61
virtual size_t OwnerHash() const =0
Returns 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 53 of file inspectable.h.

54  {
56  TYPE_ID thisType = TYPE_HASH( *this );
57  void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
58 
59  if( object )
60  aProperty->set<T>( object, aValue );
61 
62  return object != nullptr;
63  }
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:64
#define TYPE_HASH(x)
Macro to generate unique identifier for a type
Definition: property.h:55
size_t TYPE_ID
Unique type identifier
Definition: property_mgr.h:41
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Casts a type to another type.
Provides class metadata.
Definition: property_mgr.h:61
void set(void *aObject, T aValue)
Definition: property.h:268
virtual size_t OwnerHash() const =0
Returns 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 66 of file inspectable.h.

67  {
69  TYPE_ID thisType = TYPE_HASH( *this );
70  PROPERTY_BASE* prop = propMgr.GetProperty( thisType, aProperty );
71  void* object = nullptr;
72 
73  if( prop )
74  {
75  object = propMgr.TypeCast( this, thisType, prop->OwnerHash() );
76 
77  if( object )
78  prop->set<T>( object, aValue );
79  }
80 
81  return object != nullptr;
82  }
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:64
#define TYPE_HASH(x)
Macro to generate unique identifier for a type
Definition: property.h:55
size_t TYPE_ID
Unique type identifier
Definition: property_mgr.h:41
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Casts a type to another type.
PROPERTY_BASE * GetProperty(TYPE_ID aType, const wxString &aProperty) const
Returns a property for a specific type.
Provides class metadata.
Definition: property_mgr.h:61
void set(void *aObject, T aValue)
Definition: property.h:268
virtual size_t OwnerHash() const =0
Returns type-id of the Owner class.

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

◆ SetArrowLength()

void DIMENSION::SetArrowLength ( int  aLength)
inlineinherited

Definition at line 192 of file class_dimension.h.

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

References DIMENSION::m_arrowLength.

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

◆ SetAutoUnits()

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

Definition at line 174 of file class_dimension.h.

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

References DIMENSION::m_autoUnits.

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )
inlineinherited

◆ SetEnd()

void DIMENSION::SetEnd ( const wxPoint &  aPoint)
virtualinherited

◆ SetExtensionOffset()

void DIMENSION::SetExtensionOffset ( int  aOffset)
inlineinherited

Definition at line 194 of file class_dimension.h.

194 { m_extensionOffset = aOffset; }
int m_extensionOffset
Distance from feature points to extension line start.

References DIMENSION::m_extensionOffset.

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

◆ SetFlags()

void EDA_ITEM::SetFlags ( STATUS_FLAGS  aMask)
inlineinherited

Definition at line 221 of file eda_item.h.

221 { m_Flags |= aMask; }
STATUS_FLAGS m_Flags
Definition: eda_item.h:165

References EDA_ITEM::m_Flags.

Referenced by SCH_EAGLE_PLUGIN::addBusEntries(), PCB_BASE_FRAME::AddModuleToBoard(), SCH_MOVE_TOOL::AlignElements(), PCBNEW_CONTROL::AppendBoard(), MODULE::BuildPolyCourtyards(), SCH_EDIT_TOOL::ChangeTextType(), TRACKS_CLEANER::cleanup(), GRAPHICS_CLEANER::cleanupSegments(), ConvertOutlineToPolygon(), SCH_EDIT_FRAME::ConvertPart(), SCH_DRAWING_TOOLS::createNewText(), LIB_PIN_TOOL::CreatePin(), SCH_EDIT_FRAME::CreateSheetPin(), SCH_EDIT_TOOL::DoDelete(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), KIGFX::SCH_PAINTER::draw(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawLine(), DRAWING_TOOL::DrawRectangle(), LIB_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_EDIT_TOOL::Duplicate(), LIB_EDIT_FRAME::GetComponentFromRedoList(), LIB_EDIT_FRAME::GetComponentFromUndoList(), SCH_MOVE_TOOL::getConnectedDragItems(), EE_SELECTION_TOOL::Main(), EDIT_POINTS_FACTORY::Make(), TRACKS_CLEANER::mergeCollinearSegments(), LIB_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(), LIB_EDIT_TOOL::Paste(), SCH_EDITOR_CONTROL::Paste(), SCH_DRAWING_TOOLS::PlaceComponent(), SCH_DRAWING_TOOLS::PlaceImage(), PL_DRAWING_TOOLS::PlaceItem(), PCB_EDITOR_CONTROL::PlaceModule(), DRAWING_TOOL::PlaceText(), BACK_ANNOTATE::processNetNameChange(), SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_FRAME::RecomputeIntersheetsRefs(), SCH_EDIT_TOOL::RepeatDrawItem(), LIB_PIN_TOOL::RepeatPin(), LIB_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(), WS_DATA_ITEM::SyncDrawItems(), WS_DATA_ITEM_TEXT::SyncDrawItems(), DIALOG_DIMENSION_PROPERTIES::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), LIB_DRAWING_TOOLS::TwoClickPlace(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ SetForceVisible()

void EDA_ITEM::SetForceVisible ( bool  aEnable)
inlineinherited

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

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

273 { m_forceVisible = aEnable; }
bool m_forceVisible
Definition: eda_item.h:164

References EDA_ITEM::m_forceVisible.

Referenced by SCH_EDITOR_CONTROL::UpdateFind().

◆ SetKeepTextAligned()

void DIMENSION::SetKeepTextAligned ( bool  aKeepAligned)
inlineinherited

Definition at line 186 of file class_dimension.h.

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

References DIMENSION::m_keepTextAligned.

Referenced by DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ SetLayer()

void DIMENSION::SetLayer ( PCB_LAYER_ID  aLayer)
overridevirtualinherited

Function SetLayer sets the layer this item is on.

Parameters
aLayerThe layer number. is virtual because some items (in fact: class DIMENSION) have a slightly different initialization

Reimplemented from BOARD_ITEM.

Definition at line 224 of file class_dimension.cpp.

225 {
226  m_Layer = aLayer;
227  m_text.SetLayer( aLayer );
228 }
virtual void SetLayer(PCB_LAYER_ID aLayer)
Function SetLayer sets the layer this item is on.
PCB_TEXT m_text
The actual text object.
PCB_LAYER_ID m_Layer

References BOARD_ITEM::m_Layer, DIMENSION::m_text, and BOARD_ITEM::SetLayer().

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

◆ SetLayerSet()

virtual void BOARD_ITEM::SetLayerSet ( LSET  aLayers)
inlinevirtualinherited

Reimplemented in VIA, D_PAD, and ZONE_CONTAINER.

Definition at line 197 of file class_board_item.h.

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

Referenced by PANEL_SETUP_LAYERS::TransferDataFromWindow().

◆ SetLineThickness()

void DIMENSION::SetLineThickness ( int  aWidth)
inlineinherited

◆ SetLocked()

virtual void BOARD_ITEM::SetLocked ( bool  aLocked)
inlinevirtualinherited

Function SetLocked modifies 'lock' status for of the item.

Reimplemented in MODULE, and TRACK.

Definition at line 275 of file class_board_item.h.

276  {
277  // only footprints & TRACKs can be locked at this time.
278  }

Referenced by BOARD_ITEM_DESC::BOARD_ITEM_DESC(), CADSTAR_PCB_ARCHIVE_LOADER::loadGroups(), PCB_EDITOR_CONTROL::modifyLockSelected(), ALTIUM_PCB::ParsePads6Data(), ALTIUM_PCB::ParsePolygons6Data(), and CLIPBOARD_IO::SaveSelection().

◆ SetModified()

void EDA_ITEM::SetModified ( )
inherited

Definition at line 79 of file eda_item.cpp.

80 {
82 
83  // If this a child object, then the parent modification state also needs to be set.
84  if( m_Parent )
86 }
void SetModified()
Definition: eda_item.cpp:79
#define IS_CHANGED
std::function passed to nested users by ref, avoids copying std::function
Definition: eda_item.h:102
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: eda_item.h:163
void SetFlags(STATUS_FLAGS aMask)
Definition: eda_item.h:221

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

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

◆ SetOverrideText()

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

Definition at line 140 of file class_dimension.h.

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

References DIMENSION::m_valueString.

Referenced by DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ SetOverrideTextEnabled()

void DIMENSION::SetOverrideTextEnabled ( bool  aOverride)
inlineinherited

Definition at line 137 of file class_dimension.h.

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

References DIMENSION::m_overrideTextEnabled.

Referenced by DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ SetParent()

void DIMENSION::SetParent ( EDA_ITEM aParent)
overridevirtualinherited

Reimplemented from EDA_ITEM.

Definition at line 61 of file class_dimension.cpp.

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

References DIMENSION::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 105 of file class_board_item.h.

105 { m_group = aGroup; }
PCB_GROUP * m_group

References BOARD_ITEM::m_group.

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

◆ SetPosition()

void DIMENSION::SetPosition ( const wxPoint &  aPos)
overridevirtualinherited

Reimplemented from EDA_ITEM.

Definition at line 68 of file class_dimension.cpp.

69 {
70  m_text.SetTextPos( aPos );
71 }
void SetTextPos(const wxPoint &aPoint)
Definition: eda_text.h:253
PCB_TEXT m_text
The actual text object.

References DIMENSION::m_text, and EDA_TEXT::SetTextPos().

◆ SetPrecision()

void DIMENSION::SetPrecision ( int  aPrecision)
inlineinherited

◆ SetPrefix()

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

Definition at line 144 of file class_dimension.cpp.

145 {
146  m_prefix = aPrefix;
147 }
wxString m_prefix
String prepended to the value.

References DIMENSION::m_prefix.

Referenced by DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ SetSelected()

◆ SetStart()

void DIMENSION::SetStart ( const wxPoint &  aPoint)
virtualinherited

◆ SetState()

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

Definition at line 210 of file eda_item.h.

211  {
212  if( state )
213  m_Status |= type; // state = ON or OFF
214  else
215  m_Status &= ~type;
216  }
STATUS_FLAGS m_Status
Definition: eda_item.h:162

References EDA_ITEM::m_Status.

Referenced by LEGACY_PLUGIN::loadTrackList(), TRACKS_CLEANER::mergeCollinearSegments(), SELECTION_TOOL::selectConnectedTracks(), and TRACK::SetLocked().

◆ SetStatus()

void EDA_ITEM::SetStatus ( STATUS_FLAGS  aStatus)
inlineinherited

Definition at line 219 of file eda_item.h.

219 { m_Status = aStatus; }
STATUS_FLAGS m_Status
Definition: eda_item.h:162

References EDA_ITEM::m_Status.

Referenced by BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ SetSuffix()

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

Definition at line 150 of file class_dimension.cpp.

151 {
152  m_suffix = aSuffix;
153 }
wxString m_suffix
String appended to the value.

References DIMENSION::m_suffix.

Referenced by DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ SetSuppressZeroes()

void DIMENSION::SetSuppressZeroes ( bool  aSuppress)
inlineinherited

Definition at line 183 of file class_dimension.h.

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

References DIMENSION::m_suppressZeroes.

Referenced by DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ SetText()

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

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

Parameters
aNewTextis the text to use as the value

Definition at line 211 of file class_dimension.cpp.

212 {
213  m_valueString = aNewText;
214  updateText();
215 }
virtual void updateText()
Updates the text field value from the current geometry (called by updateGeometry normally)
wxString m_valueString
Displayed value when m_overrideValue = true.

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

Referenced by DRAWING_TOOL::DrawDimension().

◆ SetTextPositionMode()

void DIMENSION::SetTextPositionMode ( DIM_TEXT_POSITION  aMode)
inlineinherited

Definition at line 188 of file class_dimension.h.

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

References DIMENSION::m_textPosition.

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

◆ SetTextSize()

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

Definition at line 202 of file class_dimension.h.

203  {
204  m_text.SetTextSize( aTextSize );
205  }
void SetTextSize(const wxSize &aNewSize)
Definition: eda_text.h:244
PCB_TEXT m_text
The actual text object.

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

◆ SetUnits()

◆ SetUnitsFormat()

void DIMENSION::SetUnitsFormat ( const DIM_UNITS_FORMAT  aFormat)
inlineinherited

Definition at line 177 of file class_dimension.h.

177 { m_unitsFormat = aFormat; }
DIM_UNITS_FORMAT m_unitsFormat
How to render the units suffix.

References DIMENSION::m_unitsFormat.

Referenced by DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ SetUnitsMode()

void DIMENSION::SetUnitsMode ( DIM_UNITS_MODE  aMode)
inherited

Definition at line 186 of file class_dimension.cpp.

187 {
188  m_autoUnits = false;
189 
190  switch( aMode )
191  {
194  break;
195 
198  break;
199 
202  break;
203 
205  m_autoUnits = true;
206  break;
207  }
208 }
EDA_UNITS m_units
0 = inches, 1 = mm
bool m_autoUnits
If true, follow the currently selected UI units.

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

Referenced by DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ SetWireImage()

void EDA_ITEM::SetWireImage ( )
inlineinherited

Definition at line 196 of file eda_item.h.

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

References IS_WIRE_IMAGE, and EDA_ITEM::SetFlags().

◆ SetX()

void BOARD_ITEM::SetX ( int  aX)
inlineinherited

Definition at line 134 of file class_board_item.h.

135  {
136  wxPoint p( aX, GetY() );
137  SetPosition( p );
138  }
virtual void SetPosition(const wxPoint &aPos)
Definition: eda_item.h:327
int GetY() const

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 140 of file class_board_item.h.

141  {
142  wxPoint p( GetX(), aY );
143  SetPosition( p );
144  }
virtual void SetPosition(const wxPoint &aPos)
Definition: eda_item.h:327
int GetX() const

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

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

◆ ShowShape()

wxString BOARD_ITEM::ShowShape ( PCB_SHAPE_TYPE_T  aShape)
staticinherited

Function ShowShape converts the enum PCB_SHAPE_TYPE_T integer value to a wxString.

Definition at line 31 of file class_board_item.cpp.

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

References _, S_ARC, S_CIRCLE, S_CURVE, S_POLYGON, S_RECT, and S_SEGMENT.

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

◆ Sort()

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

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

Parameters
aLeftThe left hand item to compare.
aRightThe right hand item to compare.
Returns
True if aLeft is less than aRight.

Definition at line 510 of file eda_item.h.

510 { return *aLeft < *aRight; }

◆ SwapData()

void CENTER_DIMENSION::SwapData ( BOARD_ITEM aImage)
overridevirtual

Swap data between aItem and aImage.

aItem and aImage should have the same type Used in undo redo command to swap values between an item and its copy Only values like layer, size .. which are modified by editing are swapped

Parameters
aImage= the item image which contains data to swap

Reimplemented from BOARD_ITEM.

Definition at line 998 of file class_dimension.cpp.

999 {
1000  assert( aImage->Type() == PCB_DIM_CENTER_T );
1001 
1002  std::swap( *static_cast<CENTER_DIMENSION*>( this ), *static_cast<CENTER_DIMENSION*>( aImage ) );
1003 }
class CENTER_DIMENSION, a center point marking (graphic item)
Definition: typeinfo.h:103
KICAD_T Type() const
Function Type()
Definition: eda_item.h:182

References PCB_DIM_CENTER_T, and EDA_ITEM::Type().

◆ Text() [1/2]

◆ Text() [2/2]

PCB_TEXT& DIMENSION::Text ( ) const
inlineinherited

Definition at line 220 of file class_dimension.h.

220 { return *( const_cast<PCB_TEXT*> ( &m_text ) ); }
PCB_TEXT m_text
The actual text object.

References DIMENSION::m_text.

◆ TransformShapeWithClearanceToPolygon()

void BOARD_ITEM::TransformShapeWithClearanceToPolygon ( SHAPE_POLY_SET aCornerBuffer,
PCB_LAYER_ID  aLayer,
int  aClearanceValue,
int  aError,
ERROR_LOC  aErrorLoc,
bool  ignoreLineWidth = false 
) const
virtualinherited

Function TransformShapeWithClearanceToPolygon Convert the item shape to a closed polygon Used in filling zones calculations Circles and arcs are approximated by segments.

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

Reimplemented in ZONE_CONTAINER, D_PAD, PCB_SHAPE, and TRACK.

Definition at line 129 of file class_board_item.cpp.

133 {
134  wxASSERT_MSG( false, "Called TransformShapeWithClearanceToPolygon() on unsupported BOARD_ITEM." );
135 };

Referenced by insideCourtyard(), and process().

◆ Type()

KICAD_T EDA_ITEM::Type ( ) const
inlineinherited

Function Type()

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

Returns
KICAD_T - the type of object.

Definition at line 182 of file eda_item.h.

182 { return m_StructType; }
KICAD_T m_StructType
Run time identification, keep private so it can never be changed after a constructor sets it.
Definition: eda_item.h:159

References EDA_ITEM::m_StructType.

Referenced by MODULE::Add(), CN_CONNECTIVITY_ALGO::Add(), BOARD::Add(), CN_CLUSTER::Add(), 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(), CONNECTION_GRAPH::buildConnectionGraph(), DIALOG_SELECT_NET_FROM_LIST::buildNetsList(), SCH_SCREENS::buildScreenList(), calcArea(), calcMaxArea(), PCB_INSPECTION_TOOL::calculateSelectionRatsnest(), 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_GLOBALLABEL::CanConnect(), SCH_HIERLABEL::CanConnect(), SCH_SHEET::CanConnect(), SCH_COMPONENT::CanConnect(), ROUTER_TOOL::CanInlineDrag(), SCH_EDIT_TOOL::ChangeTextType(), CN_VISITOR::checkZoneItemConnection(), SCH_MARKER::ClassOf(), SCH_IREF::ClassOf(), PCB_TEXT::ClassOf(), SCH_JUNCTION::ClassOf(), FP_SHAPE::ClassOf(), SCH_NO_CONNECT::ClassOf(), MARKER_PCB::ClassOf(), BOARD_CONNECTED_ITEM::ClassOf(), SCH_PIN::ClassOf(), PCB_GROUP::ClassOf(), SCH_LINE::ClassOf(), PCB_TARGET::ClassOf(), SCH_FIELD::ClassOf(), FP_TEXT::ClassOf(), PCB_SHAPE::ClassOf(), ZONE_CONTAINER::ClassOf(), SCH_BITMAP::ClassOf(), D_PAD::ClassOf(), TRACK::ClassOf(), NETINFO_ITEM::ClassOf(), SCH_SHEET_PIN::ClassOf(), MODULE::ClassOf(), SCH_BUS_WIRE_ENTRY::ClassOf(), SCH_COMPONENT::ClassOf(), SCH_SCREEN::ClassOf(), SCH_BUS_BUS_ENTRY::ClassOf(), SCH_TEXT::ClassOf(), BOARD::ClassOf(), SCH_SHEET::ClassOf(), ARC::ClassOf(), SCH_LABEL::ClassOf(), VIA::ClassOf(), ALIGNED_DIMENSION::ClassOf(), SCH_GLOBALLABEL::ClassOf(), ORTHOGONAL_DIMENSION::ClassOf(), SCH_HIERLABEL::ClassOf(), LEADER::ClassOf(), ClassOf(), TRACKS_CLEANER::cleanup(), LIB_BEZIER::compare(), LIB_CIRCLE::compare(), LIB_RECTANGLE::compare(), LIB_TEXT::compare(), LIB_POLYLINE::compare(), LIB_ARC::compare(), LIB_FIELD::compare(), LIB_PIN::compare(), LIB_ITEM::compare(), EE_GRID_HELPER::computeAnchors(), GRID_HELPER::computeAnchors(), SCH_BUS_WIRE_ENTRY::ConnectionPropagatesTo(), EE_RTREE::contains(), BOARD::ConvertKIIDsToCrossReferences(), SCHEMATIC::ConvertKIIDsToRefs(), MODULE::CoverageRatio(), BOARD_ADAPTER::createLayers(), PCB_BASE_FRAME::CreateNewModule(), SCH_DRAWING_TOOLS::createNewText(), BOARD_ADAPTER::createNewTrack(), ZONE_CREATE_HELPER::createNewZone(), D_PAD::D_PAD(), SCH_SCREEN::DeleteItem(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_SCH_EDIT_ONE_FIELD::DIALOG_SCH_EDIT_ONE_FIELD(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), ALIGN_DISTRIBUTE_TOOL::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(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::doTrackDrc(), KIGFX::SCH_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::Draw(), KIGFX::PCB_PAINTER::Draw(), DRAWING_TOOL::DrawDimension(), CN_ITEM::Dump(), EDIT_TOOL::Duplicate(), SCH_ITEM::Duplicate(), MODULE::DuplicateItem(), EDA_ITEM_DESC::EDA_ITEM_DESC(), SCH_EDIT_TOOL::EditField(), SCH_EDIT_TOOL::editFieldText(), LIB_EDIT_TOOL::editTextProperties(), EditToolSelectionFilter(), CONNECTION_GRAPH::ercCheckBusToBusEntryConflicts(), CONNECTION_GRAPH::ercCheckFloatingWires(), CONNECTION_GRAPH::ercCheckLabels(), CONNECTION_GRAPH::ercCheckNoConnects(), DRC_ENGINE::EvalRulesForItems(), EDIT_TOOL::FilletTracks(), NETLIST_EXPORTER::findNextComponent(), 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(), POINT_EDITOR::get45DegConstrainer(), CN_ITEM::GetAnchor(), BOARD_ITEM::GetBoard(), SCH_FIELD::GetBoundingBox(), TRACK::GetBoundingBox(), SCH_FIELD::GetCanonicalName(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_TEXT::GetConnectionPoints(), SCH_TEXT::GetContextualTextVars(), CONNECTION_GRAPH::getDefaultConnection(), CONNECTION_SUBGRAPH::GetDriverPriority(), SCH_TEXT::GetEndPoints(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), SCH_FIELD::GetMenuImage(), DIMENSION::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_FIELD::GetName(), CONNECTION_SUBGRAPH::GetNameForDriver(), CONNECTIVITY_DATA::GetNetItems(), LIB_PART::GetNextDrawItem(), PCB_SHAPE::GetParentModule(), LIB_PART::GetPin(), SCH_COMPONENT::GetPinPhysicalPosition(), SCH_FIELD::GetPosition(), getRect(), KIGFX::SCH_PAINTER::getRenderColor(), PCB_TEXT::GetShownText(), SCH_FIELD::GetShownText(), SCH_TEXT::GetShownText(), CONVERT_TOOL::getStartEndPoints(), BOARD::GroupLegalOps(), EE_SELECTION_TOOL::GuessSelectionCandidates(), SELECTION_TOOL::GuessSelectionCandidates(), hash_eda(), EE_SELECTION_TOOL::highlight(), SELECTION_TOOL::highlightInternal(), PCB_INSPECTION_TOOL::HighlightItem(), PCB_INSPECTION_TOOL::highlightNet(), highlightNet(), SCH_EDIT_TOOL::Init(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), EE_RTREE::insert(), insideArea(), EE_COLLECTOR::Inspect(), GENERAL_COLLECTOR::Inspect(), PCB_INSPECTION_TOOL::InspectClearance(), PCB_INSPECTION_TOOL::InspectConstraints(), ARRAY_CREATOR::Invoke(), CN_ANCHOR::IsDangling(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus(), isKeepoutZone(), TRACK::IsNull(), PNS_KICAD_IFACE::IsOnLayer(), SCH_LINE::IsParallel(), SCH_FIELD::IsReplaceable(), SCH_SCREEN::IsTerminalPoint(), BOARD_ITEM::IsTrack(), itemIsIncludedByFilter(), SELECTION_TOOL::itemPassesFilter(), CONVERT_TOOL::LinesToPoly(), CLIPBOARD_IO::Load(), CADSTAR_SCH_ARCHIVE_LOADER::loadHierarchicalSheetPins(), EE_POINT_EDITOR::Main(), LIB_MOVE_TOOL::Main(), SCH_MOVE_TOOL::Main(), EE_SELECTION_TOOL::Main(), EDIT_POINTS_FACTORY::Make(), NETLIST_EXPORTER_GENERIC::makeListOfNets(), 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(), APPEARANCE_CONTROLS::OnBoardItemAdded(), APPEARANCE_CONTROLS::OnBoardItemChanged(), APPEARANCE_CONTROLS::OnBoardItemRemoved(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), PCB_EDIT_FRAME::OnEditItemRequest(), EDA_3D_CANVAS::OnMouseMove(), TRACK::cmp_tracks::operator()(), CN_VISITOR::operator()(), PCB_SHAPE::cmp_drawings::operator()(), BOARD_ITEM::ptr_cmp::operator()(), MODULE::cmp_drawings::operator()(), SCH_JUNCTION::operator<(), SCH_BUS_ENTRY_BASE::operator<(), SCH_FIELD::operator<(), SCH_LINE::operator<(), LIB_ITEM::operator<(), SCH_TEXT::operator<(), SCH_ITEM::operator<(), SCH_SHEET::operator<(), SCH_COMPONENT::operator<(), SCH_BITMAP::operator=(), SCH_SHEET::operator=(), SCH_COMPONENT::operator=(), EDIT_TOOL::PadFilter(), BOARD_COMMIT::parentObject(), PCBNEW_CONTROL::Paste(), SCH_EDITOR_CONTROL::Paste(), DRAWING_TOOL::PlaceImportedGraphics(), SCH_FIELD::Plot(), SCH_SCREEN::Plot(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), CONVERT_TOOL::PolyToLines(), SCH_FIELD::Print(), SCH_SCREEN::Print(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::processItem(), BACK_ANNOTATE::processNetNameChange(), LIB_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Properties(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_FRAME::PutDataInPreviousState(), SELECTION_TOOL::RebuildSelection(), SCH_CONNECTION::recacheName(), SCH_BASE_FRAME::RefreshSelection(), EE_RTREE::remove(), MODULE::Remove(), CN_CONNECTIVITY_ALGO::Remove(), SCH_SCREEN::Remove(), BOARD::Remove(), POINT_EDITOR::removeCorner(), POINT_EDITOR::removeCornerCondition(), LIB_PART::RemoveDrawItem(), SCH_SHEET::RemovePin(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_FIELD::Replace(), SCHEMATIC::ResolveCrossReference(), CONNECTION_SUBGRAPH::ResolveDrivers(), PCB_PARSER::resolveGroups(), WS_PROXY_UNDO_ITEM::Restore(), PL_EDITOR_FRAME::RollbackFromUndo(), SCH_EDIT_TOOL::Rotate(), SCH_TEXT::Rotate(), SCH_SEXPR_PLUGIN_CACHE::saveArc(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), SCH_SEXPR_PLUGIN_CACHE::saveBezier(), SCH_LEGACY_PLUGIN_CACHE::saveBezier(), SCH_SEXPR_PLUGIN_CACHE::saveCircle(), SCH_LEGACY_PLUGIN_CACHE::saveCircle(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList(), SCH_SEXPR_PLUGIN::saveField(), SCH_SEXPR_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_SEXPR_PLUGIN_CACHE::savePin(), SCH_LEGACY_PLUGIN_CACHE::savePin(), SCH_SEXPR_PLUGIN_CACHE::savePolyLine(), SCH_LEGACY_PLUGIN_CACHE::savePolyLine(), SCH_SEXPR_PLUGIN_CACHE::saveRectangle(), SCH_LEGACY_PLUGIN_CACHE::saveRectangle(), CLIPBOARD_IO::SaveSelection(), SCH_SEXPR_PLUGIN_CACHE::saveSymbolDrawItem(), SCH_SEXPR_PLUGIN::saveText(), SCH_SEXPR_PLUGIN_CACHE::saveText(), SCH_LEGACY_PLUGIN_CACHE::saveText(), SCH_SCREEN::Schematic(), SCH_ITEM::Schematic(), CONVERT_TOOL::SegmentToArc(), SELECTION_TOOL::select(), SELECTION_TOOL::Selectable(), EE_SELECTION_TOOL::Selectable(), SELECTION_TOOL::selectConnectedTracks(), SCH_FIELD::SetId(), ITEM_PICKER::SetItem(), SCH_FIELD::SetPosition(), DIALOG_LABEL_EDITOR::SetTitle(), PCB_EDIT_FRAME::SetTrackSegmentWidth(), BOARD_COMMIT::Stage(), SCH_JUNCTION::SwapData(), SCH_NO_CONNECT::SwapData(), SCH_BITMAP::SwapData(), PCB_TARGET::SwapData(), PCB_GROUP::SwapData(), SCH_FIELD::SwapData(), SCH_SHEET_PIN::SwapData(), PCB_TEXT::SwapData(), TRACK::SwapData(), ARC::SwapData(), ALIGNED_DIMENSION::SwapData(), ORTHOGONAL_DIMENSION::SwapData(), SCH_SHEET::SwapData(), SCH_COMPONENT::SwapData(), LEADER::SwapData(), VIA::SwapData(), SwapData(), D_PAD::SwapData(), MODULE::SwapData(), ZONE_CONTAINER::SwapData(), SwapItemData(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testCopperDrawItem(), ERC_TESTER::TestMultUnitPinConflicts(), ERC_TESTER::TestPinToPin(), ERC_TESTER::TestSimilarLabels(), PCB_GROUP::TopLevelGroup(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), DIALOG_FIELDS_EDITOR_GLOBAL::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LABEL_EDITOR::TransferDataToWindow(), TRACK::TransformShapeWithClearanceToPolygon(), LIB_DRAWING_TOOLS::TwoClickPlace(), EE_SELECTION_TOOL::unhighlight(), SELECTION_TOOL::unhighlightInternal(), KIGFX::PCB_VIEW::Update(), SCH_TEXT::UpdateDanglingState(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), DIALOG_SCH_EDIT_ONE_FIELD::UpdateField(), EE_POINT_EDITOR::updateItem(), PL_POINT_EDITOR::updateItem(), POINT_EDITOR::updateItem(), SCH_BASE_FRAME::UpdateItem(), CONNECTION_GRAPH::updateItemConnectivity(), DIALOG_SELECT_NET_FROM_LIST::updateNet(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), SCH_EDITOR_CONTROL::updatePastedInstances(), EE_POINT_EDITOR::updatePoints(), PL_POINT_EDITOR::updatePoints(), POINT_EDITOR::updatePoints(), EE_TOOL_BASE< SCH_BASE_FRAME >::updateView(), PCB_BRIGHT_BOX::ViewDraw(), SCH_BUS_ENTRY_BASE::ViewGetLayers(), PCB_GROUP::Visit(), TRACK::Visit(), GERBER_DRAW_ITEM::Visit(), SCH_SHEET::Visit(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem(), PCB_GROUP::WithinScope(), and NETLIST_EXPORTER_CADSTAR::writeListOfNets().

◆ Update()

void DIMENSION::Update ( )
inlineinherited

Updates the dimension's cached text and geometry.

Definition at line 152 of file class_dimension.h.

153  {
154  updateGeometry();
155  updateText();
156  }
virtual void updateText()
Updates the text field value from the current geometry (called by updateGeometry normally)
virtual void updateGeometry()=0
Updates the cached geometry of the dimension after changing any of its properties.

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

Referenced by DRAWING_TOOL::DrawDimension(), DIMENSION::Mirror(), DIMENSION::Move(), DIMENSION::Rotate(), DIMENSION::SetEnd(), ALIGNED_DIMENSION::SetHeight(), DIMENSION::SetStart(), ALIGNED_DIMENSION::SwapData(), ORTHOGONAL_DIMENSION::SwapData(), PCB_BASE_EDIT_FRAME::unitsChangeRefresh(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), ALIGNED_DIMENSION::UpdateHeight(), and POINT_EDITOR::updateItem().

◆ updateGeometry()

void CENTER_DIMENSION::updateGeometry ( )
overrideprotectedvirtual

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

Implements DIMENSION.

Definition at line 1036 of file class_dimension.cpp.

1037 {
1038  m_shapes.clear();
1039 
1040  VECTOR2I center( m_start );
1041  VECTOR2I arm( m_end - m_start );
1042 
1043  m_shapes.emplace_back( new SHAPE_SEGMENT( center - arm, center + arm ) );
1044 
1045  arm = arm.Rotate( DEG2RAD( 90 ) );
1046 
1047  m_shapes.emplace_back( new SHAPE_SEGMENT( center - arm, center + arm ) );
1048 }
std::vector< std::shared_ptr< SHAPE > > m_shapes
double DEG2RAD(double deg)
Definition: trigo.h:220
wxPoint m_end
Internal cache of drawn shapes.
wxPoint m_start

References DEG2RAD(), DIMENSION::m_end, DIMENSION::m_shapes, DIMENSION::m_start, and VECTOR2< T >::Rotate().

◆ updateText()

void DIMENSION::updateText ( )
protectedvirtualinherited

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

Reimplemented in ORTHOGONAL_DIMENSION, and ALIGNED_DIMENSION.

Definition at line 80 of file class_dimension.cpp.

81 {
82  wxString text = m_overrideTextEnabled ? m_valueString : GetValueText();
83 
84  switch( m_unitsFormat )
85  {
86  case DIM_UNITS_FORMAT::NO_SUFFIX: // no units
87  break;
88 
89  case DIM_UNITS_FORMAT::BARE_SUFFIX: // normal
90  text += " ";
92  break;
93 
94  case DIM_UNITS_FORMAT::PAREN_SUFFIX: // parenthetical
95  text += " (";
97  text += ")";
98  break;
99  }
100 
101  text.Prepend( m_prefix );
102  text.Append( m_suffix );
103 
104  m_text.SetText( text );
105 }
EDA_UNITS m_units
0 = inches, 1 = mm
wxString m_prefix
String prepended to the value.
wxString GetAbbreviatedUnitsLabel(EDA_UNITS aUnit, EDA_DATA_TYPE aType)
Get the units string for a given units type.
Definition: base_units.cpp:467
PCB_TEXT m_text
The actual text object.
virtual void SetText(const wxString &aText)
Definition: eda_text.cpp:120
DIM_UNITS_FORMAT m_unitsFormat
How to render the units suffix.
wxString GetValueText() const
bool m_overrideTextEnabled
Manually specify the displayed measurement value.
wxString m_valueString
Displayed value when m_overrideValue = true.
wxString m_suffix
String appended to the value.

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

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

◆ ViewBBox()

const BOX2I CENTER_DIMENSION::ViewBBox ( ) const
overridevirtual

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

Returns
BOX2I - the current bounding box

Reimplemented from DIMENSION.

Definition at line 1029 of file class_dimension.cpp.

1030 {
1031  return BOX2I( VECTOR2I( GetBoundingBox().GetPosition() ),
1032  VECTOR2I( GetBoundingBox().GetSize() ) );
1033 }
BOX2< VECTOR2I > BOX2I
Definition: box2.h:522
VECTOR2< int > VECTOR2I
Definition: vector2d.h:594
wxPoint GetPosition() const override
const EDA_RECT GetBoundingBox() const override
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.

References GetBoundingBox(), and DIMENSION::GetPosition().

◆ ViewDraw()

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

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

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

Parameters
aLayercurrent drawing layer
aViewpointer to the VIEW device we are drawing on

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

Definition at line 117 of file view_item.h.

118  {}

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

◆ ViewGetLayers()

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

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

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

Parameters
aLayers[]output layer index array
aCountnumber of layer indices in aLayers[]

Reimplemented from EDA_ITEM.

Reimplemented in D_PAD, MODULE, VIA, TRACK, FP_TEXT, ZONE_CONTAINER, PCB_GROUP, and MARKER_PCB.

Definition at line 105 of file class_board_item.cpp.

106 {
107  // Basic fallback
108  aCount = 1;
109  aLayers[0] = m_Layer;
110 }
PCB_LAYER_ID m_Layer

References BOARD_ITEM::m_Layer.

Referenced by PNS_KICAD_IFACE::IsItemVisible().

◆ ViewGetLOD()

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

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

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

Parameters
aLayercurrent drawing layer
aViewpointer 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 MODULE_ZONE_CONTAINER, D_PAD, MODULE, VIA, GERBER_DRAW_ITEM, TRACK, FP_TEXT, ZONE_CONTAINER, PCB_GROUP, and FP_SHAPE.

Definition at line 141 of file view_item.h.

142  {
143  // By default always show the item
144  return 0.0;
145  }

Referenced by PNS_KICAD_IFACE::IsItemVisible(), KIGFX::VIEW::drawItem::operator()(), EE_GRID_HELPER::queryVisible(), GRID_HELPER::queryVisible(), and SELECTION_TOOL::Selectable().

◆ viewPrivData()

◆ Visit()

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

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

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

Parameters
inspectorAn INSPECTOR instance to use in the inspection.
testDataArbitrary data used by the inspector.
scanTypesWhich KICAD_T types are of interest and the order is significant too, terminated by EOT.
Returns
SEARCH_RESULT SEARCH_QUIT if the Iterator is to stop the scan, else SCAN_CONTINUE, and determined by the inspector.

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

Definition at line 107 of file eda_item.cpp.

108 {
109 #if 0 && defined(DEBUG)
110  std::cout << GetClass().mb_str() << ' ';
111 #endif
112 
113  if( IsType( scanTypes ) )
114  {
115  if( SEARCH_RESULT::QUIT == inspector( this, testData ) )
116  return SEARCH_RESULT::QUIT;
117  }
118 
120 }
virtual bool IsType(const KICAD_T aScanTypes[]) const
Function IsType Checks whether the item is one of the listed types.
Definition: eda_item.h:251
virtual wxString GetClass() const =0
Function GetClass returns the class name.

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

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

Member Data Documentation

◆ m_arrowLength

◆ m_autoUnits

bool DIMENSION::m_autoUnits
protectedinherited

If true, follow the currently selected UI units.

Definition at line 294 of file class_dimension.h.

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

◆ m_end

◆ m_extensionOffset

int DIMENSION::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 95 of file class_board_item.h.

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

◆ m_keepTextAligned

bool DIMENSION::m_keepTextAligned
protectedinherited

◆ m_Layer

◆ m_lineThickness

int DIMENSION::m_lineThickness
protectedinherited

Thickness used for all graphics in the dimension.

Definition at line 300 of file class_dimension.h.

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

◆ m_measuredValue

int DIMENSION::m_measuredValue
protectedinherited

◆ m_overrideTextEnabled

bool DIMENSION::m_overrideTextEnabled
protectedinherited

Manually specify the displayed measurement value.

Definition at line 289 of file class_dimension.h.

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

◆ m_Parent

◆ m_precision

int DIMENSION::m_precision
protectedinherited

Number of digits to display after decimal.

Definition at line 296 of file class_dimension.h.

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

◆ m_prefix

wxString DIMENSION::m_prefix
protectedinherited

String prepended to the value.

Definition at line 291 of file class_dimension.h.

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

◆ m_shapes

◆ m_start

◆ m_Status

STATUS_FLAGS EDA_ITEM::m_Status
protectedinherited

◆ m_suffix

wxString DIMENSION::m_suffix
protectedinherited

String appended to the value.

Definition at line 292 of file class_dimension.h.

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

◆ m_suppressZeroes

bool DIMENSION::m_suppressZeroes
protectedinherited

Suppress trailing zeroes.

Definition at line 297 of file class_dimension.h.

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

◆ m_text

◆ m_textPosition

DIM_TEXT_POSITION DIMENSION::m_textPosition
protectedinherited

◆ m_units

EDA_UNITS DIMENSION::m_units
protectedinherited

◆ m_unitsFormat

DIM_UNITS_FORMAT DIMENSION::m_unitsFormat
protectedinherited

How to render the units suffix.

Definition at line 295 of file class_dimension.h.

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

◆ m_Uuid

const KIID EDA_ITEM::m_Uuid
inherited

Definition at line 151 of file eda_item.h.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::AddColumn(), SCH_COMPONENT::AddHierarchicalReference(), RC_ITEM::AddItem(), SCH_EDIT_FRAME::AnnotateComponents(), FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), SCH_SHEET_PATH::Cmp(), SCHEMATIC::ConvertRefsToKIIDs(), MICROWAVE_TOOL::createMicrowaveInductor(), D_PAD::D_PAD(), DRAWING_TOOL::DrawVia(), BOARD_ITEM::Duplicate(), SCH_ITEM::Duplicate(), MODULE::Duplicate(), MODULE::DuplicateItem(), PAD_TOOL::EditPad(), PCB_EDIT_FRAME::ExchangeFootprint(), PAD_TOOL::explodePad(), BOARD::FillItemMap(), PCB_BASE_FRAME::FocusOnItem(), SCH_EDIT_FRAME::FocusOnItem(), PCB_IO::format(), FormatProbeItem(), SCH_PIN::GetDefaultNetName(), BOARD::GetItem(), DIALOG_BOARD_REANNOTATE::GetNewRefDes(), SCH_REFERENCE::GetPath(), SCH_MARKER::GetUUID(), MARKER_PCB::GetUUID(), FIELDS_EDITOR_GRID_DATA_MODEL::groupMatch(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), SCH_LEGACY_PLUGIN::loadComponent(), CADSTAR_PCB_ARCHIVE_LOADER::loadComponents(), PCB_EDIT_FRAME::LoadFootprints(), LEGACY_PLUGIN::loadMODULE(), LEGACY_PLUGIN::loadPCB_TARGET(), LEGACY_PLUGIN::loadPCB_TEXT(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbol(), LEGACY_PLUGIN::loadTrackList(), NETLIST_EXPORTER_GENERIC::makeComponents(), SCH_EDIT_FRAME::mapExistingAnnotation(), TRACK::cmp_tracks::operator()(), PCB_SHAPE::cmp_drawings::operator()(), BOARD_ITEM::ptr_cmp::operator()(), MODULE::cmp_drawings::operator()(), MODULE::cmp_pads::operator()(), SCH_ITEM::operator<(), SCH_COMPONENT::operator<(), PCB_PARSER::parseDIMENSION(), PCB_PARSER::parseMODULE_unchecked(), SCH_EDITOR_CONTROL::Paste(), SCH_SHEET_PATH::PathAsString(), SCH_SCREENS::ReplaceDuplicateTimeStamps(), SCH_COMPONENT::ReplaceInstanceSheetPath(), PCB_PARSER::resolveGroups(), SCH_LEGACY_PLUGIN::saveComponent(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_EDIT_FRAME::SaveProject(), SCH_SEXPR_PLUGIN::saveSheet(), SCH_LEGACY_PLUGIN::saveSheet(), SCH_SEXPR_PLUGIN::saveSymbol(), SCH_COMPONENT::SCH_COMPONENT(), SCH_REFERENCE::SCH_REFERENCE(), SCH_SHEET::SCH_SHEET(), RC_ITEM::SetItems(), SwapItemData(), testGroupEqual(), SCH_EDITOR_CONTROL::updatePastedInstances(), and NETLIST_EXPORTER_ORCADPCB2::WriteNetlist().

◆ m_valueString

wxString DIMENSION::m_valueString
protectedinherited

Displayed value when m_overrideValue = true.

Definition at line 290 of file class_dimension.h.

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

◆ s_arrowAngle

◆ ZeroOffset

wxPoint BOARD_ITEM::ZeroOffset
staticinherited

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

Definition at line 167 of file class_board_item.h.

Referenced by BOARD::GetPosition().


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