Inkscape: Inkscape::UI::ControlPointSelection Class Reference

Searching...

No Matches

Group of selected control points. More...

#include <control-point-selection.h>

Inheritance diagram for Inkscape::UI::ControlPointSelection:

Public Types
using	set_type = std::unordered_set< SelectableControlPoint * >

using	Set = set_type

using	iterator = set_type::iterator

using	const_iterator = set_type::const_iterator

using	size_type = set_type::size_type

using	value_type = SelectableControlPoint *

using	key_type = SelectableControlPoint *

Public Member Functions
	ControlPointSelection (SPDesktop d, Inkscape::CanvasItemGroup th_group)

	~ControlPointSelection () override

bool	empty () const

size_type	size () const

iterator	begin ()

const_iterator	begin () const

iterator	end ()

const_iterator	end () const

std::pair< iterator, bool >	insert (const value_type &x, bool notify=true, bool to_update=true)
	Add a control point to the selection.

template<class InputIterator >
void	insert (InputIterator first, InputIterator last)

void	clear ()
	Remove all points from the selection, making it empty.

void	erase (iterator pos, bool to_update=true)
	Remove a point from the selection.

size_type	erase (const key_type &k, bool notify=true)

void	erase (iterator first, iterator last)

iterator	find (const key_type &k)

set_type const &	allPoints () const

set_type &	allPoints ()

void	selectAll ()
	Select all points that this selection can contain.

void	selectArea (Geom::Path const &, bool invert=false)
	Select all points inside the given rectangle (in desktop coordinates).

void	invertSelection ()
	Unselect all selected points and select all unselected points.

void	spatialGrow (SelectableControlPoint *origin, int dir)

bool	event (Inkscape::UI::Tools::ToolBase *tool, CanvasEvent const &event) override
	Handle input event. Returns true if handled.

void	transform (Geom::Affine const &m)
	Transform all selected control points by the given affine transformation.

void	align (Geom::Dim2 d, AlignTargetNode target=AlignTargetNode::MID_NODE)
	Align control points on the specified axis.

void	distribute (Geom::Dim2 d)
	Equdistantly distribute control points by moving them in the specified dimension.

Geom::OptRect	pointwiseBounds ()
	Get the bounds of the selection.

Geom::OptRect	bounds ()

std::optional< Geom::Point >	firstSelectedPoint () const
	The first selected point is the first selection a user makes, but only if they selected exactly one point.

bool	transformHandlesEnabled ()

void	showTransformHandles (bool v, bool one_node)

void	hideTransformHandles ()

void	restoreTransformHandles ()

void	toggleTransformHandlesMode ()

void	getOriginalPoints (std::vector< Inkscape::SnapCandidatePoint > &pts)

void	getUnselectedPoints (std::vector< Inkscape::SnapCandidatePoint > &pts)

void	setOriginalPoints ()

Public Member Functions inherited from Inkscape::UI::Manipulator
	Manipulator (SPDesktop *d)

virtual	~Manipulator ()=default

Public Attributes
sigc::signal< void()>	signal_update
	Fires when the display needs to be updated to reflect changes.

sigc::signal< void(std::vector< SelectableControlPoint * >, bool)>	signal_selection_changed

sigc::signal< void(CommitEvent)>	signal_commit
	Fires when a change that needs to be committed to XML happens.

std::list< SelectableControlPoint * >	_points_list

Public Attributes inherited from Inkscape::UI::Manipulator
SPDesktop *const	_desktop

Private Member Functions
void	_pointGrabbed (SelectableControlPoint *)

void	_pointDragged (Geom::Point &, MotionEvent const &)

void	_pointUngrabbed ()

bool	_pointClicked (SelectableControlPoint *, ButtonReleaseEvent const &)

void	_mouseoverChanged ()

void	_update ()

void	_updateTransformHandles (bool preserve_center)

void	_updateBounds ()

bool	_keyboardMove (KeyPressEvent const &, Geom::Point const &)
	Moves the selected points along the supplied unit vector according to the modifier state of the supplied event.

bool	_keyboardRotate (KeyPressEvent const &, int)
	Rotates the selected points in the given direction according to the modifier state from the supplied event.

bool	_keyboardScale (KeyPressEvent const &, int)

bool	_keyboardFlip (Geom::Dim2)

void	_keyboardTransform (Geom::Affine const &)

void	_commitHandlesTransform (CommitEvent ce)

double	_rotationRadius (Geom::Point const &)
	Computes the distance to the farthest corner of the bounding box.

Private Attributes
set_type	_points

set_type	_all_points

std::unordered_map< SelectableControlPoint *, Geom::Point >	_original_positions

std::unordered_map< SelectableControlPoint *, Geom::Affine >	_last_trans

std::optional< double >	_rot_radius

std::optional< double >	_mouseover_rot_radius

std::optional< Geom::Point >	_first_point

Geom::OptRect	_bounds

TransformHandleSet *	_handles

SelectableControlPoint *	_grabbed_point

SelectableControlPoint *	_farthest_point

unsigned	_dragging: 1

unsigned	_handles_visible: 1

unsigned	_one_node_handles: 1

Friends
class	SelectableControlPoint

Detailed Description

Group of selected control points.

Some operations can be performed on all selected points regardless of their type, therefore this class is also a Manipulator. It handles the transformations of points using the keyboard.

The exposed interface is similar to that of an STL set. Internally, a hash map is used.

Todo:: Correct iterators (that don't expose the connection list)

Definition at line 42 of file control-point-selection.h.

Member Typedef Documentation

◆ const_iterator

using Inkscape::UI::ControlPointSelection::const_iterator = set_type::const_iterator

Definition at line 53 of file control-point-selection.h.

◆ iterator

using Inkscape::UI::ControlPointSelection::iterator = set_type::iterator

Definition at line 52 of file control-point-selection.h.

◆ key_type

using Inkscape::UI::ControlPointSelection::key_type = SelectableControlPoint*

Definition at line 56 of file control-point-selection.h.

◆ Set

using Inkscape::UI::ControlPointSelection::Set = set_type

Definition at line 50 of file control-point-selection.h.

◆ set_type

using Inkscape::UI::ControlPointSelection::set_type = std::unordered_set<SelectableControlPoint*>

Definition at line 49 of file control-point-selection.h.

◆ size_type

using Inkscape::UI::ControlPointSelection::size_type = set_type::size_type

Definition at line 54 of file control-point-selection.h.

◆ value_type

using Inkscape::UI::ControlPointSelection::value_type = SelectableControlPoint*

Definition at line 55 of file control-point-selection.h.

Constructor & Destructor Documentation

◆ ControlPointSelection()

Inkscape::UI::ControlPointSelection::ControlPointSelection	(	SPDesktop *	d,
		Inkscape::CanvasItemGroup *	th_group
	)

Definition at line 53 of file control-point-selection.cpp.

References _commitHandlesTransform(), _handles, _mouseoverChanged(), _updateTransformHandles(), Inkscape::UI::TransformHandleSet::signal_commit, Inkscape::UI::ControlPoint::signal_mouseover_change, Inkscape::UI::TransformHandleSet::signal_transform, signal_update, and transform().

◆ ~ControlPointSelection()

Inkscape::UI::ControlPointSelection::~ControlPointSelection ( )

override

Definition at line 72 of file control-point-selection.cpp.

References _handles, and clear().

Member Function Documentation

◆ _commitHandlesTransform()

void Inkscape::UI::ControlPointSelection::_commitHandlesTransform ( CommitEvent ce )

private

Definition at line 682 of file control-point-selection.cpp.

References _updateBounds(), _updateTransformHandles(), and signal_commit.

Referenced by ControlPointSelection().

◆ _keyboardFlip()

bool Inkscape::UI::ControlPointSelection::_keyboardFlip ( Geom::Dim2 d )

private

Definition at line 661 of file control-point-selection.cpp.

References _handles, Inkscape::UI::COMMIT_FLIP_X, Inkscape::UI::COMMIT_FLIP_Y, empty(), Inkscape::UI::ControlPoint::mouseovered_point, Inkscape::UI::ControlPoint::position(), Inkscape::UI::TransformHandleSet::rotationCenter(), signal_commit, transform(), and Geom::X.

Referenced by event().

◆ _keyboardMove()

bool Inkscape::UI::ControlPointSelection::_keyboardMove	(	KeyPressEvent const &	event,
		Geom::Point const &	dir
	)

private

Moves the selected points along the supplied unit vector according to the modifier state of the supplied event.

Definition at line 534 of file control-point-selection.cpp.

References Inkscape::UI::Manipulator::_desktop, Inkscape::UI::COMMIT_KEYBOARD_MOVE_X, Inkscape::UI::COMMIT_KEYBOARD_MOVE_Y, SPDesktop::current_rotation(), SPDesktop::current_zoom(), delta, event(), Inkscape::Preferences::get(), Inkscape::UI::Tools::gobble_key_events(), Geom::Rotate::inverse(), Inkscape::mod_alt(), Inkscape::mod_ctrl(), Inkscape::mod_shift(), num, signal_commit, transform(), and Geom::Point::x().

Referenced by event().

◆ _keyboardRotate()

bool Inkscape::UI::ControlPointSelection::_keyboardRotate	(	KeyPressEvent const &	event,
		int	dir
	)

private

Rotates the selected points in the given direction according to the modifier state from the supplied event.

Parameters

event	Key event to take modifier state from
dir	Direction of rotation (math convention: 1 = counterclockwise, -1 = clockwise)

Definition at line 582 of file control-point-selection.cpp.

References Inkscape::UI::Manipulator::_desktop, _handles, _mouseover_rot_radius, _rot_radius, _rotationRadius(), Inkscape::UI::COMMIT_KEYBOARD_ROTATE, SPDesktop::current_zoom(), empty(), event(), Inkscape::Preferences::get(), Inkscape::Preferences::getIntLimited(), Inkscape::mod_alt(), Inkscape::UI::ControlPoint::mouseovered_point, Inkscape::UI::ControlPoint::position(), rc, Inkscape::UI::TransformHandleSet::rotationCenter(), signal_commit, and transform().

Referenced by event().

◆ _keyboardScale()

bool Inkscape::UI::ControlPointSelection::_keyboardScale	(	KeyPressEvent const &	event,
		int	dir
	)

private

◆ _keyboardTransform()

void Inkscape::UI::ControlPointSelection::_keyboardTransform ( Geom::Affine const & )

private

◆ _mouseoverChanged()

void Inkscape::UI::ControlPointSelection::_mouseoverChanged ( )

private

Definition at line 479 of file control-point-selection.cpp.

References _mouseover_rot_radius.

Referenced by ControlPointSelection().

◆ _pointClicked()

bool Inkscape::UI::ControlPointSelection::_pointClicked	(	SelectableControlPoint *	p,
		ButtonReleaseEvent const &	event
	)

private

Definition at line 468 of file control-point-selection.cpp.

References _handles_visible, event(), Inkscape::mod_none(), Inkscape::UI::SelectableControlPoint::selected(), and toggleTransformHandlesMode().

Referenced by Inkscape::UI::SelectableControlPoint::clicked().

◆ _pointDragged()

void Inkscape::UI::ControlPointSelection::_pointDragged	(	Geom::Point &	new_pos,
		MotionEvent const &	event
	)

private

◆ _pointGrabbed()

void Inkscape::UI::ControlPointSelection::_pointGrabbed ( SelectableControlPoint * point )

private

Definition at line 372 of file control-point-selection.cpp.

References _dragging, _farthest_point, _grabbed_point, _last_trans, _original_positions, _points, Geom::distance(), hideTransformHandles(), Inkscape::UI::ControlPoint::position(), and Geom::Affine::setIdentity().

Referenced by Inkscape::UI::SelectableControlPoint::grabbed().

◆ _pointUngrabbed()

void Inkscape::UI::ControlPointSelection::_pointUngrabbed ( )

private

Definition at line 456 of file control-point-selection.cpp.

References Inkscape::UI::Manipulator::_desktop, _dragging, _farthest_point, _grabbed_point, _last_trans, _original_positions, _updateBounds(), Inkscape::UI::COMMIT_MOUSE_MOVE, SPDesktop::getSnapIndicator(), Inkscape::Display::SnapIndicator::remove_snaptarget(), restoreTransformHandles(), and signal_commit.

Referenced by Inkscape::UI::SelectableControlPoint::ungrabbed().

◆ _rotationRadius()

double Inkscape::UI::ControlPointSelection::_rotationRadius ( Geom::Point const & rc )

private

Computes the distance to the farthest corner of the bounding box.

Used to determine what it means to "rotate by one pixel".

Definition at line 564 of file control-point-selection.cpp.

References bounds(), Geom::GenericRect< C >::corner(), Geom::distance(), empty(), len, and rc.

Referenced by _keyboardRotate().

◆ _update()

void Inkscape::UI::ControlPointSelection::_update ( )

private

Definition at line 484 of file control-point-selection.cpp.

References _bounds, _first_point, _handles, _updateBounds(), _updateTransformHandles(), begin(), empty(), Inkscape::UI::ControlPoint::move(), Inkscape::UI::TransformHandleSet::rotationCenter(), and size().

Referenced by clear(), erase(), erase(), insert(), insert(), invertSelection(), selectAll(), and selectArea().

◆ _updateBounds()

void Inkscape::UI::ControlPointSelection::_updateBounds ( )

private

Definition at line 500 of file control-point-selection.cpp.

References _bounds, _points, _rot_radius, and Geom::GenericOptRect< C >::expandTo().

Referenced by _commitHandlesTransform(), _pointUngrabbed(), _update(), and transform().

◆ _updateTransformHandles()

void Inkscape::UI::ControlPointSelection::_updateTransformHandles ( bool preserve_center )

private

◆ align()

void Inkscape::UI::ControlPointSelection::align	(	Geom::Dim2	d,
		AlignTargetNode	target = `AlignTargetNode::MID_NODE`
	)

Align control points on the specified axis.

Definition at line 251 of file control-point-selection.cpp.

References _points, _points_list, empty(), Inkscape::UI::FIRST_NODE, Inkscape::UI::LAST_NODE, Inkscape::UI::MAX_NODE, Inkscape::UI::MID_NODE, Inkscape::UI::MIN_NODE, and Geom::GenericOptInterval< C >::unionWith().

Referenced by Inkscape::UI::MultiPathManipulator::alignNodes().

◆ allPoints() [1/2]

set_type & Inkscape::UI::ControlPointSelection::allPoints ( )

inline

Definition at line 92 of file control-point-selection.h.

References _all_points.

◆ allPoints() [2/2]

set_type const & Inkscape::UI::ControlPointSelection::allPoints ( ) const

inline

Definition at line 91 of file control-point-selection.h.

References _all_points.

Referenced by Inkscape::UI::Node::dragged(), getUnselectedPoints(), Inkscape::UI::SelectableControlPoint::SelectableControlPoint(), Inkscape::UI::Tools::NodeTool::update_tip(), and Inkscape::UI::SelectableControlPoint::~SelectableControlPoint().

◆ begin() [1/2]

iterator Inkscape::UI::ControlPointSelection::begin ( )

inline

Definition at line 63 of file control-point-selection.h.

References _points.

Referenced by _update(), _updateTransformHandles(), clear(), and Inkscape::UI::MultiPathManipulator::event().

◆ begin() [2/2]

const_iterator Inkscape::UI::ControlPointSelection::begin ( ) const

inline

Definition at line 64 of file control-point-selection.h.

References _points.

◆ bounds()

Geom::OptRect Inkscape::UI::ControlPointSelection::bounds ( )

Definition at line 330 of file control-point-selection.cpp.

References _bounds, _points, bounds(), and size().

Referenced by _keyboardScale(), _rotationRadius(), _updateTransformHandles(), and bounds().

◆ clear()

void Inkscape::UI::ControlPointSelection::clear ( )

Remove all points from the selection, making it empty.

Definition at line 134 of file control-point-selection.cpp.

References _points, _points_list, _update(), begin(), empty(), end(), and signal_selection_changed.

Referenced by Inkscape::UI::SelectableControlPoint::_takeSelection(), Inkscape::UI::CurveDragPoint::clicked(), Inkscape::UI::PathManipulator::insertNode(), Inkscape::UI::Tools::NodeTool::root_handler(), Inkscape::UI::Tools::NodeTool::select_area(), Inkscape::UI::Tools::NodeTool::select_point(), Inkscape::SelectionHelper::selectNone(), Inkscape::UI::MultiPathManipulator::shiftSelection(), ~ControlPointSelection(), and Inkscape::UI::Tools::NodeTool::~NodeTool().

◆ distribute()

void Inkscape::UI::ControlPointSelection::distribute ( Geom::Dim2 d )

Equdistantly distribute control points by moving them in the specified dimension.

Definition at line 292 of file control-point-selection.cpp.

References _points, empty(), num, size(), Inkscape::UI::start, and Geom::GenericOptInterval< C >::unionWith().

Referenced by Inkscape::UI::MultiPathManipulator::distributeNodes().

◆ empty()

bool Inkscape::UI::ControlPointSelection::empty ( ) const

inline

Definition at line 59 of file control-point-selection.h.

References _points.

◆ end() [1/2]

iterator Inkscape::UI::ControlPointSelection::end ( )

inline

Definition at line 65 of file control-point-selection.h.

References _points.

Referenced by clear(), and Inkscape::UI::SelectableControlPoint::selected().

◆ end() [2/2]

const_iterator Inkscape::UI::ControlPointSelection::end ( ) const

inline

Definition at line 66 of file control-point-selection.h.

References _points.

◆ erase() [1/3]

ControlPointSelection::size_type Inkscape::UI::ControlPointSelection::erase	(	const key_type &	k,
		bool	notify = `true`
	)

Definition at line 112 of file control-point-selection.cpp.

References _points, erase(), and signal_selection_changed.

◆ erase() [2/3]

void Inkscape::UI::ControlPointSelection::erase	(	iterator	first,
		iterator	last
	)

Definition at line 123 of file control-point-selection.cpp.

References _update(), erase(), and signal_selection_changed.

◆ erase() [3/3]

void Inkscape::UI::ControlPointSelection::erase	(	iterator	pos,
		bool	to_update = `true`
	)

Remove a point from the selection.

Definition at line 102 of file control-point-selection.cpp.

References _points, _points_list, _update(), and Inkscape::UI::SelectableControlPoint::updateState().

Referenced by Inkscape::UI::Node::_linearGrow(), Inkscape::UI::PathManipulator::_removeNodesFromSelection(), Inkscape::UI::CurveDragPoint::clicked(), Inkscape::UI::SelectableControlPoint::clicked(), Inkscape::UI::PathManipulator::duplicateNodes(), erase(), erase(), invertSelection(), Inkscape::UI::PathManipulator::invertSelectionInSubpaths(), Inkscape::UI::SelectableControlPoint::select(), selectArea(), spatialGrow(), and Inkscape::UI::SelectableControlPoint::~SelectableControlPoint().

◆ event()

bool Inkscape::UI::ControlPointSelection::event	(	Inkscape::UI::Tools::ToolBase *	tool,
		CanvasEvent const &	event
	)

overridevirtual

Handle input event. Returns true if handled.

Implements Inkscape::UI::Manipulator.

Definition at line 689 of file control-point-selection.cpp.

References Inkscape::UI::Manipulator::_desktop, _keyboardFlip(), _keyboardMove(), _keyboardRotate(), _keyboardScale(), empty(), event(), Inkscape::KEY_PRESS, Inkscape::mod_any(), Inkscape::mod_shift(), toggleTransformHandlesMode(), Geom::X, Geom::Y, and SPDesktop::yaxisdir().

Referenced by _keyboardMove(), _keyboardRotate(), _keyboardScale(), _pointClicked(), _pointDragged(), event(), and Inkscape::UI::Tools::NodeTool::root_handler().

◆ find()

iterator Inkscape::UI::ControlPointSelection::find ( const key_type & k )

inline

Definition at line 86 of file control-point-selection.h.

References _points.

Referenced by Inkscape::UI::SelectableControlPoint::selected().

◆ firstSelectedPoint()

std::optional< Geom::Point > Inkscape::UI::ControlPointSelection::firstSelectedPoint ( ) const

The first selected point is the first selection a user makes, but only if they selected exactly one point.

Selecting multiples at once does nothing.

Definition at line 339 of file control-point-selection.cpp.

References _first_point.

◆ getOriginalPoints()

void Inkscape::UI::ControlPointSelection::getOriginalPoints ( std::vector< Inkscape::SnapCandidatePoint > & pts )

Definition at line 759 of file control-point-selection.cpp.

References _original_positions, _points, and Inkscape::SNAPSOURCE_NODE_HANDLE.

◆ getUnselectedPoints()

void Inkscape::UI::ControlPointSelection::getUnselectedPoints ( std::vector< Inkscape::SnapCandidatePoint > & pts )

Definition at line 767 of file control-point-selection.cpp.

References allPoints(), and node.

◆ hideTransformHandles()

void Inkscape::UI::ControlPointSelection::hideTransformHandles ( )

Definition at line 351 of file control-point-selection.cpp.

References _handles, and Inkscape::UI::TransformHandleSet::setVisible().

Referenced by Inkscape::UI::PathManipulator::_handleGrabbed(), _pointGrabbed(), and Inkscape::UI::CurveDragPoint::grabbed().

◆ insert() [1/2]

std::pair< ControlPointSelection::iterator, bool > Inkscape::UI::ControlPointSelection::insert	(	const value_type &	x,
		bool	notify = `true`,
		bool	to_update = `true`
	)