KiCad PCB EDA Suite: SCH_SHEET

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

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

References EDA_ITEM::m_flags.

◆ ClearSelected()

void EDA_ITEM::ClearSelected ( )

inlineinherited

Definition at line 132 of file eda_item.h.

132 { ClearFlags( SELECTED ); }

EDA_ITEM::ClearFlags

void ClearFlags(EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

Definition: eda_item.h:154

SELECTED

#define SELECTED

Definition: eda_item_flags.h:48

References EDA_ITEM::ClearFlags(), and SELECTED.

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

◆ ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )

inlineinherited

Definition at line 166 of file eda_item.h.

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

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

Referenced by SCH_EDIT_FRAME::PutDataInPreviousState().

◆ ClearViewPrivData()

void KIGFX::VIEW_ITEM::ClearViewPrivData ( )

inlineinherited

Definition at line 148 of file view_item.h.

     {
         m_viewPrivData = nullptr;
     }

References KIGFX::VIEW_ITEM::m_viewPrivData.

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

◆ Clone()

EDA_ITEM * SCH_SHEET_PIN::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 62 of file sch_sheet_pin.cpp.

 {
     return new SCH_SHEET_PIN( *this );
 }

References SCH_SHEET_PIN().

◆ ConnectedItems()

SCH_ITEM_SET & SCH_ITEM::ConnectedItems ( const SCH_SHEET_PATH & aPath )

inherited

Retrieve the set of items connected to this item on the given sheet.

Definition at line 164 of file sch_item.cpp.

 {
     return m_connected_items[ aSheet ];
 }

References SCH_ITEM::m_connected_items.

Referenced by addConnections(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), CONNECTION_GRAPH::updateItemConnectivity(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ Connection()

SCH_CONNECTION * SCH_ITEM::Connection ( const SCH_SHEET_PATH * aSheet = nullptr ) const

inherited

Retrieve the connection associated with this object in the given sheet.

Note: The returned value can be nullptr.

Definition at line 131 of file sch_item.cpp.

 {
     if( !aSheet )
         aSheet = &Schematic()->CurrentSheet();
 
     auto it = m_connection_map.find( *aSheet );
 
     if( it == m_connection_map.end() )
         return nullptr;
     else
         return it->second;
 }

References SCHEMATIC::CurrentSheet(), SCH_ITEM::m_connection_map, and SCH_ITEM::Schematic().

Referenced by CONNECTION_SUBGRAPH::Absorb(), CONNECTION_SUBGRAPH::AddItem(), CONNECTION_GRAPH::buildConnectionGraph(), KIGFX::SCH_PAINTER::draw(), CONNECTION_GRAPH::ercCheckBusToBusConflicts(), CONNECTION_GRAPH::ercCheckBusToBusEntryConflicts(), SCH_PIN::GetMsgPanelInfo(), SCH_BUS_ENTRY_BASE::GetMsgPanelInfo(), SCH_LINE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), CONNECTION_SUBGRAPH::GetNetName(), highlightNet(), SCH_ITEM::InitializeConnection(), SCH_ITEM::NetClass(), SCH_TEXT::Plot(), SCH_GLOBALLABEL::Print(), SCH_HIERLABEL::Print(), SCH_EDIT_FRAME::RecalculateConnections(), CONNECTION_SUBGRAPH::ResolveDrivers(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::TransferDataToWindow(), BUS_UNFOLD_MENU::update(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ ConnectionPropagatesTo()

virtual bool SCH_ITEM::ConnectionPropagatesTo ( const EDA_ITEM * aItem ) const

inlinevirtualinherited

Return true if this item should propagate connection info to aItem.

Reimplemented in SCH_BUS_WIRE_ENTRY, and SCH_PIN.

Definition at line 418 of file sch_item.h.

418 { return true; }

Referenced by CONNECTION_GRAPH::updateItemConnectivity().

◆ ConstrainOnEdge()

void SCH_SHEET_PIN::ConstrainOnEdge ( wxPoint Pos )

Adjust label position to edge based on proximity to vertical or horizontal edge of the parent sheet.

Definition at line 159 of file sch_sheet_pin.cpp.

 {
     SCH_SHEET* sheet = GetParent();
 
     if( sheet == nullptr )
         return;
 
     int leftSide  = sheet->m_pos.x;
     int rightSide = sheet->m_pos.x + sheet->m_size.x;
     int topSide   = sheet->m_pos.y;
     int botSide   = sheet->m_pos.y + sheet->m_size.y;
 
     SHAPE_LINE_CHAIN sheetEdge;
 
     sheetEdge.Append( leftSide,  topSide );
     sheetEdge.Append( rightSide, topSide );
     sheetEdge.Append( rightSide, botSide );
     sheetEdge.Append( leftSide,  botSide );
     sheetEdge.Append( leftSide,  topSide );
 
     switch( sheetEdge.NearestSegment( Pos ) )
     {
     case 0: SetEdge( SHEET_SIDE::TOP ); break;
     case 1: SetEdge( SHEET_SIDE::RIGHT ); break;
     case 2: SetEdge( SHEET_SIDE::BOTTOM ); break;
     case 3: SetEdge( SHEET_SIDE::LEFT ); break;
     default: wxASSERT( "Invalid segment number" );
     }
 
     switch( GetEdge() )
     {
     case SHEET_SIDE::RIGHT:
     case SHEET_SIDE::LEFT:
         SetTextY( Pos.y );
 
         if( GetTextPos().y < topSide )
             SetTextY( topSide );
 
         if( GetTextPos().y > botSide )
             SetTextY( botSide );
 
         break;
 
     case SHEET_SIDE::BOTTOM:
     case SHEET_SIDE::TOP:
         SetTextX( Pos.x );
 
         if( GetTextPos().x < leftSide )
             SetTextX( leftSide );
 
         if( GetTextPos().x > rightSide )
             SetTextX( rightSide );
 
         break;
 
     case SHEET_SIDE::UNDEFINED:
         wxASSERT( "Undefined sheet side" );
     }
 }

References SHAPE_LINE_CHAIN::Append(), BOTTOM, GetEdge(), GetParent(), EDA_TEXT::GetTextPos(), LEFT, SCH_SHEET::m_pos, SCH_SHEET::m_size, SHAPE_LINE_CHAIN::NearestSegment(), RIGHT, SetEdge(), EDA_TEXT::SetTextX(), EDA_TEXT::SetTextY(), TOP, and UNDEFINED.

Referenced by Rotate(), and SetPosition().

◆ CopyText()

void EDA_TEXT::CopyText ( const EDA_TEXT & aSrc )

inherited

Definition at line 121 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().

◆ CreateGraphicShape() [1/2]

void SCH_SHEET_PIN::CreateGraphicShape	(	const RENDER_SETTINGS *	aSettings,
		std::vector< wxPoint > &	aPoints,
		const wxPoint &	aPos
	)		const

overridevirtual

Calculate the graphic shape (a polygon) associated to the text.

Parameters

aPoints	is a buffer to fill with polygon corners coordinates.
aPos	is the position of the shape.

Reimplemented from SCH_TEXT.

Definition at line 258 of file sch_sheet_pin.cpp.

 {
     /*
      * These are the same icon shapes as SCH_HIERLABEL but the graphic icon is slightly
      * different in 2 cases:
      * for INPUT type the icon is the OUTPUT shape of SCH_HIERLABEL
      * for OUTPUT type the icon is the INPUT shape of SCH_HIERLABEL
      */
     PINSHEETLABEL_SHAPE shape = m_shape;
 
     switch( shape )
     {
     case PINSHEETLABEL_SHAPE::PS_INPUT:  shape = PINSHEETLABEL_SHAPE::PS_OUTPUT; break;
     case PINSHEETLABEL_SHAPE::PS_OUTPUT: shape = PINSHEETLABEL_SHAPE::PS_INPUT;  break;
     default:                                                                     break;
     }
 
     SCH_HIERLABEL::CreateGraphicShape( aSettings, aPoints, aPos, shape );
 }

References SCH_HIERLABEL::CreateGraphicShape(), SCH_TEXT::m_shape, PS_INPUT, and PS_OUTPUT.

◆ CreateGraphicShape() [2/2]

void SCH_HIERLABEL::CreateGraphicShape	(	const RENDER_SETTINGS *	aSettings,
		std::vector< wxPoint > &	aPoints,
		const wxPoint &	aPos,
		PINSHEETLABEL_SHAPE	aShape
	)		const

inherited

Definition at line 1616 of file sch_text.cpp.

 {
     int* Template = TemplateShape[static_cast<int>( aShape )][static_cast<int>( m_spin_style )];
     int  halfSize = GetTextHeight() / 2;
     int  imax = *Template;
     Template++;
 
     aPoints.clear();
 
     for( int ii = 0; ii < imax; ii++ )
     {
         wxPoint corner;
         corner.x = ( halfSize * (*Template) ) + aPos.x;
         Template++;
 
         corner.y = ( halfSize * (*Template) ) + aPos.y;
         Template++;
 
         aPoints.push_back( corner );
     }
 }

References EDA_TEXT::GetTextHeight(), SCH_TEXT::m_spin_style, and TemplateShape.

◆ DoHypertextMenu()

virtual void SCH_ITEM::DoHypertextMenu ( EDA_DRAW_FRAME * aFrame )

inlinevirtualinherited

Reimplemented in SCH_FIELD.

Definition at line 263 of file sch_item.h.

263 { }

◆ Duplicate()

SCH_ITEM * SCH_ITEM::Duplicate ( bool doClone = false ) const

inherited

Routine to create a new copy of given item.

The new object is not put in draw list (not linked).

Parameters

doClone (default = false) indicates unique values (such as timestamp and sheet name) should be duplicated. Use only for undo/redo operations.

Definition at line 78 of file sch_item.cpp.

 {
     SCH_ITEM* newItem = (SCH_ITEM*) Clone();
 
     if( !doClone )
         const_cast<KIID&>( newItem->m_Uuid ) = KIID();
 
     newItem->ClearFlags( SELECTED | BRIGHTENED );
 
     newItem->RunOnChildren(
             []( SCH_ITEM* aChild )
             {
                 aChild->ClearFlags( SELECTED | BRIGHTENED );
             } );
 
     return newItem;
 }

References BRIGHTENED, EDA_ITEM::ClearFlags(), EDA_ITEM::Clone(), EDA_ITEM::m_Uuid, SCH_ITEM::RunOnChildren(), and SELECTED.

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::loadItemOntoKiCadSheet(), SCH_EAGLE_PLUGIN::loadSchematic(), SCH_DRAWING_TOOLS::PlaceSymbol(), SCH_EDIT_TOOL::RepeatDrawItem(), and SCH_EDIT_FRAME::SaveCopyInUndoList().

◆ Empty()

void EDA_TEXT::Empty ( )

inlineinherited

Definition at line 254 of file eda_text.h.

254 { m_text.Empty(); }

EDA_TEXT::m_text

wxString m_text

Definition: eda_text.h:385

References EDA_TEXT::m_text.

Referenced by SCH_LEGACY_PLUGIN_CACHE::LoadPart().

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

◆ GetBoundingBox()

const EDA_RECT SCH_HIERLABEL::GetBoundingBox ( ) const

overridevirtualinherited

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

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

Reimplemented from SCH_TEXT.

Definition at line 1641 of file sch_text.cpp.

 {
     int penWidth = GetEffectiveTextPenWidth();
     int margin = GetTextOffset();
 
     int x  = GetTextPos().x;
     int y  = GetTextPos().y;
 
     int height = GetTextHeight() + penWidth + margin;
     int length = LenSize( GetShownText(), penWidth )
                  + height;                // add height for triangular shapes
 
     int dx, dy;
 
     switch( GetLabelSpinStyle() )
     {
     default:
     case LABEL_SPIN_STYLE::LEFT:
         dx = -length;
         dy = height;
         x += Mils2iu( DANGLING_SYMBOL_SIZE );
         y -= height / 2;
         break;
 
     case LABEL_SPIN_STYLE::UP:
         dx = height;
         dy = -length;
         x -= height / 2;
         y += Mils2iu( DANGLING_SYMBOL_SIZE );
         break;
 
     case LABEL_SPIN_STYLE::RIGHT:
         dx = length;
         dy = height;
         x -= Mils2iu( DANGLING_SYMBOL_SIZE );
         y -= height / 2;
         break;
 
     case LABEL_SPIN_STYLE::BOTTOM:
         dx = height;
         dy = length;
         x -= height / 2;
         y -= Mils2iu( DANGLING_SYMBOL_SIZE );
         break;
     }
 
     EDA_RECT box( wxPoint( x, y ), wxSize( dx, dy ) );
     box.Normalize();
     return box;
 }

References LABEL_SPIN_STYLE::BOTTOM, DANGLING_SYMBOL_SIZE, EDA_TEXT::GetEffectiveTextPenWidth(), SCH_TEXT::GetLabelSpinStyle(), SCH_TEXT::GetShownText(), EDA_TEXT::GetTextHeight(), SCH_TEXT::GetTextOffset(), EDA_TEXT::GetTextPos(), LABEL_SPIN_STYLE::LEFT, EDA_TEXT::LenSize(), EDA_RECT::Normalize(), LABEL_SPIN_STYLE::RIGHT, and LABEL_SPIN_STYLE::UP.

Referenced by HitTest().

◆ GetClass()

wxString SCH_SHEET_PIN::GetClass ( ) const

inlineoverridevirtual

Return the class name.

Reimplemented from SCH_TEXT.

Definition at line 80 of file sch_sheet_pin.h.

     {
         return wxT( "SCH_SHEET_PIN" );
     }

◆ GetConnectionPoints()

std::vector< wxPoint > SCH_TEXT::GetConnectionPoints ( ) const

overridevirtualinherited

Add all the connection points for this item to aPoints.

Not all schematic items have connection points so the default method does nothing.

Parameters

aPoints is the list of connection points to add to.

Reimplemented from SCH_ITEM.

Definition at line 540 of file sch_text.cpp.

 {
     // Normal text labels do not have connection points.  All others do.
     if( Type() == SCH_TEXT_T )
         return {};
 
     return { GetTextPos() };
 }

References EDA_TEXT::GetTextPos(), SCH_TEXT_T, and EDA_ITEM::Type().

◆ GetContextualTextVars()

void SCH_TEXT::GetContextualTextVars ( wxArrayString * aVars ) const

inherited

Return the set of contextual text variable tokens for this text item.

Parameters

[out] aVars

Definition at line 585 of file sch_text.cpp.

 {
     if( Type() == SCH_GLOBAL_LABEL_T || Type() == SCH_HIER_LABEL_T || Type() == SCH_SHEET_PIN_T )
         aVars->push_back( wxT( "CONNECTION_TYPE" ) );
 
     if( Type() == SCH_SHEET_PIN_T && m_parent )
         static_cast<SCH_SHEET*>( m_parent )->GetContextualTextVars( aVars );
 }

References EDA_ITEM::m_parent, SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_SHEET_PIN_T, and EDA_ITEM::Type().

Referenced by DIALOG_TEXT_AND_LABEL_PROPERTIES::onScintillaCharAdded().

◆ GetDrawRotation()

double EDA_TEXT::GetDrawRotation ( ) const

virtualinherited

Reimplemented in FP_TEXT.

Definition at line 646 of file eda_text.cpp.

 {
     return GetTextAngle();
 }

References EDA_TEXT::GetTextAngle().

Referenced by PCB_TEXT::TextHitTest(), and EDA_TEXT::TransformToSegmentList().

◆ GetEdge()

enum SHEET_SIDE SCH_SHEET_PIN::GetEdge ( ) const

Definition at line 153 of file sch_sheet_pin.cpp.

 {
     return m_edge;
 }

References m_edge.

Referenced by SCH_LINE_WIRE_BUS_TOOL::computeBreakPoint(), ConstrainOnEdge(), and SwapData().

◆ GetEditFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetEditFlags ( ) const

inlineinherited

Definition at line 158 of file eda_item.h.

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

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

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

◆ GetEffectiveTextPenWidth()

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

inherited

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

Definition at line 149 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(), PCB_TEXT::TransformTextShapeWithClearanceToPolygon(), FP_TEXT::TransformTextShapeWithClearanceToPolygon(), PCB_DIM_ALIGNED::updateGeometry(), PCB_DIM_ORTHOGONAL::updateGeometry(), 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 633 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 PCB_TEXT::GetEffectiveShape(), and FP_TEXT::GetEffectiveShape().

◆ GetEndPoints()

void SCH_SHEET_PIN::GetEndPoints ( std::vector< DANGLING_END_ITEM > & aItemList )

overridevirtual

Add the schematic item end points to aItemList if the item has end points.

The default version doesn't do anything since many of the schematic object cannot be tested for dangling ends. If you add a new schematic item that can have a dangling end ( no connect ), override this method to provide the correct end points.

Parameters

aItemList is the list of DANGLING_END_ITEMS to add to.

Reimplemented from SCH_ITEM.

Definition at line 280 of file sch_sheet_pin.cpp.

 {
     DANGLING_END_ITEM item( SHEET_LABEL_END, this, GetTextPos() );
     aItemList.push_back( item );
 }

References EDA_TEXT::GetTextPos(), and SHEET_LABEL_END.

◆ GetFieldsAutoplaced()

FIELDS_AUTOPLACED SCH_ITEM::GetFieldsAutoplaced ( ) const

inlineinherited

Return whether the fields have been automatically placed.

Definition at line 429 of file sch_item.h.

429 { return m_fieldsAutoplaced; }

SCH_ITEM::m_fieldsAutoplaced

FIELDS_AUTOPLACED m_fieldsAutoplaced

Definition: sch_item.h:494

References SCH_ITEM::m_fieldsAutoplaced.

Referenced by SCH_ITEM::AutoAutoplaceFields(), SCH_SEXPR_PLUGIN::saveSheet(), SCH_SEXPR_PLUGIN::saveSymbol(), SCH_SEXPR_PLUGIN::saveText(), and EE_POINT_EDITOR::updateParentItem().

◆ GetFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetFlags ( ) const

inlineinherited

Definition at line 155 of file eda_item.h.

155 { 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:481

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_SHAPE, and PCB_TRACK.

Definition at line 259 of file eda_item.h.

259 { return GetPosition(); }

EDA_ITEM::GetPosition

virtual wxPoint GetPosition() const

Definition: eda_item.h:252

References EDA_ITEM::GetPosition().

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

◆ GetHorizJustify()

EDA_TEXT_HJUSTIFY_T EDA_TEXT::GetHorizJustify ( ) const

inlineinherited

Definition at line 198 of file eda_text.h.

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

EDA_TEXT_HJUSTIFY_T

Definition: eda_text.h:61

Referenced by BOARD_ADAPTER::addShapeWithClearance(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), EDA_TEXT_DESC::EDA_TEXT_DESC(), AUTOPLACER::fieldHorizPlacement(), EDA_TEXT::Format(), 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(), PCB_TEXT::TransformTextShapeWithClearanceToPolygon(), FP_TEXT::TransformTextShapeWithClearanceToPolygon(), EDA_TEXT::TransformToSegmentList(), and DIALOG_SCH_FIELD_PROPERTIES::UpdateField().

TEXT_EFFECTS m_e

Definition: eda_text.h:389

TEXT_EFFECTS::hjustify

signed char hjustify

horizontal justification

Definition: eda_text.h:101

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 223 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(), EDA_TEXT::GetLinePositions(), and EDA_TEXT::GetTextBox().

◆ GetLabelBoxExpansion()

int SCH_TEXT::GetLabelBoxExpansion ( const RENDER_SETTINGS * aSettings = nullptr ) const

inherited

Definition at line 412 of file sch_text.cpp.

 {
     double ratio;
 
     if( aSettings )
         ratio = static_cast<const SCH_RENDER_SETTINGS*>( aSettings )->m_LabelSizeRatio;
     else if( Schematic() )
         ratio = Schematic()->Settings().m_LabelSizeRatio;
     else
         ratio = DEFAULT_LABEL_SIZE_RATIO; // For previews (such as in Preferences), etc.
 
     return KiROUND( ratio * GetTextSize().y );
 
     return 0;
 }

References DEFAULT_LABEL_SIZE_RATIO, EDA_TEXT::GetTextSize(), KiROUND(), SCHEMATIC_SETTINGS::m_LabelSizeRatio, SCH_ITEM::Schematic(), and SCHEMATIC::Settings().

Referenced by SCH_GLOBALLABEL::CreateGraphicShape(), and SCH_GLOBALLABEL::GetSchematicTextOffset().

◆ GetLabelSpinStyle()

LABEL_SPIN_STYLE SCH_TEXT::GetLabelSpinStyle ( ) const

inlineinherited

Definition at line 159 of file sch_text.h.

159 { return m_spin_style; }

SCH_TEXT::m_spin_style

LABEL_SPIN_STYLE m_spin_style

The orientation of text and any associated drawing elements of derived objects.

Definition: sch_text.h:276

References SCH_TEXT::m_spin_style.

Referenced by SCH_GLOBALLABEL::AutoplaceFields(), SCH_GLOBALLABEL::CreateGraphicShape(), SCH_DRAWING_TOOLS::createNewText(), KIGFX::SCH_PAINTER::draw(), SCH_HIERLABEL::GetBoundingBox(), SCH_GLOBALLABEL::GetBoundingBoxBase(), SCH_TEXT::GetMsgPanelInfo(), SCH_TEXT::GetSchematicTextOffset(), SCH_GLOBALLABEL::GetSchematicTextOffset(), SCH_HIERLABEL::GetSchematicTextOffset(), SCH_TEXT::MirrorHorizontally(), SCH_TEXT::MirrorSpinStyle(), SCH_TEXT::MirrorVertically(), SCH_TEXT::Rotate90(), SCH_SEXPR_PLUGIN::saveText(), SCH_LEGACY_PLUGIN::saveText(), DIALOG_TEXT_AND_LABEL_PROPERTIES::TransferDataFromWindow(), and DIALOG_TEXT_AND_LABEL_PROPERTIES::TransferDataToWindow().

◆ GetLayer()

SCH_LAYER_ID SCH_ITEM::GetLayer ( ) const

inlineinherited

Return the layer this item is on.

Definition at line 268 of file sch_item.h.

268 { return m_layer; }

SCH_ITEM::m_layer

SCH_LAYER_ID m_layer

Definition: sch_item.h:492

References SCH_ITEM::m_layer.

Referenced by SCH_JUNCTION::CanConnect(), SCH_NO_CONNECT::CanConnect(), SCH_BUS_WIRE_ENTRY::CanConnect(), SCH_BUS_BUS_ENTRY::CanConnect(), SCH_LINE::CanConnect(), SCH_LABEL::CanConnect(), SCH_ITEM::CanConnect(), SCH_SHEET::CanConnect(), SCH_GLOBALLABEL::CanConnect(), SCH_HIERLABEL::CanConnect(), SCH_SYMBOL::CanConnect(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), KIGFX::SCH_PAINTER::draw(), CONNECTION_GRAPH::ercCheckBusToNetConflicts(), CONNECTION_GRAPH::ercCheckFloatingWires(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_LINE::GetEndPoints(), SCH_BUS_ENTRY_BASE::GetMsgPanelInfo(), SCH_LINE::GetMsgPanelInfo(), SCH_EDIT_TOOL::Init(), SCH_LINE::IsBus(), SCH_LINE::IsGraphicLine(), SCH_SCREEN::IsJunctionNeeded(), SCH_LINE::IsWire(), SCH_SCREEN::MarkConnections(), SCH_LINE::MergeOverlap(), SCH_BUS_ENTRY_BASE::operator<(), SCH_JUNCTION::operator<(), SCH_TEXT::operator<(), SCH_LINE::operator<(), SCH_JUNCTION::Plot(), SCH_BITMAP::Plot(), SCH_FIELD::Plot(), SCH_LINE::Plot(), SCH_SCREEN::Plot(), SCH_JUNCTION::Print(), SCH_LINE::Print(), SCH_SCREEN::Print(), SCH_LEGACY_PLUGIN::saveBusEntry(), SCH_SEXPR_PLUGIN::saveLine(), SCH_LEGACY_PLUGIN::saveLine(), SCH_LEGACY_PLUGIN::saveText(), SCH_EDIT_FRAME::SchematicCleanUp(), and SCH_EDIT_FRAME::TrimWire().

◆ 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 430 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 SCH_SHEET_PIN::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 293 of file sch_sheet_pin.cpp.

 {
     return BITMAPS::add_hierar_pin;
 }

References add_hierar_pin.

◆ GetMsgPanelInfo()

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

overridevirtualinherited

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 744 of file sch_text.cpp.

 {
     wxString msg;
 
     switch( Type() )
     {
     case SCH_TEXT_T:          msg = _( "Graphic Text" );           break;
     case SCH_LABEL_T:         msg = _( "Label" );                  break;
     case SCH_GLOBAL_LABEL_T:  msg = _( "Global Label" );           break;
     case SCH_HIER_LABEL_T:    msg = _( "Hierarchical Label" );     break;
     case SCH_SHEET_PIN_T:     msg = _( "Hierarchical Sheet Pin" ); break;
     default: return;
     }
 
     // Don't use GetShownText() here; we want to show the user the variable references
     aList.push_back( MSG_PANEL_ITEM( msg, UnescapeString( GetText() ) ) );
 
     switch( GetLabelSpinStyle() )
     {
     case LABEL_SPIN_STYLE::LEFT:   msg = _( "Align right" );   break;
     case LABEL_SPIN_STYLE::UP:     msg = _( "Align bottom" );  break;
     case LABEL_SPIN_STYLE::RIGHT:  msg = _( "Align left" );    break;
     case LABEL_SPIN_STYLE::BOTTOM: msg = _( "Align top" );     break;
     default:                       msg = wxT( "???" );         break;
     }
 
     aList.push_back( MSG_PANEL_ITEM( _( "Justification" ), msg, BROWN ) );
 
     wxString textStyle[] = { _( "Normal" ), _( "Italic" ), _( "Bold" ), _( "Bold Italic" ) };
     int style = 0;
 
     if( IsItalic() )
         style = 1;
 
     if( IsBold() )
         style += 2;
 
     aList.push_back( MSG_PANEL_ITEM( _( "Style" ), textStyle[style] ) );
 
     // Display electrical type if it is relevant
     if( Type() == SCH_GLOBAL_LABEL_T || Type() == SCH_HIER_LABEL_T || Type() == SCH_SHEET_PIN_T )
     {
         msg = getElectricalTypeLabel( GetShape() );
         aList.push_back( MSG_PANEL_ITEM( _( "Type" ), msg ) );
     }
 
     // Display text size (X or Y value, with are the same value in Eeschema)
     msg = MessageTextFromValue( aFrame->GetUserUnits(), GetTextWidth() );
     aList.push_back( MSG_PANEL_ITEM( _( "Size" ), msg ) );
 
     SCH_CONNECTION* conn = dynamic_cast<SCH_EDIT_FRAME*>( aFrame ) ? Connection() : nullptr;
 
     if( conn )
     {
         conn->AppendInfoToMsgPanel( aList );
 
         if( !conn->IsBus() )
         {
             NET_SETTINGS& netSettings = Schematic()->Prj().GetProjectFile().NetSettings();
             const wxString& netname = conn->Name( true );
 
             if( netSettings.m_NetClassAssignments.count( netname ) )
             {
                 const wxString& netclassName = netSettings.m_NetClassAssignments[ netname ];
                 aList.push_back( MSG_PANEL_ITEM( _( "Assigned Netclass" ), netclassName ) );
             }
         }
     }
 }

References _, SCH_CONNECTION::AppendInfoToMsgPanel(), LABEL_SPIN_STYLE::BOTTOM, BROWN, SCH_ITEM::Connection(), getElectricalTypeLabel(), SCH_TEXT::GetLabelSpinStyle(), PROJECT::GetProjectFile(), SCH_TEXT::GetShape(), EDA_TEXT::GetText(), EDA_TEXT::GetTextWidth(), EDA_BASE_FRAME::GetUserUnits(), EDA_TEXT::IsBold(), SCH_CONNECTION::IsBus(), EDA_TEXT::IsItalic(), LABEL_SPIN_STYLE::LEFT, NET_SETTINGS::m_NetClassAssignments, MessageTextFromValue(), SCH_CONNECTION::Name(), PROJECT_FILE::NetSettings(), SCHEMATIC::Prj(), LABEL_SPIN_STYLE::RIGHT, SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_LABEL_T, SCH_SHEET_PIN_T, SCH_TEXT_T, SCH_ITEM::Schematic(), EDA_ITEM::Type(), UnescapeString(), and LABEL_SPIN_STYLE::UP.

◆ GetNumber()

int SCH_SHEET_PIN::GetNumber ( ) const

inline

Get the sheet label number.

Returns: Number of the sheet label.

Definition at line 115 of file sch_sheet_pin.h.

115 { return m_number; }

SCH_SHEET_PIN::m_number

int m_number

Label number use for saving sheet label to file.

Definition: sch_sheet_pin.h:189

References m_number.

Referenced by SwapData().

◆ GetParent()

SCH_SHEET* SCH_SHEET_PIN::GetParent ( void ) const

inline

Get the parent sheet object of this sheet pin.

Returns: The sheet that is the parent of this sheet pin or NULL if it does not have a parent.

Definition at line 140 of file sch_sheet_pin.h.

140 { return (SCH_SHEET*) m_parent; }

EDA_ITEM::m_parent

EDA_ITEM * m_parent

Linked list: Link (parent struct)

Definition: eda_item.h:479

SCH_SHEET

Sheet symbol placed in a schematic, and is the entry point for a sub schematic.

Definition: sch_sheet.h:54

References EDA_ITEM::m_parent.

Referenced by ConstrainOnEdge(), SCH_SCREEN::DeleteItem(), DIALOG_SHEET_PIN_PROPERTIES::onComboBox(), SetEdge(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), and DIALOG_SHEET_PIN_PROPERTIES::TransferDataToWindow().

◆ GetPenWidth()

int SCH_SHEET_PIN::GetPenWidth ( ) const

overridevirtual

Returns: the size of the "pen" that be used to draw or plot this item

Reimplemented from SCH_ITEM.

Definition at line 98 of file sch_sheet_pin.cpp.

 {
     if( Schematic() )
         return Schematic()->Settings().m_DefaultLineWidth;
 
     return Mils2iu( DEFAULT_LINE_WIDTH_MILS );
 }

References DEFAULT_LINE_WIDTH_MILS, SCHEMATIC_SETTINGS::m_DefaultLineWidth, SCH_ITEM::Schematic(), and SCHEMATIC::Settings().

◆ GetPosition()

wxPoint SCH_TEXT::GetPosition ( ) const

inlineoverridevirtualinherited

Reimplemented from EDA_ITEM.

Definition at line 239 of file sch_text.h.

239 { return EDA_TEXT::GetTextPos(); }

EDA_TEXT::GetTextPos

const wxPoint & GetTextPos() const

Definition: eda_text.h:247

References EDA_TEXT::GetTextPos().

Referenced by SCH_EAGLE_PLUGIN::adjustNetLabels(), SCH_GLOBALLABEL::AutoplaceFields(), SCH_LINE_WIRE_BUS_TOOL::computeBreakPoint(), SCH_LABEL::GetBoundingBox(), SCH_MOVE_TOOL::getConnectedDragItems(), IsPointClickableAnchor(), SCH_LABEL::IsPointClickableAnchor(), SCH_GLOBALLABEL::IsPointClickableAnchor(), SCH_HIERLABEL::IsPointClickableAnchor(), SCH_EAGLE_PLUGIN::SEG_DESC::LabelAttached(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), SCH_GLOBALLABEL::MirrorHorizontally(), SCH_GLOBALLABEL::MirrorSpinStyle(), SCH_GLOBALLABEL::MirrorVertically(), SCH_TEXT::operator<(), SCH_GLOBALLABEL::Rotate90(), SCH_SEXPR_PLUGIN::saveText(), and SCH_LEGACY_PLUGIN::saveText().

◆ GetSchematicTextOffset()

wxPoint SCH_HIERLABEL::GetSchematicTextOffset ( const RENDER_SETTINGS * aSettings ) const

overridevirtualinherited

This offset depends on the orientation, the type of text, and the area required to draw the associated graphic symbol or to put the text above a wire.

Returns: the offset between the SCH_TEXT position and the text itself position

Reimplemented from SCH_TEXT.

Definition at line 1693 of file sch_text.cpp.

 {
     wxPoint text_offset;
     int     dist = GetTextOffset( aSettings );
 
     dist += GetTextWidth();
 
     switch( GetLabelSpinStyle() )
     {
     default:
     case LABEL_SPIN_STYLE::LEFT:   text_offset.x = -dist; break; // Orientation horiz normale
     case LABEL_SPIN_STYLE::UP:     text_offset.y = -dist; break; // Orientation vert UP
     case LABEL_SPIN_STYLE::RIGHT:  text_offset.x = dist;  break; // Orientation horiz inverse
     case LABEL_SPIN_STYLE::BOTTOM: text_offset.y = dist;  break; // Orientation vert BOTTOM
     }
 
     return text_offset;
 }

References LABEL_SPIN_STYLE::BOTTOM, SCH_TEXT::GetLabelSpinStyle(), SCH_TEXT::GetTextOffset(), EDA_TEXT::GetTextWidth(), LABEL_SPIN_STYLE::LEFT, LABEL_SPIN_STYLE::RIGHT, and LABEL_SPIN_STYLE::UP.

Referenced by SCH_HIERLABEL::Print().

◆ GetSelectMenuText()

wxString SCH_SHEET_PIN::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 287 of file sch_sheet_pin.cpp.

 {
     return wxString::Format( _( "Hierarchical Sheet Pin %s" ), ShortenedShownText() );
 }

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

◆ GetShape()

PINSHEETLABEL_SHAPE SCH_TEXT::GetShape ( ) const

inlineinherited

Definition at line 161 of file sch_text.h.

161 { return m_shape; }

SCH_TEXT::m_shape

PINSHEETLABEL_SHAPE m_shape

Definition: sch_text.h:258

References SCH_TEXT::m_shape.

Referenced by SCH_DRAWING_TOOLS::createNewText(), SCH_DRAWING_TOOLS::createSheetPin(), SCH_TEXT::GetMsgPanelInfo(), SCH_TEXT::GetShownText(), CONNECTION_SUBGRAPH::ResolveDrivers(), SCH_SEXPR_PLUGIN::saveText(), SCH_LEGACY_PLUGIN::saveText(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataToWindow(), and DIALOG_TEXT_AND_LABEL_PROPERTIES::TransferDataToWindow().

◆ GetShownText()

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

overridevirtualinherited

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 595 of file sch_text.cpp.

 {
     std::function<bool( wxString* )> textResolver =
             [&]( wxString* token ) -> bool
             {
                 if( ( Type() == SCH_GLOBAL_LABEL_T
                         || Type() == SCH_HIER_LABEL_T
                         || Type() == SCH_SHEET_PIN_T )
                      && token->IsSameAs( wxT( "CONNECTION_TYPE" ) ) )
                 {
                     *token = getElectricalTypeLabel( GetShape() );
                     return true;
                 }
 
                 if( Type() == SCH_SHEET_PIN_T && m_parent )
                 {
                     SCH_SHEET* sheet = static_cast<SCH_SHEET*>( m_parent );
 
                     if( sheet->ResolveTextVar( token, aDepth ) )
                         return true;
                 }
 
                 if( Type() == SCH_TEXT_T )
                 {
                     if( token->Contains( ':' ) )
                     {
                         if( Schematic()->ResolveCrossReference( token, aDepth ) )
                             return true;
                     }
                     else
                     {
                         SCHEMATIC* schematic = Schematic();
                         SCH_SHEET* sheet = schematic ? schematic->CurrentSheet().Last() : nullptr;
 
                         if( sheet && sheet->ResolveTextVar( token, aDepth + 1 ) )
                             return true;
                     }
                 }
 
                 return false;
             };
 
     std::function<bool( wxString* )> schematicTextResolver =
             [&]( wxString* token ) -> bool
             {
                 return Schematic()->ResolveTextVar( token, aDepth + 1 );
             };
 
     wxString text = EDA_TEXT::GetShownText();
 
     if( text == "~" )   // Legacy placeholder for empty string
     {
         text = "";
     }
     else if( HasTextVars() )
     {
         wxCHECK_MSG( Schematic(), wxEmptyString, "No parent SCHEMATIC set for SCH_TEXT!" );
 
         PROJECT* project = nullptr;
 
         if( Schematic() )
             project = &Schematic()->Prj();
 
         if( aDepth < 10 )
             text = ExpandTextVars( text, &textResolver, &schematicTextResolver, project );
     }
 
     return text;
 }

References SCHEMATIC::CurrentSheet(), ExpandTextVars(), getElectricalTypeLabel(), SCH_TEXT::GetShape(), EDA_TEXT::GetShownText(), EDA_TEXT::HasTextVars(), SCH_SHEET_PATH::Last(), EDA_ITEM::m_parent, SCHEMATIC::Prj(), project, SCHEMATIC::ResolveCrossReference(), SCHEMATIC::ResolveTextVar(), SCH_SHEET::ResolveTextVar(), SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_SHEET_PIN_T, SCH_TEXT_T, SCH_ITEM::Schematic(), text, and EDA_ITEM::Type().

Referenced by SCH_GLOBALLABEL::CreateGraphicShape(), KIGFX::SCH_PAINTER::draw(), SCH_HIERLABEL::GetBoundingBox(), SCH_GLOBALLABEL::GetBoundingBoxBase(), and SCH_TEXT::Plot().

◆ GetState()

int EDA_ITEM::GetState ( EDA_ITEM_FLAGS type ) const

inlineinherited

Definition at line 137 of file eda_item.h.

     {
         return m_status & type;
     }

References EDA_ITEM::m_status.

Referenced by BOARD_ITEM::IsLocked().

◆ GetStatus()

EDA_ITEM_FLAGS EDA_ITEM::GetStatus ( ) const

inlineinherited

Definition at line 150 of file eda_item.h.

150 { return m_status; }

EDA_ITEM::m_status

EDA_ITEM_FLAGS m_status

Definition: eda_item.h:478

References EDA_ITEM::m_status.

◆ GetStoredPos()

wxPoint& SCH_ITEM::GetStoredPos ( )

inlineinherited

Definition at line 231 of file sch_item.h.

231 { return m_storedPos; }

SCH_ITEM::m_storedPos

wxPoint m_storedPos

Definition: sch_item.h:495

References SCH_ITEM::m_storedPos.

◆ GetStroke()

virtual STROKE_PARAMS SCH_ITEM::GetStroke ( ) const

inlinevirtualinherited

Reimplemented in SCH_LINE, and SCH_BUS_ENTRY_BASE.

Definition at line 460 of file sch_item.h.

460 { wxCHECK( false, STROKE_PARAMS() ); }

STROKE_PARAMS

Simple container to manage line stroke parameters.

Definition: sch_item.h:151

Referenced by DIALOG_LINE_WIRE_BUS_PROPERTIES::TransferDataToWindow().

◆ 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 133 of file eda_text.h.

133 { return m_text; }

EDA_TEXT::m_text

wxString m_text

Definition: eda_text.h:385

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_IO::format(), FormatProbeItem(), SCH_SYMBOL::GetFootprint(), LIB_FIELD::GetFullText(), FOOTPRINT_INFO_GENERATOR::GetHtmlFieldRow(), CADSTAR_PCB_ARCHIVE_LOADER::getKiCadNet(), FP_TEXT::GetLength(), getMatchingTextItem(), PCB_TEXT::GetMsgPanelInfo(), FP_TEXT::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(), LEGACY_PLUGIN::loadPCB_TEXT(), SCH_EAGLE_PLUGIN::loadSchematic(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), SCH_EAGLE_PLUGIN::loadSegments(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), 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 174 of file eda_text.h.

174 { 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(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), PCB_TEXT::Flip(), FP_TEXT::Flip(), PCB_IO::format(), LIB_TEXT::GetBoundingBox(), SCH_FIELD::GetBoundingBox(), LIB_FIELD::GetBoundingBox(), PCB_TEXT::GetBoundingBox(), SCH_TEXT::GetBoundingBox(), SCH_LABEL::GetBoundingBox(), 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(), PCB_TEXT::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(), PCB_TEXT::TransformTextShapeWithClearanceToPolygon(), and DIALOG_SCH_FIELD_PROPERTIES::UpdateField().

TEXT_EFFECTS m_e

Definition: eda_text.h:389

TEXT_EFFECTS::angle

double angle

now: 0.1 degrees; future: degrees

Definition: eda_text.h:105

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

◆ GetTextAngleDegrees()

double EDA_TEXT::GetTextAngleDegrees ( ) const

inlineinherited

Definition at line 176 of file eda_text.h.

176 { return GetTextAngle() / 10.0; }

EDA_TEXT::GetTextAngle

double GetTextAngle() const

Definition: eda_text.h:174

References EDA_TEXT::GetTextAngle().

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

◆ GetTextAngleRadians()

double EDA_TEXT::GetTextAngleRadians ( ) const

inlineinherited

Definition at line 177 of file eda_text.h.

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

EDA_TEXT::GetTextAngle

double GetTextAngle() const

Definition: eda_text.h:174

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 229 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 );
     int         dx = KiROUND( font.ComputeStringBoundaryLimits( text, fontSize, penWidth ).x );
     int         dy = GetInterline();
 
     // 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( dx, dy );
     wxPoint pos = GetTextPos();
 
     if( IsMultilineAllowed() && aLine > 0 && ( aLine < static_cast<int>( strings.GetCount() ) ) )
     {
         pos.y -= aLine * GetInterline();
     }
 
     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 );
             dx = KiROUND( font.ComputeStringBoundaryLimits( text, fontSize, penWidth ).x );
             textsize.x = std::max( textsize.x, dx );
             textsize.y += dy;
         }
     }
 
     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() - ( dy / 2) );
         break;
 
     case GR_TEXT_VJUSTIFY_BOTTOM:
         rect.SetY( rect.GetY() - dy );
         break;
     }
 
     if( linecount > 1 )
     {
         int yoffset;
         linecount -= 1;
 
         switch( GetVertJustify() )
         {
         case GR_TEXT_VJUSTIFY_TOP:
             break;
 
         case GR_TEXT_VJUSTIFY_CENTER:
             yoffset = linecount * GetInterline() / 2;
             rect.SetY( rect.GetY() - yoffset );
             break;
 
         case GR_TEXT_VJUSTIFY_BOTTOM:
             yoffset = linecount * GetInterline();
             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, thickness * 1.5 );
 
     rect.Normalize();       // Make h and v sizes always >= 0
 
     return rect;
 }

References basic_gal, EDA_TEXT::GetEffectiveTextPenWidth(), EDA_TEXT::GetHorizJustify(), EDA_TEXT::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(), and VECTOR2< T >::y.

◆ GetTextHeight()

int EDA_TEXT::GetTextHeight ( ) const

inlineinherited

Definition at line 244 of file eda_text.h.

244 { return m_e.size.y; }

TEXT_EFFECTS m_e

Definition: eda_text.h:389

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(), PCB_TEXT::GetMsgPanelInfo(), LIB_FIELD::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:103

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

◆ GetTextOffset()

int SCH_TEXT::GetTextOffset ( const RENDER_SETTINGS * aSettings = nullptr ) const

inherited

Definition at line 395 of file sch_text.cpp.

 {
     double ratio;
 
     if( aSettings )
         ratio = static_cast<const SCH_RENDER_SETTINGS*>( aSettings )->m_TextOffsetRatio;
     else if( Schematic() )
         ratio = Schematic()->Settings().m_TextOffsetRatio;
     else
         ratio = DEFAULT_TEXT_OFFSET_RATIO;   // For previews (such as in Preferences), etc.
 
     return KiROUND( ratio * GetTextSize().y );
 
     return 0;
 }

References DEFAULT_TEXT_OFFSET_RATIO, EDA_TEXT::GetTextSize(), KiROUND(), SCHEMATIC_SETTINGS::m_TextOffsetRatio, SCH_ITEM::Schematic(), and SCHEMATIC::Settings().

Referenced by SCH_GLOBALLABEL::AutoplaceFields(), SCH_LABEL::GetBoundingBox(), SCH_HIERLABEL::GetBoundingBox(), SCH_GLOBALLABEL::GetBoundingBoxBase(), SCH_TEXT::GetSchematicTextOffset(), and SCH_HIERLABEL::GetSchematicTextOffset().

◆ GetTextPos()

const wxPoint& EDA_TEXT::GetTextPos ( ) const

inlineinherited

Definition at line 247 of file eda_text.h.

247 { return m_e.pos; }

Referenced by BOARD_ADAPTER::addShapeWithClearance(), LIB_TEXT::compare(), LIB_FIELD::compare(), ConstrainOnEdge(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), SCH_LABEL::doIsConnected(), SCH_GLOBALLABEL::doIsConnected(), SCH_HIERLABEL::doIsConnected(), KIGFX::DS_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), PCB_TEXT::Flip(), FP_TEXT::Flip(), PCB_IO::format(), LIB_TEXT::GetBoundingBox(), SCH_FIELD::GetBoundingBox(), LIB_FIELD::GetBoundingBox(), PCB_TEXT::GetBoundingBox(), FP_TEXT::GetBoundingBox(), SCH_TEXT::GetBoundingBox(), SCH_LABEL::GetBoundingBox(), SCH_HIERLABEL::GetBoundingBox(), SCH_GLOBALLABEL::GetBoundingBoxBase(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_TEXT::GetConnectionPoints(), GetEndPoints(), SCH_TEXT::GetEndPoints(), SCH_FIELD::GetLibPosition(), EDA_TEXT::GetLinePositions(), PCB_TEXT::GetPosition(), FP_TEXT::GetPosition(), LIB_TEXT::GetPosition(), LIB_FIELD::GetPosition(), SCH_FIELD::GetPosition(), SCH_TEXT::GetPosition(), DS_DRAW_ITEM_TEXT::GetPosition(), EDA_TEXT::GetTextBox(), LIB_TEXT::HitTest(), LIB_FIELD::HitTest(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymDefIntoLibrary(), FP_TEXT::Mirror(), PCB_DIMENSION_BASE::Mirror(), LIB_TEXT::MirrorHorizontal(), LIB_FIELD::MirrorHorizontal(), MirrorHorizontally(), SCH_TEXT::MirrorHorizontally(), SCH_GLOBALLABEL::MirrorHorizontally(), SCH_GLOBALLABEL::MirrorSpinStyle(), LIB_TEXT::MirrorVertical(), LIB_FIELD::MirrorVertical(), MirrorVertically(), SCH_TEXT::MirrorVertically(), SCH_GLOBALLABEL::MirrorVertically(), LIB_TEXT::NormalizeJustification(), DIALOG_UPDATE_SYMBOL_FIELDS::onOkButtonClicked(), DRAWING_TOOL::PlaceText(), SCH_TEXT::Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotPcbText(), LIB_FIELD::print(), EDA_TEXT::Print(), SCH_GLOBALLABEL::Print(), SCH_HIERLABEL::Print(), DIALOG_CHANGE_SYMBOLS::processSymbol(), PCB_TEXT::Rotate(), LIB_TEXT::Rotate(), FP_TEXT::Rotate(), Rotate(), LIB_FIELD::Rotate(), SCH_TEXT::Rotate(), PCB_DIMENSION_BASE::Rotate(), SCH_GLOBALLABEL::Rotate(), SCH_GLOBALLABEL::Rotate90(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveText(), FP_TEXT::SetDrawCoord(), FP_TEXT::SetLocalCoord(), FP_TEXT::TextHitTest(), EDA_TEXT::TextHitTest(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), EDA_TEXT::TransformBoundingBoxWithClearanceToPolygon(), FP_TEXT::TransformShapeWithClearanceToPolygon(), PCB_TEXT::TransformTextShapeWithClearanceToPolygon(), FP_TEXT::TransformTextShapeWithClearanceToPolygon(), EDA_TEXT::TransformToSegmentList(), SCH_TEXT::UpdateDanglingState(), DIALOG_SCH_FIELD_PROPERTIES::UpdateField(), and FP_TEXT::ViewBBox().

TEXT_EFFECTS m_e

Definition: eda_text.h:389

TEXT_EFFECTS::pos

wxPoint pos

Definition: eda_text.h:106

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

◆ GetTextSize()

const wxSize& EDA_TEXT::GetTextSize ( ) const

inlineinherited

Definition at line 238 of file eda_text.h.

238 { return m_e.size; }

TEXT_EFFECTS m_e

Definition: eda_text.h:389

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(), PCB_TEXT::TransformTextShapeWithClearanceToPolygon(), FP_TEXT::TransformTextShapeWithClearanceToPolygon(), EDA_TEXT::TransformToSegmentList(), and SCH_GLOBALLABEL::UpdateIntersheetRefProps().

wxSize size

Definition: eda_text.h:103

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 491 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_FIELD::GetMsgPanelInfo().

◆ GetTextThickness()

int EDA_TEXT::GetTextThickness ( ) const

inlineinherited

Definition at line 160 of file eda_text.h.

160 { return m_e.penwidth; };

Referenced by EDA_TEXT_DESC::EDA_TEXT_DESC(), EDA_TEXT::Format(), EDA_TEXT::GetEffectiveTextPenWidth(), LIB_TEXT::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), LIB_TEXT::GetWidth(), LIB_FIELD::GetWidth(), 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:389

TEXT_EFFECTS::penwidth

int penwidth

Definition: eda_text.h:104

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

◆ GetTextWidth()

int EDA_TEXT::GetTextWidth ( ) const

inlineinherited

Definition at line 241 of file eda_text.h.

241 { return m_e.size.x; }

TEXT_EFFECTS m_e

Definition: eda_text.h:389

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(), PCB_TEXT::GetMsgPanelInfo(), LIB_FIELD::GetMsgPanelInfo(), FP_TEXT::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_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_SHEET_PIN_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:103

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

◆ GetVertJustify()

EDA_TEXT_VJUSTIFY_T EDA_TEXT::GetVertJustify ( ) const

inlineinherited

Definition at line 199 of file eda_text.h.

199 { 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::GetLinePositions(), EDA_TEXT::GetTextBox(), EDA_TEXT::IsDefaultFormatting(), 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(), PCB_TEXT::TransformTextShapeWithClearanceToPolygon(), FP_TEXT::TransformTextShapeWithClearanceToPolygon(), EDA_TEXT::TransformToSegmentList(), and DIALOG_SCH_FIELD_PROPERTIES::UpdateField().

TEXT_EFFECTS m_e

Definition: eda_text.h:389

TEXT_EFFECTS::vjustify

signed char vjustify

vertical justification

Definition: eda_text.h:102

EDA_TEXT_VJUSTIFY_T

Definition: eda_text.h:68

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

◆ HasFlag()

bool EDA_ITEM::HasFlag ( EDA_ITEM_FLAGS aFlag ) const

inlineinherited

Definition at line 156 of file eda_item.h.

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

EDA_TEXT::m_shown_text_has_text_var_refs

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

References EDA_ITEM::m_flags.

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

◆ HasLineStroke()

virtual bool SCH_ITEM::HasLineStroke ( ) const

inlinevirtualinherited

Check if this schematic item has line stoke properties.

See also: STROKE_PARAMS

Returns: true if this schematic item support line stroke properties. Otherwise, false.

Reimplemented in SCH_LINE, and SCH_BUS_ENTRY_BASE.

Definition at line 458 of file sch_item.h.

458 { return false; }

Referenced by EE_SELECTION::AllItemsHaveLineStroke(), and SCH_EDIT_TOOL::Properties().

◆ HasTextVars()

bool EDA_TEXT::HasTextVars ( ) const

inlineinherited

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

Definition at line 151 of file eda_text.h.

151 { return m_shown_text_has_text_var_refs; }

bool m_shown_text_has_text_var_refs

Definition: eda_text.h:387

References EDA_TEXT::m_shown_text_has_text_var_refs.

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

◆ HitTest() [1/2]

bool SCH_SHEET_PIN::HitTest	(	const wxPoint &	aPosition,
		int	aAccuracy = `0`
	)		const

overridevirtual

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

Parameters

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

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

Reimplemented from EDA_ITEM.

Definition at line 299 of file sch_sheet_pin.cpp.

 {
     EDA_RECT rect = GetBoundingBox();
 
     rect.Inflate( aAccuracy );
 
     return rect.Contains( aPoint );
 }

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

◆ HitTest() [2/2]

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

overridevirtualinherited

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

Parameters

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

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

Reimplemented from EDA_ITEM.

Reimplemented in SCH_GLOBALLABEL.

Definition at line 686 of file sch_text.cpp.

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

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

◆ IncrementLabel()

bool SCH_TEXT::IncrementLabel ( int aIncrement )

inherited

Increment the label text, if it ends with a number.

Parameters

aIncrement = the increment value to add to the number ending the text.

Definition at line 235 of file sch_text.cpp.

 {
     wxString text = GetText();
     bool ReturnVal = IncrementLabelMember( text, aIncrement );
 
     if( ReturnVal )
         SetText( text );
 
     return ReturnVal;
 }

References EDA_TEXT::GetText(), IncrementLabelMember(), EDA_TEXT::SetText(), and text.

◆ InitializeConnection()

SCH_CONNECTION * SCH_ITEM::InitializeConnection	(	const SCH_SHEET_PATH &	aPath,
		CONNECTION_GRAPH *	aGraph
	)

inherited

Create a new connection object associated with this object.

Parameters

aPath is the sheet path to initialize.

Definition at line 176 of file sch_item.cpp.

 {
     SCH_CONNECTION* connection = Connection( &aSheet );
 
     if( connection )
     {
         connection->Reset();
     }
     else
     {
         connection = new SCH_CONNECTION( this );
         m_connection_map.insert( std::make_pair( aSheet, connection ) );
     }
 
     connection->SetGraph( aGraph );
     connection->SetSheet( aSheet );
     return connection;
 }

References SCH_ITEM::Connection(), SCH_ITEM::m_connection_map, SCH_CONNECTION::Reset(), SCH_CONNECTION::SetGraph(), and SCH_CONNECTION::SetSheet().

◆ IsBold()

bool EDA_TEXT::IsBold ( ) const

inlineinherited

Definition at line 183 of file eda_text.h.

183 { return m_e.Bit( TE_BOLD ); }

EDA_TEXT::TE_BOLD

Definition: eda_text.h:394

TEXT_EFFECTS m_e

Definition: eda_text.h:389

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(), PCB_TEXT::TransformTextShapeWithClearanceToPolygon(), FP_TEXT::TransformTextShapeWithClearanceToPolygon(), and SCH_GLOBALLABEL::UpdateIntersheetRefProps().

void Bit(int aBit, bool aValue)

Definition: eda_text.h:108

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

◆ IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const

inlineinherited

Definition at line 126 of file eda_item.h.

126 { return m_flags & BRIGHTENED; }

SCH_ITEM::m_connectivity_dirty

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

BRIGHTENED

#define BRIGHTENED

item is drawn with a bright contour

Definition: eda_item_flags.h:65

References BRIGHTENED, and EDA_ITEM::m_flags.

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

◆ IsConnectable()

bool SCH_SHEET_PIN::IsConnectable ( ) const

inlineoverridevirtual

Returns: true if the schematic item can connect to another schematic item.

Reimplemented from SCH_ITEM.

Definition at line 171 of file sch_sheet_pin.h.

171 { return true; }

◆ IsConnected()

bool SCH_ITEM::IsConnected ( const wxPoint & aPoint ) const

inherited

Test the item to see if it is connected to aPoint.

Parameters

aPoint is a reference to a wxPoint object containing the coordinates to test.

Returns: True if connection to aPoint exists.

Definition at line 122 of file sch_item.cpp.

 {
     if(( m_flags & STRUCT_DELETED ) || ( m_flags & SKIP_STRUCT ) )
         return false;
 
     return doIsConnected( aPosition );
 }

References SCH_ITEM::doIsConnected(), EDA_ITEM::m_flags, SKIP_STRUCT, and STRUCT_DELETED.

Referenced by SCH_SCREEN::IsJunctionNeeded(), and SCH_SCREEN::IsTerminalPoint().

◆ IsConnectivityDirty()

bool SCH_ITEM::IsConnectivityDirty ( )

inlineinherited

Definition at line 420 of file sch_item.h.

420 { return m_connectivity_dirty; }

bool m_connectivity_dirty

Definition: sch_item.h:504

References SCH_ITEM::m_connectivity_dirty.

◆ IsDangling()

bool SCH_TEXT::IsDangling ( ) const

inlineoverridevirtualinherited

Reimplemented from SCH_ITEM.

Definition at line 230 of file sch_text.h.

230 { return m_isDangling; }

SCH_TEXT::m_isDangling

bool m_isDangling

True if not connected to another object if the object derive from SCH_TEXT supports connections.

Definition: sch_text.h:262

References SCH_TEXT::m_isDangling.

Referenced by SCH_EDIT_TOOL::ChangeTextType(), and KIGFX::SCH_PAINTER::draw().

◆ IsDefaultFormatting()

bool EDA_TEXT::IsDefaultFormatting ( ) const

inherited

Definition at line 512 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 121 of file eda_item.h.

121 { return m_flags & IS_DRAGGING; }

IS_DRAGGING

#define IS_DRAGGING

Item being dragged.

Definition: eda_item_flags.h:43

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

References IS_DRAGGING, and EDA_ITEM::m_flags.

Referenced by DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES().

◆ IsEntered()

bool EDA_ITEM::IsEntered ( ) const

inlineinherited

Definition at line 124 of file eda_item.h.

124 { return m_flags & ENTERED; }

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

ENTERED

#define ENTERED

indicates a group has been entered

Definition: eda_item_flags.h:72

References ENTERED, and EDA_ITEM::m_flags.

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

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const

inlineinherited

Definition at line 206 of file eda_item.h.

206 { return m_forceVisible; }

EDA_ITEM::m_forceVisible

bool m_forceVisible

Definition: eda_item.h:480

References EDA_ITEM::m_forceVisible.

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

◆ IsHypertext()

virtual bool SCH_ITEM::IsHypertext ( ) const

inlinevirtualinherited

Allow items to support hypertext actions when hovered/clicked.

Reimplemented in SCH_FIELD.

Definition at line 261 of file sch_item.h.

261 { return false; }

◆ IsItalic()

bool EDA_TEXT::IsItalic ( ) const

inlineinherited

Definition at line 180 of file eda_text.h.

180 { return m_e.Bit( TE_ITALIC ); }

TEXT_EFFECTS m_e

Definition: eda_text.h:389

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(), PCB_TEXT::TransformTextShapeWithClearanceToPolygon(), FP_TEXT::TransformTextShapeWithClearanceToPolygon(), EDA_TEXT::TransformToSegmentList(), and SCH_GLOBALLABEL::UpdateIntersheetRefProps().

void Bit(int aBit, bool aValue)

Definition: eda_text.h:108

EDA_TEXT::TE_ITALIC

Definition: eda_text.h:393

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

◆ IsLocked()

virtual bool SCH_ITEM::IsLocked ( ) const

inlinevirtualinherited

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

Definition at line 251 of file sch_item.h.

251 { return false; }

◆ IsMirrored()

bool EDA_TEXT::IsMirrored ( ) const

inlineinherited

Definition at line 189 of file eda_text.h.

189 { return m_e.Bit( TE_MIRROR ); }

EDA_TEXT::TE_MIRROR

Definition: eda_text.h:392

TEXT_EFFECTS m_e

Definition: eda_text.h:389

Referenced by BOARD_ADAPTER::addShapeWithClearance(), KIGFX::SCH_PAINTER::draw(), EDA_TEXT_DESC::EDA_TEXT_DESC(), PCB_TEXT::Flip(), EDA_TEXT::Format(), PCB_TEXT::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(), PCB_TEXT::TransformTextShapeWithClearanceToPolygon(), FP_TEXT::TransformTextShapeWithClearanceToPolygon(), and EDA_TEXT::TransformToSegmentList().

void Bit(int aBit, bool aValue)

Definition: eda_text.h:108

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

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const

inlineinherited

Definition at line 118 of file eda_item.h.

118 { return m_flags & IS_CHANGED; }

IS_CHANGED

#define IS_CHANGED

Item was edited, and modified.

Definition: eda_item_flags.h:37

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

References IS_CHANGED, and EDA_ITEM::m_flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMovableFromAnchorPoint()

bool SCH_SHEET_PIN::IsMovableFromAnchorPoint ( ) const

inlineoverridevirtual

Return true for items which are moved with the anchor point at mouse cursor and false for items moved with no reference to anchor (usually large items).

Returns: true for a hierarchical sheet pin.

Reimplemented from SCH_ITEM.

Definition at line 93 of file sch_sheet_pin.h.

93 { return true; }

◆ IsMoving()

bool EDA_ITEM::IsMoving ( ) const

inlineinherited

Definition at line 120 of file eda_item.h.

120 { return m_flags & IS_MOVING; }

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

IS_MOVING

#define IS_MOVING

Item being moved.

Definition: eda_item_flags.h:40

References IS_MOVING, and EDA_ITEM::m_flags.

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

◆ IsMultilineAllowed()

bool EDA_TEXT::IsMultilineAllowed ( ) const

inlineinherited

Definition at line 196 of file eda_text.h.

196 { return m_e.Bit( TE_MULTILINE ); }

TEXT_EFFECTS m_e

Definition: eda_text.h:389

void Bit(int aBit, bool aValue)

Definition: eda_text.h:108

EDA_TEXT::TE_MULTILINE

Definition: eda_text.h:395

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

119 { return m_flags & IS_NEW; }

IS_NEW

#define IS_NEW

New item, just created.

Definition: eda_item_flags.h:41

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_EDIT_TOOL::AutoplaceFields(), 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:481

References IS_NEW, and EDA_ITEM::m_flags.

◆ IsPointClickableAnchor()

bool SCH_SHEET_PIN::IsPointClickableAnchor ( const wxPoint & aPos ) const

inlineoverridevirtual

Returns: true if the given point can start drawing (usually means the anchor is unused/free/dangling).

Reimplemented from SCH_ITEM.

Definition at line 179 of file sch_sheet_pin.h.

     {
         return m_isDangling && GetPosition() == aPos;
     }

References SCH_TEXT::GetPosition(), and SCH_TEXT::m_isDangling.

◆ IsReplaceable()

bool SCH_SHEET_PIN::IsReplaceable ( ) const

inlineoverridevirtual

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 from SCH_TEXT.

Definition at line 167 of file sch_sheet_pin.h.

167 { return true; }

◆ IsResized()

bool EDA_ITEM::IsResized ( ) const

inlineinherited

Definition at line 125 of file eda_item.h.

125 { return m_flags & IS_RESIZING; }

IS_RESIZING

#define IS_RESIZING

Item being resized.

Definition: eda_item_flags.h:42

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

References IS_RESIZING, and EDA_ITEM::m_flags.

◆ IsSelected()

bool EDA_ITEM::IsSelected ( ) const

inlineinherited

Definition at line 123 of file eda_item.h.

123 { return m_flags & SELECTED; }

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

SELECTED

#define SELECTED

Definition: eda_item_flags.h:48

References EDA_ITEM::m_flags, and SELECTED.

◆ IsType()

virtual bool EDA_ITEM::IsType ( const KICAD_T aScanTypes[] ) const

inlinevirtualinherited

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 in PCB_VIA, SCH_LABEL, PCB_DIMENSION_BASE, PAD, SCH_FIELD, FP_TEXT, SCH_LINE, PCB_SHAPE, FP_SHAPE, and PCB_TEXT.

Definition at line 183 of file eda_item.h.

     {
         if( aScanTypes[0] == SCH_LOCATE_ANY_T )
             return true;
 
         for( const KICAD_T* p = aScanTypes; *p != EOT; ++p )
         {
             if( m_structType == *p )
                 return true;
         }
 
         return false;
     }

References EOT, EDA_ITEM::m_structType, and SCH_LOCATE_ANY_T.

Referenced by ROUTER_TOOL::CanInlineDrag(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingBus(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLine(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingWire(), PCB_TEXT::IsType(), FP_SHAPE::IsType(), PCB_SHAPE::IsType(), SCH_LINE::IsType(), FP_TEXT::IsType(), SCH_FIELD::IsType(), PAD::IsType(), PCB_DIMENSION_BASE::IsType(), SCH_LABEL::IsType(), PCB_VIA::IsType(), EE_POINT_EDITOR::Main(), PL_POINT_EDITOR::Main(), EE_SELECTION_TOOL::RequestSelection(), SCH_BASE_FRAME::UpdateItem(), EDA_ITEM::Visit(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ IsVisible()

virtual bool EDA_TEXT::IsVisible ( ) const

inlinevirtualinherited

Reimplemented in PCB_TEXT.

Definition at line 186 of file eda_text.h.

186 { return m_e.Bit( TE_VISIBLE ); }

TEXT_EFFECTS m_e

Definition: eda_text.h:389

Referenced by BOARD_ADAPTER::addFootprintShapesWithClearance(), SCH_EDITOR_CONTROL::AssignFootprints(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), KIGFX::SCH_PAINTER::draw(), EDA_TEXT_DESC::EDA_TEXT_DESC(), SCH_EDIT_TOOL::EditField(), PCB_IO::format(), EDA_TEXT::Format(), FOOTPRINT::GetBoundingBox(), FP_TEXT::GetMsgPanelInfo(), SCH_FIELD::HitTest(), EDA_TEXT::IsDefaultFormatting(), SCH_FIELD::Matches(), DIALOG_UPDATE_SYMBOL_FIELDS::onOkButtonClicked(), SCH_FIELD::Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItems(), SCH_FIELD::Print(), LIB_FIELD::print(), LIB_SYMBOL::Print(), DIALOG_CHANGE_SYMBOLS::processSymbol(), processTextItem(), SCH_EDIT_TOOL::Properties(), SCH_LEGACY_PLUGIN::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveText(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), and FP_TEXT::ViewGetLayers().

void Bit(int aBit, bool aValue)

Definition: eda_text.h:108

EDA_TEXT::TE_VISIBLE

Definition: eda_text.h:396

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

◆ IsWireImage()

bool EDA_ITEM::IsWireImage ( ) const

inlineinherited

Definition at line 122 of file eda_item.h.

122 { return m_flags & IS_WIRE_IMAGE; }

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

IS_WIRE_IMAGE

#define IS_WIRE_IMAGE

Item to be drawn as wireframe while editing.

Definition: eda_item_flags.h:45

References IS_WIRE_IMAGE, and EDA_ITEM::m_flags.

◆ IterateForward() [1/2]

template<class T >

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

inlinestaticinherited

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

Definition at line 295 of file eda_item.h.

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

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

Referenced by GERBER_FILE_IMAGE::Visit().

◆ IterateForward() [2/2]

template<class T >

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

inlinestaticinherited

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

Definition at line 314 of file eda_item.h.

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

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

◆ 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 194 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 63 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_SCH_FIELD_PROPERTIES::UpdateField(), and DIALOG_FIELD_PROPERTIES::updateText().

◆ MapVertJustify()

EDA_TEXT_VJUSTIFY_T EDA_TEXT::MapVertJustify ( int aVertJustify )

staticinherited

Definition at line 77 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_SCH_FIELD_PROPERTIES::UpdateField(), and DIALOG_FIELD_PROPERTIES::updateText().

◆ Matches() [1/2]

bool SCH_SHEET_PIN::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 157 of file sch_sheet_pin.h.

     {
         return SCH_ITEM::Matches( GetText(), aSearchData );
     }

References EDA_TEXT::GetText(), and EDA_ITEM::Matches().

◆ Matches() [2/2]

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

protectedinherited

Compare aText against search criteria in aSearchData.

This is a helper function for simplify derived class logic.

Parameters

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

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

Definition at line 118 of file eda_item.cpp.

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

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

◆ MirrorHorizontally()

void SCH_SHEET_PIN::MirrorHorizontally ( int aCenter )

overridevirtual

Mirror item horizontally about aCenter.

Implements SCH_ITEM.

Definition at line 235 of file sch_sheet_pin.cpp.

 {
     int p = GetTextPos().x - aCenter;
 
     SetTextX( aCenter - p );
 
     switch( m_edge )
     {
     case SHEET_SIDE::LEFT: SetEdge( SHEET_SIDE::RIGHT ); break;
     case SHEET_SIDE::RIGHT: SetEdge( SHEET_SIDE::LEFT ); break;
     default: break;
     }
 }

References EDA_TEXT::GetTextPos(), LEFT, m_edge, RIGHT, SetEdge(), and EDA_TEXT::SetTextX().

◆ MirrorSpinStyle()

void SCH_TEXT::MirrorSpinStyle ( bool aLeftRight )

virtualinherited

Reimplemented in SCH_GLOBALLABEL.

Definition at line 310 of file sch_text.cpp.

 {
     if( aLeftRight )
         SetLabelSpinStyle( GetLabelSpinStyle().MirrorY() );
     else
         SetLabelSpinStyle( GetLabelSpinStyle().MirrorX() );
 }

References SCH_TEXT::GetLabelSpinStyle(), and SCH_TEXT::SetLabelSpinStyle().

Referenced by SCH_EDIT_TOOL::Mirror(), and SCH_GLOBALLABEL::MirrorSpinStyle().

◆ MirrorVertically()

void SCH_SHEET_PIN::MirrorVertically ( int aCenter )

overridevirtual

Mirror item vertically about aCenter.

Implements SCH_ITEM.

Definition at line 220 of file sch_sheet_pin.cpp.

 {
     int p = GetTextPos().y - aCenter;
 
     SetTextY( aCenter - p );
 
     switch( m_edge )
     {
     case SHEET_SIDE::TOP: SetEdge( SHEET_SIDE::BOTTOM ); break;
     case SHEET_SIDE::BOTTOM: SetEdge( SHEET_SIDE::TOP ); break;
     default: break;
     }
 }

References BOTTOM, EDA_TEXT::GetTextPos(), m_edge, SetEdge(), EDA_TEXT::SetTextY(), and TOP.

◆ Move()

void SCH_SHEET_PIN::Move ( const wxPoint & aMoveVector )

inlineoverridevirtual

Move the item by aMoveVector to a new position.

Implements SCH_ITEM.

Definition at line 148 of file sch_sheet_pin.h.

     {
         Offset( aMoveVector );
     }

References EDA_TEXT::Offset().

◆ NetClass()

NETCLASSPTR SCH_ITEM::NetClass ( const SCH_SHEET_PATH * aSheet = nullptr ) const

inherited

Definition at line 145 of file sch_item.cpp.

 {
     if( m_connection_map.size() )
     {
         SCH_CONNECTION* connection = Connection( aSheet );
 
         if( connection )
         {
             NET_SETTINGS&   netSettings = Schematic()->Prj().GetProjectFile().NetSettings();
             const wxString& netclassName = netSettings.GetNetclassName( connection->Name() );
 
             return netSettings.m_NetClasses.Find( netclassName );
         }
     }
 
     return nullptr;
 }

References SCH_ITEM::Connection(), NETCLASSES::Find(), NET_SETTINGS::GetNetclassName(), PROJECT::GetProjectFile(), SCH_ITEM::m_connection_map, NET_SETTINGS::m_NetClasses, SCH_CONNECTION::Name(), PROJECT_FILE::NetSettings(), SCHEMATIC::Prj(), and SCH_ITEM::Schematic().

Referenced by SCH_LINE::GetEffectiveLineStyle(), SCH_JUNCTION::getEffectiveShape(), SCH_JUNCTION::GetJunctionColor(), SCH_LINE::GetLineColor(), SCH_BUS_WIRE_ENTRY::GetPenWidth(), SCH_LINE::GetPenWidth(), SCH_BUS_BUS_ENTRY::GetPenWidth(), SCH_BUS_ENTRY_BASE::GetStrokeColor(), and SCH_BUS_ENTRY_BASE::GetStrokeStyle().

◆ Offset()

void EDA_TEXT::Offset ( const wxPoint & aOffset )

inlineinherited

Definition at line 252 of file eda_text.h.

252 { m_e.pos += aOffset; }

References color, SCH_ITEM::Connection(), SCH_TEXT::CreateGraphicShape(), KIGFX::RENDER_SETTINGS::GetDefaultPenWidth(), EDA_TEXT::GetEffectiveTextPenWidth(), EDA_TEXT::GetHorizJustify(), KIGFX::RENDER_SETTINGS::GetLayerColor(), EDA_TEXT::GetLinePositions(), KIGFX::RENDER_SETTINGS::GetMinPenWidth(), SCH_TEXT::GetSchematicTextOffset(), SCH_TEXT::GetShownText(), EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextPos(), EDA_TEXT::GetTextSize(), EDA_TEXT::GetVertJustify(), EDA_TEXT::IsBold(), SCH_CONNECTION::IsBus(), EDA_TEXT::IsItalic(), EDA_TEXT::IsMultilineAllowed(), LAYER_BUS, SCH_ITEM::m_layer, NO_FILL, PLOTTER::PlotPoly(), PLOTTER::RenderSettings(), PLOTTER::SetCurrentLineWidth(), PLOTTER::Text(), and wxStringSplit().

TEXT_EFFECTS m_e

Definition: eda_text.h:389

TEXT_EFFECTS::pos

wxPoint pos

Definition: eda_text.h:106

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

Referenced by CADSTAR_ARCHIVE_PARSER::FixTextPositionNoAlignment(), PCB_TEXT::Move(), FP_TEXT::Move(), SCH_FIELD::Move(), 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<() [1/2]

bool SCH_TEXT::operator< ( const SCH_ITEM & aItem ) const

overridevirtualinherited

Reimplemented from SCH_ITEM.

Definition at line 375 of file sch_text.cpp.

 {
     if( Type() != aItem.Type() )
         return Type() < aItem.Type();
 
     auto other = static_cast<const SCH_TEXT*>( &aItem );
 
     if( GetLayer() != other->GetLayer() )
             return GetLayer() < other->GetLayer();
 
     if( GetPosition().x != other->GetPosition().x )
         return GetPosition().x < other->GetPosition().x;
 
     if( GetPosition().y != other->GetPosition().y )
         return GetPosition().y < other->GetPosition().y;
 
     return GetText() < other->GetText();
 }

References SCH_ITEM::GetLayer(), SCH_TEXT::GetPosition(), EDA_TEXT::GetText(), and EDA_ITEM::Type().

◆ operator<() [2/2]

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

inherited

Test if another item is less than this object.

Parameters

aItem - Item to compare against.

Returns: - True if aItem is less than the item.

Definition at line 171 of file eda_item.cpp.

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

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

◆ operator==()

bool SCH_SHEET_PIN::operator== ( const SCH_SHEET_PIN * aPin ) const

Definition at line 92 of file sch_sheet_pin.cpp.

 {
     return aPin == this;
 }

◆ Plot()

void SCH_TEXT::Plot ( PLOTTER * aPlotter ) const

overridevirtualinherited

Plot the schematic item to aPlotter.

Parameters

aPlotter is the PLOTTER object to plot to.

Reimplemented from SCH_ITEM.

Reimplemented in SCH_GLOBALLABEL.

Definition at line 698 of file sch_text.cpp.

 {
     static std::vector<wxPoint> s_poly;
 
     RENDER_SETTINGS* settings = aPlotter->RenderSettings();
     SCH_CONNECTION*  connection = Connection();
     int              layer = ( connection && connection->IsBus() ) ? LAYER_BUS : m_layer;
     COLOR4D          color = settings->GetLayerColor( layer );
     int              penWidth = GetEffectiveTextPenWidth( settings->GetDefaultPenWidth() );
 
     penWidth = std::max( penWidth, settings->GetMinPenWidth() );
     aPlotter->SetCurrentLineWidth( penWidth );
 
     if( IsMultilineAllowed() )
     {
         std::vector<wxPoint> positions;
         wxArrayString strings_list;
         wxStringSplit( GetShownText(), strings_list, '\n' );
         positions.reserve( strings_list.Count() );
 
         GetLinePositions( positions, (int) strings_list.Count() );
 
         for( unsigned ii = 0; ii < strings_list.Count(); ii++ )
         {
             wxPoint textpos = positions[ii] + GetSchematicTextOffset( aPlotter->RenderSettings() );
             wxString& txt = strings_list.Item( ii );
             aPlotter->Text( textpos, color, txt, GetTextAngle(), GetTextSize(), GetHorizJustify(),
                             GetVertJustify(), penWidth, IsItalic(), IsBold() );
         }
     }
     else
     {
         wxPoint textpos = GetTextPos() + GetSchematicTextOffset( aPlotter->RenderSettings() );
 
         aPlotter->Text( textpos, color, GetShownText(), GetTextAngle(), GetTextSize(),
                         GetHorizJustify(), GetVertJustify(), penWidth, IsItalic(), IsBold() );
     }
 
     // Draw graphic symbol for global or hierarchical labels
     CreateGraphicShape( aPlotter->RenderSettings(), s_poly, GetTextPos() );
 
     if( s_poly.size() )
         aPlotter->PlotPoly( s_poly, FILL_TYPE::NO_FILL, penWidth );
 }

Referenced by SCH_GLOBALLABEL::Plot().

◆ Print() [1/2]

void SCH_SHEET_PIN::Print	(	const RENDER_SETTINGS *	aSettings,
		const wxPoint &	aOffset
	)

overridevirtual

Print a schematic item.

Each schematic item should have its own method

Parameters

aOffset is the drawing offset (usually {0,0} but can be different when moving an object).

Implements SCH_ITEM.

Definition at line 68 of file sch_sheet_pin.cpp.

 {
     // The icon selection is handle by the virtual method CreateGraphicShape called by ::Print
     SCH_HIERLABEL::Print( aSettings, aOffset );
 }

References SCH_HIERLABEL::Print().

◆ Print() [2/2]

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 407 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 SCH_SHEET_PIN::Replace	(	const wxFindReplaceData &	aSearchData,
		void *	aAuxData = `nullptr`
	)

inlineoverridevirtual

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 from EDA_ITEM.

Definition at line 162 of file sch_sheet_pin.h.

     {
         return EDA_TEXT::Replace( aSearchData );
     }

References EDA_TEXT::Replace().

◆ Replace() [2/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 170 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 Replace(), SCH_FIELD::Replace(), and SCH_TEXT::Replace().

◆ Replace() [3/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 145 of file eda_item.cpp.

 {
     wxString searchString = (aSearchData.GetFlags() & wxFR_MATCHCASE) ? aText : aText.Upper();
 
     int result = searchString.Find( ( aSearchData.GetFlags() & wxFR_MATCHCASE ) ?
                                     aSearchData.GetFindString() :
                                     aSearchData.GetFindString().Upper() );
 
     if( result == wxNOT_FOUND )
         return false;
 
     wxString prefix = aText.Left( result );
     wxString suffix;
 
     if( aSearchData.GetFindString().length() + result < aText.length() )
         suffix = aText.Right( aText.length() - ( aSearchData.GetFindString().length() + result ) );
 
     wxLogTrace( traceFindReplace, wxT( "Replacing '%s', prefix '%s', replace '%s', suffix '%s'." ),
                 aText, prefix, aSearchData.GetReplaceString(), suffix );
 
     aText = prefix + aSearchData.GetReplaceString() + suffix;
 
     return true;
 }

References traceFindReplace.

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

◆ Rotate()

void SCH_SHEET_PIN::Rotate ( const wxPoint & aCenter )

overridevirtual

Rotate the item around aCenter 90 degrees in the clockwise direction.

Implements SCH_ITEM.

Definition at line 250 of file sch_sheet_pin.cpp.

 {
     wxPoint pt = GetTextPos();
     RotatePoint( &pt, aCenter, 900 );
     ConstrainOnEdge( pt );
 }

References ConstrainOnEdge(), EDA_TEXT::GetTextPos(), and RotatePoint().

◆ Rotate90()

void SCH_TEXT::Rotate90 ( bool aClockwise )

virtualinherited

Reimplemented in SCH_GLOBALLABEL.

Definition at line 301 of file sch_text.cpp.

 {
     if( aClockwise )
         SetLabelSpinStyle( GetLabelSpinStyle().RotateCW() );
     else
         SetLabelSpinStyle( GetLabelSpinStyle().RotateCCW() );
 }

References SCH_TEXT::GetLabelSpinStyle(), and SCH_TEXT::SetLabelSpinStyle().

Referenced by SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SCH_EDIT_TOOL::Rotate(), SCH_TEXT::Rotate(), and SCH_GLOBALLABEL::Rotate90().

◆ RunOnChildren()

virtual void SCH_ITEM::RunOnChildren ( const std::function< void(SCH_ITEM *)> & aFunction )

inlinevirtualinherited

Reimplemented in SCH_SYMBOL, SCH_SHEET, and SCH_GLOBALLABEL.

Definition at line 449 of file sch_item.h.

449 { }

Referenced by SCH_ITEM::Duplicate(), SCH_SHEET_LIST::GetItem(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ Schematic()

SCHEMATIC * SCH_ITEM::Schematic ( ) const

inherited

Searches the item hierarchy to find a SCHEMATIC.

Every SCH_ITEM that lives on a SCH_SCREEN should be parented to either that screen or another SCH_ITEM on the same screen (for example, pins to their symbols).

Every SCH_SCREEN should be parented to the SCHEMATIC.

Note: This hierarchy is not the same as the sheet hierarchy!

Returns: the parent schematic this item lives on, or nullptr.

Definition at line 97 of file sch_item.cpp.

 {
     EDA_ITEM* parent = GetParent();
 
     while( parent )
     {
         if( parent->Type() == SCHEMATIC_T )
             return static_cast<SCHEMATIC*>( parent );
         else
             parent = parent->GetParent();
     }
 
     return nullptr;
 }

References EDA_ITEM::GetParent(), SCHEMATIC_T, and EDA_ITEM::Type().

Referenced by SCH_ITEM::Connection(), SCH_DRAWING_TOOLS::createSheetPin(), DIALOG_SCH_FIELD_PROPERTIES::DIALOG_SCH_FIELD_PROPERTIES(), SCH_FIELD::DoHypertextMenu(), SCH_GLOBALLABEL::GetBoundingBox(), SCH_MARKER::GetColorLayer(), SCH_JUNCTION::getEffectiveShape(), SCH_TEXT::GetLabelBoxExpansion(), SCH_BUS_ENTRY_BASE::GetMsgPanelInfo(), SCH_LINE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_NO_CONNECT::GetPenWidth(), GetPenWidth(), SCH_BUS_WIRE_ENTRY::GetPenWidth(), SCH_LINE::GetPenWidth(), SCH_BUS_BUS_ENTRY::GetPenWidth(), SCH_SHEET::GetPenWidth(), SCH_SYMBOL::GetPins(), SCH_FIELD::GetShownText(), SCH_TEXT::GetShownText(), SCH_TEXT::GetTextOffset(), SCH_PIN::HitTest(), SCH_GLOBALLABEL::HitTest(), inheritNetclass(), SCH_SHEET::IsRootSheet(), SCH_LABEL::IsType(), SCH_ITEM::NetClass(), DIALOG_SYMBOL_PROPERTIES::OnAddField(), DIALOG_TEXT_AND_LABEL_PROPERTIES::onScintillaCharAdded(), DIALOG_SCH_FIELD_PROPERTIES::onScintillaCharAdded(), SCH_GLOBALLABEL::Plot(), SCH_GLOBALLABEL::Print(), SCH_HIERLABEL::Print(), SCH_SHEET::ResolveTextVar(), SCH_SYMBOL::ResolveTextVar(), SCH_GLOBALLABEL::ResolveTextVar(), DIALOG_SCH_FIELD_PROPERTIES::UpdateField(), and SCH_MARKER::ViewGetLayers().

◆ 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 182 of file eda_text.h.

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

EDA_TEXT::TE_BOLD

Definition: eda_text.h:394

TEXT_EFFECTS m_e

Definition: eda_text.h:389

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:108

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

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )

inlineinherited

Definition at line 130 of file eda_item.h.

130 { SetFlags( BRIGHTENED ); }

EDA_ITEM::SetFlags

void SetFlags(EDA_ITEM_FLAGS aMask)

Definition: eda_item.h:153

BRIGHTENED

#define BRIGHTENED

item is drawn with a bright contour

Definition: eda_item_flags.h:65

References BRIGHTENED, and EDA_ITEM::SetFlags().

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

◆ SetConnectivityDirty()

void SCH_ITEM::SetConnectivityDirty ( bool aDirty = true )

inlineinherited

Definition at line 422 of file sch_item.h.

422 { m_connectivity_dirty = aDirty; }

SCH_ITEM::m_connectivity_dirty

bool m_connectivity_dirty

Definition: sch_item.h:504

References SCH_ITEM::m_connectivity_dirty.

Referenced by SCH_EDIT_FRAME::SaveCopyInUndoList().

◆ SetEdge()

void SCH_SHEET_PIN::SetEdge ( SHEET_SIDE aEdge )

Definition at line 115 of file sch_sheet_pin.cpp.

 {
     SCH_SHEET* Sheet = GetParent();
 
     // use SHEET_UNDEFINED_SIDE to adjust text orientation without changing edge
 
     switch( aEdge )
     {
     case SHEET_SIDE::LEFT:
         m_edge = aEdge;
         SetTextX( Sheet->m_pos.x );
         SetLabelSpinStyle( LABEL_SPIN_STYLE::RIGHT ); // Orientation horiz inverse
         break;
 
     case SHEET_SIDE::RIGHT:
         m_edge = aEdge;
         SetTextX( Sheet->m_pos.x + Sheet->m_size.x );
         SetLabelSpinStyle( LABEL_SPIN_STYLE::LEFT ); // Orientation horiz normal
         break;
 
     case SHEET_SIDE::TOP:
         m_edge = aEdge;
         SetTextY( Sheet->m_pos.y );
         SetLabelSpinStyle( LABEL_SPIN_STYLE::BOTTOM ); // Orientation vert BOTTOM
         break;
 
     case SHEET_SIDE::BOTTOM:
         m_edge = aEdge;
         SetTextY( Sheet->m_pos.y + Sheet->m_size.y );
         SetLabelSpinStyle( LABEL_SPIN_STYLE::UP ); // Orientation vert UP
         break;
 
     default:
         break;
     }
 }

References BOTTOM, LABEL_SPIN_STYLE::BOTTOM, GetParent(), LEFT, LABEL_SPIN_STYLE::LEFT, m_edge, SCH_SHEET::m_pos, SCH_SHEET::m_size, RIGHT, LABEL_SPIN_STYLE::RIGHT, SCH_HIERLABEL::SetLabelSpinStyle(), EDA_TEXT::SetTextX(), EDA_TEXT::SetTextY(), TOP, and LABEL_SPIN_STYLE::UP.

Referenced by ConstrainOnEdge(), MirrorHorizontally(), MirrorVertically(), SCH_ALTIUM_PLUGIN::ParseSheetEntry(), SCH_SHEET_PIN(), and SwapData().

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

◆ SetFieldsAutoplaced()

void SCH_ITEM::SetFieldsAutoplaced ( )

inlineinherited

Definition at line 431 of file sch_item.h.

431 { m_fieldsAutoplaced = FIELDS_AUTOPLACED_AUTO; }

FIELDS_AUTOPLACED_AUTO

Definition: sch_item.h:55

SCH_ITEM::m_fieldsAutoplaced

FIELDS_AUTOPLACED m_fieldsAutoplaced

Definition: sch_item.h:494

References FIELDS_AUTOPLACED_AUTO, and SCH_ITEM::m_fieldsAutoplaced.

◆ SetFlags()

void EDA_ITEM::SetFlags ( EDA_ITEM_FLAGS aMask )

inlineinherited

Definition at line 153 of file eda_item.h.

153 { m_flags |= aMask; }

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

References EDA_ITEM::m_flags.

◆ SetForceVisible()

void EDA_ITEM::SetForceVisible ( bool aEnable )

inlineinherited

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

Parameters

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

Definition at line 204 of file eda_item.h.

204 { m_forceVisible = aEnable; }

EDA_ITEM::m_forceVisible

bool m_forceVisible

Definition: eda_item.h:480

References EDA_ITEM::m_forceVisible.

Referenced by SCH_EDITOR_CONTROL::UpdateFind().

◆ SetHorizJustify()

void EDA_TEXT::SetHorizJustify ( EDA_TEXT_HJUSTIFY_T aType )

inlineinherited

Definition at line 201 of file eda_text.h.

201 { 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(), DRAWING_TOOL::DrawBoardCharacteristics(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), DRAWING_TOOL::DrawSpecificationStackup(), 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(), and DIALOG_FIELD_PROPERTIES::updateText().

TEXT_EFFECTS m_e

Definition: eda_text.h:389

TEXT_EFFECTS::hjustify

signed char hjustify

horizontal justification

Definition: eda_text.h:101

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

◆ SetIsDangling()

void SCH_TEXT::SetIsDangling ( bool aIsDangling )

inlineinherited

Definition at line 231 of file sch_text.h.

231 { m_isDangling = aIsDangling; }

SCH_TEXT::m_isDangling

bool m_isDangling

True if not connected to another object if the object derive from SCH_TEXT supports connections.

Definition: sch_text.h:262

References SCH_TEXT::m_isDangling.

Referenced by SCH_EDIT_TOOL::ChangeTextType(), and PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems().

◆ SetItalic()

void EDA_TEXT::SetItalic ( bool isItalic )

inlineinherited

Definition at line 179 of file eda_text.h.

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

TEXT_EFFECTS m_e

Definition: eda_text.h:389

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::DrawBoardCharacteristics(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawSpecificationStackup(), 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:108

EDA_TEXT::TE_ITALIC

Definition: eda_text.h:393

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

◆ SetLabelSpinStyle()

void SCH_HIERLABEL::SetLabelSpinStyle ( LABEL_SPIN_STYLE aSpinStyle )

overridevirtualinherited

Set a spin or rotation angle, along with specific horizontal and vertical justification styles with each angle.

Parameters

aSpinStyle Spin style as per LABEL_SPIN_STYLE storage class, may be the enum values or int value

Reimplemented from SCH_TEXT.

Definition at line 1548 of file sch_text.cpp.

 {
     m_spin_style = aSpinStyle;
 
     // Assume "Right" and Left" mean which side of the port symbol the text will be on
     // If we are left of the symbol, we want to right justify to line up with the symbol
     switch( aSpinStyle )
     {
     default:
         wxLogWarning( "SetLabelSpinStyle bad spin style" );
         break;
 
     case LABEL_SPIN_STYLE::LEFT:
         //
         m_spin_style = LABEL_SPIN_STYLE::LEFT; // Handle the error spin style by resetting
         SetTextAngle( TEXT_ANGLE_HORIZ );
         SetHorizJustify( GR_TEXT_HJUSTIFY_RIGHT );
         SetVertJustify( GR_TEXT_VJUSTIFY_CENTER );
         break;
 
     case LABEL_SPIN_STYLE::UP:
         SetTextAngle( TEXT_ANGLE_VERT );
         SetHorizJustify( GR_TEXT_HJUSTIFY_LEFT );
         SetVertJustify( GR_TEXT_VJUSTIFY_CENTER );
         break;
 
     case LABEL_SPIN_STYLE::RIGHT:
         SetTextAngle( TEXT_ANGLE_HORIZ );
         SetHorizJustify( GR_TEXT_HJUSTIFY_LEFT );
         SetVertJustify( GR_TEXT_VJUSTIFY_CENTER );
         break;
 
     case LABEL_SPIN_STYLE::BOTTOM:
         SetTextAngle( TEXT_ANGLE_VERT );
         SetHorizJustify( GR_TEXT_HJUSTIFY_RIGHT );
         SetVertJustify( GR_TEXT_VJUSTIFY_CENTER );
         break;
     }
 }

References LABEL_SPIN_STYLE::BOTTOM, GR_TEXT_HJUSTIFY_LEFT, GR_TEXT_HJUSTIFY_RIGHT, GR_TEXT_VJUSTIFY_CENTER, LABEL_SPIN_STYLE::LEFT, SCH_TEXT::m_spin_style, LABEL_SPIN_STYLE::RIGHT, EDA_TEXT::SetHorizJustify(), EDA_TEXT::SetTextAngle(), EDA_TEXT::SetVertJustify(), TEXT_ANGLE_HORIZ, TEXT_ANGLE_VERT, and LABEL_SPIN_STYLE::UP.

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), CADSTAR_SCH_ARCHIVE_LOADER::loadHierarchicalSheetPins(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), SCH_ALTIUM_PLUGIN::ParseSheetEntry(), and SetEdge().

◆ SetLayer()

void SCH_ITEM::SetLayer ( SCH_LAYER_ID aLayer )

inlineinherited

Set the layer this item is on.

Parameters

aLayer The layer number.

Definition at line 275 of file sch_item.h.

275 { m_layer = aLayer; }

SCH_ITEM::m_layer

SCH_LAYER_ID m_layer

Definition: sch_item.h:492

References SCH_ITEM::m_layer.

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), KIGFX::SCH_PAINTER::draw(), CADSTAR_SCH_ARCHIVE_LOADER::loadBusses(), CADSTAR_SCH_ARCHIVE_LOADER::loadGraphicStaightSegment(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), SCH_NO_CONNECT::SCH_NO_CONNECT(), SCH_FIELD::SetId(), and CONNECTION_GRAPH::updateItemConnectivity().

◆ SetLocked()

virtual void SCH_ITEM::SetLocked ( bool aLocked )

inlinevirtualinherited

Set the 'lock' status to aLocked for of this item.

Definition at line 256 of file sch_item.h.

256 {}

◆ SetMirrored()

void EDA_TEXT::SetMirrored ( bool isMirrored )

inlineinherited

Definition at line 188 of file eda_text.h.

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

EDA_TEXT::TE_MIRROR

Definition: eda_text.h:392

TEXT_EFFECTS m_e

Definition: eda_text.h:389

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), PCAD2KICAD::PCB_FOOTPRINT::AddToBoard(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), EDA_TEXT_DESC::EDA_TEXT_DESC(), PCB_TEXT::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:108

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 195 of file eda_text.h.

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

TEXT_EFFECTS m_e

Definition: eda_text.h:389

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(), PCB_EDIT_FRAME::ExchangeFootprint(), LIB_SYMBOL::Flatten(), FOOTPRINT::FOOTPRINT(), PCB_IO::FootprintSave(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), CADSTAR_SCH_ARCHIVE_LOADER::getKiCadSchText(), LIB_SYMBOL::LIB_SYMBOL(), SCH_LEGACY_PLUGIN_CACHE::loadAliases(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), SCH_SEXPR_PLUGIN::loadHierarchy(), SCH_LEGACY_PLUGIN::loadHierarchy(), 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(), 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:108

EDA_TEXT::TE_MULTILINE

Definition: eda_text.h:395

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

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

◆ SetNumber()

void SCH_SHEET_PIN::SetNumber ( int aNumber )

Set the sheet label number.

Parameters

aNumber New sheet number label.

Definition at line 107 of file sch_sheet_pin.cpp.

 {
     wxASSERT( aNumber >= 2 );
 
     m_number = aNumber;
 }

References m_number.

Referenced by SwapData().

◆ SetParent()

virtual void EDA_ITEM::SetParent ( EDA_ITEM * aParent )

inlinevirtualinherited

Reimplemented in PCB_DIMENSION_BASE.

Definition at line 116 of file eda_item.h.

116 { m_parent = aParent; }

EDA_ITEM::m_parent

EDA_ITEM * m_parent

Linked list: Link (parent struct)

Definition: eda_item.h:479

References EDA_ITEM::m_parent.

◆ SetPosition()

void SCH_SHEET_PIN::SetPosition ( const wxPoint & aPosition )

inlineoverridevirtual

Reimplemented from EDA_ITEM.

Definition at line 177 of file sch_sheet_pin.h.

177 { ConstrainOnEdge( aPosition ); }

SCH_SHEET_PIN::ConstrainOnEdge

void ConstrainOnEdge(wxPoint Pos)

Adjust label position to edge based on proximity to vertical or horizontal edge of the parent sheet.

Definition: sch_sheet_pin.cpp:159

References ConstrainOnEdge().

Referenced by SCH_DRAWING_TOOLS::createSheetPin(), and SCH_ALTIUM_PLUGIN::ParseSheetEntry().

◆ SetSelected()

void EDA_ITEM::SetSelected ( )

inlineinherited

Definition at line 129 of file eda_item.h.

129 { SetFlags( SELECTED ); }

EDA_ITEM::SetFlags

void SetFlags(EDA_ITEM_FLAGS aMask)

Definition: eda_item.h:153

SELECTED

#define SELECTED

Definition: eda_item_flags.h:48

References SELECTED, and EDA_ITEM::SetFlags().

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

◆ SetShape()

void SCH_TEXT::SetShape ( PINSHEETLABEL_SHAPE aShape )

inlineinherited

Definition at line 163 of file sch_text.h.

163 { m_shape = aShape; }

SCH_TEXT::m_shape

PINSHEETLABEL_SHAPE m_shape

Definition: sch_text.h:258

References SCH_TEXT::m_shape.

Referenced by SCH_EDIT_TOOL::ChangeTextType(), SCH_DRAWING_TOOLS::createNewText(), SCH_DRAWING_TOOLS::createSheetPin(), CADSTAR_SCH_ARCHIVE_LOADER::loadHierarchicalSheetPins(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), SCH_ALTIUM_PLUGIN::ParsePort(), SCH_ALTIUM_PLUGIN::ParseSheetEntry(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), and DIALOG_TEXT_AND_LABEL_PROPERTIES::TransferDataFromWindow().

◆ SetState()

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

inlineinherited

Definition at line 142 of file eda_item.h.

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

References EDA_ITEM::m_status.

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

◆ SetStatus()

void EDA_ITEM::SetStatus ( EDA_ITEM_FLAGS aStatus )

inlineinherited

Definition at line 151 of file eda_item.h.

151 { m_status = aStatus; }

EDA_ITEM::m_status

EDA_ITEM_FLAGS m_status

Definition: eda_item.h:478

References EDA_ITEM::m_status.

Referenced by BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ SetStoredPos()

void SCH_ITEM::SetStoredPos ( const wxPoint & aPos )

inlineinherited

Definition at line 232 of file sch_item.h.

232 { m_storedPos = aPos; }

SCH_ITEM::m_storedPos

wxPoint m_storedPos

Definition: sch_item.h:495

References SCH_ITEM::m_storedPos.

Referenced by SCH_MOVE_TOOL::Main().

◆ SetStroke()

virtual void SCH_ITEM::SetStroke ( const STROKE_PARAMS & aStroke )

inlinevirtualinherited

Reimplemented in SCH_LINE, and SCH_BUS_ENTRY_BASE.

Definition at line 462 of file sch_item.h.

462 { wxCHECK( false, /* void */ ); }

◆ SetText()

void EDA_TEXT::SetText ( const wxString & aText )

virtualinherited

Definition at line 114 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(), 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(), TUNER_SLIDER::onSave(), 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_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_AND_LABEL_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(), and PCB_DIMENSION_BASE::updateText().

◆ SetTextAngle()

virtual void EDA_TEXT::SetTextAngle ( double aAngle )

inlinevirtualinherited

Reimplemented in DS_DRAW_ITEM_TEXT, FP_TEXT, and PCB_TEXT.

Definition at line 167 of file eda_text.h.

     {
         // Higher level classes may be more restrictive than this by overloading
         // SetTextAngle() or merely calling EDA_TEXT::SetTextAngle() after clamping
         // aAngle before calling this lowest inline accessor.
         m_e.angle = aAngle;
     }

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

Referenced by GRAPHICS_IMPORTER_PCBNEW::AddText(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), SCH_GLOBALLABEL::AutoplaceFields(), eagleToKicadAlignment(), LIB_TEXT::HitTest(), LIB_FIELD::HitTest(), LIB_FIELD::Init(), SCH_LEGACY_PLUGIN_CACHE::loadField(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), SCH_LEGACY_PLUGIN::loadSymbol(), DIALOG_SHEET_PROPERTIES::OnAddField(), DIALOG_SYMBOL_PROPERTIES::OnAddField(), SCH_ALTIUM_PLUGIN::ParsePowerPort(), ALTIUM_PCB::ParseTexts6Data(), SCH_EDIT_TOOL::Rotate(), LIB_TEXT::Rotate(), LIB_FIELD::Rotate(), SCH_GLOBALLABEL::Rotate90(), SCH_TEXT::SetLabelSpinStyle(), SCH_GLOBALLABEL::SetLabelSpinStyle(), SCH_HIERLABEL::SetLabelSpinStyle(), PCB_TEXT::SetTextAngle(), FP_TEXT::SetTextAngle(), DS_DRAW_ITEM_TEXT::SetTextAngle(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), and DIALOG_FIELD_PROPERTIES::updateText().

◆ SetTextHeight()

void EDA_TEXT::SetTextHeight ( int aHeight )

inlineinherited

Definition at line 243 of file eda_text.h.

243 { m_e.size.y = aHeight; }

TEXT_EFFECTS m_e

Definition: eda_text.h:389

wxSize size

Definition: eda_text.h:103

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 246 of file eda_text.h.

246 { m_e.pos = aPoint; }

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(), DRAWING_TOOL::DrawBoardCharacteristics(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), DRAWING_TOOL::DrawSpecificationStackup(), 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(), PCB_TEXT::Rotate(), LIB_TEXT::Rotate(), FP_TEXT::Rotate(), LIB_FIELD::Rotate(), SCH_TEXT::Rotate(), PCB_DIMENSION_BASE::Rotate(), SCH_GLOBALLABEL::Rotate(), SCH_GLOBALLABEL::Rotate90(), SCH_FIELD::SCH_FIELD(), SCH_SHEET_PIN(), SCH_TEXT::SCH_TEXT(), FP_TEXT::SetDrawCoord(), PCB_TEXT::SetPosition(), FP_TEXT::SetPosition(), SCH_FIELD::SetPosition(), SCH_TEXT::SetPosition(), DS_DRAW_ITEM_TEXT::SetPosition(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), SCH_SYMBOL::UpdateFields(), DIALOG_FIELD_PROPERTIES::updateText(), PCB_DIM_ALIGNED::updateText(), and PCB_DIM_ORTHOGONAL::updateText().

TEXT_EFFECTS m_e

Definition: eda_text.h:389

TEXT_EFFECTS::pos

wxPoint pos

Definition: eda_text.h:106

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

◆ SetTextSize()

void EDA_TEXT::SetTextSize ( const wxSize & aNewSize )

inlineinherited

Definition at line 237 of file eda_text.h.

237 { m_e.size = aNewSize; }

TEXT_EFFECTS m_e

Definition: eda_text.h:389