KiCad PCB EDA Suite: PCB_TEXT Class Reference

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

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:480

References EDA_ITEM::m_flags.

◆ ClearSelected()

void EDA_ITEM::ClearSelected ( )

inlineinherited

Definition at line 131 of file eda_item.h.

131 { ClearFlags( SELECTED ); }

EDA_ITEM::ClearFlags

void ClearFlags(EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

Definition: eda_item.h:153

SELECTED

#define SELECTED

Definition: eda_item_flags.h:48

References EDA_ITEM::ClearFlags(), and SELECTED.

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

◆ ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )

inlineinherited

Definition at line 165 of file eda_item.h.

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

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

Referenced by SCH_EDIT_FRAME::PutDataInPreviousState().

◆ ClearViewPrivData()

void KIGFX::VIEW_ITEM::ClearViewPrivData ( )

inlineinherited

Definition at line 143 of file view_item.h.

  {
  m_viewPrivData = nullptr;
  }

References KIGFX::VIEW_ITEM::m_viewPrivData.

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

◆ Clone()

EDA_ITEM * PCB_TEXT::Clone ( ) const

overridevirtual

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

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

Returns: A clone of the item.

Reimplemented from EDA_ITEM.

Definition at line 202 of file pcb_text.cpp.

 {
  return new PCB_TEXT( *this );
 }

References PCB_TEXT().

◆ Compare()

int EDA_TEXT::Compare ( const EDA_TEXT * aOther ) const

inherited

Definition at line 659 of file eda_text.cpp.

 {
 #define EPSILON 2 // Should be enough for rounding errors on calculated items
 
 #define TEST( a, b ) { if( a != b ) return a - b; }
 #define TEST_E( a, b ) { if( abs( a - b ) > EPSILON ) return a - b; }
 #define TEST_PT( a, b ) { TEST_E( a.x, b.x ); TEST_E( a.y, b.y ); }
 
  TEST_PT( m_e.pos, aOther->m_e.pos );
 
  TEST_PT( m_e.size, aOther->m_e.size );
  TEST_E( m_e.penwidth, aOther->m_e.penwidth );
  TEST( m_e.angle, aOther->m_e.angle );
 
  TEST( m_e.hjustify, aOther->m_e.hjustify );
  TEST( m_e.vjustify, aOther->m_e.vjustify );
  TEST( m_e.bits, aOther->m_e.bits );
 
  return m_text.Cmp( aOther->m_text );
 }

References TEXT_EFFECTS::angle, TEXT_EFFECTS::bits, TEXT_EFFECTS::hjustify, EDA_TEXT::m_e, EDA_TEXT::m_text, TEXT_EFFECTS::penwidth, TEXT_EFFECTS::pos, TEXT_EFFECTS::size, TEST, TEST_E, TEST_PT, and TEXT_EFFECTS::vjustify.

◆ CopyText()

void EDA_TEXT::CopyText ( const EDA_TEXT & aSrc )

inherited

Definition at line 131 of file eda_text.cpp.

 {
  m_text = aSrc.m_text;
  m_shown_text = aSrc.m_shown_text;
  m_shown_text_has_text_var_refs = aSrc.m_shown_text_has_text_var_refs;
 }

References EDA_TEXT::m_shown_text, EDA_TEXT::m_shown_text_has_text_var_refs, and EDA_TEXT::m_text.

Referenced by LIB_FIELD::Copy(), and CLIPBOARD_IO::SaveSelection().

◆ DeleteStructure()

void BOARD_ITEM::DeleteStructure ( )

inherited

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

Definition at line 128 of file board_item.cpp.

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

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

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

◆ Duplicate()

BOARD_ITEM * BOARD_ITEM::Duplicate ( ) const

virtualinherited

Create a copy of this BOARD_ITEM.

Reimplemented in FOOTPRINT.

Definition at line 144 of file board_item.cpp.

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

References PCB_GROUP::AddItem(), EDA_ITEM::Clone(), BOARD_ITEM::GetParentGroup(), and EDA_ITEM::m_Uuid.

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

◆ Empty()

void EDA_TEXT::Empty ( )

inlineinherited

Definition at line 275 of file eda_text.h.

275 { m_text.Empty(); }

EDA_TEXT::m_text

wxString m_text

Definition: eda_text.h:411

References EDA_TEXT::m_text.

Referenced by SCH_LEGACY_PLUGIN_CACHE::LoadPart().

◆ Flip() [1/2]

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

overridevirtual

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

 {
  if( aFlipLeftRight )
  {
  SetTextX( MIRRORVAL( GetTextPos().x, aCentre.x ) );
  SetTextAngle( -GetTextAngle() );
  }
  else
  {
  SetTextY( MIRRORVAL( GetTextPos().y, aCentre.y ) );
  SetTextAngle( 1800 - GetTextAngle() );
  }
 
  SetLayer( FlipLayer( GetLayer(), GetBoard()->GetCopperLayerCount() ) );
  SetMirrored( !IsMirrored() );
 }

References FlipLayer(), BOARD_ITEM::GetBoard(), BOARD_ITEM::GetLayer(), EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextPos(), EDA_TEXT::IsMirrored(), MIRRORVAL(), BOARD_ITEM::SetLayer(), EDA_TEXT::SetMirrored(), SetTextAngle(), EDA_TEXT::SetTextX(), and EDA_TEXT::SetTextY().

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText().

◆ Flip() [2/2]

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

inlineinherited

Definition at line 264 of file board_item.h.

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

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

◆ Format()

void EDA_TEXT::Format	(	OUTPUTFORMATTER *	aFormatter,
		int	aNestLevel,
		int	aControlBits
	)		const

virtualinherited

Output the object to aFormatter in s-expression form.

Parameters

aFormatter	The OUTPUTFORMATTER object to write to.
aNestLevel	The indentation next level.
aControlBits	The control bit definition for object specific formatting.

Exceptions

IO_ERROR on write error.

Definition at line 539 of file eda_text.cpp.

 {
 #ifndef GERBVIEW // Gerbview does not use EDA_TEXT::Format
  // and does not define FormatInternalUnits, used here
  // however this function should exist
 
  aFormatter->Print( aNestLevel + 1, "(effects" );
 
  // Text size
  aFormatter->Print( 0, " (font" );
 
  aFormatter->Print( 0, " (size %s %s)",
  FormatInternalUnits( GetTextHeight() ).c_str(),
  FormatInternalUnits( GetTextWidth() ).c_str() );
 
  if( GetTextThickness() )
  {
  aFormatter->Print( 0, " (thickness %s)",
  FormatInternalUnits( GetTextThickness() ).c_str() );
  }
 
  if( IsBold() )
  aFormatter->Print( 0, " bold" );
 
  if( IsItalic() )
  aFormatter->Print( 0, " italic" );
 
  aFormatter->Print( 0, ")"); // (font
 
  if( IsMirrored() || GetHorizJustify() != GR_TEXT_HJUSTIFY_CENTER
  || GetVertJustify() != GR_TEXT_VJUSTIFY_CENTER )
  {
  aFormatter->Print( 0, " (justify");
 
  if( GetHorizJustify() != GR_TEXT_HJUSTIFY_CENTER )
  aFormatter->Print( 0, GetHorizJustify() == GR_TEXT_HJUSTIFY_LEFT ? " left" : " right" );
 
  if( GetVertJustify() != GR_TEXT_VJUSTIFY_CENTER )
  aFormatter->Print( 0, GetVertJustify() == GR_TEXT_VJUSTIFY_TOP ? " top" : " bottom" );
 
  if( IsMirrored() )
  aFormatter->Print( 0, " mirror" );
 
  aFormatter->Print( 0, ")" ); // (justify
  }
 
  if( !(aControlBits & CTL_OMIT_HIDE) && !IsVisible() )
  aFormatter->Print( 0, " hide" );
 
  aFormatter->Print( 0, ")\n" ); // (justify
 
 #endif
 }

References CTL_OMIT_HIDE, FormatInternalUnits(), EDA_TEXT::GetHorizJustify(), EDA_TEXT::GetTextHeight(), EDA_TEXT::GetTextThickness(), EDA_TEXT::GetTextWidth(), EDA_TEXT::GetVertJustify(), GR_TEXT_HJUSTIFY_CENTER, GR_TEXT_HJUSTIFY_LEFT, GR_TEXT_VJUSTIFY_CENTER, GR_TEXT_VJUSTIFY_TOP, EDA_TEXT::IsBold(), EDA_TEXT::IsItalic(), EDA_TEXT::IsMirrored(), EDA_TEXT::IsVisible(), and OUTPUTFORMATTER::Print().

Referenced by SCH_SEXPR_PLUGIN::saveField(), SCH_SEXPR_PLUGIN_CACHE::saveField(), SCH_SEXPR_PLUGIN::saveText(), and SCH_SEXPR_PLUGIN_CACHE::saveText().

◆ Get() [1/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE * aProperty )

inlineinherited

Definition at line 86 of file inspectable.h.

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

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

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

◆ Get() [2/3]

template<typename T >

T INSPECTABLE::Get ( PROPERTY_BASE * aProperty )

inlineinherited

Definition at line 95 of file inspectable.h.

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

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

◆ Get() [3/3]

template<typename T >

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

inlineinherited

Definition at line 104 of file inspectable.h.

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

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

◆ GetBoard() [1/2]

const BOARD * BOARD_ITEM::GetBoard ( ) const

virtualinherited

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

Definition at line 36 of file board_item.cpp.

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

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

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

◆ GetBoard() [2/2]

BOARD * BOARD_ITEM::GetBoard ( )

virtualinherited

Definition at line 50 of file board_item.cpp.

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

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

◆ GetBoundingBox()

const EDA_RECT PCB_TEXT::GetBoundingBox ( ) const

overridevirtual

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

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

Reimplemented from EDA_ITEM.

Definition at line 132 of file pcb_text.cpp.

 {
  EDA_RECT rect = GetTextBox();
 
  if( GetTextAngle() != 0 )
  rect = rect.GetBoundingBoxRotated( GetTextPos(), GetTextAngle() );
 
  return rect;
 }

References EDA_RECT::GetBoundingBoxRotated(), EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextBox(), and EDA_TEXT::GetTextPos().

Referenced by DRAWING_TOOL::DrawBoardCharacteristics(), and TextHitTest().

◆ GetCenter()

virtual wxPoint BOARD_ITEM::GetCenter ( ) const

inlinevirtualinherited

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

Returns: center point of the item

Reimplemented in PCB_ARC, PAD, PCB_SHAPE, and PCB_MARKER.

Definition at line 81 of file board_item.h.

  {
  return GetBoundingBox().GetCenter();
  }

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

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

◆ GetClass()

wxString PCB_TEXT::GetClass ( ) const

inlineoverridevirtual

Return the class name.

Implements EDA_ITEM.

Definition at line 115 of file pcb_text.h.

  {
  return wxT( "PTEXT" );
  }

◆ GetDrawHorizJustify()

virtual EDA_TEXT_HJUSTIFY_T EDA_TEXT::GetDrawHorizJustify ( ) const

inlinevirtualinherited

Reimplemented in SCH_FIELD.

Definition at line 390 of file eda_text.h.

390 { return GetHorizJustify(); };

EDA_TEXT::GetHorizJustify

EDA_TEXT_HJUSTIFY_T GetHorizJustify() const

Definition: eda_text.h:219

References EDA_TEXT::GetHorizJustify().

Referenced by EDA_TEXT::TransformToSegmentList().

◆ GetDrawPos()

virtual wxPoint EDA_TEXT::GetDrawPos ( ) const

inlinevirtualinherited

Reimplemented in SCH_FIELD.

Definition at line 389 of file eda_text.h.

389 { return GetTextPos(); }

EDA_TEXT::GetTextPos

const wxPoint & GetTextPos() const

Definition: eda_text.h:268

References EDA_TEXT::GetTextPos().

Referenced by EDA_TEXT::TransformToSegmentList().

◆ GetDrawRotation()

virtual double EDA_TEXT::GetDrawRotation ( ) const

inlinevirtualinherited

Reimplemented in FP_TEXT, and SCH_FIELD.

Definition at line 388 of file eda_text.h.

388 { return GetTextAngle(); }

EDA_TEXT::GetTextAngle

double GetTextAngle() const

Definition: eda_text.h:195

References EDA_TEXT::GetTextAngle().

Referenced by EDA_TEXT::TransformToSegmentList().

◆ GetDrawVertJustify()

virtual EDA_TEXT_VJUSTIFY_T EDA_TEXT::GetDrawVertJustify ( ) const

inlinevirtualinherited

Reimplemented in SCH_FIELD.

Definition at line 391 of file eda_text.h.

391 { return GetVertJustify(); };

EDA_TEXT::GetVertJustify

EDA_TEXT_VJUSTIFY_T GetVertJustify() const

Definition: eda_text.h:220

References EDA_TEXT::GetVertJustify().

Referenced by EDA_TEXT::TransformToSegmentList().

◆ GetEditFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetEditFlags ( ) const

inlineinherited

Definition at line 157 of file eda_item.h.

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

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

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

◆ GetEffectiveShape()

std::shared_ptr< SHAPE > PCB_TEXT::GetEffectiveShape	(	PCB_LAYER_ID	aLayer = `UNDEFINED_LAYER`,
		FLASHING	aFlash = `FLASHING::DEFAULT`
	)		const

overridevirtual

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

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

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

Parameters

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

Reimplemented from BOARD_ITEM.

Definition at line 216 of file pcb_text.cpp.

 {
  return GetEffectiveTextShape();
 }

References EDA_TEXT::GetEffectiveTextShape().

◆ GetEffectiveTextPenWidth()

int EDA_TEXT::GetEffectiveTextPenWidth ( int aDefaultWidth = 0 ) const

inherited

The EffectiveTextPenWidth uses the text thickness if > 1 or aDefaultWidth.

Definition at line 159 of file eda_text.cpp.

 {
  int width = GetTextThickness();
 
  if( width <= 1 )
  {
  width = aDefaultWidth;
 
  if( IsBold() )
  width = GetPenSizeForBold( GetTextWidth() );
  else if( width <= 1 )
  width = GetPenSizeForNormal( GetTextWidth() );
  }
 
  // Clip pen size for small texts:
  width = Clamp_Text_PenSize( width, GetTextSize(), ALLOW_BOLD_THICKNESS );
 
  return width;
 }

References ALLOW_BOLD_THICKNESS, Clamp_Text_PenSize(), GetPenSizeForBold(), GetPenSizeForNormal(), EDA_TEXT::GetTextSize(), EDA_TEXT::GetTextThickness(), EDA_TEXT::GetTextWidth(), and EDA_TEXT::IsBold().

Referenced by BOARD_ADAPTER::addShapeWithClearance(), KIGFX::DS_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), SCH_HIERLABEL::GetBoundingBox(), SCH_GLOBALLABEL::GetBoundingBoxBase(), EDA_TEXT::GetEffectiveTextShape(), LIB_TEXT::GetPenWidth(), LIB_FIELD::GetPenWidth(), SCH_FIELD::GetPenWidth(), SCH_TEXT::GetPenWidth(), EDA_TEXT::GetTextBox(), KIGFX::SCH_PAINTER::getTextThickness(), LIB_TEXT::Plot(), SCH_FIELD::Plot(), SCH_TEXT::Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotPcbText(), LIB_TEXT::print(), SCH_FIELD::Print(), EDA_TEXT::printOneLineOfText(), PNS_KICAD_IFACE_BASE::syncTextItem(), TransformTextShapeWithClearanceToPolygon(), FP_TEXT::TransformTextShapeWithClearanceToPolygon(), PCB_DIM_LEADER::updateGeometry(), PCB_DIM_ALIGNED::updateText(), and PCB_DIM_ORTHOGONAL::updateText().

◆ GetEffectiveTextShape()

std::shared_ptr< SHAPE_COMPOUND > EDA_TEXT::GetEffectiveTextShape ( ) const

inherited

Definition at line 646 of file eda_text.cpp.

 {
  std::shared_ptr<SHAPE_COMPOUND> shape = std::make_shared<SHAPE_COMPOUND>();
  int penWidth = GetEffectiveTextPenWidth();
  std::vector<wxPoint> pts = TransformToSegmentList();
 
  for( unsigned jj = 0; jj < pts.size(); jj += 2 )
  shape->AddShape( new SHAPE_SEGMENT( pts[jj], pts[jj+1], penWidth ) );
 
  return shape;
 }

References EDA_TEXT::GetEffectiveTextPenWidth(), and EDA_TEXT::TransformToSegmentList().

Referenced by GetEffectiveShape(), and FP_TEXT::GetEffectiveShape().

◆ GetFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetFlags ( ) const

inlineinherited

Definition at line 154 of file eda_item.h.

154 { return m_flags; }

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

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:480

References EDA_ITEM::m_flags.

◆ GetFocusPosition()

virtual const wxPoint EDA_ITEM::GetFocusPosition ( ) const

inlinevirtualinherited

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

Reimplemented in BOARD, PCB_TRACK, and PCB_SHAPE.

Definition at line 258 of file eda_item.h.

258 { return GetPosition(); }

EDA_ITEM::GetPosition

virtual wxPoint GetPosition() const

Definition: eda_item.h:251

References EDA_ITEM::GetPosition().

Referenced by SCH_EDIT_FRAME::FocusOnItem().

◆ GetHorizJustify()

EDA_TEXT_HJUSTIFY_T EDA_TEXT::GetHorizJustify ( ) const

inlineinherited

Definition at line 219 of file eda_text.h.

219 { return EDA_TEXT_HJUSTIFY_T( m_e.hjustify ); };

EDA_TEXT_HJUSTIFY_T

Definition: eda_text.h:82

Referenced by BOARD_ADAPTER::addShapeWithClearance(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), EDA_TEXT_DESC::EDA_TEXT_DESC(), AUTOPLACER::fieldHPlacement(), EDA_TEXT::Format(), EDA_TEXT::GetDrawHorizJustify(), SCH_FIELD::GetEffectiveHorizJustify(), LIB_TEXT::GetMsgPanelInfo(), LIB_FIELD::GetMsgPanelInfo(), SCH_FIELD::GetMsgPanelInfo(), EDA_TEXT::GetTextBox(), EDA_TEXT::IsDefaultFormatting(), SCH_FIELD::IsHorizJustifyFlipped(), FP_TEXT::KeepUpright(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), LEGACY_PLUGIN::loadPCB_TEXT(), SCH_EDIT_TOOL::Mirror(), LIB_TEXT::MirrorHorizontal(), SCH_GLOBALLABEL::MirrorHorizontally(), SCH_GLOBALLABEL::MirrorSpinStyle(), LIB_TEXT::MirrorVertical(), LIB_TEXT::NormalizeJustification(), SCH_TEXT::Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotPcbText(), positioningChanged(), LIB_FIELD::print(), EDA_TEXT::printOneLineOfText(), LIB_TEXT::Rotate(), SCH_GLOBALLABEL::Rotate90(), SCH_LEGACY_PLUGIN::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveText(), KIGFX::GAL::SetTextAttributes(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), TransformTextShapeWithClearanceToPolygon(), and FP_TEXT::TransformTextShapeWithClearanceToPolygon().

TEXT_EFFECTS m_e

Definition: eda_text.h:415

TEXT_EFFECTS::hjustify

signed char hjustify

horizontal justification

Definition: eda_text.h:122

References TEXT_EFFECTS::hjustify, and EDA_TEXT::m_e.

◆ GetInterline()

int EDA_TEXT::GetInterline ( ) const

inherited

Return the distance between two lines of text.

Calculates the distance (pitch) between two lines of text. This distance includes the interline distance plus room for characters like j, {, and [. It also used for single line text, to calculate the text bounding box.

Definition at line 233 of file eda_text.cpp.

 {
  return KiROUND( KIGFX::STROKE_FONT::GetInterline( GetTextHeight() ) );
 }

References KIGFX::STROKE_FONT::GetInterline(), EDA_TEXT::GetTextHeight(), and KiROUND().

Referenced by CADSTAR_ARCHIVE_PARSER::FixTextPositionNoAlignment(), and EDA_TEXT::GetLinePositions().

◆ GetLayer()

virtual PCB_LAYER_ID BOARD_ITEM::GetLayer ( ) const

inlinevirtualinherited

Return the primary layer this item is on.

Reimplemented in ZONE.

Definition at line 143 of file board_item.h.

143 { return m_layer; }

BOARD_ITEM::m_layer

PCB_LAYER_ID m_layer

Definition: board_item.h:313

References BOARD_ITEM::m_layer.

◆ GetLayerName()

wxString BOARD_ITEM::GetLayerName ( ) const

inherited

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

Returns: the layer name associated with this item.

Definition at line 75 of file board_item.cpp.

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

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

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

◆ GetLayerSet()

virtual LSET BOARD_ITEM::GetLayerSet ( ) const

inlinevirtualinherited

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

Reimplemented in PAD, PCB_VIA, ZONE, and PCB_GROUP.

Definition at line 148 of file board_item.h.

148 { return LSET( m_layer ); }

LSET

LSET is a set of PCB_LAYER_IDs.

Definition: layer_ids.h:516

BOARD_ITEM::m_layer

PCB_LAYER_ID m_layer

Definition: board_item.h:313

References BOARD_ITEM::m_layer.

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

◆ GetLinePositions()

void EDA_TEXT::GetLinePositions	(	std::vector< wxPoint > &	aPositions,
		int	aLineCount
	)		const

inherited

Populate aPositions with the position of each line of a multiline text, according to the vertical justification and the rotation of the whole text.

Parameters

aPositions	is the list to populate by the wxPoint positions.
aLineCount	is the number of lines (not recalculated here for efficiency reasons.

Definition at line 443 of file eda_text.cpp.

 {
  wxPoint pos = GetTextPos(); // Position of first line of the
  // multiline text according to
  // the center of the multiline text block
 
  wxPoint offset; // Offset to next line.
 
  offset.y = GetInterline();
 
  if( aLineCount > 1 )
  {
  switch( GetVertJustify() )
  {
  case GR_TEXT_VJUSTIFY_TOP:
  break;
 
  case GR_TEXT_VJUSTIFY_CENTER:
  pos.y -= ( aLineCount - 1 ) * offset.y / 2;
  break;
 
  case GR_TEXT_VJUSTIFY_BOTTOM:
  pos.y -= ( aLineCount - 1 ) * offset.y;
  break;
  }
  }
 
  // Rotate the position of the first line
  // around the center of the multiline text block
  RotatePoint( &pos, GetTextPos(), GetTextAngle() );
 
  // Rotate the offset lines to increase happened in the right direction
  RotatePoint( &offset, GetTextAngle() );
 
  for( int ii = 0; ii < aLineCount; ii++ )
  {
  aPositions.push_back( pos );
  pos += offset;
  }
 }

References EDA_TEXT::GetInterline(), EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextPos(), EDA_TEXT::GetVertJustify(), GR_TEXT_VJUSTIFY_BOTTOM, GR_TEXT_VJUSTIFY_CENTER, GR_TEXT_VJUSTIFY_TOP, and RotatePoint().

Referenced by SCH_TEXT::Plot(), BRDITEMS_PLOTTER::PlotPcbText(), EDA_TEXT::Print(), and EDA_TEXT::TransformToSegmentList().

◆ GetMenuImage()

BITMAPS PCB_TEXT::GetMenuImage ( ) const

overridevirtual

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

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

Returns: The menu image associated with the item.

Reimplemented from EDA_ITEM.

Definition at line 196 of file pcb_text.cpp.

 {
  return BITMAPS::text;
 }

References text.

◆ GetMsgPanelInfo()

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

overridevirtual

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

Parameters

aList is the list to populate.

Reimplemented from EDA_ITEM.

Definition at line 110 of file pcb_text.cpp.

 {
  EDA_UNITS units = aFrame->GetUserUnits();
 
  // Don't use GetShownText() here; we want to show the user the variable references
  aList.emplace_back( _( "PCB Text" ), UnescapeString( GetText() ) );
 
  if( aFrame->GetName() == PCB_EDIT_FRAME_NAME && IsLocked() )
  aList.emplace_back( _( "Status" ), _( "Locked" ) );
 
  aList.emplace_back( _( "Layer" ), GetLayerName() );
 
  aList.emplace_back( _( "Mirror" ), IsMirrored() ? _( "Yes" ) : _( "No" ) );
 
  aList.emplace_back( _( "Angle" ), wxString::Format( wxT( "%g" ), GetTextAngleDegrees() ) );
 
  aList.emplace_back( _( "Thickness" ), MessageTextFromValue( units, GetTextThickness() ) );
  aList.emplace_back( _( "Width" ), MessageTextFromValue( units, GetTextWidth() ) );
  aList.emplace_back( _( "Height" ), MessageTextFromValue( units, GetTextHeight() ) );
 }

References _, Format(), BOARD_ITEM::GetLayerName(), EDA_TEXT::GetText(), EDA_TEXT::GetTextAngleDegrees(), EDA_TEXT::GetTextHeight(), EDA_TEXT::GetTextThickness(), EDA_TEXT::GetTextWidth(), EDA_BASE_FRAME::GetUserUnits(), BOARD_ITEM::IsLocked(), EDA_TEXT::IsMirrored(), MessageTextFromValue(), PCB_EDIT_FRAME_NAME, and UnescapeString().

◆ GetParent()

BOARD_ITEM_CONTAINER* BOARD_ITEM::GetParent ( void ) const

inlineinherited

Definition at line 136 of file board_item.h.

136 { return (BOARD_ITEM_CONTAINER*) m_parent; }

EDA_ITEM::m_parent

EDA_ITEM * m_parent

Linked list: Link (parent struct)

Definition: eda_item.h:478

BOARD_ITEM_CONTAINER

Abstract interface for BOARD_ITEMs capable of storing other items inside.

Definition: board_item_container.h:52

References EDA_ITEM::m_parent.

◆ GetParentFootprint()

BOARD_ITEM_CONTAINER * BOARD_ITEM::GetParentFootprint ( ) const

inherited

Definition at line 191 of file board_item.cpp.

 {
  BOARD_ITEM_CONTAINER* ancestor = GetParent();
 
  while( ancestor && ancestor->Type() == PCB_GROUP_T )
  ancestor = ancestor->GetParent();
 
  return ( ancestor && ancestor->Type() == PCB_FOOTPRINT_T ) ? ancestor : nullptr;
 }

References BOARD_ITEM::GetParent(), PCB_FOOTPRINT_T, PCB_GROUP_T, and EDA_ITEM::Type().

Referenced by CN_CONNECTIVITY_ALGO::Add(), PNS::ITEM::collideSimple(), and CONVERT_TOOL::CreatePolys().

◆ GetParentGroup()

PCB_GROUP* BOARD_ITEM::GetParentGroup ( ) const

inlineinherited

Definition at line 60 of file board_item.h.

60 { return m_group; }

BOARD_ITEM::m_group

PCB_GROUP * m_group

Definition: board_item.h:314

References BOARD_ITEM::m_group.

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

◆ GetPosition()

virtual wxPoint PCB_TEXT::GetPosition ( ) const

inlineoverridevirtual

Reimplemented from EDA_ITEM.

Definition at line 76 of file pcb_text.h.

  {
  return EDA_TEXT::GetTextPos();
  }

References EDA_TEXT::GetTextPos().

Referenced by PCB_GRID_HELPER::computeAnchors(), ALTIUM_PCB::HelperParseDimensions6Radial(), PCB_POINT_EDITOR::makePoints(), PCB_DIM_LEADER::updateGeometry(), PCB_POINT_EDITOR::updateItem(), and PCB_POINT_EDITOR::updatePoints().

◆ GetSelectMenuText()

wxString PCB_TEXT::GetSelectMenuText ( EDA_UNITS aUnits ) const

overridevirtual

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

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

Returns: The menu text string.

Reimplemented from EDA_ITEM.

Definition at line 190 of file pcb_text.cpp.

 {
  return wxString::Format( _( "PCB Text '%s' on %s"), ShortenedShownText(), GetLayerName() );
 }

References _, Format(), BOARD_ITEM::GetLayerName(), and EDA_TEXT::ShortenedShownText().

◆ GetShownText()

wxString PCB_TEXT::GetShownText ( int aDepth = 0 ) const

overridevirtual

Return the string actually shown after processing of the base text.

Parameters

aDepth is used to prevent infinite recursions and loops when expanding text variables.

Reimplemented from EDA_TEXT.

Definition at line 56 of file pcb_text.cpp.

 {
  BOARD* board = dynamic_cast<BOARD*>( GetParent() );
 
  std::function<bool( wxString* )> pcbTextResolver =
  [&]( wxString* token ) -> bool
  {
  if( token->IsSameAs( wxT( "LAYER" ) ) )
  {
  *token = GetLayerName();
  return true;
  }
 
  if( token->Contains( ':' ) )
  {
  wxString remainder;
  wxString ref = token->BeforeFirst( ':', &remainder );
  BOARD_ITEM* refItem = board->GetItem( KIID( ref ) );
 
  if( refItem && refItem->Type() == PCB_FOOTPRINT_T )
  {
  FOOTPRINT* refFP = static_cast<FOOTPRINT*>( refItem );
 
  if( refFP->ResolveTextVar( &remainder, aDepth + 1 ) )
  {
  *token = remainder;
  return true;
  }
  }
  }
  return false;
  };
 
  std::function<bool( wxString* )> boardTextResolver =
  [&]( wxString* token ) -> bool
  {
  return board->ResolveTextVar( token, aDepth + 1 );
  };
 
  wxString text = EDA_TEXT::GetShownText();
 
  if( board && HasTextVars() && aDepth < 10 )
  text = ExpandTextVars( text, &pcbTextResolver, &boardTextResolver, board->GetProject() );
 
  return text;
 }

References ExpandTextVars(), BOARD::GetItem(), BOARD_ITEM::GetLayerName(), BOARD_ITEM::GetParent(), BOARD::GetProject(), EDA_TEXT::GetShownText(), EDA_TEXT::HasTextVars(), PCB_FOOTPRINT_T, BOARD::ResolveTextVar(), FOOTPRINT::ResolveTextVar(), text, and EDA_ITEM::Type().

Referenced by BOARD_ADAPTER::addShapeWithClearance(), KIGFX::PCB_PAINTER::draw(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_DIM_LEADER::GetMsgPanelInfo(), Matches(), BRDITEMS_PLOTTER::PlotPcbText(), TransformTextShapeWithClearanceToPolygon(), and DIALOG_DIMENSION_PROPERTIES::updatePreviewText().

◆ GetState()

int EDA_ITEM::GetState ( EDA_ITEM_FLAGS type ) const

inlineinherited

Definition at line 136 of file eda_item.h.

  {
  return m_status & type;
  }

References EDA_ITEM::m_status.

Referenced by BOARD_ITEM::IsLocked().

◆ GetStatus()

EDA_ITEM_FLAGS EDA_ITEM::GetStatus ( ) const

inlineinherited

Definition at line 149 of file eda_item.h.

149 { return m_status; }

EDA_ITEM::m_status

EDA_ITEM_FLAGS m_status

Definition: eda_item.h:477

References EDA_ITEM::m_status.

◆ GetText()

virtual const wxString& EDA_TEXT::GetText ( ) const

inlinevirtualinherited

Return the string associated with the text object.

Returns: a const wxString reference containing the string of the item.

Definition at line 154 of file eda_text.h.

154 { return m_text; }

EDA_TEXT::m_text

wxString m_text

Definition: eda_text.h:411

References EDA_TEXT::m_text.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), SCH_EAGLE_PLUGIN::addImplicitConnections(), NETLIST_EXPORTER_XML::addSymbolFields(), SIM_PLOT_FRAME::AddTuner(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), CONNECTION_GRAPH::buildConnectionGraph(), LIB_TEXT::Clone(), LIB_TEXT::compare(), LIB_FIELD::compare(), SCH_DRAWING_TOOLS::createNewText(), SCH_DRAWING_TOOLS::createSheetPin(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), DIALOG_LIB_FIELD_PROPERTIES::DIALOG_LIB_FIELD_PROPERTIES(), DIALOG_SCH_FIELD_PROPERTIES::DIALOG_SCH_FIELD_PROPERTIES(), KIGFX::SCH_VIEW::DisplaySymbol(), SCH_FIELD::DoHypertextMenu(), KIGFX::SCH_PAINTER::draw(), EDA_TEXT_DESC::EDA_TEXT_DESC(), CONNECTION_GRAPH::ercCheckHierSheets(), CADSTAR_ARCHIVE_PARSER::FixTextPositionNoAlignment(), LIB_SYMBOL::Flatten(), PCB_PLUGIN::format(), FormatProbeItem(), SCH_SYMBOL::GetFootprint(), LIB_FIELD::GetFullText(), FOOTPRINT_INFO_GENERATOR::GetHtmlFieldRow(), CADSTAR_PCB_ARCHIVE_LOADER::getKiCadNet(), FP_TEXT::GetLength(), getMatchingTextItem(), GetMsgPanelInfo(), LIB_TEXT::GetMsgPanelInfo(), LIB_FIELD::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), SCH_FIELD::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_SYMBOL::GetRef(), FOOTPRINT::GetReference(), LIB_SYMBOL::GetSearchText(), PCB_DIMENSION_BASE::GetText(), FOOTPRINT::GetValue(), SCH_SYMBOL::GetValue(), LIB_FIELD::HitTest(), SCH_DRAWING_TOOLS::importHierLabel(), SCH_TEXT::IncrementLabel(), GENERAL_COLLECTOR::Inspect(), SCH_FIELD::IsVoid(), CADSTAR_SCH_ARCHIVE_LOADER::Load(), LEGACY_PLUGIN::loadPCB_TEXT(), SCH_EAGLE_PLUGIN::loadSchematic(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), SCH_EAGLE_PLUGIN::loadSegments(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), SCH_SHEET_PIN::Matches(), SCH_TEXT::Matches(), DIALOG_UPDATE_SYMBOL_FIELDS::onOkButtonClicked(), SCH_TEXT::operator<(), SCH_FIELD::operator<(), LIB_FIELD::operator=(), SCH_SEXPR_PARSER::parseEDA_TEXT(), PCB_PARSER::parseEDA_TEXT(), SCH_SEXPR_PARSER::parseSchematicSymbol(), SCH_EDITOR_CONTROL::Paste(), DRAWING_TOOL::PlaceText(), LIB_TEXT::Plot(), LIB_FIELD::Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItems(), DIALOG_RESCUE_EACH::PopulateInstanceList(), LIB_FIELD::print(), DIALOG_CHANGE_SYMBOLS::processSymbol(), processTextItem(), SCH_EDIT_FRAME::RecomputeIntersheetRefs(), SCH_GLOBALLABEL::ResolveTextVar(), SCH_SEXPR_PLUGIN::saveField(), SCH_LEGACY_PLUGIN::saveField(), SCH_SEXPR_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN::saveSheet(), SCH_LEGACY_PLUGIN::saveSymbol(), SCH_LEGACY_PLUGIN_CACHE::SaveSymbol(), SCH_SEXPR_PLUGIN::saveText(), SCH_LEGACY_PLUGIN::saveText(), SCH_SEXPR_PLUGIN_CACHE::saveText(), SCH_LEGACY_PLUGIN_CACHE::saveText(), SYMBOL_VIEWER_FRAME::setupUIConditions(), SYMBOL_EDIT_FRAME::setupUIConditions(), EE_INSPECTION_TOOL::ShowDatasheet(), SCH_SHEET::SymbolCount(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_EDIT_SYMBOLS_LIBID::TransferDataFromWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_AND_LABEL_PROPERTIES::TransferDataToWindow(), DIALOG_SHEET_PROPERTIES::TransferDataToWindow(), EDA_TEXT::TransformBoundingBoxWithClearanceToPolygon(), TUNER_SLIDER::TUNER_SLIDER(), SCH_EDITOR_CONTROL::updatePastedSymbol(), SYMBOL_EDIT_FRAME::UpdateSymbolMsgPanelInfo(), and FP_TEXT::ViewGetLOD().

◆ GetTextAngle()

double EDA_TEXT::GetTextAngle ( ) const

inlineinherited

Definition at line 195 of file eda_text.h.

195 { return m_e.angle; }

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), BOARD_ADAPTER::addShapeWithClearance(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), KIGFX::DS_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), Flip(), FP_TEXT::Flip(), PCB_PLUGIN::format(), LIB_TEXT::GetBoundingBox(), SCH_FIELD::GetBoundingBox(), LIB_FIELD::GetBoundingBox(), GetBoundingBox(), SCH_TEXT::GetBoundingBox(), SCH_LABEL::GetBoundingBox(), SCH_FIELD::GetDrawRotation(), FP_TEXT::GetDrawRotation(), EDA_TEXT::GetDrawRotation(), EDA_TEXT::GetLinePositions(), EDA_TEXT::GetTextAngleDegrees(), EDA_TEXT::GetTextAngleRadians(), LIB_TEXT::HitTest(), LIB_FIELD::HitTest(), FP_TEXT::KeepUpright(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymDefIntoLibrary(), PCB_DIMENSION_BASE::Mirror(), LIB_TEXT::MirrorHorizontal(), SCH_GLOBALLABEL::MirrorSpinStyle(), LIB_TEXT::MirrorVertical(), LIB_TEXT::NormalizeJustification(), EAGLE_PLUGIN::orientFPText(), ALTIUM_PCB::ParseTexts6Data(), LIB_TEXT::Plot(), LIB_FIELD::Plot(), SCH_FIELD::Plot(), SCH_TEXT::Plot(), BRDITEMS_PLOTTER::PlotPcbText(), positioningChanged(), LIB_TEXT::print(), SCH_FIELD::Print(), LIB_FIELD::print(), EDA_TEXT::printOneLineOfText(), SCH_EDIT_TOOL::Rotate(), Rotate(), LIB_TEXT::Rotate(), FP_TEXT::Rotate(), LIB_FIELD::Rotate(), PCB_DIMENSION_BASE::Rotate(), SCH_GLOBALLABEL::Rotate90(), SCH_LEGACY_PLUGIN::saveField(), SCH_SEXPR_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_SEXPR_PLUGIN::saveText(), SCH_SEXPR_PLUGIN_CACHE::saveText(), SCH_LEGACY_PLUGIN_CACHE::saveText(), EDA_TEXT::TextHitTest(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), EDA_TEXT::TransformBoundingBoxWithClearanceToPolygon(), TransformTextShapeWithClearanceToPolygon(), and DIALOG_SCH_FIELD_PROPERTIES::UpdateField().

TEXT_EFFECTS m_e

Definition: eda_text.h:415

TEXT_EFFECTS::angle

double angle

now: 0.1 degrees; future: degrees

Definition: eda_text.h:126

References TEXT_EFFECTS::angle, and EDA_TEXT::m_e.

◆ GetTextAngleDegrees()

double EDA_TEXT::GetTextAngleDegrees ( ) const

inlineinherited

Definition at line 197 of file eda_text.h.

197 { return GetTextAngle() / 10.0; }

EDA_TEXT::GetTextAngle

double GetTextAngle() const

Definition: eda_text.h:195

References EDA_TEXT::GetTextAngle().

Referenced by CADSTAR_ARCHIVE_PARSER::FixTextPositionNoAlignment(), GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), and SCH_SEXPR_PLUGIN::saveField().

◆ GetTextAngleRadians()

double EDA_TEXT::GetTextAngleRadians ( ) const

inlineinherited

Definition at line 198 of file eda_text.h.

198 { return GetTextAngle() * M_PI/1800; }

EDA_TEXT::GetTextAngle

double GetTextAngle() const

Definition: eda_text.h:195

References EDA_TEXT::GetTextAngle().

Referenced by KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), PCB_DIM_ALIGNED::updateGeometry(), PCB_DIM_ORTHOGONAL::updateGeometry(), and PCB_DIM_LEADER::updateGeometry().

◆ GetTextBox()

EDA_RECT EDA_TEXT::GetTextBox	(	int	aLine = `-1`,
		bool	aInvertY = `false`
	)		const

inherited

Useful in multiline texts to calculate the full text or a line area (for zones filling, locate functions....)

Parameters

aLine	The line of text to consider. Pass -1 for all lines.
aInvertY	Invert the Y axis when calculating bounding box.

Returns: the rect containing the line of text (i.e. the position and the size of one line) this rectangle is calculated for 0 orient text. If orientation is not 0 the rect must be rotated to match the physical area

Definition at line 239 of file eda_text.cpp.

 {
  EDA_RECT rect;
  wxArrayString strings;
  wxString text = GetShownText();
  int thickness = GetEffectiveTextPenWidth();
  int linecount = 1;
  bool hasOverBar = false; // true if the first line of text as an overbar
 
  if( IsMultilineAllowed() )
  {
  wxStringSplit( text, strings, '\n' );
 
  if( strings.GetCount() ) // GetCount() == 0 for void strings
  {
  if( aLine >= 0 && ( aLine < static_cast<int>( strings.GetCount() ) ) )
  text = strings.Item( aLine );
  else
  text = strings.Item( 0 );
 
  linecount = strings.GetCount();
  }
  }
 
  // Search for overbar symbol. Only text is scanned,
  // because only this line can change the bounding box
  for( unsigned ii = 1; ii < text.size(); ii++ )
  {
  if( text[ii-1] == '~' && text[ii] == '{' )
  {
  hasOverBar = true;
  break;
  }
  }
 
  // calculate the H and V size
  const auto& font = basic_gal.GetStrokeFont();
  VECTOR2D fontSize( GetTextSize() );
  double penWidth( thickness );
  VECTOR2D extents = font.ComputeStringBoundaryLimits( text, fontSize, penWidth );
  double interline = KIGFX::STROKE_FONT::GetInterline( fontSize.y );
 
  // Creates bounding box (rectangle) for horizontal, left and top justified text. The
  // bounding box will be moved later according to the actual text options
  wxSize textsize = wxSize( KiROUND( extents.x ), KiROUND( extents.y ) );
  wxPoint pos = GetTextPos();
 
  if( IsMultilineAllowed() && aLine > 0 && ( aLine < static_cast<int>( strings.GetCount() ) ) )
  pos.y -= KiROUND( aLine * interline );
 
  if( aInvertY )
  pos.y = -pos.y;
 
  rect.SetOrigin( pos );
 
  if( hasOverBar )
  { // A overbar adds an extra size to the text
  // Height from the base line text of chars like [ or {
  double curr_height = GetTextHeight() * 1.15;
  double overbarPosition = font.ComputeOverbarVerticalPosition( fontSize.y );
  int extra_height = KiROUND( overbarPosition - curr_height );
 
  extra_height += thickness / 2;
  textsize.y += extra_height;
  rect.Move( wxPoint( 0, -extra_height ) );
  }
 
  // for multiline texts and aLine < 0, merge all rectangles
  // ( if aLine < 0, we want the full text bounding box )
  if( IsMultilineAllowed() && aLine < 0 )
  {
  for( unsigned ii = 1; ii < strings.GetCount(); ii++ )
  {
  text = strings.Item( ii );
  extents = font.ComputeStringBoundaryLimits( text, fontSize, penWidth );
  textsize.x = std::max( textsize.x, KiROUND( extents.x ) );
  }
 
  // interline spacing is only *between* lines, so total height is the height of the first
  // line plus the interline distance (with interline spacing) for all subsequent lines
  // Don't add interline spacing to empty textboxes
  if( strings.GetCount() )
  textsize.y += KiROUND( ( strings.GetCount() - 1 ) * interline );
  }
 
  rect.SetSize( textsize );
 
  /* Now, calculate the rect origin, according to text justification
  * At this point the rectangle origin is the text origin (m_Pos).
  * This is true only for left and top text justified texts (using top to bottom Y axis
  * orientation). and must be recalculated for others justifications
  * also, note the V justification is relative to the first line
  */
  switch( GetHorizJustify() )
  {
  case GR_TEXT_HJUSTIFY_LEFT:
  if( IsMirrored() )
  rect.SetX( rect.GetX() - rect.GetWidth() );
  break;
 
  case GR_TEXT_HJUSTIFY_CENTER:
  rect.SetX( rect.GetX() - ( rect.GetWidth() / 2 ) );
  break;
 
  case GR_TEXT_HJUSTIFY_RIGHT:
  if( !IsMirrored() )
  rect.SetX( rect.GetX() - rect.GetWidth() );
  break;
  }
 
  switch( GetVertJustify() )
  {
  case GR_TEXT_VJUSTIFY_TOP:
  break;
 
  case GR_TEXT_VJUSTIFY_CENTER:
  rect.SetY( rect.GetY() - KiROUND( interline / 2.0 ) );
  break;
 
  case GR_TEXT_VJUSTIFY_BOTTOM:
  rect.SetY( rect.GetY() - KiROUND( interline ) );
  break;
  }
 
  if( linecount > 1 )
  {
  int yoffset;
  linecount -= 1;
 
  switch( GetVertJustify() )
  {
  case GR_TEXT_VJUSTIFY_TOP:
  break;
 
  case GR_TEXT_VJUSTIFY_CENTER:
  yoffset = KiROUND( linecount * interline / 2.0 );
  rect.SetY( rect.GetY() - yoffset );
  break;
 
  case GR_TEXT_VJUSTIFY_BOTTOM:
  yoffset = KiROUND( linecount * interline );
  rect.SetY( rect.GetY() - yoffset );
  break;
  }
  }
 
  // Many fonts draw diacriticals, descenders, etc. outside the X-height of the font. This
  // will cacth most (but probably not all) of them.
  rect.Inflate( 0, KiROUND( thickness * 0.75 ) );
 
  rect.Normalize(); // Make h and v sizes always >= 0
 
  return rect;
 }

References basic_gal, EDA_TEXT::GetEffectiveTextPenWidth(), EDA_TEXT::GetHorizJustify(), KIGFX::STROKE_FONT::GetInterline(), EDA_TEXT::GetShownText(), KIGFX::GAL::GetStrokeFont(), EDA_TEXT::GetTextHeight(), EDA_TEXT::GetTextPos(), EDA_TEXT::GetTextSize(), EDA_TEXT::GetVertJustify(), EDA_RECT::GetWidth(), EDA_RECT::GetX(), EDA_RECT::GetY(), GR_TEXT_HJUSTIFY_CENTER, GR_TEXT_HJUSTIFY_LEFT, GR_TEXT_HJUSTIFY_RIGHT, GR_TEXT_VJUSTIFY_BOTTOM, GR_TEXT_VJUSTIFY_CENTER, GR_TEXT_VJUSTIFY_TOP, EDA_RECT::Inflate(), EDA_TEXT::IsMirrored(), EDA_TEXT::IsMultilineAllowed(), KiROUND(), EDA_RECT::Move(), EDA_RECT::Normalize(), EDA_RECT::SetOrigin(), EDA_RECT::SetSize(), EDA_RECT::SetX(), EDA_RECT::SetY(), text, wxStringSplit(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ GetTextHeight()

int EDA_TEXT::GetTextHeight ( ) const

inlineinherited

Definition at line 265 of file eda_text.h.

265 { return m_e.size.y; }

TEXT_EFFECTS m_e

Definition: eda_text.h:415

Referenced by LIB_TEXT::compare(), LIB_FIELD::compare(), SCH_GLOBALLABEL::CreateGraphicShape(), SCH_HIERLABEL::CreateGraphicShape(), EDA_TEXT_DESC::EDA_TEXT_DESC(), EDA_TEXT::Format(), SCH_HIERLABEL::GetBoundingBox(), SCH_GLOBALLABEL::GetBoundingBoxBase(), EDA_TEXT::GetInterline(), GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), SCH_GLOBALLABEL::GetSchematicTextOffset(), EDA_TEXT::GetTextBox(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), SCH_SEXPR_PLUGIN::saveField(), PCB_DIM_ALIGNED::updateText(), and PCB_DIM_ORTHOGONAL::updateText().

wxSize size

Definition: eda_text.h:124

References EDA_TEXT::m_e, and TEXT_EFFECTS::size.

◆ GetTextPos()

const wxPoint& EDA_TEXT::GetTextPos ( ) const

inlineinherited

Definition at line 268 of file eda_text.h.

268 { return m_e.pos; }

TEXT_EFFECTS m_e

Definition: eda_text.h:415

wxPoint pos

Definition: eda_text.h:127

References EDA_TEXT::m_e, and TEXT_EFFECTS::pos.

◆ GetTextSize()

const wxSize& EDA_TEXT::GetTextSize ( ) const

inlineinherited

Definition at line 259 of file eda_text.h.

259 { return m_e.size; }

TEXT_EFFECTS m_e

Definition: eda_text.h:415

Referenced by BOARD_ADAPTER::addShapeWithClearance(), MICROWAVE_TOOL::createMicrowaveInductor(), KIGFX::SCH_PAINTER::draw(), EDA_TEXT::GetEffectiveTextPenWidth(), SCH_TEXT::GetLabelBoxExpansion(), CADSTAR_SCH_ARCHIVE_LOADER::getScaledLibPart(), EDA_TEXT::GetTextBox(), SCH_TEXT::GetTextOffset(), EDA_TEXT::LenSize(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), EAGLE_PLUGIN::orientFPText(), LIB_TEXT::Plot(), LIB_FIELD::Plot(), SCH_FIELD::Plot(), SCH_TEXT::Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotPcbText(), LIB_TEXT::print(), SCH_FIELD::Print(), LIB_FIELD::print(), EDA_TEXT::printOneLineOfText(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), SCH_LEGACY_PLUGIN::saveSheet(), KIGFX::GAL::SetTextAttributes(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), TransformTextShapeWithClearanceToPolygon(), FP_TEXT::TransformTextShapeWithClearanceToPolygon(), EDA_TEXT::TransformToSegmentList(), and SCH_GLOBALLABEL::UpdateIntersheetRefProps().

wxSize size

Definition: eda_text.h:124

References EDA_TEXT::m_e, and TEXT_EFFECTS::size.

◆ GetTextStyleName()

wxString EDA_TEXT::GetTextStyleName ( ) const

inherited

Returns: a wxString with the style name( Normal, Italic, Bold, Bold+Italic).

Definition at line 504 of file eda_text.cpp.

 {
  int style = 0;
 
  if( IsItalic() )
  style = 1;
 
  if( IsBold() )
  style += 2;
 
  wxString stylemsg[4] = {
  _("Normal"),
  _("Italic"),
  _("Bold"),
  _("Bold+Italic")
  };
 
  return stylemsg[style];
 }

References _, EDA_TEXT::IsBold(), and EDA_TEXT::IsItalic().

Referenced by LIB_TEXT::GetMsgPanelInfo(), LIB_FIELD::GetMsgPanelInfo(), and SCH_FIELD::GetMsgPanelInfo().

◆ GetTextThickness()

int EDA_TEXT::GetTextThickness ( ) const

inlineinherited

Definition at line 181 of file eda_text.h.

181 { return m_e.penwidth; };

Referenced by EDA_TEXT_DESC::EDA_TEXT_DESC(), EDA_TEXT::Format(), EDA_TEXT::GetEffectiveTextPenWidth(), GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), EDA_TEXT::IsDefaultFormatting(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), SCH_LEGACY_PLUGIN::saveText(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), and SCH_GLOBALLABEL::UpdateIntersheetRefProps().

TEXT_EFFECTS m_e

Definition: eda_text.h:415

TEXT_EFFECTS::penwidth

int penwidth

Definition: eda_text.h:125

References EDA_TEXT::m_e, and TEXT_EFFECTS::penwidth.

◆ GetTextWidth()

int EDA_TEXT::GetTextWidth ( ) const

inlineinherited

Definition at line 262 of file eda_text.h.

262 { return m_e.size.x; }

TEXT_EFFECTS m_e

Definition: eda_text.h:415

Referenced by LIB_TEXT::compare(), LIB_FIELD::compare(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), EDA_TEXT_DESC::EDA_TEXT_DESC(), EDA_TEXT::Format(), EDA_TEXT::GetEffectiveTextPenWidth(), GetMsgPanelInfo(), LIB_TEXT::GetMsgPanelInfo(), LIB_FIELD::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), SCH_FIELD::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_HIERLABEL::GetSchematicTextOffset(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), SCH_EAGLE_PLUGIN::loadTextAttributes(), SCH_LEGACY_PLUGIN::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN::saveText(), SCH_LEGACY_PLUGIN_CACHE::saveText(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_AND_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_AND_LABEL_PROPERTIES::TransferDataToWindow(), PCB_DIM_ALIGNED::updateGeometry(), PCB_DIM_ORTHOGONAL::updateGeometry(), PCB_DIM_LEADER::updateGeometry(), and DIALOG_FIELD_PROPERTIES::updateText().

wxSize size

Definition: eda_text.h:124

References EDA_TEXT::m_e, and TEXT_EFFECTS::size.

◆ GetVertJustify()

EDA_TEXT_VJUSTIFY_T EDA_TEXT::GetVertJustify ( ) const

inlineinherited

Definition at line 220 of file eda_text.h.

220 { return EDA_TEXT_VJUSTIFY_T( m_e.vjustify ); };

Referenced by BOARD_ADAPTER::addShapeWithClearance(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), EDA_TEXT_DESC::EDA_TEXT_DESC(), EDA_TEXT::Format(), EDA_TEXT::GetDrawVertJustify(), SCH_FIELD::GetEffectiveVertJustify(), EDA_TEXT::GetLinePositions(), LIB_TEXT::GetMsgPanelInfo(), LIB_FIELD::GetMsgPanelInfo(), SCH_FIELD::GetMsgPanelInfo(), EDA_TEXT::GetTextBox(), EDA_TEXT::IsDefaultFormatting(), SCH_FIELD::IsVertJustifyFlipped(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), SCH_EDIT_TOOL::Mirror(), LIB_TEXT::MirrorHorizontal(), LIB_TEXT::MirrorVertical(), LIB_TEXT::NormalizeJustification(), SCH_TEXT::Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotPcbText(), positioningChanged(), LIB_FIELD::print(), EDA_TEXT::printOneLineOfText(), LIB_TEXT::Rotate(), SCH_LEGACY_PLUGIN::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveText(), KIGFX::GAL::SetTextAttributes(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), TransformTextShapeWithClearanceToPolygon(), and FP_TEXT::TransformTextShapeWithClearanceToPolygon().

TEXT_EFFECTS m_e

Definition: eda_text.h:415

TEXT_EFFECTS::vjustify

signed char vjustify

vertical justification

Definition: eda_text.h:123

EDA_TEXT_VJUSTIFY_T

Definition: eda_text.h:89

References EDA_TEXT::m_e, and TEXT_EFFECTS::vjustify.

◆ GetX()

int BOARD_ITEM::GetX ( ) const

inlineinherited

Definition at line 64 of file board_item.h.

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

References EDA_ITEM::GetPosition().

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

◆ GetY()

int BOARD_ITEM::GetY ( ) const

inlineinherited

Definition at line 70 of file board_item.h.

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

References EDA_ITEM::GetPosition().

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

◆ HasFlag()

bool EDA_ITEM::HasFlag ( EDA_ITEM_FLAGS aFlag ) const

inlineinherited

Definition at line 155 of file eda_item.h.

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

EDA_TEXT::m_shown_text_has_text_var_refs

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:480

References EDA_ITEM::m_flags.

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

◆ HasTextVars()

bool EDA_TEXT::HasTextVars ( ) const

inlineinherited

Indicates the ShownText has text var references which need to be processed.

Definition at line 172 of file eda_text.h.

172 { return m_shown_text_has_text_var_refs; }

bool m_shown_text_has_text_var_refs

Definition: eda_text.h:413

References EDA_TEXT::m_shown_text_has_text_var_refs.

Referenced by GetShownText(), SCH_FIELD::GetShownText(), SCH_TEXT::GetShownText(), and FP_TEXT::GetShownText().

◆ HitTest() [1/2]

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

inlineoverridevirtual

Test if aPosition is inside or on the boundary of this item.

Parameters

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

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

Reimplemented from EDA_ITEM.

Definition at line 102 of file pcb_text.h.

  {
  return TextHitTest( aPosition, aAccuracy );
  }

References TextHitTest().

◆ HitTest() [2/2]

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

inlineoverridevirtual

Parameters

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

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

Reimplemented from EDA_ITEM.

Definition at line 110 of file pcb_text.h.

  {
  return TextHitTest( aRect, aContained, aAccuracy );
  }

References TextHitTest().

◆ IsBold()

bool EDA_TEXT::IsBold ( ) const

inlineinherited

Definition at line 204 of file eda_text.h.

204 { return m_e.Bit( TE_BOLD ); }

EDA_TEXT::TE_BOLD

Definition: eda_text.h:420

TEXT_EFFECTS m_e

Definition: eda_text.h:415

Referenced by BOARD_ADAPTER::addShapeWithClearance(), SCH_DRAWING_TOOLS::createNewText(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), KIGFX::SCH_PAINTER::draw(), EDA_TEXT_DESC::EDA_TEXT_DESC(), EDA_TEXT::Format(), EDA_TEXT::GetEffectiveTextPenWidth(), SCH_TEXT::GetMsgPanelInfo(), EDA_TEXT::GetTextStyleName(), EDA_TEXT::IsDefaultFormatting(), EDA_TEXT::LenSize(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), LIB_TEXT::Plot(), LIB_FIELD::Plot(), SCH_FIELD::Plot(), SCH_TEXT::Plot(), LIB_TEXT::print(), SCH_FIELD::Print(), LIB_FIELD::print(), EDA_TEXT::printOneLineOfText(), SCH_LEGACY_PLUGIN::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveText(), KIGFX::GAL::SetTextAttributes(), DIALOG_TEXT_AND_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_AND_LABEL_PROPERTIES::TransferDataToWindow(), TransformTextShapeWithClearanceToPolygon(), FP_TEXT::TransformTextShapeWithClearanceToPolygon(), and SCH_GLOBALLABEL::UpdateIntersheetRefProps().

void Bit(int aBit, bool aValue)

Definition: eda_text.h:129

References TEXT_EFFECTS::Bit(), EDA_TEXT::m_e, and EDA_TEXT::TE_BOLD.

◆ IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const

inlineinherited

Definition at line 125 of file eda_item.h.

125 { return m_flags & BRIGHTENED; }

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

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:480

BRIGHTENED

#define BRIGHTENED

item is drawn with a bright contour

Definition: eda_item_flags.h:65

References BRIGHTENED, and EDA_ITEM::m_flags.

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

◆ IsConnected()

virtual bool BOARD_ITEM::IsConnected ( ) const

inlinevirtualinherited

Returns information if the object is derived from BOARD_CONNECTED_ITEM.

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

Reimplemented in ZONE, and BOARD_CONNECTED_ITEM.

Definition at line 103 of file board_item.h.

  {
  return false;
  }

◆ IsDefaultFormatting()

bool EDA_TEXT::IsDefaultFormatting ( ) const

inherited

Definition at line 525 of file eda_text.cpp.

 {
  return ( IsVisible()
  && !IsMirrored()
  && GetHorizJustify() == GR_TEXT_HJUSTIFY_CENTER
  && GetVertJustify() == GR_TEXT_VJUSTIFY_CENTER
  && GetTextThickness() == 0
  && !IsItalic()
  && !IsBold()
  && !IsMultilineAllowed()
  );
 }

References EDA_TEXT::GetHorizJustify(), EDA_TEXT::GetTextThickness(), EDA_TEXT::GetVertJustify(), GR_TEXT_HJUSTIFY_CENTER, GR_TEXT_VJUSTIFY_CENTER, EDA_TEXT::IsBold(), EDA_TEXT::IsItalic(), EDA_TEXT::IsMirrored(), EDA_TEXT::IsMultilineAllowed(), and EDA_TEXT::IsVisible().

Referenced by SCH_SEXPR_PLUGIN::saveField().

◆ IsDragging()

bool EDA_ITEM::IsDragging ( ) const

inlineinherited

Definition at line 120 of file eda_item.h.

120 { return m_flags & IS_DRAGGING; }

IS_DRAGGING

#define IS_DRAGGING

Item being dragged.

Definition: eda_item_flags.h:43

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:480

References IS_DRAGGING, and EDA_ITEM::m_flags.

Referenced by DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES().

◆ IsEntered()

bool EDA_ITEM::IsEntered ( ) const

inlineinherited

Definition at line 123 of file eda_item.h.

123 { return m_flags & ENTERED; }

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:480

ENTERED

#define ENTERED

indicates a group has been entered

Definition: eda_item_flags.h:72

References ENTERED, and EDA_ITEM::m_flags.

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

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const

inlineinherited

Definition at line 205 of file eda_item.h.

205 { return m_forceVisible; }

EDA_ITEM::m_forceVisible

bool m_forceVisible

Definition: eda_item.h:479

References EDA_ITEM::m_forceVisible.

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

◆ IsItalic()

bool EDA_TEXT::IsItalic ( ) const

inlineinherited

Definition at line 201 of file eda_text.h.

201 { return m_e.Bit( TE_ITALIC ); }

TEXT_EFFECTS m_e

Definition: eda_text.h:415

Referenced by BOARD_ADAPTER::addShapeWithClearance(), SCH_DRAWING_TOOLS::createNewText(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), KIGFX::SCH_PAINTER::draw(), EDA_TEXT_DESC::EDA_TEXT_DESC(), EDA_TEXT::Format(), SCH_TEXT::GetMsgPanelInfo(), EDA_TEXT::GetTextStyleName(), EDA_TEXT::IsDefaultFormatting(), EDA_TEXT::LenSize(), LIB_TEXT::Plot(), LIB_FIELD::Plot(), SCH_FIELD::Plot(), SCH_TEXT::Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotPcbText(), LIB_TEXT::print(), SCH_FIELD::Print(), LIB_FIELD::print(), EDA_TEXT::printOneLineOfText(), SCH_LEGACY_PLUGIN::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN::saveText(), SCH_LEGACY_PLUGIN_CACHE::saveText(), KIGFX::GAL::SetTextAttributes(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_AND_LABEL_PROPERTIES::TransferDataToWindow(), TransformTextShapeWithClearanceToPolygon(), FP_TEXT::TransformTextShapeWithClearanceToPolygon(), EDA_TEXT::TransformToSegmentList(), and SCH_GLOBALLABEL::UpdateIntersheetRefProps().

void Bit(int aBit, bool aValue)

Definition: eda_text.h:129

EDA_TEXT::TE_ITALIC

Definition: eda_text.h:419

References TEXT_EFFECTS::Bit(), EDA_TEXT::m_e, and EDA_TEXT::TE_ITALIC.

◆ IsLocked()

bool BOARD_ITEM::IsLocked ( ) const

virtualinherited

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

Reimplemented in FOOTPRINT, and PAD.

Definition at line 64 of file board_item.cpp.

 {
  if( GetParentGroup() )
  return GetParentGroup()->IsLocked();
 
  const BOARD* board = GetBoard();
 
  return board && board->GetBoardUse() != BOARD_USE::FPHOLDER && GetState( LOCKED );
 }

References FPHOLDER, BOARD_ITEM::GetBoard(), BOARD::GetBoardUse(), BOARD_ITEM::GetParentGroup(), EDA_ITEM::GetState(), BOARD_ITEM::IsLocked(), and LOCKED.

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

◆ IsMirrored()

bool EDA_TEXT::IsMirrored ( ) const

inlineinherited

Definition at line 210 of file eda_text.h.

210 { return m_e.Bit( TE_MIRROR ); }

EDA_TEXT::TE_MIRROR

Definition: eda_text.h:418

TEXT_EFFECTS m_e

Definition: eda_text.h:415

Referenced by BOARD_ADAPTER::addShapeWithClearance(), KIGFX::SCH_PAINTER::draw(), EDA_TEXT_DESC::EDA_TEXT_DESC(), Flip(), EDA_TEXT::Format(), GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), EDA_TEXT::GetTextBox(), EDA_TEXT::IsDefaultFormatting(), PCB_DIMENSION_BASE::Mirror(), EAGLE_PLUGIN::orientFPText(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotPcbText(), EDA_TEXT::printOneLineOfText(), KIGFX::GAL::SetTextAttributes(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), TransformTextShapeWithClearanceToPolygon(), FP_TEXT::TransformTextShapeWithClearanceToPolygon(), and EDA_TEXT::TransformToSegmentList().

void Bit(int aBit, bool aValue)

Definition: eda_text.h:129

References TEXT_EFFECTS::Bit(), EDA_TEXT::m_e, and EDA_TEXT::TE_MIRROR.

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const

inlineinherited

Definition at line 117 of file eda_item.h.

117 { return m_flags & IS_CHANGED; }

IS_CHANGED

#define IS_CHANGED

Item was edited, and modified.

Definition: eda_item_flags.h:37

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:480

References IS_CHANGED, and EDA_ITEM::m_flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMoving()

bool EDA_ITEM::IsMoving ( ) const

inlineinherited

Definition at line 119 of file eda_item.h.

119 { return m_flags & IS_MOVING; }

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:480

IS_MOVING

#define IS_MOVING

Item being moved.

Definition: eda_item_flags.h:40

References IS_MOVING, and EDA_ITEM::m_flags.

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

◆ IsMultilineAllowed()

bool EDA_TEXT::IsMultilineAllowed ( ) const

inlineinherited

Definition at line 217 of file eda_text.h.

217 { return m_e.Bit( TE_MULTILINE ); }

TEXT_EFFECTS m_e

Definition: eda_text.h:415

void Bit(int aBit, bool aValue)

Definition: eda_text.h:129

EDA_TEXT::TE_MULTILINE

Definition: eda_text.h:421

References TEXT_EFFECTS::Bit(), EDA_TEXT::m_e, and EDA_TEXT::TE_MULTILINE.

Referenced by DIALOG_TEXT_AND_LABEL_PROPERTIES::DIALOG_TEXT_AND_LABEL_PROPERTIES(), EDA_TEXT::GetTextBox(), EDA_TEXT::IsDefaultFormatting(), SCH_TEXT::Plot(), BRDITEMS_PLOTTER::PlotPcbText(), EDA_TEXT::Print(), and EDA_TEXT::TransformToSegmentList().

◆ IsNew()

bool EDA_ITEM::IsNew ( ) const

inlineinherited

Definition at line 118 of file eda_item.h.

118 { return m_flags & IS_NEW; }

IS_NEW

#define IS_NEW

New item, just created.

Definition: eda_item_flags.h:41

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

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:480

References IS_NEW, and EDA_ITEM::m_flags.

◆ IsOnCopperLayer()

virtual bool BOARD_ITEM::IsOnCopperLayer ( ) const

inlinevirtualinherited

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

Reimplemented in PAD, PCB_TRACK, and ZONE.

Definition at line 111 of file board_item.h.

  {
  return IsCopperLayer( GetLayer() );
  }

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

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

◆ IsOnLayer()

virtual bool BOARD_ITEM::IsOnLayer ( PCB_LAYER_ID aLayer ) const

inlinevirtualinherited

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

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

Parameters

aLayer The layer to test for.

Returns: true if on given layer, else false.

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

Definition at line 195 of file board_item.h.

  {
   return m_layer == aLayer;
  }

References BOARD_ITEM::m_layer.

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

◆ IsReplaceable()

virtual bool EDA_ITEM::IsReplaceable ( ) const

inlinevirtualinherited

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

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

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

Definition at line 402 of file eda_item.h.

402 { return false; }

Referenced by EDA_ITEM::Matches().

◆ IsResized()

bool EDA_ITEM::IsResized ( ) const

inlineinherited

Definition at line 124 of file eda_item.h.

124 { return m_flags & IS_RESIZING; }

IS_RESIZING

#define IS_RESIZING

Item being resized.

Definition: eda_item_flags.h:42

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:480

References IS_RESIZING, and EDA_ITEM::m_flags.

◆ IsSelected()

bool EDA_ITEM::IsSelected ( ) const

inlineinherited

Definition at line 122 of file eda_item.h.

122 { return m_flags & SELECTED; }

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:480

SELECTED

#define SELECTED

Definition: eda_item_flags.h:48

References EDA_ITEM::m_flags, and SELECTED.

◆ IsTrack()

bool BOARD_ITEM::IsTrack ( ) const

inlineinherited

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

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

Definition at line 205 of file board_item.h.

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

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

◆ IsType()

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

inlineoverridevirtual

Check whether the item is one of the listed types.

Parameters

aScanTypes List of item types

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

Reimplemented from EDA_ITEM.

Definition at line 51 of file pcb_text.h.

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

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

◆ IsVisible()

bool PCB_TEXT::IsVisible ( ) const

inlineoverridevirtual

Reimplemented from EDA_TEXT.

Definition at line 69 of file pcb_text.h.

69 { return true; }

◆ IsWireImage()

bool EDA_ITEM::IsWireImage ( ) const

inlineinherited

Definition at line 121 of file eda_item.h.

121 { return m_flags & IS_WIRE_IMAGE; }

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:480

IS_WIRE_IMAGE

#define IS_WIRE_IMAGE

Item to be drawn as wireframe while editing.

Definition: eda_item_flags.h:45

References IS_WIRE_IMAGE, and EDA_ITEM::m_flags.

◆ IterateForward() [1/2]

template<class T >

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

inlinestaticinherited

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

Definition at line 294 of file eda_item.h.

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

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

Referenced by GERBER_FILE_IMAGE::Visit().

◆ IterateForward() [2/2]

template<class T >

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

inlinestaticinherited

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

Definition at line 313 of file eda_item.h.

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

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

◆ layerMaskDescribe()

wxString BOARD_ITEM::layerMaskDescribe ( ) const

protectedvirtualinherited

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

The BOARD is needed because layer names are customizable.

Reimplemented in PCB_VIA.

Definition at line 87 of file board_item.cpp.

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

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

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

◆ LenSize()

int EDA_TEXT::LenSize	(	const wxString &	aLine,
		int	aThickness
	)		const

inherited

Returns: the text length in internal units.

Parameters

aLine	the line of text to consider. For single line text, this parameter is always m_Text.
aThickness	the stroke width of the text.

Definition at line 204 of file eda_text.cpp.

 {
  basic_gal.SetFontItalic( IsItalic() );
  basic_gal.SetFontBold( IsBold() );
  basic_gal.SetFontUnderlined( false );
  basic_gal.SetLineWidth( (float) aThickness );
  basic_gal.SetGlyphSize( VECTOR2D( GetTextSize() ) );
 
  VECTOR2D tsize = basic_gal.GetTextLineSize( aLine );
 
  return KiROUND( tsize.x );
 }

References basic_gal, KIGFX::GAL::GetTextLineSize(), EDA_TEXT::GetTextSize(), EDA_TEXT::IsBold(), EDA_TEXT::IsItalic(), KiROUND(), KIGFX::GAL::SetFontBold(), KIGFX::GAL::SetFontItalic(), KIGFX::GAL::SetFontUnderlined(), KIGFX::GAL::SetGlyphSize(), KIGFX::GAL::SetLineWidth(), and VECTOR2< T >::x.

Referenced by SCH_GLOBALLABEL::CreateGraphicShape(), SCH_HIERLABEL::GetBoundingBox(), and SCH_GLOBALLABEL::GetBoundingBoxBase().

◆ MapHorizJustify()

EDA_TEXT_HJUSTIFY_T EDA_TEXT::MapHorizJustify ( int aHorizJustify )

staticinherited

Definition at line 73 of file eda_text.cpp.

 {
  wxASSERT( aHorizJustify >= GR_TEXT_HJUSTIFY_LEFT && aHorizJustify <= GR_TEXT_HJUSTIFY_RIGHT );
 
  if( aHorizJustify > GR_TEXT_HJUSTIFY_RIGHT )
  return GR_TEXT_HJUSTIFY_RIGHT;
 
  if( aHorizJustify < GR_TEXT_HJUSTIFY_LEFT )
  return GR_TEXT_HJUSTIFY_LEFT;
 
  return static_cast<EDA_TEXT_HJUSTIFY_T>( aHorizJustify );
 }

References GR_TEXT_HJUSTIFY_LEFT, and GR_TEXT_HJUSTIFY_RIGHT.

Referenced by DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), DIALOG_LIB_FIELD_PROPERTIES::UpdateField(), and DIALOG_SCH_FIELD_PROPERTIES::UpdateField().

◆ MapVertJustify()

EDA_TEXT_VJUSTIFY_T EDA_TEXT::MapVertJustify ( int aVertJustify )

staticinherited

Definition at line 87 of file eda_text.cpp.

 {
  wxASSERT( aVertJustify >= GR_TEXT_VJUSTIFY_TOP && aVertJustify <= GR_TEXT_VJUSTIFY_BOTTOM );
 
  if( aVertJustify > GR_TEXT_VJUSTIFY_BOTTOM )
  return GR_TEXT_VJUSTIFY_BOTTOM;
 
  if( aVertJustify < GR_TEXT_VJUSTIFY_TOP )
  return GR_TEXT_VJUSTIFY_TOP;
 
  return static_cast<EDA_TEXT_VJUSTIFY_T>( aVertJustify );
 }

References GR_TEXT_VJUSTIFY_BOTTOM, and GR_TEXT_VJUSTIFY_TOP.

Referenced by DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), DIALOG_LIB_FIELD_PROPERTIES::UpdateField(), and DIALOG_SCH_FIELD_PROPERTIES::UpdateField().

◆ Matches() [1/2]

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

inlineoverridevirtual

Compare the item against the search criteria in aSearchData.

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

Parameters

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

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

Reimplemented from EDA_ITEM.

Definition at line 71 of file pcb_text.h.

  {
  return BOARD_ITEM::Matches( GetShownText(), aSearchData );
  }

References GetShownText(), and EDA_ITEM::Matches().

Referenced by DIALOG_FIND::search().

◆ Matches() [2/2]

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

protectedinherited

Compare aText against search criteria in aSearchData.

This is a helper function for simplify derived class logic.

Parameters

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

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

Definition at line 118 of file eda_item.cpp.

 {
  wxString text = aText;
  int flags = aSearchData.GetFlags();
  wxString searchText = aSearchData.GetFindString();
 
  // Don't match if searching for replaceable item and the item doesn't support text replace.
  if( ( flags & FR_SEARCH_REPLACE ) && !IsReplaceable() )
  return false;
 
  if( !( flags & wxFR_MATCHCASE ) )
  {
  text.MakeUpper();
  searchText.MakeUpper();
  }
 
  if( flags & wxFR_WHOLEWORD )
  {
  int ii = 0;
 
  while( ii < (int) text.length() )
  {
  int next = text.find( searchText, ii );
 
  if( next == wxNOT_FOUND )
  return false;
 
  ii = next;
  next += searchText.length();
 
  bool startOK = ( ii == 0 || !wxIsalnum( text.GetChar( ii - 1 ) ) );
  bool endOK = ( next == (int) text.length() || !wxIsalnum( text.GetChar( next ) ) );
 
  if( startOK && endOK )
  return true;
  else
  ii++;
  }
 
  return false;
  }
  else if( flags & FR_MATCH_WILDCARD )
  {
   return text.Matches( searchText );
  }
  else
  {
  return text.Find( searchText ) != wxNOT_FOUND;
  }
 }

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

◆ Move() [1/2]

void PCB_TEXT::Move ( const wxPoint & aMoveVector )

inlineoverridevirtual

Move this object.

Parameters

aMoveVector the move vector for this object.

Reimplemented from BOARD_ITEM.

Definition at line 86 of file pcb_text.h.

  {
  EDA_TEXT::Offset( aMoveVector );
  }

References EDA_TEXT::Offset().

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), and ALTIUM_PCB::HelperParseDimensions6Radial().

◆ Move() [2/2]

void BOARD_ITEM::Move ( const VECTOR2I & aMoveVector )

inlineinherited

Definition at line 238 of file board_item.h.

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

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

◆ Offset()

void EDA_TEXT::Offset ( const wxPoint & aOffset )

inlineinherited

Definition at line 273 of file eda_text.h.

273 { m_e.pos += aOffset; }

TEXT_EFFECTS m_e

Definition: eda_text.h:415

wxPoint pos

Definition: eda_text.h:127

References EDA_TEXT::m_e, and TEXT_EFFECTS::pos.

Referenced by CADSTAR_ARCHIVE_PARSER::FixTextPositionNoAlignment(), Move(), FP_TEXT::Move(), SCH_FIELD::Move(), SCH_SHEET_PIN::Move(), SCH_TEXT::Move(), PCB_DIMENSION_BASE::Move(), LIB_TEXT::Offset(), LIB_FIELD::Offset(), FP_TEXT::SetDrawCoord(), DIALOG_SHEET_PROPERTIES::TransferDataToWindow(), and DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow().

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

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

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

◆ Print()

void EDA_TEXT::Print	(	const RENDER_SETTINGS *	aSettings,
		const wxPoint &	aOffset,
		const COLOR4D &	aColor,
		OUTLINE_MODE	aDisplay_mode = `FILLED`
	)

inherited

Print this text object to the device context aDC.

Parameters

aDC	the current Device Context.
aOffset	draw offset (usually (0,0)).
aColor	text color.
aDisplay_mode	FILLED or SKETCH.

Definition at line 420 of file eda_text.cpp.

 {
  if( IsMultilineAllowed() )
  {
  std::vector<wxPoint> positions;
  wxArrayString strings;
  wxStringSplit( GetShownText(), strings, '\n' );
 
  positions.reserve( strings.Count() );
 
  GetLinePositions( positions, strings.Count() );
 
  for( unsigned ii = 0; ii < strings.Count(); ii++ )
  printOneLineOfText( aSettings, aOffset, aColor, aFillMode, strings[ii], positions[ii] );
  }
  else
  {
  printOneLineOfText( aSettings, aOffset, aColor, aFillMode, GetShownText(), GetTextPos() );
  }
 }

References EDA_TEXT::GetLinePositions(), EDA_TEXT::GetShownText(), EDA_TEXT::GetTextPos(), EDA_TEXT::IsMultilineAllowed(), EDA_TEXT::printOneLineOfText(), and wxStringSplit().

Referenced by SCH_TEXT::Print(), SCH_GLOBALLABEL::Print(), SCH_HIERLABEL::Print(), and DS_DRAW_ITEM_TEXT::PrintWsItem().

◆ Replace() [1/3]

bool EDA_TEXT::Replace ( const wxFindReplaceData & aSearchData )

inherited

Helper function used in search and replace dialog.

Perform a text replace using the find and replace criteria in aSearchData.

Parameters

aSearchData A reference to a wxFindReplaceData object containing the search and replace criteria.

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

Definition at line 180 of file eda_text.cpp.

 {
  bool retval = EDA_ITEM::Replace( aSearchData, m_text );
  cacheShownText();
 
  return retval;
 }

References EDA_TEXT::cacheShownText(), EDA_TEXT::m_text, and EDA_ITEM::Replace().

Referenced by SCH_SHEET_PIN::Replace(), SCH_FIELD::Replace(), and SCH_TEXT::Replace().

◆ Replace() [2/3]

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

staticinherited

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

Parameters

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

Returns: True if aText was modified, otherwise false.

Definition at line 170 of file eda_item.cpp.

 {
  wxString text = aText;
  int flags = aSearchData.GetFlags();
  wxString searchText = aSearchData.GetFindString();
  wxString result;
  bool replaced = false;
 
  if( flags & wxFR_MATCHCASE )
  {
  text = text.Upper();
  searchText = searchText.Upper();
  }
 
  int ii = 0;
 
  while( ii < (int) text.length() )
  {
  int next = text.find( searchText, ii );
 
  if( next == wxNOT_FOUND )
  {
  result += aText.Mid( ii, wxString::npos );
  break;
  }
 
  if( next > ii )
  result += aText.Mid( ii, next - ii );
 
  ii = next;
  next += searchText.length();
 
  bool startOK;
  bool endOK;
 
  if( flags & wxFR_WHOLEWORD )
  {
  startOK = ( ii == 0 || !wxIsalnum( text.GetChar( ii - 1 ) ) );
  endOK = ( next == (int) text.length() || !wxIsalnum( text.GetChar( next ) ) );
  }
  else
  {
  startOK = true;
  endOK = true;
  }
 
  if( startOK && endOK )
  {
  result += aSearchData.GetReplaceString();
  replaced = true;
  ii = next;
  }
  else
  {
  result += aText.GetChar( ii );
  ii++;
  }
  }
 
  aText = result;
  return replaced;
 }

References next(), and text.

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

◆ Replace() [3/3]

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

inlinevirtualinherited

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

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

Parameters

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

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

Reimplemented in SCH_TEXT, SCH_FIELD, SCH_SHEET_PIN, and SCH_PIN.

Definition at line 391 of file eda_item.h.

  {
  return false;
  }

◆ Rotate() [1/2]

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

overridevirtual

Rotate this object.

Parameters

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

Reimplemented from BOARD_ITEM.

Definition at line 162 of file pcb_text.cpp.

 {
  wxPoint pt = GetTextPos();
  RotatePoint( &pt, aRotCentre, aAngle );
  SetTextPos( pt );
 
  SetTextAngle( GetTextAngle() + aAngle );
 }

References EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextPos(), RotatePoint(), SetTextAngle(), and EDA_TEXT::SetTextPos().

◆ Rotate() [2/2]

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

inlineinherited

Definition at line 251 of file board_item.h.

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

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

◆ Set() [1/3]

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

inlineinherited

Definition at line 42 of file inspectable.h.

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

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

◆ Set() [2/3]

template<typename T >

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

inlineinherited

Definition at line 55 of file inspectable.h.

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

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

◆ Set() [3/3]

template<typename T >

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

inlineinherited

Definition at line 68 of file inspectable.h.

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

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

◆ SetBold()

void EDA_TEXT::SetBold ( bool aBold )

inlineinherited

Definition at line 203 of file eda_text.h.

203 { m_e.Bit( TE_BOLD, aBold); }

EDA_TEXT::TE_BOLD

Definition: eda_text.h:420

TEXT_EFFECTS m_e

Definition: eda_text.h:415

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), SCH_EDIT_TOOL::ChangeTextType(), SCH_DRAWING_TOOLS::createNewText(), DS_DRAW_ITEM_TEXT::DS_DRAW_ITEM_TEXT(), EDA_TEXT_DESC::EDA_TEXT_DESC(), ALTIUM_PCB::HelperParseDimensions6Linear(), ALTIUM_PCB::HelperParseDimensions6Radial(), SCH_LEGACY_PLUGIN_CACHE::loadField(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), SCH_LEGACY_PLUGIN::loadSymbol(), SCH_EAGLE_PLUGIN::loadTextAttributes(), SCH_SEXPR_PARSER::parseEDA_TEXT(), PCB_PARSER::parseEDA_TEXT(), SCH_ALTIUM_PLUGIN::ParseLabel(), ALTIUM_PCB::ParseTexts6Data(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_AND_LABEL_PROPERTIES::TransferDataFromWindow(), SCH_GLOBALLABEL::UpdateIntersheetRefProps(), and DIALOG_FIELD_PROPERTIES::updateText().

void Bit(int aBit, bool aValue)

Definition: eda_text.h:129

References TEXT_EFFECTS::Bit(), EDA_TEXT::m_e, and EDA_TEXT::TE_BOLD.

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )

inlineinherited

Definition at line 129 of file eda_item.h.

129 { SetFlags( BRIGHTENED ); }

EDA_ITEM::SetFlags

void SetFlags(EDA_ITEM_FLAGS aMask)

Definition: eda_item.h:152

BRIGHTENED

#define BRIGHTENED

item is drawn with a bright contour

Definition: eda_item_flags.h:65

References BRIGHTENED, and EDA_ITEM::SetFlags().

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

◆ SetEffects()

void EDA_TEXT::SetEffects ( const EDA_TEXT & aSrc )

inherited

Set the text effects from another instance.

TEXT_EFFECTS is not exposed in the public API, but includes everything except the actual text string itself.

Definition at line 139 of file eda_text.cpp.

 {
  m_e = aSrc.m_e;
 }

References EDA_TEXT::m_e.

Referenced by LIB_TEXT::Clone(), LIB_FIELD::Copy(), SCH_FIELD::ImportValues(), DIALOG_UPDATE_SYMBOL_FIELDS::onOkButtonClicked(), LIB_FIELD::operator=(), DIALOG_CHANGE_SYMBOLS::processSymbol(), CLIPBOARD_IO::SaveSelection(), and FP_TEXT::SetEffects().

◆ SetFlags()

void EDA_ITEM::SetFlags ( EDA_ITEM_FLAGS aMask )

inlineinherited

Definition at line 152 of file eda_item.h.

152 { m_flags |= aMask; }

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:480

References EDA_ITEM::m_flags.

◆ SetForceVisible()

void EDA_ITEM::SetForceVisible ( bool aEnable )

inlineinherited

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

Parameters

aEnable True forces the item to be drawn. False uses the item's visibility setting to determine if the item is to be drawn.

Definition at line 203 of file eda_item.h.

203 { m_forceVisible = aEnable; }

EDA_ITEM::m_forceVisible

bool m_forceVisible

Definition: eda_item.h:479

References EDA_ITEM::m_forceVisible.

Referenced by SCH_EDITOR_CONTROL::UpdateFind().

◆ SetHorizJustify()

void EDA_TEXT::SetHorizJustify ( EDA_TEXT_HJUSTIFY_T aType )

inlineinherited

Definition at line 222 of file eda_text.h.

222 { m_e.hjustify = aType; };

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), GRAPHICS_IMPORTER_PCBNEW::AddText(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), SCH_GLOBALLABEL::AutoplaceFields(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), eagleToKicadAlignment(), EDA_TEXT_DESC::EDA_TEXT_DESC(), ALTIUM_PCB::HelperParseDimensions6Radial(), AUTOPLACER::justifyField(), FP_TEXT::KeepUpright(), CADSTAR_PCB_ARCHIVE_LOADER::loadDimensions(), SCH_LEGACY_PLUGIN_CACHE::loadField(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), FABMASTER::loadFootprints(), LEGACY_PLUGIN::loadMODULE_TEXT(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), SCH_LEGACY_PLUGIN::loadSymbol(), SCH_EDIT_TOOL::Mirror(), LIB_TEXT::MirrorHorizontal(), SCH_GLOBALLABEL::MirrorHorizontally(), SCH_GLOBALLABEL::MirrorSpinStyle(), LIB_TEXT::MirrorVertical(), EAGLE_PLUGIN::orientFPText(), EAGLE_PLUGIN::packageText(), SCH_SEXPR_PARSER::parseEDA_TEXT(), PCB_PARSER::parseEDA_TEXT(), SCH_ALTIUM_PLUGIN::ParsePowerPort(), ALTIUM_PCB::ParseTexts6Data(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), LIB_TEXT::Rotate(), SCH_GLOBALLABEL::Rotate90(), SCH_TEXT::SetLabelSpinStyle(), SCH_GLOBALLABEL::SetLabelSpinStyle(), SCH_HIERLABEL::SetLabelSpinStyle(), PCAD2KICAD::SetTextJustify(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_FIELD_PROPERTIES::UpdateField(), and DIALOG_SCH_FIELD_PROPERTIES::UpdateField().

TEXT_EFFECTS m_e

Definition: eda_text.h:415

TEXT_EFFECTS::hjustify

signed char hjustify

horizontal justification

Definition: eda_text.h:122

References TEXT_EFFECTS::hjustify, and EDA_TEXT::m_e.

◆ SetItalic()

void EDA_TEXT::SetItalic ( bool isItalic )

inlineinherited

Definition at line 200 of file eda_text.h.

200 { m_e.Bit( TE_ITALIC, isItalic ); }

TEXT_EFFECTS m_e

Definition: eda_text.h:415

Referenced by PCAD2KICAD::PCB_FOOTPRINT::AddToBoard(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), SCH_EDIT_TOOL::ChangeTextType(), PCB_BASE_FRAME::CreateNewFootprint(), SCH_DRAWING_TOOLS::createNewText(), DRAWING_TOOL::DrawDimension(), DS_DRAW_ITEM_TEXT::DS_DRAW_ITEM_TEXT(), EDA_TEXT_DESC::EDA_TEXT_DESC(), ALTIUM_PCB::HelperParseDimensions6Linear(), ALTIUM_PCB::HelperParseDimensions6Radial(), SCH_LEGACY_PLUGIN_CACHE::loadField(), FABMASTER::loadFootprints(), LEGACY_PLUGIN::loadMODULE_TEXT(), LEGACY_PLUGIN::loadPCB_TEXT(), SCH_LEGACY_PLUGIN::loadSymbol(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnAddField(), DIALOG_FOOTPRINT_PROPERTIES::OnAddField(), SCH_SEXPR_PARSER::parseEDA_TEXT(), PCB_PARSER::parseEDA_TEXT(), SCH_ALTIUM_PLUGIN::ParseLabel(), ALTIUM_PCB::ParseTexts6Data(), DRAWING_TOOL::PlaceText(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_AND_LABEL_PROPERTIES::TransferDataFromWindow(), SCH_GLOBALLABEL::UpdateIntersheetRefProps(), and DIALOG_FIELD_PROPERTIES::updateText().

void Bit(int aBit, bool aValue)

Definition: eda_text.h:129

EDA_TEXT::TE_ITALIC

Definition: eda_text.h:419

References TEXT_EFFECTS::Bit(), EDA_TEXT::m_e, and EDA_TEXT::TE_ITALIC.

◆ SetLayer()

virtual void BOARD_ITEM::SetLayer ( PCB_LAYER_ID aLayer )

inlinevirtualinherited

Set the layer this item is on.

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

Parameters

aLayer The layer number.

Reimplemented in PCB_DIMENSION_BASE, ZONE, and PCB_GROUP.

Definition at line 164 of file board_item.h.

  {
  m_layer = aLayer;
  }

References BOARD_ITEM::m_layer.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), PNS_KICAD_IFACE::AddItem(), PCAD2KICAD::PCB_ARC::AddToBoard(), PCAD2KICAD::PCB_LINE::AddToBoard(), PCAD2KICAD::PCB_FOOTPRINT::AddToBoard(), PCAD2KICAD::PCB_ARC::AddToFootprint(), PCAD2KICAD::PCB_LINE::AddToFootprint(), PCAD2KICAD::PCB_POLYGON::AddToFootprint(), BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), BOARD_ITEM_DESC::BOARD_ITEM_DESC(), BOOST_AUTO_TEST_CASE(), ZONE_CREATE_HELPER::commitZone(), CONVERT_TOOL::CreateLines(), MICROWAVE_TOOL::createMicrowaveInductor(), PCB_BASE_FRAME::CreateNewFootprint(), MICROWAVE_TOOL::createPolygonShape(), CONVERT_TOOL::CreatePolys(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::drawArc(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarShape(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), PAD_TOOL::explodePad(), EDIT_TOOL::FilletTracks(), PCB_TARGET::Flip(), Flip(), PCB_TRACK::Flip(), FP_SHAPE::Flip(), PCB_SHAPE::Flip(), FP_TEXT::Flip(), FOOTPRINT::Flip(), PCB_ARC::Flip(), FOOTPRINT_DESC::FOOTPRINT_DESC(), FP_TEXT::FP_TEXT(), ALTIUM_PCB::HelperCreateBoardOutline(), ALTIUM_PCB::HelperParseDimensions6Datum(), ALTIUM_PCB::HelperParseDimensions6Leader(), ALTIUM_PCB::HelperParsePad6NonCopper(), initTextTable(), LEGACY_PLUGIN::loadFOOTPRINT(), FABMASTER::loadFootprints(), FABMASTER::loadGraphics(), LEGACY_PLUGIN::loadMODULE_TEXT(), CADSTAR_PCB_ARCHIVE_LOADER::loadNetTracks(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), FABMASTER::loadPolygon(), EAGLE_PLUGIN::loadSignals(), LEGACY_PLUGIN::loadTrackList(), main(), DSN::SPECCTRA_DB::makeTRACK(), CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromShapes(), GRAPHICS_CLEANER::mergeRects(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnAddField(), DIALOG_FOOTPRINT_PROPERTIES::OnAddField(), EAGLE_PLUGIN::packageCircle(), EAGLE_PLUGIN::packagePolygon(), EAGLE_PLUGIN::packageRectangle(), EAGLE_PLUGIN::packageText(), EAGLE_PLUGIN::packageWire(), ALTIUM_PCB::ParseArcs6Data(), ALTIUM_PCB::ParseComponents6Data(), ALTIUM_PCB::ParseFills6Data(), GPCB_FPL_CACHE::parseFOOTPRINT(), ALTIUM_PCB::ParseShapeBasedRegions6Data(), ALTIUM_PCB::ParseTexts6Data(), ALTIUM_PCB::ParseTracks6Data(), DRAWING_TOOL::PlaceCharacteristics(), DRAWING_TOOL::PlaceStackup(), BOARD_EDITOR_CONTROL::PlaceTarget(), DRAWING_TOOL::PlaceText(), BRDITEMS_PLOTTER::PlotDimension(), BRDITEMS_PLOTTER::PlotPcbTarget(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::processItem(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), processTextItem(), PNS_PCBNEW_RULE_RESOLVER::QueryConstraint(), DIALOG_PAD_PROPERTIES::redraw(), CLIPBOARD_IO::SaveSelection(), CONVERT_TOOL::SegmentToArc(), PCB_DIMENSION_BASE::SetLayer(), GLOBAL_EDIT_TOOL::swapBoardItem(), TRACK_VIA_DESC::TRACK_VIA_DESC(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), and DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow().

◆ SetLayerSet()

virtual void BOARD_ITEM::SetLayerSet ( LSET aLayers )

inlinevirtualinherited

Reimplemented in PAD, PCB_VIA, and ZONE.

Definition at line 149 of file board_item.h.

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

Referenced by PANEL_SETUP_LAYERS::TransferDataFromWindow().

◆ SetLocked()

virtual void BOARD_ITEM::SetLocked ( bool aLocked )

inlinevirtualinherited

Modify the 'lock' status for of the item.

Reimplemented in FOOTPRINT, and PCB_GROUP.

Definition at line 218 of file board_item.h.

  {
  SetState( LOCKED, aLocked );
  }

References LOCKED, and EDA_ITEM::SetState().

Referenced by BOARD_ITEM_DESC::BOARD_ITEM_DESC(), EDIT_TOOL::DragArcTrack(), ZONE_SETTINGS::ExportSetting(), EDIT_TOOL::FilletTracks(), ROUTER_TOOL::InlineDrag(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), CADSTAR_PCB_ARCHIVE_LOADER::loadNetTracks(), DSN::SPECCTRA_DB::makeTRACK(), CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromShapes(), BOARD_EDITOR_CONTROL::modifyLockSelected(), PCB_PARSER::Parse(), ALTIUM_PCB::ParsePolygons6Data(), processTextItem(), PCB_GROUP::SetLocked(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

◆ SetMirrored()

void EDA_TEXT::SetMirrored ( bool isMirrored )

inlineinherited

Definition at line 209 of file eda_text.h.

209 { m_e.Bit( TE_MIRROR, isMirrored ); }

EDA_TEXT::TE_MIRROR

Definition: eda_text.h:418

TEXT_EFFECTS m_e

Definition: eda_text.h:415

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), PCAD2KICAD::PCB_FOOTPRINT::AddToBoard(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), EDA_TEXT_DESC::EDA_TEXT_DESC(), Flip(), FP_TEXT::Flip(), FP_TEXT::FP_TEXT(), LEGACY_PLUGIN::loadMODULE_TEXT(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), PCB_DIMENSION_BASE::Mirror(), DIALOG_FOOTPRINT_PROPERTIES::OnAddField(), EAGLE_PLUGIN::orientFPText(), EAGLE_PLUGIN::packageText(), SCH_SEXPR_PARSER::parseEDA_TEXT(), PCB_PARSER::parseEDA_TEXT(), ALTIUM_PCB::ParseTexts6Data(), DRAWING_TOOL::PlaceText(), and DIALOG_TEXT_PROPERTIES::TransferDataFromWindow().

void Bit(int aBit, bool aValue)

Definition: eda_text.h:129

References TEXT_EFFECTS::Bit(), EDA_TEXT::m_e, and EDA_TEXT::TE_MIRROR.

◆ SetModified()

void EDA_ITEM::SetModified ( )

inherited

Definition at line 65 of file eda_item.cpp.

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

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

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

◆ SetMultilineAllowed()

void EDA_TEXT::SetMultilineAllowed ( bool aAllow )

inlineinherited

Parameters

aAllow true if ok to use multiline option, false if ok to use only single line text. (Single line is faster in calculations than multiline.)

Definition at line 216 of file eda_text.h.

216 { m_e.Bit( TE_MULTILINE, aAllow ); }

TEXT_EFFECTS m_e

Definition: eda_text.h:415

Referenced by FOOTPRINT::Add(), BOARD::Add(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), BOARD_NETLIST_UPDATER::addNewFootprint(), SCH_SHEET::AddPin(), PAD::AddPrimitive(), PAD::AddPrimitiveArc(), PAD::AddPrimitiveCircle(), PAD::AddPrimitiveCurve(), PAD::AddPrimitivePoly(), PAD::AddPrimitiveRect(), PAD::AddPrimitiveSegment(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), SCH_SCREEN::Append(), LIB_FIELD::Copy(), SYMBOL_EDIT_FRAME::CreateNewSymbol(), SCH_DRAWING_TOOLS::createNewText(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), PCB_EDIT_FRAME::ExchangeFootprint(), LIB_SYMBOL::Flatten(), FOOTPRINT::FOOTPRINT(), PCB_PLUGIN::FootprintSave(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), CADSTAR_SCH_ARCHIVE_LOADER::getKiCadSchText(), LIB_SYMBOL::LIB_SYMBOL(), SCH_LEGACY_PLUGIN_CACHE::loadAliases(), CADSTAR_SCH_ARCHIVE_LOADER::loadChildSheets(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), SCH_SEXPR_PLUGIN::loadHierarchy(), SCH_LEGACY_PLUGIN::loadHierarchy(), DIALOG_LIB_EDIT_PIN_TABLE::OnAddRow(), FOOTPRINT::operator=(), LIB_SYMBOL::operator=(), PCB_PARSER::parseFOOTPRINT_unchecked(), SCH_SEXPR_PARSER::ParseSchematic(), SCH_SEXPR_PARSER::ParseSymbol(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), PCB_CONTROL::Paste(), SCH_EDITOR_CONTROL::Paste(), pasteFootprintItemsToFootprintEditor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), BACK_ANNOTATE::processNetNameChange(), BOARD_COMMIT::Push(), SCH_SEXPR_PLUGIN_CACHE::removeSymbol(), SCH_LEGACY_PLUGIN_CACHE::removeSymbol(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), SaveCopyOfZones(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SHEET_PIN::SCH_SHEET_PIN(), LIB_SYMBOL::SetFields(), PCB_DIMENSION_BASE::SetParent(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), SCH_SHEET::SwapData(), SCH_GLOBALLABEL::SwapData(), SCH_SYMBOL::SwapData(), and SwapItemData().

void Bit(int aBit, bool aValue)

Definition: eda_text.h:129

EDA_TEXT::TE_MULTILINE

Definition: eda_text.h:421

References TEXT_EFFECTS::Bit(), EDA_TEXT::m_e, and EDA_TEXT::TE_MULTILINE.

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::loadSymDefIntoLibrary(), PCB_TEXT(), SCH_HIERLABEL::SCH_HIERLABEL(), SCH_LABEL::SCH_LABEL(), and SCH_TEXT::SCH_TEXT().

◆ SetParent()

virtual void EDA_ITEM::SetParent ( EDA_ITEM * aParent )

inlinevirtualinherited

Reimplemented in PCB_DIMENSION_BASE.

Definition at line 115 of file eda_item.h.

115 { m_parent = aParent; }

EDA_ITEM::m_parent

EDA_ITEM * m_parent

Linked list: Link (parent struct)

Definition: eda_item.h:478

References EDA_ITEM::m_parent.

◆ SetParentGroup()

void BOARD_ITEM::SetParentGroup ( PCB_GROUP * aGroup )

inlineinherited

Definition at line 59 of file board_item.h.

59 { m_group = aGroup; }

BOARD_ITEM::m_group

PCB_GROUP * m_group

Definition: board_item.h:314

References BOARD_ITEM::m_group.

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

◆ SetPosition()

virtual void PCB_TEXT::SetPosition ( const wxPoint & aPos )

inlineoverridevirtual

Reimplemented from EDA_ITEM.

Definition at line 81 of file pcb_text.h.

  {
  EDA_TEXT::SetTextPos( aPos );
  }

References EDA_TEXT::SetTextPos().

Referenced by DRAWING_TOOL::DrawBoardCharacteristics(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), DRAWING_TOOL::DrawDimension(), ALTIUM_PCB::HelperParseDimensions6Radial(), EAGLE_PLUGIN::loadPlain(), and PCB_POINT_EDITOR::updateItem().

◆ SetSelected()

void EDA_ITEM::SetSelected ( )

inlineinherited

Definition at line 128 of file eda_item.h.

128 { SetFlags( SELECTED ); }

EDA_ITEM::SetFlags

void SetFlags(EDA_ITEM_FLAGS aMask)

Definition: eda_item.h:152

SELECTED

#define SELECTED

Definition: eda_item_flags.h:48

References SELECTED, and EDA_ITEM::SetFlags().

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

◆ SetState()

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

inlineinherited

Definition at line 141 of file eda_item.h.

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

References EDA_ITEM::m_status.

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

◆ SetStatus()

void EDA_ITEM::SetStatus ( EDA_ITEM_FLAGS aStatus )

inlineinherited

Definition at line 150 of file eda_item.h.

150 { m_status = aStatus; }

EDA_ITEM::m_status

EDA_ITEM_FLAGS m_status

Definition: eda_item.h:477

References EDA_ITEM::m_status.

Referenced by BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ SetText()

void EDA_TEXT::SetText ( const wxString & aText )

virtualinherited

Definition at line 124 of file eda_text.cpp.

 {
  m_text = aText;
  cacheShownText();
 }

References EDA_TEXT::cacheShownText(), and EDA_TEXT::m_text.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), SCH_EAGLE_PLUGIN::addImplicitConnections(), GRAPHICS_IMPORTER_PCBNEW::AddText(), PCAD2KICAD::PCB_FOOTPRINT::AddToBoard(), FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), LIB_TEXT::Clone(), createBoard(), PCB_BASE_FRAME::CreateNewFootprint(), SYMBOL_EDIT_FRAME::CreateNewSymbol(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), DRAWING_TOOL::DrawBoardCharacteristics(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), DRAWING_TOOL::DrawSpecificationStackup(), FOOTPRINT::DuplicateItem(), EDA_TEXT_DESC::EDA_TEXT_DESC(), CADSTAR_SCH_ARCHIVE_LOADER::getKiCadSchText(), SCH_SYMBOL::GetValue(), LIB_FIELD::HitTest(), SCH_TEXT::IncrementLabel(), SCH_LEGACY_PLUGIN_CACHE::loadAliases(), CADSTAR_SCH_ARCHIVE_LOADER::loadBusses(), CADSTAR_SCH_ARCHIVE_LOADER::loadChildSheets(), SCH_LEGACY_PLUGIN_CACHE::loadDocs(), SCH_LEGACY_PLUGIN_CACHE::loadField(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), FABMASTER::loadFootprints(), SCH_EAGLE_PLUGIN::loadFrame(), CADSTAR_SCH_ARCHIVE_LOADER::loadHierarchicalSheetPins(), SCH_EAGLE_PLUGIN::loadInstance(), SCH_EAGLE_PLUGIN::loadLibrary(), LEGACY_PLUGIN::loadMODULE_TEXT(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), SCH_LEGACY_PLUGIN_CACHE::LoadPart(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), SCH_EAGLE_PLUGIN::loadSheet(), SCH_LEGACY_PLUGIN::loadSheet(), CADSTAR_SCH_ARCHIVE_LOADER::loadSheetAndChildSheets(), SCH_LEGACY_PLUGIN::loadSymbol(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymDefIntoLibrary(), DIALOG_UPDATE_SYMBOL_FIELDS::onOkButtonClicked(), DIALOG_SHEET_PROPERTIES::OnUpdateUI(), LIB_FIELD::operator=(), EAGLE_PLUGIN::orientFPText(), EAGLE_PLUGIN::packageText(), SCH_SEXPR_PARSER::parseEDA_TEXT(), PCB_PARSER::parseEDA_TEXT(), SCH_ALTIUM_PLUGIN::ParseFileName(), SCH_ALTIUM_PLUGIN::ParseLabel(), SCH_ALTIUM_PLUGIN::ParseParameter(), SCH_ALTIUM_PLUGIN::ParsePowerPort(), SCH_ALTIUM_PLUGIN::ParseSheetEntry(), SCH_ALTIUM_PLUGIN::ParseSheetName(), ALTIUM_PCB::ParseTexts6Data(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), SCH_EDITOR_CONTROL::Paste(), LIB_SYMBOL::PlotLibFields(), DIALOG_CHANGE_SYMBOLS::processSymbol(), processTextItem(), SCH_SEXPR_PLUGIN_CACHE::saveDcmInfoAsFields(), CLIPBOARD_IO::SaveSelection(), SCH_SYMBOL::SCH_SYMBOL(), LIB_SYMBOL::SetName(), SCH_SYMBOL::SetRef(), FOOTPRINT::SetReference(), FOOTPRINT::SetValue(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_AND_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_SPICE_MODEL::TransferDataFromWindow(), DIALOG_SHEET_PROPERTIES::TransferDataToWindow(), SCH_SHEET_PATH::UpdateAllScreenReferences(), DIALOG_LIB_FIELD_PROPERTIES::UpdateField(), DIALOG_SCH_FIELD_PROPERTIES::UpdateField(), SCH_SYMBOL::UpdateFields(), SCH_SHEET_LIST::UpdateSymbolInstances(), PCB_DIMENSION_BASE::updateText(), and SIM_PLOT_FRAME::UpdateTunerValue().

◆ SetTextAngle()

void PCB_TEXT::SetTextAngle ( double aAngle )

overridevirtual

Reimplemented from EDA_TEXT.

Definition at line 104 of file pcb_text.cpp.

 {
  EDA_TEXT::SetTextAngle( NormalizeAngle360Min( aAngle ) );
 }

References NormalizeAngle360Min(), and EDA_TEXT::SetTextAngle().

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), Flip(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), PCB_DIMENSION_BASE::Mirror(), Rotate(), PCB_DIMENSION_BASE::Rotate(), PCB_DIM_ALIGNED::updateText(), and PCB_DIM_ORTHOGONAL::updateText().

◆ SetTextHeight()

void EDA_TEXT::SetTextHeight ( int aHeight )

inlineinherited

Definition at line 264 of file eda_text.h.

264 { m_e.size.y = aHeight; }

TEXT_EFFECTS m_e

Definition: eda_text.h:415

wxSize size

Definition: eda_text.h:124

References EDA_TEXT::m_e, and TEXT_EFFECTS::size.

Referenced by GRAPHICS_IMPORTER_PCBNEW::AddText(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), EDA_TEXT_DESC::EDA_TEXT_DESC(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), and FABMASTER::loadFootprints().

◆ SetTextPos()

void EDA_TEXT::SetTextPos ( const wxPoint & aPoint )

inlineinherited

Definition at line 267 of file eda_text.h.

267 { m_e.pos = aPoint; }

TEXT_EFFECTS m_e

Definition: eda_text.h:415

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), GRAPHICS_IMPORTER_PCBNEW::AddText(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), CADSTAR_SCH_ARCHIVE_LOADER::applyToLibraryFieldAttribute(), SCH_GLOBALLABEL::AutoplaceFields(), LIB_TEXT::BeginEdit(), LIB_FIELD::BeginEdit(), LIB_TEXT::CalcEdit(), LIB_FIELD::CalcEdit(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), DS_DRAW_ITEM_TEXT::DS_DRAW_ITEM_TEXT(), FP_TEXT::FP_TEXT(), LIB_TEXT::HitTest(), LIB_FIELD::HitTest(), CADSTAR_PCB_ARCHIVE_LOADER::loadDimensions(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), FABMASTER::loadFootprints(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), SCH_LEGACY_PLUGIN::loadSymbol(), PCB_DIMENSION_BASE::Mirror(), SCH_GLOBALLABEL::MirrorSpinStyle(), LIB_TEXT::MoveTo(), LIB_FIELD::MoveTo(), LIB_TEXT::NormalizeJustification(), EAGLE_PLUGIN::orientFPText(), EAGLE_PLUGIN::packageText(), SCH_SEXPR_PARSER::parseSchText(), DRAWING_TOOL::PlaceText(), DIALOG_CHANGE_SYMBOLS::processSymbol(), Rotate(), LIB_TEXT::Rotate(), FP_TEXT::Rotate(), LIB_FIELD::Rotate(), SCH_SHEET_PIN::Rotate(), SCH_TEXT::Rotate(), PCB_DIMENSION_BASE::Rotate(), SCH_GLOBALLABEL::Rotate(), SCH_GLOBALLABEL::Rotate90(), SCH_FIELD::SCH_FIELD(), SCH_SHEET_PIN::SCH_SHEET_PIN(), SCH_TEXT::SCH_TEXT(), FP_TEXT::SetDrawCoord(), SetPosition(), FP_TEXT::SetPosition(), SCH_FIELD::SetPosition(), SCH_TEXT::SetPosition(), DS_DRAW_ITEM_TEXT::SetPosition(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_FIELD_PROPERTIES::UpdateField(), SCH_SYMBOL::UpdateFields(), PCB_DIM_ALIGNED::updateText(), and PCB_DIM_ORTHOGONAL::updateText().

wxPoint pos

Definition: eda_text.h:127

References EDA_TEXT::m_e, and TEXT_EFFECTS::pos.

◆ SetTextSize()

void EDA_TEXT::SetTextSize ( const wxSize & aNewSize )

inlineinherited

Definition at line 258 of file eda_text.h.

258 { m_e.size = aNewSize; }

TEXT_EFFECTS m_e

Definition: eda_text.h:415

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), SCH_EAGLE_PLUGIN::addImplicitConnections(), CADSTAR_PCB_ARCHIVE_LOADER::applyDimensionSettings(), SCH_EDIT_TOOL::ChangeTextType(), MICROWAVE_TOOL::createBaseFootprint(), PCB_BASE_FRAME::CreateNewFootprint(), SCH_DRAWING_TOOLS::createNewText(), SCH_DRAWING_TOOLS::createSheetPin(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), DRAWING_TOOL::DrawDimension(), DS_DRAW_ITEM_TEXT::DS_DRAW_ITEM_TEXT(), EDA_TEXT::EDA_TEXT(), CADSTAR_SCH_ARCHIVE_LOADER::getScaledLibPart(), ALTIUM_PCB::HelperParseDimensions6Linear(), ALTIUM_PCB::HelperParseDimensions6Radial(), LIB_TEXT::LIB_TEXT(), SCH_LEGACY_PLUGIN_CACHE::loadField(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), SCH_EAGLE_PLUGIN::loadFrame(), LEGACY_PLUGIN::loadMODULE_TEXT(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), SCH_LEGACY_PLUGIN::loadSheet(), SCH_LEGACY_PLUGIN::loadSymbol(), SCH_EAGLE_PLUGIN::loadTextAttributes(), DIALOG_LIB_SYMBOL_PROPERTIES::OnAddField(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnAddField(), DIALOG_SYMBOL_PROPERTIES::OnAddField(), DIALOG_FOOTPRINT_PROPERTIES::OnAddField(), EAGLE_PLUGIN::orientFPText(), EAGLE_PLUGIN::packageText(), SCH_SEXPR_PARSER::parseEDA_TEXT(), PCB_PARSER::parseEDA_TEXT(), SCH_ALTIUM_PLUGIN::ParseLabel(), ALTIUM_PCB::ParseTexts6Data(), DRAWING_TOOL::PlaceText(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), BACK_ANNOTATE::processNetNameChange(), PCB_DIMENSION_BASE::SetTextSize(), PCAD2KICAD::SetTextSizeFromStrokeFontHeight(), PCAD2KICAD::SetTextSizeFromTrueTypeFontHeight(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_AND_LABEL_PROPERTIES::TransferDataFromWindow(), SCH_GLOBALLABEL::UpdateIntersheetRefProps(), and DIALOG_FIELD_PROPERTIES::updateText().

wxSize size

Definition: eda_text.h:124

References EDA_TEXT::m_e, and TEXT_EFFECTS::size.

◆ SetTextThickness()

void EDA_TEXT::SetTextThickness ( int aWidth )

inlineinherited

The TextThickness is that set by the user.

The EffectiveTextPenWidth also factors in bold text and thickness clamping.

Definition at line 180 of file eda_text.h.

180 { m_e.penwidth = aWidth; };

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), GRAPHICS_IMPORTER_PCBNEW::AddText(), PCAD2KICAD::PCB_FOOTPRINT::AddToBoard(), CADSTAR_PCB_ARCHIVE_LOADER::applyDimensionSettings(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), SCH_EDIT_TOOL::ChangeTextType(), MICROWAVE_TOOL::createBaseFootprint(), PCB_BASE_FRAME::CreateNewFootprint(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), DRAWING_TOOL::DrawDimension(), DS_DRAW_ITEM_TEXT::DS_DRAW_ITEM_TEXT(), EDA_TEXT_DESC::EDA_TEXT_DESC(), FP_TEXT::FP_TEXT(), ALTIUM_PCB::HelperParseDimensions6Linear(), ALTIUM_PCB::HelperParseDimensions6Radial(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), FABMASTER::loadFootprints(), LEGACY_PLUGIN::loadMODULE_TEXT(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), SCH_EAGLE_PLUGIN::loadTextAttributes(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnAddField(), DIALOG_FOOTPRINT_PROPERTIES::OnAddField(), EAGLE_PLUGIN::orientFPText(), EAGLE_PLUGIN::packageText(), SCH_SEXPR_PARSER::parseEDA_TEXT(), PCB_PARSER::parseEDA_TEXT(), ALTIUM_PCB::ParseTexts6Data(), DRAWING_TOOL::PlaceText(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_AND_LABEL_PROPERTIES::TransferDataFromWindow(), and SCH_GLOBALLABEL::UpdateIntersheetRefProps().

TEXT_EFFECTS m_e

Definition: eda_text.h:415

TEXT_EFFECTS::penwidth

int penwidth

Definition: eda_text.h:125

References EDA_TEXT::m_e, and TEXT_EFFECTS::penwidth.

◆ SetTextWidth()

void EDA_TEXT::SetTextWidth ( int aWidth )

inlineinherited

Definition at line 261 of file eda_text.h.

261 { m_e.size.x = aWidth; }

TEXT_EFFECTS m_e

Definition: eda_text.h:415

wxSize size

Definition: eda_text.h:124

References EDA_TEXT::m_e, and TEXT_EFFECTS::size.

Referenced by GRAPHICS_IMPORTER_PCBNEW::AddText(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), EDA_TEXT_DESC::EDA_TEXT_DESC(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), and FABMASTER::loadFootprints().

◆ SetTextX()

void EDA_TEXT::SetTextX ( int aX )

inlineinherited

Definition at line 270 of file eda_text.h.

270 { m_e.pos.x = aX; }

TEXT_EFFECTS m_e

Definition: eda_text.h:415

wxPoint pos

Definition: eda_text.h:127

References EDA_TEXT::m_e, and TEXT_EFFECTS::pos.

Referenced by SCH_SHEET_PIN::ConstrainOnEdge(), Flip(), FP_TEXT::Flip(), FP_TEXT::Mirror(), LIB_TEXT::MirrorHorizontal(), LIB_FIELD::MirrorHorizontal(), SCH_SHEET_PIN::MirrorHorizontally(), SCH_TEXT::MirrorHorizontally(), and SCH_SHEET_PIN::SetSide().

◆ SetTextY()

void EDA_TEXT::SetTextY ( int aY )

inlineinherited

Definition at line 271 of file eda_text.h.

271 { m_e.pos.y = aY; }

TEXT_EFFECTS m_e

Definition: eda_text.h:415

wxPoint pos

Definition: eda_text.h:127

References EDA_TEXT::m_e, and TEXT_EFFECTS::pos.

Referenced by SCH_SHEET_PIN::ConstrainOnEdge(), Flip(), FP_TEXT::Flip(), FP_TEXT::Mirror(), LIB_TEXT::MirrorVertical(), LIB_FIELD::MirrorVertical(), SCH_SHEET_PIN::MirrorVertically(), SCH_TEXT::MirrorVertically(), and SCH_SHEET_PIN::SetSide().

◆ SetVertJustify()

void EDA_TEXT::SetVertJustify ( EDA_TEXT_VJUSTIFY_T aType )

inlineinherited

Definition at line 223 of file eda_text.h.

223 { m_e.vjustify = aType; };