KiCad PCB EDA Suite
EC_VERTICAL Class Reference

Class EC_VERTICAL. 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)
 Constructor. More...
 
virtual void Apply (EDIT_POINT &aHandle) override
 

More...
 
void Apply ()
 Function Apply() 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

Class EC_VERTICAL.

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

Definition at line 81 of file edit_constraints.h.

Constructor & Destructor Documentation

◆ EC_VERTICAL()

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

Constructor.

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

Definition at line 90 of file edit_constraints.h.

90  :
91  EDIT_CONSTRAINT<EDIT_POINT>( aConstrained ), m_constrainer( aConstrainer )
92  {}
const EDIT_POINT & m_constrainer
Point that imposes the constraint.

Member Function Documentation

◆ Apply() [1/2]

void EDIT_CONSTRAINT< EDIT_POINT >::Apply ( )
inlineinherited

Function Apply()

Corrects coordinates of the constrained edit handle.

Definition at line 66 of file edit_constraints.h.

67  {
69  }
void Apply()
Function Apply()
EDIT_POINT & m_constrained
Point that is constrained by rules implemented by Apply()

◆ Apply() [2/2]

void EC_VERTICAL::Apply ( EDIT_POINT aHandle)
overridevirtual

Function Apply() Corrects coordinates of the constrained edit handle.

Implements EDIT_CONSTRAINT< EDIT_POINT >.

Definition at line 34 of file edit_constraints.cpp.

35 {
36  VECTOR2I point = aHandle.GetPosition();
37  point.x = m_constrainer.GetPosition().x;
38  aHandle.SetPosition( point );
39 }
const EDIT_POINT & m_constrainer
Point that imposes the constraint.
virtual VECTOR2I GetPosition() const
Function GetPosition()
Definition: edit_points.h:68
virtual void SetPosition(const VECTOR2I &aPosition)
Function SetPosition()
Definition: edit_points.h:105

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 72 of file edit_constraints.h.

◆ m_constrainer

const EDIT_POINT& EC_VERTICAL::m_constrainer
private

Point that imposes the constraint.

Definition at line 98 of file edit_constraints.h.

Referenced by Apply().


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