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

"Standard" segment editing behavior for EDA_SHAPE segments. More...

#include <point_editor_behavior.h>

Inheritance diagram for EDA_SEGMENT_POINT_EDIT_BEHAVIOR:
POINT_EDIT_BEHAVIOR

Public Member Functions

 EDA_SEGMENT_POINT_EDIT_BEHAVIOR (EDA_SHAPE &aSegment)
 
void MakePoints (EDIT_POINTS &aPoints) override
 Construct the initial set of edit points for the item and append to the given list.
 
void UpdatePoints (EDIT_POINTS &aPoints) override
 Update the list of the edit points for the item.
 
void UpdateItem (const EDIT_POINT &aEditedPoint, EDIT_POINTS &aPoints, COMMIT &aCommit, std::vector< EDA_ITEM * > &aUpdatedItems) override
 Update the item with the new positions of the edit points.
 
OPT_VECTOR2I Get45DegreeConstrainer (const EDIT_POINT &aEditedPoint, EDIT_POINTS &aPoints) const override
 Get the 45-degree constrainer for the item, when the given point is moved.
 

Protected Types

enum  SEGMENT_POINTS { SEGMENT_START , SEGMENT_END , SEGMENT_MAX_POINTS }
 

Static Protected Member Functions

static bool isModified (const EDIT_POINT &aEditedPoint, const EDIT_POINT &aPoint)
 Checks if two points are the same instance - which means the point is being edited.
 

Private Attributes

EDA_SHAPEm_segment
 

Detailed Description

"Standard" segment editing behavior for EDA_SHAPE segments.

Definition at line 191 of file point_editor_behavior.h.

Member Enumeration Documentation

◆ SEGMENT_POINTS

Enumerator
SEGMENT_START 
SEGMENT_END 
SEGMENT_MAX_POINTS 

Definition at line 210 of file point_editor_behavior.h.

Constructor & Destructor Documentation

◆ EDA_SEGMENT_POINT_EDIT_BEHAVIOR()

EDA_SEGMENT_POINT_EDIT_BEHAVIOR::EDA_SEGMENT_POINT_EDIT_BEHAVIOR ( EDA_SHAPE aSegment)
inline

Definition at line 194 of file point_editor_behavior.h.

References EDA_SHAPE::GetShape().

Member Function Documentation

◆ Get45DegreeConstrainer()

OPT_VECTOR2I EDA_SEGMENT_POINT_EDIT_BEHAVIOR::Get45DegreeConstrainer ( const EDIT_POINT aEditedPoint,
EDIT_POINTS aPoints 
) const
overridevirtual

Get the 45-degree constrainer for the item, when the given point is moved.

Return std::nullopt if not, and the caller can decide.

If you want to actively disable constraining, return the aEditedPoint position.

Reimplemented from POINT_EDIT_BEHAVIOR.

Definition at line 132 of file point_editor_behavior.cpp.

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

◆ isModified()

◆ MakePoints()

void EDA_SEGMENT_POINT_EDIT_BEHAVIOR::MakePoints ( EDIT_POINTS aPoints)
overridevirtual

Construct the initial set of edit points for the item and append to the given list.

Parameters
aPointsThe list of edit points to fill.

Implements POINT_EDIT_BEHAVIOR.

Definition at line 104 of file point_editor_behavior.cpp.

References EDIT_POINTS::AddPoint(), EDA_SHAPE::GetEnd(), EDA_SHAPE::GetStart(), and m_segment.

◆ UpdateItem()

void EDA_SEGMENT_POINT_EDIT_BEHAVIOR::UpdateItem ( const EDIT_POINT aEditedPoint,
EDIT_POINTS aPoints,
COMMIT aCommit,
std::vector< EDA_ITEM * > &  aUpdatedItems 
)
overridevirtual

Update the item with the new positions of the edit points.

This method should all commit and add to the update list anything that is NOT the parent item of the EDIT_POINTs. For example, connected lines, parent tables, etc. The item itself is already handled (most behaviors don't need more than that).

Parameters
aEditedPointThe point that was dragged. You can use this to check by address which point to update.
aPointsThe new positions of the edit points.
aCommitThe commit object to use to modify the item.
aUpdatedItemsThe list of items that were updated by the edit (not only the item that was being edited, but also any other items that were affected, e.g. by being conneted to the edited item).

Implements POINT_EDIT_BEHAVIOR.

Definition at line 118 of file point_editor_behavior.cpp.

References CHECK_POINT_COUNT, EDIT_POINT::GetPosition(), POINT_EDIT_BEHAVIOR::isModified(), m_segment, EDIT_POINTS::Point(), SEGMENT_END, SEGMENT_MAX_POINTS, SEGMENT_START, EDA_SHAPE::SetEnd(), and EDA_SHAPE::SetStart().

◆ UpdatePoints()

void EDA_SEGMENT_POINT_EDIT_BEHAVIOR::UpdatePoints ( EDIT_POINTS aPoints)
overridevirtual

Update the list of the edit points for the item.

Be very careful not to overrun the list of points - this class knows how bug there are because it made them in the first place.

If item has changed such that that number of points needs to change, this method has to handle that (probably by clearing the list and refilling it).

Parameters
aPointsThe list of edit points to update.

Implements POINT_EDIT_BEHAVIOR.

Definition at line 110 of file point_editor_behavior.cpp.

References CHECK_POINT_COUNT, EDA_SHAPE::GetEnd(), EDA_SHAPE::GetStart(), m_segment, EDIT_POINTS::Point(), SEGMENT_END, SEGMENT_MAX_POINTS, and SEGMENT_START.

Member Data Documentation

◆ m_segment

EDA_SHAPE& EDA_SEGMENT_POINT_EDIT_BEHAVIOR::m_segment
private

Definition at line 219 of file point_editor_behavior.h.

Referenced by MakePoints(), UpdateItem(), and UpdatePoints().


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