KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
TEARDROP_PARAMETERS Class Reference

TEARDROP_PARAMETARS is a helper class to handle parameters needed to build teardrops for a board these parameters are sizes and filters. More...

#include <teardrop_parameters.h>

Public Member Functions

 TEARDROP_PARAMETERS ()
 
void SetTeardropMaxSize (int aMaxLen, int aMaxHeight)
 Set max allowed length and height for teardrops in IU.
 
void SetTeardropSizeRatio (double aLenghtRatio=0.5, double aHeightRatio=1.0)
 Set prefered length and height ratio for teardrops the prefered length and height are VIAPAD width * aLenghtRatio and VIAPAD width * aHeightRatio.
 
void SetTeardropCurvedPrm (int aCurveSegCount=0)
 Set the teardrop curved or straight.
 
bool IsCurved () const
 
bool operator== (const TEARDROP_PARAMETERS &aOther) const
 
bool operator!= (const TEARDROP_PARAMETERS &aOther) const
 

Public Attributes

int m_TdMaxLen
 max allowed length for teardrops in IU. <= 0 to disable
 
int m_TdMaxWidth
 max allowed height for teardrops in IU. <= 0 to disable
 
double m_BestLengthRatio
 The length of a teardrop as ratio between length and size of pad/via.
 
double m_BestWidthRatio
 The height of a teardrop as ratio between height and size of pad/via.
 
double m_WidthtoSizeFilterRatio
 The ratio (H/D) between the via/pad size and the track width max value to create a teardrop 1.0 (100 %) always creates a teardrop, 0.0 (0%) never create a teardrop.
 
int m_CurveSegCount
 True if the teardrop should be curved.
 
bool m_Enabled
 Flag to enable teardrops.
 
bool m_AllowUseTwoTracks
 True to create teardrops using 2 track segments if the first in too small.
 
bool m_TdOnPadsInZones
 A filter to exclude pads inside zone fills.
 

Detailed Description

TEARDROP_PARAMETARS is a helper class to handle parameters needed to build teardrops for a board these parameters are sizes and filters.

Definition at line 47 of file teardrop_parameters.h.

Constructor & Destructor Documentation

◆ TEARDROP_PARAMETERS()

TEARDROP_PARAMETERS::TEARDROP_PARAMETERS ( )
inline

Definition at line 50 of file teardrop_parameters.h.

Member Function Documentation

◆ IsCurved()

bool TEARDROP_PARAMETERS::IsCurved ( ) const
inline

Definition at line 92 of file teardrop_parameters.h.

References m_CurveSegCount.

Referenced by TEARDROP_MANAGER::computeTeardropPolygon(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DIALOG_PAD_PROPERTIES::initValues(), and PANEL_SETUP_TEARDROPS::TransferDataToWindow().

◆ operator!=()

bool TEARDROP_PARAMETERS::operator!= ( const TEARDROP_PARAMETERS &  aOther) const
inline

Definition at line 107 of file teardrop_parameters.h.

◆ operator==()

bool TEARDROP_PARAMETERS::operator== ( const TEARDROP_PARAMETERS &  aOther) const
inline

Definition at line 94 of file teardrop_parameters.h.

References m_AllowUseTwoTracks, m_BestLengthRatio, m_BestWidthRatio, m_CurveSegCount, m_Enabled, m_TdMaxLen, m_TdMaxWidth, m_TdOnPadsInZones, and m_WidthtoSizeFilterRatio.

◆ SetTeardropCurvedPrm()

void TEARDROP_PARAMETERS::SetTeardropCurvedPrm ( int  aCurveSegCount = 0)
inline

Set the teardrop curved or straight.

Definition at line 87 of file teardrop_parameters.h.

References m_CurveSegCount.

◆ SetTeardropMaxSize()

void TEARDROP_PARAMETERS::SetTeardropMaxSize ( int  aMaxLen,
int  aMaxHeight 
)
inline

Set max allowed length and height for teardrops in IU.

a value <= 0 disable the constraint

Definition at line 67 of file teardrop_parameters.h.

References m_TdMaxLen, and m_TdMaxWidth.

◆ SetTeardropSizeRatio()

void TEARDROP_PARAMETERS::SetTeardropSizeRatio ( double  aLenghtRatio = 0.5,
double  aHeightRatio = 1.0 
)
inline

Set prefered length and height ratio for teardrops the prefered length and height are VIAPAD width * aLenghtRatio and VIAPAD width * aHeightRatio.

Definition at line 78 of file teardrop_parameters.h.

References m_BestLengthRatio, and m_BestWidthRatio.

Member Data Documentation

◆ m_AllowUseTwoTracks

bool TEARDROP_PARAMETERS::m_AllowUseTwoTracks

True to create teardrops using 2 track segments if the first in too small.

Definition at line 130 of file teardrop_parameters.h.

Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), TEARDROP_MANAGER::findAnchorPointsOnTrack(), PCB_IO_KICAD_SEXPR::formatTeardropParameters(), BOARD_CONNECTED_ITEM::GetTeardropAllowSpanTwoTracks(), DIALOG_PAD_PROPERTIES::initValues(), isDefaultTeardropParameters(), operator==(), PCB_IO_KICAD_SEXPR_PARSER::parseTEARDROP_PARAMETERS(), DIALOG_GLOBAL_EDIT_TEARDROPS::setSpecifiedParams(), BOARD_CONNECTED_ITEM::SetTeardropAllowSpanTwoTracks(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), PANEL_SETUP_TEARDROPS::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::transferDataToPad(), and PANEL_SETUP_TEARDROPS::TransferDataToWindow().

◆ m_BestLengthRatio

double TEARDROP_PARAMETERS::m_BestLengthRatio

The length of a teardrop as ratio between length and size of pad/via.

Definition at line 118 of file teardrop_parameters.h.

Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), TEARDROP_MANAGER::findAnchorPointsOnTrack(), PCB_IO_KICAD_SEXPR::formatTeardropParameters(), BOARD_CONNECTED_ITEM::GetTeardropBestLengthRatio(), DIALOG_PAD_PROPERTIES::initValues(), isDefaultTeardropParameters(), operator==(), PCB_IO_KICAD_SEXPR_PARSER::parseTEARDROP_PARAMETERS(), DIALOG_GLOBAL_EDIT_TEARDROPS::setSpecifiedParams(), BOARD_CONNECTED_ITEM::SetTeardropBestLengthRatio(), SetTeardropSizeRatio(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), PANEL_SETUP_TEARDROPS::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::transferDataToPad(), and PANEL_SETUP_TEARDROPS::TransferDataToWindow().

◆ m_BestWidthRatio

double TEARDROP_PARAMETERS::m_BestWidthRatio

The height of a teardrop as ratio between height and size of pad/via.

Definition at line 120 of file teardrop_parameters.h.

Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), TEARDROP_MANAGER::computeAnchorPoints(), TEARDROP_MANAGER::computeCurvedForRoundShape(), TEARDROP_MANAGER::computeTeardropPolygon(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), PCB_IO_KICAD_SEXPR::formatTeardropParameters(), BOARD_CONNECTED_ITEM::GetTeardropBestWidthRatio(), DIALOG_PAD_PROPERTIES::initValues(), isDefaultTeardropParameters(), operator==(), PCB_IO_KICAD_SEXPR_PARSER::parseTEARDROP_PARAMETERS(), DIALOG_GLOBAL_EDIT_TEARDROPS::setSpecifiedParams(), BOARD_CONNECTED_ITEM::SetTeardropBestWidthRatio(), SetTeardropSizeRatio(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), PANEL_SETUP_TEARDROPS::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::transferDataToPad(), PANEL_SETUP_TEARDROPS::TransferDataToWindow(), and TEARDROP_MANAGER::UpdateTeardrops().

◆ m_CurveSegCount

int TEARDROP_PARAMETERS::m_CurveSegCount

True if the teardrop should be curved.

Definition at line 125 of file teardrop_parameters.h.

Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), PCB_IO_KICAD_SEXPR::formatTeardropParameters(), BOARD_CONNECTED_ITEM::GetTeardropCurved(), IsCurved(), isDefaultTeardropParameters(), operator==(), PCB_IO_KICAD_SEXPR_PARSER::parseTEARDROP_PARAMETERS(), DIALOG_GLOBAL_EDIT_TEARDROPS::setSpecifiedParams(), BOARD_CONNECTED_ITEM::SetTeardropCurved(), SetTeardropCurvedPrm(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), PANEL_SETUP_TEARDROPS::TransferDataFromWindow(), and DIALOG_PAD_PROPERTIES::transferDataToPad().

◆ m_Enabled

bool TEARDROP_PARAMETERS::m_Enabled

Flag to enable teardrops.

Definition at line 128 of file teardrop_parameters.h.

Referenced by DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), PCB_IO_KICAD_SEXPR::formatTeardropParameters(), BOARD_CONNECTED_ITEM::GetTeardropsEnabled(), DIALOG_PAD_PROPERTIES::initValues(), isDefaultTeardropParameters(), operator==(), PCB_IO_KICAD_SEXPR_PARSER::parseTEARDROP_PARAMETERS(), DIALOG_GLOBAL_EDIT_TEARDROPS::processItem(), BOARD_CONNECTED_ITEM::SetTeardropsEnabled(), DIALOG_GLOBAL_EDIT_TEARDROPS::TransferDataFromWindow(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::transferDataToPad(), and TEARDROP_MANAGER::UpdateTeardrops().

◆ m_TdMaxLen

int TEARDROP_PARAMETERS::m_TdMaxLen

max allowed length for teardrops in IU. <= 0 to disable

Definition at line 114 of file teardrop_parameters.h.

Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), TEARDROP_MANAGER::findAnchorPointsOnTrack(), PCB_IO_KICAD_SEXPR::formatTeardropParameters(), BOARD_CONNECTED_ITEM::GetTeardropMaxLength(), DIALOG_PAD_PROPERTIES::initValues(), isDefaultTeardropParameters(), operator==(), PCB_IO_KICAD_SEXPR_PARSER::parseTEARDROP_PARAMETERS(), DIALOG_GLOBAL_EDIT_TEARDROPS::setSpecifiedParams(), BOARD_CONNECTED_ITEM::SetTeardropMaxLength(), SetTeardropMaxSize(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), PANEL_SETUP_TEARDROPS::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::transferDataToPad(), and PANEL_SETUP_TEARDROPS::TransferDataToWindow().

◆ m_TdMaxWidth

int TEARDROP_PARAMETERS::m_TdMaxWidth

max allowed height for teardrops in IU. <= 0 to disable

Definition at line 116 of file teardrop_parameters.h.

Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), TEARDROP_MANAGER::computeAnchorPoints(), TEARDROP_MANAGER::computeCurvedForRoundShape(), TEARDROP_MANAGER::computeTeardropPolygon(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), PCB_IO_KICAD_SEXPR::formatTeardropParameters(), BOARD_CONNECTED_ITEM::GetTeardropMaxWidth(), DIALOG_PAD_PROPERTIES::initValues(), isDefaultTeardropParameters(), operator==(), PCB_IO_KICAD_SEXPR_PARSER::parseTEARDROP_PARAMETERS(), DIALOG_GLOBAL_EDIT_TEARDROPS::setSpecifiedParams(), SetTeardropMaxSize(), BOARD_CONNECTED_ITEM::SetTeardropMaxWidth(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), PANEL_SETUP_TEARDROPS::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::transferDataToPad(), PANEL_SETUP_TEARDROPS::TransferDataToWindow(), and TEARDROP_MANAGER::UpdateTeardrops().

◆ m_TdOnPadsInZones

bool TEARDROP_PARAMETERS::m_TdOnPadsInZones

A filter to exclude pads inside zone fills.

Definition at line 132 of file teardrop_parameters.h.

Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), PCB_IO_KICAD_SEXPR::formatTeardropParameters(), BOARD_CONNECTED_ITEM::GetTeardropPreferZoneConnections(), DIALOG_PAD_PROPERTIES::initValues(), isDefaultTeardropParameters(), operator==(), PCB_IO_KICAD_SEXPR_PARSER::parseTEARDROP_PARAMETERS(), DIALOG_GLOBAL_EDIT_TEARDROPS::setSpecifiedParams(), BOARD_CONNECTED_ITEM::SetTeardropPreferZoneConnections(), PANEL_SETUP_TEARDROPS::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::transferDataToPad(), PANEL_SETUP_TEARDROPS::TransferDataToWindow(), and TEARDROP_MANAGER::UpdateTeardrops().

◆ m_WidthtoSizeFilterRatio

double TEARDROP_PARAMETERS::m_WidthtoSizeFilterRatio

The ratio (H/D) between the via/pad size and the track width max value to create a teardrop 1.0 (100 %) always creates a teardrop, 0.0 (0%) never create a teardrop.

Definition at line 123 of file teardrop_parameters.h.

Referenced by TEARDROP_MANAGER::AddTeardropsOnTracks(), BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), PCB_IO_KICAD_SEXPR::formatTeardropParameters(), BOARD_CONNECTED_ITEM::GetTeardropMaxTrackWidth(), DIALOG_PAD_PROPERTIES::initValues(), isDefaultTeardropParameters(), operator==(), PCB_IO_KICAD_SEXPR_PARSER::parseTEARDROP_PARAMETERS(), DIALOG_GLOBAL_EDIT_TEARDROPS::setSpecifiedParams(), BOARD_CONNECTED_ITEM::SetTeardropMaxTrackWidth(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), PANEL_SETUP_TEARDROPS::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::transferDataToPad(), PANEL_SETUP_TEARDROPS::TransferDataToWindow(), and TEARDROP_MANAGER::UpdateTeardrops().

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