KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Protected Types | Static Protected Member Functions | Private Attributes | List of all members
EDA_BEZIER_POINT_EDIT_BEHAVIOR Class Reference

"Standard" bezier editing behavior for EDA_SHAPE beziers. More...

#include <point_editor_behavior.h>

Inheritance diagram for EDA_BEZIER_POINT_EDIT_BEHAVIOR:
POINT_EDIT_BEHAVIOR

Public Member Functions

 EDA_BEZIER_POINT_EDIT_BEHAVIOR (EDA_SHAPE &aBezier, int aMaxError)
 
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.
 
virtual void FinalizeItem (EDIT_POINTS &aPoints, COMMIT &aCommit)
 Finalize the edit operation.
 
virtual OPT_VECTOR2I Get45DegreeConstrainer (const EDIT_POINT &aEditedPoint, EDIT_POINTS &aPoints) const
 Get the 45-degree constrainer for the item, when the given point is moved.
 

Protected Types

enum  BEZIER_POINTS {
  BEZIER_START , BEZIER_CTRL_PT1 , BEZIER_CTRL_PT2 , BEZIER_END ,
  BEZIER_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_SHAPE & m_bezier
 
int m_maxError
 

Detailed Description

"Standard" bezier editing behavior for EDA_SHAPE beziers.

Definition at line 288 of file point_editor_behavior.h.

Member Enumeration Documentation

◆ BEZIER_POINTS

enum EDA_BEZIER_POINT_EDIT_BEHAVIOR::BEZIER_POINTS
protected
Enumerator
BEZIER_START 
BEZIER_CTRL_PT1 
BEZIER_CTRL_PT2 
BEZIER_END 
BEZIER_MAX_POINTS 

Definition at line 306 of file point_editor_behavior.h.

Constructor & Destructor Documentation

◆ EDA_BEZIER_POINT_EDIT_BEHAVIOR()

EDA_BEZIER_POINT_EDIT_BEHAVIOR::EDA_BEZIER_POINT_EDIT_BEHAVIOR ( EDA_SHAPE & aBezier,
int aMaxError )
inline

Definition at line 291 of file point_editor_behavior.h.

References BEZIER, EDA_SHAPE::GetShape(), m_bezier, and m_maxError.

Member Function Documentation

◆ FinalizeItem()

virtual void POINT_EDIT_BEHAVIOR::FinalizeItem ( EDIT_POINTS & aPoints,
COMMIT & aCommit )
inlinevirtualinherited

Finalize the edit operation.

(optional)

This is called once, after the user has finished editing (e.g. released the mouse button).

Parameters
aPointsThe final positions of the edit points.
aCommitThe commit object to use to modify the item.

Reimplemented in POLYGON_POINT_EDIT_BEHAVIOR.

Definition at line 81 of file point_editor_behavior.h.

◆ Get45DegreeConstrainer()

virtual OPT_VECTOR2I POINT_EDIT_BEHAVIOR::Get45DegreeConstrainer ( const EDIT_POINT & aEditedPoint,
EDIT_POINTS & aPoints ) const
inlinevirtualinherited

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 in ALIGNED_DIMENSION_POINT_EDIT_BEHAVIOR, DIM_CENTER_POINT_EDIT_BEHAVIOR, DIM_RADIAL_POINT_EDIT_BEHAVIOR, EDA_ARC_POINT_EDIT_BEHAVIOR, EDA_CIRCLE_POINT_EDIT_BEHAVIOR, and EDA_SEGMENT_POINT_EDIT_BEHAVIOR.

Definition at line 109 of file point_editor_behavior.h.

◆ isModified()

static bool POINT_EDIT_BEHAVIOR::isModified ( const EDIT_POINT & aEditedPoint,
const EDIT_POINT & aPoint )
inlinestaticprotectedinherited

Checks if two points are the same instance - which means the point is being edited.

Definition at line 120 of file point_editor_behavior.h.

Referenced by ALIGNED_DIMENSION_POINT_EDIT_BEHAVIOR::Get45DegreeConstrainer(), DIM_CENTER_POINT_EDIT_BEHAVIOR::Get45DegreeConstrainer(), DIM_RADIAL_POINT_EDIT_BEHAVIOR::Get45DegreeConstrainer(), RECTANGLE_POINT_EDIT_BEHAVIOR::PinEditedCorner(), ALIGNED_DIMENSION_POINT_EDIT_BEHAVIOR::updateAlignedDimension(), BITMAP_POINT_EDIT_BEHAVIOR::UpdateItem(), DIM_CENTER_POINT_EDIT_BEHAVIOR::UpdateItem(), DIM_LEADER_POINT_EDIT_BEHAVIOR::UpdateItem(), DIM_RADIAL_POINT_EDIT_BEHAVIOR::UpdateItem(), EDA_ARC_POINT_EDIT_BEHAVIOR::UpdateItem(), EDA_BEZIER_POINT_EDIT_BEHAVIOR::UpdateItem(), EDA_CIRCLE_POINT_EDIT_BEHAVIOR::UpdateItem(), EDA_SEGMENT_POINT_EDIT_BEHAVIOR::UpdateItem(), PAD_POINT_EDIT_BEHAVIOR::UpdateItem(), PCB_TABLECELL_POINT_EDIT_BEHAVIOR::UpdateItem(), RECTANGLE_POINT_EDIT_BEHAVIOR::UpdateItem(), RECTANGLE_POINT_EDIT_BEHAVIOR::UpdateItem(), RECTANGLE_POINT_EDIT_BEHAVIOR::UpdateItem(), REFERENCE_IMAGE_POINT_EDIT_BEHAVIOR::UpdateItem(), SCH_TABLECELL_POINT_EDIT_BEHAVIOR::UpdateItem(), SHAPE_GROUP_POINT_EDIT_BEHAVIOR::UpdateItem(), SHEET_POINT_EDIT_BEHAVIOR::UpdateItem(), ALIGNED_DIMENSION_POINT_EDIT_BEHAVIOR::updateOrthogonalDimension(), and POLYGON_POINT_EDIT_BEHAVIOR::UpdateOutlineFromPoints().

◆ MakePoints()

void EDA_BEZIER_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 192 of file point_editor_behavior.cpp.

References EDIT_POINTS::AddIndicatorLine(), EDIT_POINTS::AddPoint(), BEZIER_CTRL_PT1, BEZIER_CTRL_PT2, BEZIER_END, BEZIER_START, m_bezier, and EDIT_POINTS::Point().

◆ UpdateItem()

void EDA_BEZIER_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 215 of file point_editor_behavior.cpp.

References BEZIER_CTRL_PT1, BEZIER_CTRL_PT2, BEZIER_END, BEZIER_MAX_POINTS, BEZIER_START, CHECK_POINT_COUNT, EDIT_POINT::GetPosition(), POINT_EDIT_BEHAVIOR::isModified(), m_bezier, m_maxError, and EDIT_POINTS::Point().

◆ UpdatePoints()

void EDA_BEZIER_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 204 of file point_editor_behavior.cpp.

References BEZIER_CTRL_PT1, BEZIER_CTRL_PT2, BEZIER_END, BEZIER_MAX_POINTS, BEZIER_START, CHECK_POINT_COUNT, m_bezier, EDIT_POINTS::Point(), and EDIT_POINT::SetPosition().

Member Data Documentation

◆ m_bezier

EDA_SHAPE& EDA_BEZIER_POINT_EDIT_BEHAVIOR::m_bezier
private

Definition at line 317 of file point_editor_behavior.h.

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

◆ m_maxError

int EDA_BEZIER_POINT_EDIT_BEHAVIOR::m_maxError
private

Definition at line 318 of file point_editor_behavior.h.

Referenced by EDA_BEZIER_POINT_EDIT_BEHAVIOR(), and UpdateItem().

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