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

Point editor behavior for the PCB_GENERATOR class. More...

Inheritance diagram for GENERATOR_POINT_EDIT_BEHAVIOR:
POINT_EDIT_BEHAVIOR

Public Member Functions

 GENERATOR_POINT_EDIT_BEHAVIOR (PCB_GENERATOR &aGenerator)
 
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 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.
 

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

PCB_GENERATORm_generator
 

Detailed Description

Point editor behavior for the PCB_GENERATOR class.

This just delegates to the PCB_GENERATOR's own methods.

Definition at line 1224 of file pcb_point_editor.cpp.

Constructor & Destructor Documentation

◆ GENERATOR_POINT_EDIT_BEHAVIOR()

GENERATOR_POINT_EDIT_BEHAVIOR::GENERATOR_POINT_EDIT_BEHAVIOR ( PCB_GENERATOR aGenerator)
inline

Definition at line 1227 of file pcb_point_editor.cpp.

Member Function Documentation

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

Definition at line 96 of file point_editor_behavior.h.

◆ isModified()

◆ MakePoints()

void GENERATOR_POINT_EDIT_BEHAVIOR::MakePoints ( EDIT_POINTS aPoints)
inlineoverridevirtual

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 1229 of file pcb_point_editor.cpp.

References m_generator, and PCB_GENERATOR::MakeEditPoints().

◆ UpdateItem()

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

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 1239 of file pcb_point_editor.cpp.

References m_generator, and PCB_GENERATOR::UpdateFromEditPoints().

◆ UpdatePoints()

void GENERATOR_POINT_EDIT_BEHAVIOR::UpdatePoints ( EDIT_POINTS aPoints)
inlineoverridevirtual

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 1234 of file pcb_point_editor.cpp.

References m_generator, and PCB_GENERATOR::UpdateEditPoints().

Member Data Documentation

◆ m_generator

PCB_GENERATOR& GENERATOR_POINT_EDIT_BEHAVIOR::m_generator
private

Definition at line 1246 of file pcb_point_editor.cpp.

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


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