"Standard" reference image editing behavior. More...

#include <point_editor_behavior.h>

Inheritance diagram for REFERENCE_IMAGE_POINT_EDIT_BEHAVIOR:

Public Member Functions
	REFERENCE_IMAGE_POINT_EDIT_BEHAVIOR (REFERENCE_IMAGE &aImage, int aMinSize)

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 Types
enum	REFIMG_POINTS { REFIMG_TOP_LEFT , REFIMG_TOP_RIGHT , REFIMG_BOT_RIGHT , REFIMG_BOT_LEFT , REFIMG_ORIGIN , REFIMG_ROTATION , REFIMG_MAX_POINTS }

Private Attributes
REFERENCE_IMAGE &	m_image

int	m_minSize

Detailed Description

"Standard" reference image editing behavior.

Works over the REFERENCE_IMAGE basis of PCB_REFERENCE_IMAGE and SCH_BITMAP.

The corner handles sit on the image's bounding box, because the raster is stored upright and only turned when it is drawn. A cardinal rotation puts the box corners on the image corners; any other angle leaves them on the drawn extent.

Drag semantics:

Corner handles: resize the image.
Origin handle: move the transform origin.

Definition at line 416 of file point_editor_behavior.h.

Member Enumeration Documentation

◆ REFIMG_POINTS

enum REFERENCE_IMAGE_POINT_EDIT_BEHAVIOR::REFIMG_POINTS

private

Enumerator
REFIMG_TOP_LEFT
REFIMG_TOP_RIGHT
REFIMG_BOT_RIGHT
REFIMG_BOT_LEFT
REFIMG_ORIGIN
REFIMG_ROTATION
REFIMG_MAX_POINTS

Definition at line 418 of file point_editor_behavior.h.

Constructor & Destructor Documentation

◆ REFERENCE_IMAGE_POINT_EDIT_BEHAVIOR()

REFERENCE_IMAGE_POINT_EDIT_BEHAVIOR::REFERENCE_IMAGE_POINT_EDIT_BEHAVIOR	(	REFERENCE_IMAGE &	aImage,
		int	aMinSize )

inline

Parameters

aImage	the image to edit.
aMinSize	the smallest width and height the image may be scaled to, in IU.

Definition at line 435 of file point_editor_behavior.h.

References m_image, and m_minSize.

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

aPoints	The final positions of the edit points.
aCommit	The commit object to use to modify the item.

Reimplemented in EDA_POLYGON_POINT_EDIT_BEHAVIOR, and POLYGON_POINT_EDIT_BEHAVIOR.

Definition at line 80 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 107 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 118 of file point_editor_behavior.h.

◆ MakePoints()

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

aPoints The list of edit points to fill.

Implements POINT_EDIT_BEHAVIOR.

Definition at line 845 of file point_editor_behavior.cpp.

References EDIT_POINTS::AddIndicatorLine(), EDIT_POINTS::AddPoint(), EDIT_POINTS::Point(), REFIMG_BOT_LEFT, REFIMG_BOT_RIGHT, REFIMG_MAX_POINTS, REFIMG_ORIGIN, REFIMG_ROTATION, REFIMG_TOP_LEFT, REFIMG_TOP_RIGHT, and UpdatePoints().

◆ UpdateItem()

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

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.

Definition at line 894 of file point_editor_behavior.cpp.

References ANGLE_90, CHECK_POINT_COUNT, VECTOR2< T >::EuclideanNorm(), EDIT_POINT::GetPosition(), POINT_EDIT_BEHAVIOR::isModified(), m_image, m_minSize, EDIT_POINTS::Point(), RADIANS_T, REFIMG_BOT_LEFT, REFIMG_BOT_RIGHT, REFIMG_MAX_POINTS, REFIMG_ORIGIN, REFIMG_ROTATION, REFIMG_TOP_LEFT, REFIMG_TOP_RIGHT, sign(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ UpdatePoints()

bool REFERENCE_IMAGE_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 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

aPoints The list of edit points to update.

Implements POINT_EDIT_BEHAVIOR.

Definition at line 862 of file point_editor_behavior.cpp.

References GetRotated(), KiROUND(), m_image, EDIT_POINTS::Point(), EDIT_POINTS::PointsSize(), REFIMG_BOT_LEFT, REFIMG_BOT_RIGHT, REFIMG_MAX_POINTS, REFIMG_ORIGIN, REFIMG_ROTATION, REFIMG_TOP_LEFT, REFIMG_TOP_RIGHT, EDIT_POINT::SetPosition(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by MakePoints().

Member Data Documentation

◆ m_image

REFERENCE_IMAGE& REFERENCE_IMAGE_POINT_EDIT_BEHAVIOR::m_image

private

Definition at line 449 of file point_editor_behavior.h.

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

◆ m_minSize

int REFERENCE_IMAGE_POINT_EDIT_BEHAVIOR::m_minSize

private

Definition at line 450 of file point_editor_behavior.h.

Referenced by REFERENCE_IMAGE_POINT_EDIT_BEHAVIOR(), and UpdateItem().

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

Public Member Functions

Static Protected Member Functions

Private Types

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ REFIMG_POINTS

Constructor & Destructor Documentation

◆ REFERENCE_IMAGE_POINT_EDIT_BEHAVIOR()

Member Function Documentation

◆ FinalizeItem()

◆ Get45DegreeConstrainer()

◆ isModified()

◆ MakePoints()

◆ UpdateItem()

◆ UpdatePoints()

Member Data Documentation

◆ m_image

◆ m_minSize