KiCad PCB EDA Suite
Loading...
Searching...
No Matches
EDIT_LINE Class Reference

Represent a line connecting two EDIT_POINTs. More...

#include <edit_points.h>

Inheritance diagram for EDIT_LINE:
EDIT_POINT

Public Member Functions

 EDIT_LINE (EDIT_POINT &aOrigin, EDIT_POINT &aEnd)
 
virtual VECTOR2I GetPosition () const override
 Return coordinates of an EDIT_POINT.
 
virtual void SetPosition (const VECTOR2I &aPosition) override
 Return coordinates of an EDIT_POINT.
 
virtual void ApplyConstraint (const GRID_HELPER &aGrid) override
 Correct coordinates of an EDIT_POINT by applying previously set constraint.
 
void SetConstraint (EDIT_CONSTRAINT< EDIT_LINE > *aConstraint)
 Set a constraint for and EDIT_POINT.
 
EDIT_CONSTRAINT< EDIT_LINE > * GetConstraint () const
 Return the constraint imposed on an EDIT_POINT.
 
EDIT_POINTGetOrigin ()
 Return the origin EDIT_POINT.
 
const EDIT_POINTGetOrigin () const
 
EDIT_POINTGetEnd ()
 Return the end EDIT_POINT.
 
const EDIT_POINTGetEnd () const
 
bool HasCenterPoint () const
 Is the center-point of the line useful to be shown?
 
void SetHasCenterPoint (bool aHasCenterPoint)
 Set if the center-point of the line should be shown.
 
bool DrawLine () const
 Should the line itself be drawn, or just the end and/or center points?
 
void SetDrawLine (bool aShowLine)
 Set if the line itself should be drawn.
 
bool operator== (const EDIT_POINT &aOther) const
 
bool operator== (const EDIT_LINE &aOther) const
 
virtual std::pair< EDA_ITEM *, int > GetConnected () const
 Return a connected item record comprising an EDA_ITEM* and a STARTPOINT/ENDPOINT flag.
 
int GetX () const
 Return X coordinate of an EDIT_POINT.
 
int GetY () const
 Return Y coordinate of an EDIT_POINT.
 
virtual void SetPosition (int x, int y)
 
bool WithinPoint (const VECTOR2I &aPoint, unsigned int aSize) const
 Check if given point is within a square centered in the EDIT_POINT position.
 
void SetConstraint (EDIT_CONSTRAINT< EDIT_POINT > *aConstraint)
 Set a constraint for and EDIT_POINT.
 
void ClearConstraint ()
 Remove previously set constraint.
 
bool IsConstrained () const
 Check if point is constrained.
 
bool IsActive () const
 
void SetActive (bool aActive=true)
 
bool IsHover () const
 
void SetHover (bool aHover=true)
 
bool DrawCircle () const
 
void SetDrawCircle (bool aDrawCircle=true)
 
GRID_CONSTRAINT_TYPE GetGridConstraint () const
 
void SetGridConstraint (GRID_CONSTRAINT_TYPE aConstraint)
 
SNAP_CONSTRAINT_TYPE GetSnapConstraint () const
 
void SetSnapConstraint (SNAP_CONSTRAINT_TYPE aConstraint)
 

Static Public Attributes

static const int POINT_SIZE = 8
 Single point size in pixels.
 
static const int BORDER_SIZE = 2
 Border size when not hovering.
 
static const int HOVER_SIZE = 5
 Border size when hovering.
 

Private Attributes

EDIT_POINTm_origin
 Origin point for a line.
 
EDIT_POINTm_end
 End point for a line.
 
bool m_hasCenterPoint = true
 True if the line has a (useful) center point.
 
bool m_showLine = false
 True if the line itself should be drawn.
 
std::shared_ptr< EDIT_CONSTRAINT< EDIT_LINE > > m_constraint
 Constraint for the point, NULL if none.
 
VECTOR2I m_position
 Position of EDIT_POINT.
 
bool m_isActive
 True if this point is being manipulated.
 
bool m_isHover
 True if this point is being hovered over.
 
bool m_drawCircle
 True if the point is drawn circular.
 
GRID_CONSTRAINT_TYPE m_gridConstraint
 Describe the grid snapping behavior.
 
SNAP_CONSTRAINT_TYPE m_snapConstraint
 Describe the object snapping behavior.
 
std::pair< EDA_ITEM *, int > m_connected
 An optional connected item record used to mimic polyLine behavior with individual line segments.
 

Detailed Description

Represent a line connecting two EDIT_POINTs.

This allows one to move them both by dragging the EDIT_POINT in the middle. It uses references to EDIT_POINTs, all coordinates are automatically synchronized.

Definition at line 227 of file edit_points.h.

Constructor & Destructor Documentation

◆ EDIT_LINE()

EDIT_LINE::EDIT_LINE ( EDIT_POINT & aOrigin,
EDIT_POINT & aEnd )
inline
Parameters
aOriginis the origin of EDIT_LINE.
aEndis the end of EDIT_LINE.

Definition at line 234 of file edit_points.h.

References EDIT_POINT::EDIT_POINT(), GetPosition(), m_end, m_origin, EDIT_POINT::SetGridConstraint(), and SNAP_BY_GRID.

Referenced by operator==().

Member Function Documentation

◆ ApplyConstraint()

virtual void EDIT_LINE::ApplyConstraint ( const GRID_HELPER & aGrid)
inlineoverridevirtual

Correct coordinates of an EDIT_POINT by applying previously set constraint.

Reimplemented from EDIT_POINT.

Definition at line 258 of file edit_points.h.

References m_constraint, m_end, and m_origin.

◆ ClearConstraint()

void EDIT_POINT::ClearConstraint ( )
inlineinherited

Remove previously set constraint.

Definition at line 149 of file edit_points.h.

References m_constraint.

◆ DrawCircle()

bool EDIT_POINT::DrawCircle ( ) const
inlineinherited

Definition at line 179 of file edit_points.h.

References m_drawCircle.

◆ DrawLine()

bool EDIT_LINE::DrawLine ( ) const
inline

Should the line itself be drawn, or just the end and/or center points?

Definition at line 325 of file edit_points.h.

References m_showLine.

◆ GetConnected()

virtual std::pair< EDA_ITEM *, int > EDIT_POINT::GetConnected ( ) const
inlinevirtualinherited

Return a connected item record comprising an EDA_ITEM* and a STARTPOINT/ENDPOINT flag.

Definition at line 80 of file edit_points.h.

References m_connected.

Referenced by LINE_POINT_EDIT_BEHAVIOR::UpdateItem().

◆ GetConstraint()

EDIT_CONSTRAINT< EDIT_LINE > * EDIT_LINE::GetConstraint ( ) const
inline

Return the constraint imposed on an EDIT_POINT.

If there are no constraints, NULL is returned.

Definition at line 281 of file edit_points.h.

References m_constraint.

◆ GetEnd() [1/2]

EDIT_POINT & EDIT_LINE::GetEnd ( )
inline

◆ GetEnd() [2/2]

const EDIT_POINT & EDIT_LINE::GetEnd ( ) const
inline

Definition at line 307 of file edit_points.h.

References EDIT_POINT::EDIT_POINT(), and m_end.

◆ GetGridConstraint()

GRID_CONSTRAINT_TYPE EDIT_POINT::GetGridConstraint ( ) const
inlineinherited

◆ GetOrigin() [1/2]

EDIT_POINT & EDIT_LINE::GetOrigin ( )
inline

◆ GetOrigin() [2/2]

const EDIT_POINT & EDIT_LINE::GetOrigin ( ) const
inline

Definition at line 294 of file edit_points.h.

References EDIT_POINT::EDIT_POINT(), and m_origin.

◆ GetPosition()

virtual VECTOR2I EDIT_LINE::GetPosition ( ) const
inlineoverridevirtual

Return coordinates of an EDIT_POINT.

Note
It may be different than coordinates of a graphical item that is bound to the EDIT_POINT.

Reimplemented from EDIT_POINT.

Definition at line 243 of file edit_points.h.

References m_end, and m_origin.

Referenced by EC_CONVERGING::Apply(), EC_PERPLINE::Apply(), EC_CONVERGING::EC_CONVERGING(), EC_PERPLINE::EC_PERPLINE(), EDIT_LINE(), operator==(), and SetPosition().

◆ GetSnapConstraint()

SNAP_CONSTRAINT_TYPE EDIT_POINT::GetSnapConstraint ( ) const
inlineinherited

Definition at line 185 of file edit_points.h.

References m_snapConstraint.

◆ GetX()

◆ GetY()

int EDIT_POINT::GetY ( ) const
inlineinherited

Return Y coordinate of an EDIT_POINT.

Definition at line 96 of file edit_points.h.

References GetPosition(), and VECTOR2< T >::y.

Referenced by PCB_TABLECELL_POINT_EDIT_BEHAVIOR::UpdateItem(), and SCH_TABLECELL_POINT_EDIT_BEHAVIOR::UpdateItem().

◆ HasCenterPoint()

bool EDIT_LINE::HasCenterPoint ( ) const
inline

Is the center-point of the line useful to be shown?

Definition at line 315 of file edit_points.h.

References m_hasCenterPoint.

◆ IsActive()

bool EDIT_POINT::IsActive ( ) const
inlineinherited

◆ IsConstrained()

bool EDIT_POINT::IsConstrained ( ) const
inlineinherited

Check if point is constrained.

Returns
True is point is constrained, false otherwise.

Definition at line 159 of file edit_points.h.

References m_constraint.

◆ IsHover()

bool EDIT_POINT::IsHover ( ) const
inlineinherited

Definition at line 176 of file edit_points.h.

References m_isHover.

Referenced by KIGFX::PREVIEW::ANGLE_ITEM::drawPreviewShape(), and EDIT_POINTS::ViewDraw().

◆ operator==() [1/2]

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

Definition at line 337 of file edit_points.h.

References EDIT_LINE(), m_end, and m_origin.

◆ operator==() [2/2]

bool EDIT_LINE::operator== ( const EDIT_POINT & aOther) const
inline

Definition at line 332 of file edit_points.h.

References EDIT_POINT::EDIT_POINT(), GetPosition(), and EDIT_POINT::GetPosition().

◆ SetActive()

void EDIT_POINT::SetActive ( bool aActive = true)
inlineinherited

Definition at line 174 of file edit_points.h.

References m_isActive.

Referenced by PCB_POINT_EDITOR::OnSelectionChange().

◆ SetConstraint() [1/2]

◆ SetConstraint() [2/2]

◆ SetDrawCircle()

void EDIT_POINT::SetDrawCircle ( bool aDrawCircle = true)
inlineinherited

◆ SetDrawLine()

void EDIT_LINE::SetDrawLine ( bool aShowLine)
inline

Set if the line itself should be drawn.

Definition at line 330 of file edit_points.h.

References m_showLine.

Referenced by EDIT_POINTS::AddIndicatorLine().

◆ SetGridConstraint()

void EDIT_POINT::SetGridConstraint ( GRID_CONSTRAINT_TYPE aConstraint)
inlineinherited

Definition at line 183 of file edit_points.h.

References m_gridConstraint.

Referenced by EDIT_LINE::EDIT_LINE(), and PCB_TUNING_PATTERN::MakeEditPoints().

◆ SetHasCenterPoint()

void EDIT_LINE::SetHasCenterPoint ( bool aHasCenterPoint)
inline

Set if the center-point of the line should be shown.

Definition at line 320 of file edit_points.h.

References m_hasCenterPoint.

Referenced by EDIT_POINTS::AddIndicatorLine().

◆ SetHover()

void EDIT_POINT::SetHover ( bool aHover = true)
inlineinherited

Definition at line 177 of file edit_points.h.

References m_isHover.

◆ SetPosition() [1/2]

virtual void EDIT_LINE::SetPosition ( const VECTOR2I & aPosition)
inlineoverridevirtual

Return coordinates of an EDIT_POINT.

Note
It may be different than coordinates of a graphical item that is bound to the EDIT_POINT.

Reimplemented from EDIT_POINT.

Definition at line 249 of file edit_points.h.

References GetPosition(), m_end, and m_origin.

Referenced by EC_CONVERGING::Apply(), and EC_PERPLINE::Apply().

◆ SetPosition() [2/2]

virtual void EDIT_POINT::SetPosition ( int x,
int y )
inlinevirtualinherited

Definition at line 113 of file edit_points.h.

References m_position.

◆ SetSnapConstraint()

◆ WithinPoint()

bool EDIT_POINT::WithinPoint ( const VECTOR2I & aPoint,
unsigned int aSize ) const
inherited

Check if given point is within a square centered in the EDIT_POINT position.

Parameters
aPointis point to be checked.
aSizeis length of the square side.

Definition at line 37 of file edit_points.cpp.

References GetPosition(), VECTOR2< T >::x, and VECTOR2< T >::y.

Member Data Documentation

◆ BORDER_SIZE

const int EDIT_POINT::BORDER_SIZE = 2
staticinherited

Border size when not hovering.

Definition at line 200 of file edit_points.h.

Referenced by KIGFX::PREVIEW::ANGLE_ITEM::drawPreviewShape(), and EDIT_POINTS::ViewDraw().

◆ HOVER_SIZE

const int EDIT_POINT::HOVER_SIZE = 5
staticinherited

Border size when hovering.

Definition at line 201 of file edit_points.h.

Referenced by EDIT_POINTS::ViewDraw().

◆ m_connected

std::pair<EDA_ITEM*, int> EDIT_POINT::m_connected
privateinherited

An optional connected item record used to mimic polyLine behavior with individual line segments.

Definition at line 214 of file edit_points.h.

Referenced by GetConnected().

◆ m_constraint

std::shared_ptr<EDIT_CONSTRAINT<EDIT_LINE> > EDIT_LINE::m_constraint
private

Constraint for the point, NULL if none.

Definition at line 350 of file edit_points.h.

Referenced by ApplyConstraint(), GetConstraint(), and SetConstraint().

◆ m_drawCircle

bool EDIT_POINT::m_drawCircle
privateinherited

True if the point is drawn circular.

Definition at line 208 of file edit_points.h.

Referenced by DrawCircle(), and SetDrawCircle().

◆ m_end

EDIT_POINT& EDIT_LINE::m_end
private

End point for a line.

Definition at line 344 of file edit_points.h.

Referenced by ApplyConstraint(), EDIT_LINE(), GetEnd(), GetEnd(), GetPosition(), operator==(), and SetPosition().

◆ m_gridConstraint

GRID_CONSTRAINT_TYPE EDIT_POINT::m_gridConstraint
privateinherited

Describe the grid snapping behavior.

Definition at line 209 of file edit_points.h.

Referenced by GetGridConstraint(), and SetGridConstraint().

◆ m_hasCenterPoint

bool EDIT_LINE::m_hasCenterPoint = true
private

True if the line has a (useful) center point.

Definition at line 346 of file edit_points.h.

Referenced by HasCenterPoint(), and SetHasCenterPoint().

◆ m_isActive

bool EDIT_POINT::m_isActive
privateinherited

True if this point is being manipulated.

Definition at line 206 of file edit_points.h.

Referenced by IsActive(), and SetActive().

◆ m_isHover

bool EDIT_POINT::m_isHover
privateinherited

True if this point is being hovered over.

Definition at line 207 of file edit_points.h.

Referenced by IsHover(), and SetHover().

◆ m_origin

EDIT_POINT& EDIT_LINE::m_origin
private

Origin point for a line.

Definition at line 343 of file edit_points.h.

Referenced by ApplyConstraint(), EDIT_LINE(), GetOrigin(), GetOrigin(), GetPosition(), operator==(), and SetPosition().

◆ m_position

VECTOR2I EDIT_POINT::m_position
privateinherited

Position of EDIT_POINT.

Definition at line 205 of file edit_points.h.

Referenced by GetPosition(), operator==(), SetPosition(), and SetPosition().

◆ m_showLine

bool EDIT_LINE::m_showLine = false
private

True if the line itself should be drawn.

Definition at line 347 of file edit_points.h.

Referenced by DrawLine(), and SetDrawLine().

◆ m_snapConstraint

SNAP_CONSTRAINT_TYPE EDIT_POINT::m_snapConstraint
privateinherited

Describe the object snapping behavior.

Definition at line 210 of file edit_points.h.

Referenced by GetSnapConstraint(), and SetSnapConstraint().

◆ POINT_SIZE

const int EDIT_POINT::POINT_SIZE = 8
staticinherited

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