KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
GEOM_SYNCER Class Referenceabstract

A class that operates over a list of BOUND_CONTROLs and keeps them in sync with a PCB_SHAPE. More...

Inheritance diagram for GEOM_SYNCER:
ARC_GEOM_SYNCER BEZIER_GEOM_SYNCER CIRCLE_GEOM_SYNCER LINE_GEOM_SYNCER RECTANGLE_GEOM_SYNCER

Public Member Functions

 GEOM_SYNCER (PCB_SHAPE &aShape, std::vector< BOUND_CONTROL > &aBoundCtrls)
 
void BindCtrls (size_t aFrom, size_t aTo, std::function< void()> aCb)
 
void SetShape (PCB_SHAPE &aShape)
 
virtual bool Validate (wxArrayString &aErrs) const
 

Protected Member Functions

virtual void updateAll ()=0
 
wxTextCtrl * GetCtrl (size_t aIndex) const
 
int GetIntValue (size_t aIndex) const
 
EDA_ANGLE GetAngleValue (size_t aIndex) const
 
void ChangeValue (size_t aIndex, int aValue)
 
void ChangeAngleValue (size_t aIndex, const EDA_ANGLE &aValue)
 
PCB_SHAPE & GetShape ()
 
const PCB_SHAPE & GetShape () const
 

Private Attributes

PCB_SHAPE & m_shape
 
std::vector< BOUND_CONTROL > & m_boundCtrls
 

Detailed Description

A class that operates over a list of BOUND_CONTROLs and keeps them in sync with a PCB_SHAPE.

Exactly how that is done depends on the kind of shape.

Inherit from this class and implement the relvant update functions and listen for changes on the right controls for each mode (e.g. edit line segment by endpoints).

Definition at line 66 of file pcbnew/dialogs/dialog_shape_properties.cpp.

Constructor & Destructor Documentation

◆ GEOM_SYNCER()

GEOM_SYNCER::GEOM_SYNCER ( PCB_SHAPE & aShape,
std::vector< BOUND_CONTROL > & aBoundCtrls )
inline

Definition at line 69 of file pcbnew/dialogs/dialog_shape_properties.cpp.

References m_boundCtrls, and m_shape.

Referenced by ARC_GEOM_SYNCER::ARC_GEOM_SYNCER(), BEZIER_GEOM_SYNCER::BEZIER_GEOM_SYNCER(), CIRCLE_GEOM_SYNCER::CIRCLE_GEOM_SYNCER(), LINE_GEOM_SYNCER::LINE_GEOM_SYNCER(), and RECTANGLE_GEOM_SYNCER::RECTANGLE_GEOM_SYNCER().

Member Function Documentation

◆ BindCtrls()

void GEOM_SYNCER::BindCtrls ( size_t aFrom,
size_t aTo,
std::function< void()> aCb )
inline

Definition at line 75 of file pcbnew/dialogs/dialog_shape_properties.cpp.

References m_boundCtrls.

Referenced by ARC_GEOM_SYNCER::ARC_GEOM_SYNCER(), BEZIER_GEOM_SYNCER::BEZIER_GEOM_SYNCER(), CIRCLE_GEOM_SYNCER::CIRCLE_GEOM_SYNCER(), LINE_GEOM_SYNCER::LINE_GEOM_SYNCER(), and RECTANGLE_GEOM_SYNCER::RECTANGLE_GEOM_SYNCER().

◆ ChangeAngleValue()

void GEOM_SYNCER::ChangeAngleValue ( size_t aIndex,
const EDA_ANGLE & aValue )
inlineprotected

Definition at line 125 of file pcbnew/dialogs/dialog_shape_properties.cpp.

References m_boundCtrls.

Referenced by ARC_GEOM_SYNCER::updateCSA(), and LINE_GEOM_SYNCER::updatePolar().

◆ ChangeValue()

void GEOM_SYNCER::ChangeValue ( size_t aIndex,
int aValue )
inlineprotected

Definition at line 119 of file pcbnew/dialogs/dialog_shape_properties.cpp.

References m_boundCtrls.

Referenced by BEZIER_GEOM_SYNCER::updateBezier(), CIRCLE_GEOM_SYNCER::updateCenterPoint(), CIRCLE_GEOM_SYNCER::updateCenterRadius(), RECTANGLE_GEOM_SYNCER::updateCenterSize(), RECTANGLE_GEOM_SYNCER::updateCorners(), RECTANGLE_GEOM_SYNCER::updateCornerSize(), ARC_GEOM_SYNCER::updateCSA(), LINE_GEOM_SYNCER::updateEnds(), LINE_GEOM_SYNCER::updatePolar(), ARC_GEOM_SYNCER::updateSME(), and LINE_GEOM_SYNCER::updateStartMidpoint().

◆ GetAngleValue()

EDA_ANGLE GEOM_SYNCER::GetAngleValue ( size_t aIndex) const
inlineprotected

Definition at line 113 of file pcbnew/dialogs/dialog_shape_properties.cpp.

References m_boundCtrls.

Referenced by ARC_GEOM_SYNCER::OnCSAChange(), LINE_GEOM_SYNCER::OnPolarChange(), and ARC_GEOM_SYNCER::Validate().

◆ GetCtrl()

wxTextCtrl * GEOM_SYNCER::GetCtrl ( size_t aIndex) const
inlineprotected

Definition at line 101 of file pcbnew/dialogs/dialog_shape_properties.cpp.

References m_boundCtrls.

◆ GetIntValue()

int GEOM_SYNCER::GetIntValue ( size_t aIndex) const
inlineprotected

Definition at line 107 of file pcbnew/dialogs/dialog_shape_properties.cpp.

References m_boundCtrls.

Referenced by BEZIER_GEOM_SYNCER::OnBezierChange(), CIRCLE_GEOM_SYNCER::OnCenterPointChange(), CIRCLE_GEOM_SYNCER::OnCenterRadiusChange(), RECTANGLE_GEOM_SYNCER::OnCenterSizeChange(), RECTANGLE_GEOM_SYNCER::OnCornersChange(), RECTANGLE_GEOM_SYNCER::OnCornerSizeChange(), ARC_GEOM_SYNCER::OnCSAChange(), LINE_GEOM_SYNCER::OnEndsChange(), LINE_GEOM_SYNCER::OnPolarChange(), ARC_GEOM_SYNCER::OnSMEChange(), LINE_GEOM_SYNCER::OnStartMidpointChange(), ARC_GEOM_SYNCER::Validate(), CIRCLE_GEOM_SYNCER::Validate(), and RECTANGLE_GEOM_SYNCER::Validate().

◆ GetShape() [1/2]

PCB_SHAPE & GEOM_SYNCER::GetShape ( )
inlineprotected

Definition at line 131 of file pcbnew/dialogs/dialog_shape_properties.cpp.

References m_shape.

Referenced by ARC_GEOM_SYNCER::ARC_GEOM_SYNCER(), BEZIER_GEOM_SYNCER::BEZIER_GEOM_SYNCER(), CIRCLE_GEOM_SYNCER::CIRCLE_GEOM_SYNCER(), LINE_GEOM_SYNCER::LINE_GEOM_SYNCER(), BEZIER_GEOM_SYNCER::OnBezierChange(), CIRCLE_GEOM_SYNCER::OnCenterPointChange(), CIRCLE_GEOM_SYNCER::OnCenterRadiusChange(), RECTANGLE_GEOM_SYNCER::OnCenterSizeChange(), RECTANGLE_GEOM_SYNCER::OnCornersChange(), RECTANGLE_GEOM_SYNCER::OnCornerSizeChange(), ARC_GEOM_SYNCER::OnCSAChange(), LINE_GEOM_SYNCER::OnEndsChange(), LINE_GEOM_SYNCER::OnPolarChange(), ARC_GEOM_SYNCER::OnSMEChange(), LINE_GEOM_SYNCER::OnStartMidpointChange(), RECTANGLE_GEOM_SYNCER::RECTANGLE_GEOM_SYNCER(), BEZIER_GEOM_SYNCER::updateBezier(), CIRCLE_GEOM_SYNCER::updateCenterPoint(), CIRCLE_GEOM_SYNCER::updateCenterRadius(), RECTANGLE_GEOM_SYNCER::updateCenterSize(), RECTANGLE_GEOM_SYNCER::updateCorners(), RECTANGLE_GEOM_SYNCER::updateCornerSize(), ARC_GEOM_SYNCER::updateCSA(), LINE_GEOM_SYNCER::updateEnds(), LINE_GEOM_SYNCER::updatePolar(), ARC_GEOM_SYNCER::updateSME(), and LINE_GEOM_SYNCER::updateStartMidpoint().

◆ GetShape() [2/2]

const PCB_SHAPE & GEOM_SYNCER::GetShape ( ) const
inlineprotected

Definition at line 133 of file pcbnew/dialogs/dialog_shape_properties.cpp.

References m_shape.

◆ SetShape()

void GEOM_SYNCER::SetShape ( PCB_SHAPE & aShape)
inline

Definition at line 90 of file pcbnew/dialogs/dialog_shape_properties.cpp.

References m_shape, and updateAll().

◆ updateAll()

virtual void GEOM_SYNCER::updateAll ( )
protectedpure virtual

Implemented in ARC_GEOM_SYNCER, BEZIER_GEOM_SYNCER, CIRCLE_GEOM_SYNCER, LINE_GEOM_SYNCER, and RECTANGLE_GEOM_SYNCER.

Referenced by SetShape().

◆ Validate()

virtual bool GEOM_SYNCER::Validate ( wxArrayString & aErrs) const
inlinevirtual

Reimplemented in ARC_GEOM_SYNCER, CIRCLE_GEOM_SYNCER, and RECTANGLE_GEOM_SYNCER.

Definition at line 96 of file pcbnew/dialogs/dialog_shape_properties.cpp.

Member Data Documentation

◆ m_boundCtrls

std::vector<BOUND_CONTROL>& GEOM_SYNCER::m_boundCtrls
private

Definition at line 137 of file pcbnew/dialogs/dialog_shape_properties.cpp.

Referenced by BindCtrls(), ChangeAngleValue(), ChangeValue(), GEOM_SYNCER(), GetAngleValue(), GetCtrl(), and GetIntValue().

◆ m_shape

PCB_SHAPE& GEOM_SYNCER::m_shape
private

Definition at line 136 of file pcbnew/dialogs/dialog_shape_properties.cpp.

Referenced by GEOM_SYNCER(), GetShape(), GetShape(), and SetShape().

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