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

Creepage: a board edge shape. More...

#include <drc_creepage_utils.h>

Inheritance diagram for BE_SHAPE:
CREEP_SHAPE BE_SHAPE_CIRCLE BE_SHAPE_POINT BE_SHAPE_ARC

Public Types

enum class  TYPE { UNDEFINED = 0 , POINT , CIRCLE , ARC }
 

Public Member Functions

 BE_SHAPE ()
 
virtual int GetRadius () const
 
virtual EDA_ANGLE GetStartAngle () const
 
virtual EDA_ANGLE GetEndAngle () const
 
virtual VECTOR2I GetStartPoint () const
 
virtual VECTOR2I GetEndPoint () const
 
VECTOR2I GetPos () const
 
CREEP_SHAPE::TYPE GetType () const
 
const BOARD_ITEM * GetParent () const
 
void SetParent (BOARD_ITEM *aParent)
 
virtual void ConnectChildren (std::shared_ptr< GraphNode > &a1, std::shared_ptr< GraphNode > &a2, CreepageGraph &aG) const
 
std::vector< PATH_CONNECTION > ReversePaths (const std::vector< PATH_CONNECTION > &aV) const
 
std::vector< PATH_CONNECTION > Paths (const CREEP_SHAPE &aS2, double aMaxWeight, double aMaxSquaredWeight) const
 
virtual std::vector< PATH_CONNECTION > Paths (const BE_SHAPE_POINT &aS2, double aMaxWeight, double aMaxSquaredWeight) const
 
virtual std::vector< PATH_CONNECTION > Paths (const BE_SHAPE_CIRCLE &aS2, double aMaxWeight, double aMaxSquaredWeight) const
 
virtual std::vector< PATH_CONNECTION > Paths (const BE_SHAPE_ARC &aS2, double aMaxWeight, double aMaxSquaredWeight) const
 
virtual std::vector< PATH_CONNECTION > Paths (const CU_SHAPE_SEGMENT &aS2, double aMaxWeight, double aMaxSquaredWeight) const
 
virtual std::vector< PATH_CONNECTION > Paths (const CU_SHAPE_CIRCLE &aS2, double aMaxWeight, double aMaxSquaredWeight) const
 
virtual std::vector< PATH_CONNECTION > Paths (const CU_SHAPE_ARC &aS2, double aMaxWeight, double aMaxSquaredWeight) const
 
bool IsConductive ()
 

Protected Attributes

bool m_conductive = false
 
BOARD_ITEM * m_parent = nullptr
 
VECTOR2I m_pos = VECTOR2I( 0, 0 )
 
CREEP_SHAPE::TYPE m_type = CREEP_SHAPE::TYPE::UNDEFINED
 

Detailed Description

Creepage: a board edge shape.

Definition at line 272 of file drc_creepage_utils.h.

Member Enumeration Documentation

◆ TYPE

enum class CREEP_SHAPE::TYPE
stronginherited
Enumerator
UNDEFINED 
POINT 
CIRCLE 
ARC 

Definition at line 164 of file drc_creepage_utils.h.

Constructor & Destructor Documentation

◆ BE_SHAPE()

BE_SHAPE::BE_SHAPE ( )
inline

Definition at line 275 of file drc_creepage_utils.h.

References CREEP_SHAPE::m_conductive.

Member Function Documentation

◆ ConnectChildren()

void CREEP_SHAPE::ConnectChildren ( std::shared_ptr< GraphNode > &  a1,
std::shared_ptr< GraphNode > &  a2,
CreepageGraph &  aG 
) const
virtualinherited

Reimplemented in BE_SHAPE_POINT, BE_SHAPE_CIRCLE, and BE_SHAPE_ARC.

Definition at line 704 of file drc_creepage_utils.cpp.

◆ GetEndAngle()

virtual EDA_ANGLE CREEP_SHAPE::GetEndAngle ( ) const
inlinevirtualinherited

Reimplemented in CU_SHAPE_ARC, and BE_SHAPE_ARC.

Definition at line 178 of file drc_creepage_utils.h.

◆ GetEndPoint()

virtual VECTOR2I CREEP_SHAPE::GetEndPoint ( ) const
inlinevirtualinherited

Reimplemented in CU_SHAPE_ARC, and BE_SHAPE_ARC.

Definition at line 180 of file drc_creepage_utils.h.

◆ GetParent()

const BOARD_ITEM * CREEP_SHAPE::GetParent ( ) const
inlineinherited

Definition at line 183 of file drc_creepage_utils.h.

References CREEP_SHAPE::m_parent.

◆ GetPos()

VECTOR2I CREEP_SHAPE::GetPos ( ) const
inlineinherited

Definition at line 181 of file drc_creepage_utils.h.

References CREEP_SHAPE::m_pos.

Referenced by CreepageGraph::Addshape(), areEquivalent(), compareShapes(), GraphConnection::GetShapes(), BE_SHAPE_ARC::IsThereATangentPassingThroughPoint(), CU_SHAPE_CIRCLE::Paths(), CU_SHAPE_ARC::Paths(), BE_SHAPE_CIRCLE::Paths(), BE_SHAPE_ARC::Paths(), CU_SHAPE_SEGMENT::Paths(), and BE_SHAPE_POINT::Paths().

◆ GetRadius()

virtual int CREEP_SHAPE::GetRadius ( ) const
inlinevirtualinherited

Reimplemented in CU_SHAPE_CIRCLE, CU_SHAPE_ARC, BE_SHAPE_CIRCLE, and BE_SHAPE_ARC.

Definition at line 176 of file drc_creepage_utils.h.

Referenced by areEquivalent(), and compareShapes().

◆ GetStartAngle()

virtual EDA_ANGLE CREEP_SHAPE::GetStartAngle ( ) const
inlinevirtualinherited

Reimplemented in CU_SHAPE_ARC, and BE_SHAPE_ARC.

Definition at line 177 of file drc_creepage_utils.h.

◆ GetStartPoint()

virtual VECTOR2I CREEP_SHAPE::GetStartPoint ( ) const
inlinevirtualinherited

Reimplemented in CU_SHAPE_ARC, and BE_SHAPE_ARC.

Definition at line 179 of file drc_creepage_utils.h.

◆ GetType()

CREEP_SHAPE::TYPE CREEP_SHAPE::GetType ( ) const
inlineinherited

Definition at line 182 of file drc_creepage_utils.h.

References CREEP_SHAPE::m_type.

Referenced by areEquivalent(), and compareShapes().

◆ IsConductive()

bool CREEP_SHAPE::IsConductive ( )
inlineinherited

Definition at line 247 of file drc_creepage_utils.h.

References CREEP_SHAPE::m_conductive.

◆ Paths() [1/7]

virtual std::vector< PATH_CONNECTION > CREEP_SHAPE::Paths ( const BE_SHAPE_ARC &  aS2,
double  aMaxWeight,
double  aMaxSquaredWeight 
) const
inlinevirtualinherited

Reimplemented in CU_SHAPE_SEGMENT, CU_SHAPE_CIRCLE, CU_SHAPE_ARC, BE_SHAPE_POINT, BE_SHAPE_CIRCLE, and BE_SHAPE_ARC.

Definition at line 221 of file drc_creepage_utils.h.

◆ Paths() [2/7]

virtual std::vector< PATH_CONNECTION > CREEP_SHAPE::Paths ( const BE_SHAPE_CIRCLE &  aS2,
double  aMaxWeight,
double  aMaxSquaredWeight 
) const
inlinevirtualinherited

Reimplemented in CU_SHAPE_SEGMENT, CU_SHAPE_CIRCLE, CU_SHAPE_ARC, BE_SHAPE_POINT, BE_SHAPE_CIRCLE, and BE_SHAPE_ARC.

Definition at line 215 of file drc_creepage_utils.h.

◆ Paths() [3/7]

virtual std::vector< PATH_CONNECTION > CREEP_SHAPE::Paths ( const BE_SHAPE_POINT &  aS2,
double  aMaxWeight,
double  aMaxSquaredWeight 
) const
inlinevirtualinherited

Reimplemented in CU_SHAPE_SEGMENT, CU_SHAPE_CIRCLE, CU_SHAPE_ARC, BE_SHAPE_POINT, BE_SHAPE_CIRCLE, and BE_SHAPE_ARC.

Definition at line 209 of file drc_creepage_utils.h.

◆ Paths() [4/7]

std::vector< PATH_CONNECTION > CREEP_SHAPE::Paths ( const CREEP_SHAPE &  aS2,
double  aMaxWeight,
double  aMaxSquaredWeight 
) const
inlineinherited

Definition at line 203 of file drc_creepage_utils.h.

◆ Paths() [5/7]

virtual std::vector< PATH_CONNECTION > CREEP_SHAPE::Paths ( const CU_SHAPE_ARC &  aS2,
double  aMaxWeight,
double  aMaxSquaredWeight 
) const
inlinevirtualinherited

Reimplemented in CU_SHAPE_SEGMENT, CU_SHAPE_CIRCLE, CU_SHAPE_ARC, BE_SHAPE_POINT, and BE_SHAPE_ARC.

Definition at line 239 of file drc_creepage_utils.h.

◆ Paths() [6/7]

virtual std::vector< PATH_CONNECTION > CREEP_SHAPE::Paths ( const CU_SHAPE_CIRCLE &  aS2,
double  aMaxWeight,
double  aMaxSquaredWeight 
) const
inlinevirtualinherited

Reimplemented in CU_SHAPE_SEGMENT, CU_SHAPE_CIRCLE, CU_SHAPE_ARC, BE_SHAPE_POINT, BE_SHAPE_CIRCLE, and BE_SHAPE_ARC.

Definition at line 233 of file drc_creepage_utils.h.

◆ Paths() [7/7]

virtual std::vector< PATH_CONNECTION > CREEP_SHAPE::Paths ( const CU_SHAPE_SEGMENT &  aS2,
double  aMaxWeight,
double  aMaxSquaredWeight 
) const
inlinevirtualinherited

Reimplemented in CU_SHAPE_SEGMENT, CU_SHAPE_CIRCLE, CU_SHAPE_ARC, BE_SHAPE_POINT, BE_SHAPE_CIRCLE, and BE_SHAPE_ARC.

Definition at line 227 of file drc_creepage_utils.h.

◆ ReversePaths()

std::vector< PATH_CONNECTION > CREEP_SHAPE::ReversePaths ( const std::vector< PATH_CONNECTION > &  aV) const
inlineinherited

Definition at line 189 of file drc_creepage_utils.h.

Referenced by BE_SHAPE_CIRCLE::Paths(), BE_SHAPE_ARC::Paths(), CU_SHAPE_CIRCLE::Paths(), CU_SHAPE_ARC::Paths(), and BE_SHAPE_POINT::Paths().

◆ SetParent()

void CREEP_SHAPE::SetParent ( BOARD_ITEM *  aParent)
inlineinherited

Definition at line 184 of file drc_creepage_utils.h.

References CREEP_SHAPE::m_parent.

Referenced by CreepageGraph::Addshape(), and CreepageGraph::TransformEdgeToCreepShapes().

Member Data Documentation

◆ m_conductive

bool CREEP_SHAPE::m_conductive = false
protectedinherited

Definition at line 251 of file drc_creepage_utils.h.

Referenced by BE_SHAPE(), CU_SHAPE::CU_SHAPE(), and CREEP_SHAPE::IsConductive().

◆ m_parent

BOARD_ITEM* CREEP_SHAPE::m_parent = nullptr
protectedinherited

Definition at line 252 of file drc_creepage_utils.h.

Referenced by CreepageGraph::FindNode(), CREEP_SHAPE::GetParent(), and CREEP_SHAPE::SetParent().

◆ m_pos

VECTOR2I CREEP_SHAPE::m_pos = VECTOR2I( 0, 0 )
protectedinherited

Definition at line 253 of file drc_creepage_utils.h.

Referenced by BE_SHAPE_ARC::AngleBetweenStartAndEnd(), BE_SHAPE_CIRCLE::BE_SHAPE_CIRCLE(), BE_SHAPE_POINT::BE_SHAPE_POINT(), CREEP_SHAPE::GetPos(), BE_SHAPE_ARC::IsThereATangentPassingThroughPoint(), and BE_SHAPE_CIRCLE::ShortenChildDueToGV().

◆ m_type

CREEP_SHAPE::TYPE CREEP_SHAPE::m_type = CREEP_SHAPE::TYPE::UNDEFINED
protectedinherited

Definition at line 254 of file drc_creepage_utils.h.

Referenced by BE_SHAPE_ARC::BE_SHAPE_ARC(), BE_SHAPE_CIRCLE::BE_SHAPE_CIRCLE(), BE_SHAPE_POINT::BE_SHAPE_POINT(), CU_SHAPE_ARC::CU_SHAPE_ARC(), and CREEP_SHAPE::GetType().

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