Class that implements "standard" polygon editing behavior. More...

#include <point_editor_behavior.h>

Inheritance diagram for POLYGON_POINT_EDIT_BEHAVIOR:

Public Member Functions
	POLYGON_POINT_EDIT_BEHAVIOR (SHAPE_POLY_SET &aPolygon)

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 Public Member Functions
static void	BuildForPolyOutline (EDIT_POINTS &aPoints, const SHAPE_POLY_SET &aOutline)
	Build the edit points for the given polygon outline.

static void	UpdatePointsFromOutline (const SHAPE_POLY_SET &aOutline, EDIT_POINTS &aPoints)
	Update the edit points with the current polygon outline.

static void	UpdateOutlineFromPoints (SHAPE_POLY_SET &aOutline, const EDIT_POINT &aEditedPoint, EDIT_POINTS &aPoints)
	Update the polygon outline with the new positions of the edit 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
SHAPE_POLY_SET &	m_polygon

Detailed Description

Class that implements "standard" polygon editing behavior.

You still need to implement the POINT_EDIT_BEHAVIOR interface (in particular, you may need to construct a poly set from or apply the poly set to an actual object) but you can use the helper methods in this class to do the actual work.

Definition at line 126 of file point_editor_behavior.h.

Constructor & Destructor Documentation

◆ POLYGON_POINT_EDIT_BEHAVIOR()

POLYGON_POINT_EDIT_BEHAVIOR::POLYGON_POINT_EDIT_BEHAVIOR ( SHAPE_POLY_SET & aPolygon )

inline

Definition at line 129 of file point_editor_behavior.h.

Member Function Documentation

◆ BuildForPolyOutline()

void POLYGON_POINT_EDIT_BEHAVIOR::BuildForPolyOutline	(	EDIT_POINTS &	aPoints,
		const SHAPE_POLY_SET &	aOutline
	)

static

Build the edit points for the given polygon outline.

Definition at line 29 of file point_editor_behavior.cpp.

References EDIT_POINTS::AddBreak(), EDIT_POINTS::AddLine(), EDIT_POINTS::AddPoint(), SHAPE_POLY_SET::CIterateWithHoles(), EDIT_POINTS::GetContourStartIdx(), EDIT_POINTS::IsContourEnd(), EDIT_POINTS::Line(), EDIT_POINTS::LinesSize(), EDIT_POINTS::Point(), EDIT_LINE::SetConstraint(), and SHAPE_POLY_SET::TotalVertices().

Referenced by MakePoints(), and UpdatePointsFromOutline().

◆ 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()

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

◆ MakePoints()

void POLYGON_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

aPoints The list of edit points to fill.

Implements POINT_EDIT_BEHAVIOR.

Definition at line 149 of file point_editor_behavior.h.

References BuildForPolyOutline(), and m_polygon.

◆ UpdateItem()

void POLYGON_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

aEditedPoint	The point that was dragged. You can use this to check by address which point to update.
aPoints	The new positions of the edit points.
aCommit	The commit object to use to modify the item.
aUpdatedItems	The 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.

Reimplemented in ZONE_POINT_EDIT_BEHAVIOR.

Definition at line 159 of file point_editor_behavior.h.

References m_polygon, and UpdateOutlineFromPoints().

Referenced by ZONE_POINT_EDIT_BEHAVIOR::UpdateItem().