KiCad PCB EDA Suite
Loading...
Searching...
No Matches
GRID_POINT_EDIT_BEHAVIOR Class Reference
Inheritance diagram for GRID_POINT_EDIT_BEHAVIOR:
POINT_EDIT_BEHAVIOR

Public Member Functions

 GRID_POINT_EDIT_BEHAVIOR (PCB_GRID_ITEM &aGridItem)
 
void MakePoints (EDIT_POINTS &aPoints) override
 Construct the initial set of edit points for the item and append to the given list.
 
bool 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.
 

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 Member Functions

VECTOR2I toLocal (const VECTOR2I &aWorld) const
 
VECTOR2I toWorld (const VECTOR2I &aLocal) const
 
VECTOR2I cornerLocal (int aX, int aY) const
 
VECTOR2I radiusEndLocal () const
 
VECTOR2I arcEndLocal () const
 
VECTOR2I arcMidLocal () const
 

Private Attributes

PCB_GRID_ITEMm_gridItem
 

Detailed Description

Definition at line 844 of file pcb_point_editor.cpp.

Constructor & Destructor Documentation

◆ GRID_POINT_EDIT_BEHAVIOR()

GRID_POINT_EDIT_BEHAVIOR::GRID_POINT_EDIT_BEHAVIOR ( PCB_GRID_ITEM & aGridItem)
inline

Definition at line 847 of file pcb_point_editor.cpp.

References m_gridItem.

Member Function Documentation

◆ arcEndLocal()

VECTOR2I GRID_POINT_EDIT_BEHAVIOR::arcEndLocal ( ) const
inlineprivate

Definition at line 1016 of file pcb_point_editor.cpp.

References KiROUND(), and m_gridItem.

Referenced by MakePoints(), and UpdatePoints().

◆ arcMidLocal()

VECTOR2I GRID_POINT_EDIT_BEHAVIOR::arcMidLocal ( ) const
inlineprivate

Definition at line 1023 of file pcb_point_editor.cpp.

References KiROUND(), and m_gridItem.

Referenced by MakePoints(), and UpdatePoints().

◆ cornerLocal()

VECTOR2I GRID_POINT_EDIT_BEHAVIOR::cornerLocal ( int aX,
int aY ) const
inlineprivate

Definition at line 1007 of file pcb_point_editor.cpp.

References m_gridItem.

Referenced by MakePoints(), and UpdatePoints().

◆ 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 a point (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 EDA_POLYGON_POINT_EDIT_BEHAVIOR, and POLYGON_POINT_EDIT_BEHAVIOR.

Definition at line 79 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 106 of file point_editor_behavior.h.

◆ isModified()

◆ MakePoints()

void GRID_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 852 of file pcb_point_editor.cpp.

References EDIT_POINTS::AddPoint(), arcEndLocal(), arcMidLocal(), CARTESIAN, cornerLocal(), m_gridItem, POLAR, radiusEndLocal(), and toWorld().

◆ radiusEndLocal()

VECTOR2I GRID_POINT_EDIT_BEHAVIOR::radiusEndLocal ( ) const
inlineprivate

Definition at line 1014 of file pcb_point_editor.cpp.

References m_gridItem.

Referenced by MakePoints(), and UpdatePoints().

◆ toLocal()

VECTOR2I GRID_POINT_EDIT_BEHAVIOR::toLocal ( const VECTOR2I & aWorld) const
inlineprivate

Definition at line 992 of file pcb_point_editor.cpp.

References m_gridItem, and RotatePoint().

Referenced by UpdateItem().

◆ toWorld()

VECTOR2I GRID_POINT_EDIT_BEHAVIOR::toWorld ( const VECTOR2I & aLocal) const
inlineprivate

Definition at line 999 of file pcb_point_editor.cpp.

References m_gridItem, and RotatePoint().

Referenced by MakePoints(), and UpdatePoints().

◆ UpdateItem()

void GRID_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 909 of file pcb_point_editor.cpp.

References std::abs(), CARTESIAN, EDIT_POINT::GetPosition(), POINT_EDIT_BEHAVIOR::isModified(), KiROUND(), m_gridItem, M_PI, EDIT_POINTS::Point(), POLAR, RADIANS_T, toLocal(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ UpdatePoints()

bool GRID_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 big they 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).

If the behavior itself must change (for instance, a rectangle is non-cardinallly rotated to a polygon), the method should return false.

Parameters
aPointsThe list of edit points to update.

Implements POINT_EDIT_BEHAVIOR.

Definition at line 878 of file pcb_point_editor.cpp.

References arcEndLocal(), arcMidLocal(), CARTESIAN, cornerLocal(), m_gridItem, EDIT_POINTS::Point(), EDIT_POINTS::PointsSize(), POLAR, radiusEndLocal(), EDIT_POINT::SetPosition(), and toWorld().

Member Data Documentation

◆ m_gridItem

PCB_GRID_ITEM& GRID_POINT_EDIT_BEHAVIOR::m_gridItem
private

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