KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Static Protected Member Functions | Private Member Functions | Private Attributes | List of all members
SHAPE_GROUP_POINT_EDIT_BEHAVIOR Class Reference
Inheritance diagram for SHAPE_GROUP_POINT_EDIT_BEHAVIOR:
POINT_EDIT_BEHAVIOR

Public Member Functions

 SHAPE_GROUP_POINT_EDIT_BEHAVIOR (PCB_GROUP &aGroup)
 
 SHAPE_GROUP_POINT_EDIT_BEHAVIOR (std::vector< PCB_SHAPE * > aShapes, BOARD_ITEM *aParent)
 
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.
 
BOARD_ITEM * GetParent () const
 
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

BOX2I getBoundingBox () const
 

Private Attributes

PCB_GROUP * m_group
 
std::vector< PCB_SHAPE * > m_shapes
 
BOARD_ITEM * m_parent
 
std::unordered_map< PCB_SHAPE *, double > m_originalWidths
 

Detailed Description

Definition at line 1647 of file pcb_point_editor.cpp.

Constructor & Destructor Documentation

◆ SHAPE_GROUP_POINT_EDIT_BEHAVIOR() [1/2]

SHAPE_GROUP_POINT_EDIT_BEHAVIOR::SHAPE_GROUP_POINT_EDIT_BEHAVIOR ( PCB_GROUP & aGroup)
inline

Definition at line 1650 of file pcb_point_editor.cpp.

References PCB_GROUP::GetBoardItems(), m_group, and m_parent.

◆ SHAPE_GROUP_POINT_EDIT_BEHAVIOR() [2/2]

SHAPE_GROUP_POINT_EDIT_BEHAVIOR::SHAPE_GROUP_POINT_EDIT_BEHAVIOR ( std::vector< PCB_SHAPE * > aShapes,
BOARD_ITEM * aParent )
inline

Definition at line 1665 of file pcb_point_editor.cpp.

References m_group, m_originalWidths, m_parent, m_shapes, and move.

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 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 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 108 of file point_editor_behavior.h.

◆ getBoundingBox()

BOX2I SHAPE_GROUP_POINT_EDIT_BEHAVIOR::getBoundingBox ( ) const
inlineprivate

Definition at line 1774 of file pcb_point_editor.cpp.

References m_shapes, and BOX2< Vec >::Merge().

◆ GetParent()

BOARD_ITEM * SHAPE_GROUP_POINT_EDIT_BEHAVIOR::GetParent ( ) const
inline

Definition at line 1771 of file pcb_point_editor.cpp.

References m_parent.

◆ 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 119 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 SHAPE_GROUP_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 1674 of file pcb_point_editor.cpp.

References EDIT_POINTS::AddIndicatorLine(), EDIT_POINTS::AddPoint(), BOX2< Vec >::Centre(), getBoundingBox(), BOX2< Vec >::GetEnd(), BOX2< Vec >::GetOrigin(), EDIT_POINTS::Point(), RECT_BOT_LEFT, RECT_BOT_RIGHT, RECT_TOP_LEFT, RECT_TOP_RIGHT, VECTOR2< T >::x, and VECTOR2< T >::y.

◆ UpdateItem()

void SHAPE_GROUP_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 1706 of file pcb_point_editor.cpp.

References BOX2< Vec >::Centre(), delta, getBoundingBox(), BOX2< Vec >::GetHeight(), EDIT_POINT::GetPosition(), BOX2< Vec >::GetWidth(), POINT_EDIT_BEHAVIOR::isModified(), KiROUND(), m_group, m_originalWidths, m_shapes, COMMIT::Modify(), RECTANGLE_POINT_EDIT_BEHAVIOR::PinEditedCorner(), EDIT_POINTS::Point(), RECT_BOT_LEFT, RECT_BOT_RIGHT, RECT_CENTER, RECT_TOP_LEFT, RECT_TOP_RIGHT, RECURSE, scale, UpdatePoints(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ UpdatePoints()

bool SHAPE_GROUP_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 1692 of file pcb_point_editor.cpp.

References BOX2< Vec >::Centre(), getBoundingBox(), BOX2< Vec >::GetEnd(), BOX2< Vec >::GetOrigin(), EDIT_POINTS::Point(), RECT_BOT_LEFT, RECT_BOT_RIGHT, RECT_CENTER, RECT_TOP_LEFT, RECT_TOP_RIGHT, EDIT_POINT::SetPosition(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by UpdateItem().

Member Data Documentation

◆ m_group

PCB_GROUP* SHAPE_GROUP_POINT_EDIT_BEHAVIOR::m_group
private

Definition at line 1785 of file pcb_point_editor.cpp.

Referenced by SHAPE_GROUP_POINT_EDIT_BEHAVIOR(), SHAPE_GROUP_POINT_EDIT_BEHAVIOR(), and UpdateItem().

◆ m_originalWidths

std::unordered_map<PCB_SHAPE*, double> SHAPE_GROUP_POINT_EDIT_BEHAVIOR::m_originalWidths
private

Definition at line 1788 of file pcb_point_editor.cpp.

Referenced by SHAPE_GROUP_POINT_EDIT_BEHAVIOR(), and UpdateItem().

◆ m_parent

BOARD_ITEM* SHAPE_GROUP_POINT_EDIT_BEHAVIOR::m_parent
private

Definition at line 1787 of file pcb_point_editor.cpp.

Referenced by GetParent(), SHAPE_GROUP_POINT_EDIT_BEHAVIOR(), and SHAPE_GROUP_POINT_EDIT_BEHAVIOR().

◆ m_shapes

std::vector<PCB_SHAPE*> SHAPE_GROUP_POINT_EDIT_BEHAVIOR::m_shapes
private

Definition at line 1786 of file pcb_point_editor.cpp.

Referenced by getBoundingBox(), SHAPE_GROUP_POINT_EDIT_BEHAVIOR(), and UpdateItem().

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