KiCad PCB EDA Suite
EC_VERTICAL Class Reference

EDIT_CONSTRAINT that imposes a constraint that two points have to have the same X coordinate. More...

#include <edit_constraints.h>

Inheritance diagram for EC_VERTICAL:
EDIT_CONSTRAINT< EDIT_POINT >

Public Member Functions

 EC_VERTICAL (EDIT_POINT &aConstrained, const EDIT_POINT &aConstrainer)
 Correct coordinates of the constrained edit handle. More...
 
virtual void Apply (EDIT_POINT &aHandle) override
 Correct coordinates of the constrained edit handle. More...
 
void Apply ()
 Correct coordinates of the constrained edit handle. More...
 

Protected Attributes

EDIT_POINTm_constrained
 Point that is constrained by rules implemented by Apply(). More...
 

Private Attributes

const EDIT_POINTm_constrainer
 Point that imposes the constraint. More...
 

Detailed Description

EDIT_CONSTRAINT that imposes a constraint that two points have to have the same X coordinate.

Definition at line 84 of file edit_constraints.h.

Constructor & Destructor Documentation

◆ EC_VERTICAL()

EC_VERTICAL::EC_VERTICAL ( EDIT_POINT aConstrained,
const EDIT_POINT aConstrainer 
)
inline

Correct coordinates of the constrained edit handle.

Parameters
aConstrainedis the point that is put under constrain.
aConstraineris the point that is the source of the constrain.

Definition at line 91 of file edit_constraints.h.

Member Function Documentation

◆ Apply() [1/2]

void EDIT_CONSTRAINT< EDIT_POINT >::Apply ( )
inlineinherited

Correct coordinates of the constrained edit handle.

Definition at line 71 of file edit_constraints.h.

72  {
74  }
void Apply()
Correct coordinates of the constrained edit handle.
EDIT_POINT & m_constrained
Point that is constrained by rules implemented by Apply().

◆ Apply() [2/2]

void EC_VERTICAL::Apply ( EDIT_POINT aHandle)
overridevirtual

Correct coordinates of the constrained edit handle.

Implements EDIT_CONSTRAINT< EDIT_POINT >.

Definition at line 38 of file edit_constraints.cpp.

39 {
40  VECTOR2I point = aHandle.GetPosition();
41  point.x = m_constrainer.GetPosition().x;
42  aHandle.SetPosition( point );
43 }
const EDIT_POINT & m_constrainer
Point that imposes the constraint.
virtual VECTOR2I GetPosition() const
Return coordinates of an EDIT_POINT.
Definition: edit_points.h:70
virtual void SetPosition(const VECTOR2I &aPosition)
Set new coordinates for an EDIT_POINT.
Definition: edit_points.h:106

References EDIT_POINT::GetPosition(), m_constrainer, EDIT_POINT::SetPosition(), and VECTOR2< T >::x.

Member Data Documentation

◆ m_constrained

EDIT_POINT & EDIT_CONSTRAINT< EDIT_POINT >::m_constrained
protectedinherited

Point that is constrained by rules implemented by Apply().

Definition at line 77 of file edit_constraints.h.

◆ m_constrainer

const EDIT_POINT& EC_VERTICAL::m_constrainer
private

Point that imposes the constraint.

Definition at line 99 of file edit_constraints.h.

Referenced by Apply().


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