Inkscape: Inkscape::UI::Tools::PenTool Class Reference

Searching...

No Matches

PenTool: a context for pen tool events. More...

#include <pen-tool.h>

Inheritance diagram for Inkscape::UI::Tools::PenTool:

Public Types
enum	Mode { MODE_CLICK , MODE_DRAG }

enum	State { POINT , CONTROL , CLOSE , STOP , DEAD }

Public Member Functions
	PenTool (SPDesktop *desktop, std::string &&prefs_path="/tools/freehand/pen", std::string &&cursor_filename="pen.svg")

	~PenTool () override

void	nextParaxialDirection (Geom::Point const &pt, Geom::Point const &origin, guint state)

void	setPolylineMode ()

bool	hasWaitingLPE ()

void	waitForLPEMouseClicks (Inkscape::LivePathEffect::EffectType effect_type, unsigned int num_clicks, bool use_polylines=true)

Public Member Functions inherited from Inkscape::UI::Tools::FreehandBase
	FreehandBase (SPDesktop *desktop, std::string &&prefs_path, std::string &&cursor_filename)

	~FreehandBase () override

std::optional< Geom::Point >	red_curve_get_last_point () const

void	onSelectionModified ()

Public Member Functions inherited from Inkscape::UI::Tools::ToolBase
	ToolBase (SPDesktop *desktop, std::string &&prefs_path, std::string &&cursor_filename, bool uses_snap=true)

virtual	~ToolBase ()

virtual void	menu_popup (CanvasEvent const &event, SPObject *obj=nullptr)
	Create popup menu and tell Gtk to show it.

virtual bool	can_undo (bool redo=false)

virtual bool	is_ready () const

virtual void	switching_away (std::string const &new_tool)

std::string const &	getPrefsPath () const

void	enableSelectionCue (bool enable=true)
	Enables/disables the ToolBase's SelCue.

MessageContext *	defaultMessageContext () const

SPDesktop *	getDesktop () const

SPGroup *	currentLayer () const

void	set_last_active_tool (Glib::ustring last_tool)

const Glib::ustring &	get_last_active_tool () const

bool	start_root_handler (CanvasEvent const &event)
	Handles snapping events for all tools and then passes to tool_root_handler.

bool	tool_root_handler (CanvasEvent const &event)
	Calls the right tool's event handler, depending on the selected tool and state.

bool	start_item_handler (SPItem *item, CanvasEvent const &event)
	Starts handling item snapping and pass to virtual_item_handler afterwards.

bool	virtual_item_handler (SPItem *item, CanvasEvent const &event)

bool	is_panning () const
	True if we're panning with any method (space bar, middle-mouse, right-mouse+Ctrl)

bool	is_space_panning () const
	True if we're panning with the space bar.

void	snap_delay_handler (gpointer item, gpointer item2, MotionEvent const &event, DelayedSnapEvent::Origin origin)
	Analyses the current event, calculates the mouse speed, turns snapping off (temporarily) if the mouse speed is above a threshold, and stores the current event such that it can be re-triggered when needed (re-triggering is controlled by a timeout).

void	process_delayed_snap_event ()
	When the delayed snap event timer expires, this method will be called and will re-inject the last motion event in an appropriate place, with snapping being turned on again.

void	discard_delayed_snap_event ()
	If a delayed snap event has been scheduled, this function will cancel it.

void	set_cursor (std::string filename)
	Sets the current cursor to the given filename.

void	use_cursor (Glib::RefPtr< Gdk::Cursor > cursor)
	Set the cursor to this specific one, don't remember it.

Glib::RefPtr< Gdk::Cursor >	get_cursor (Gtk::Widget &widget, std::string const &filename) const
	Returns the Gdk Cursor for the given filename.

void	use_tool_cursor ()
	Uses the saved cursor, based on the saved filename.

void	enableGrDrag (bool enable=true)

bool	deleteSelectedDrag (bool just_one)
	Delete a selected GrDrag point.

bool	hasGradientDrag () const
	Return true if there is a gradient drag.

GrDrag *	get_drag ()

Public Attributes
Geom::Point	p_array [5]

Geom::Point	previous

gint	npoints = 0
	\invar npoints in {0, 2, 5}.

Mode	mode = MODE_CLICK

State	state = POINT

bool	polylines_only = false

bool	polylines_paraxial = false

Geom::Point	paraxial_angle

bool	spiro = false

bool	bspline = false

unsigned int	expecting_clicks_for_LPE = 0

Inkscape::LivePathEffect::Effect *	waiting_LPE = nullptr

SPLPEItem *	waiting_item = nullptr

CanvasItemPtr< CanvasItemCtrl >	ctrl [4]

CanvasItemPtr< CanvasItemCurve >	cl0

CanvasItemPtr< CanvasItemCurve >	cl1

bool	events_disabled = false

Public Attributes inherited from Inkscape::UI::Tools::FreehandBase
Selection *	selection = nullptr

CanvasItemPtr< CanvasItemBpath >	red_bpath

Geom::PathVector	red_curve

CanvasItemPtr< CanvasItemBpath >	blue_bpath

Geom::PathVector	blue_curve

std::vector< CanvasItemPtr< CanvasItemBpath > >	green_bpaths

std::shared_ptr< Geom::PathVector >	green_curve

std::unique_ptr< SPDrawAnchor >	green_anchor

bool	green_closed = false

SPItem *	white_item = nullptr

std::vector< std::shared_ptr< Geom::PathVector > >	white_curves

std::vector< std::unique_ptr< SPDrawAnchor > >	white_anchors

std::shared_ptr< Geom::PathVector >	sa_overwrited

SPDrawAnchor *	sa = nullptr

SPDrawAnchor *	ea = nullptr

LivePathEffect::EffectType	waiting_LPE_type = LivePathEffect::INVALID_LPE

sigc::connection	sel_changed_connection

sigc::connection	sel_modified_connection

bool	red_curve_is_valid = false

bool	anchor_statusbar = false

bool	tablet_enabled = false

bool	is_tablet = false

double	pressure = 1.0

Public Attributes inherited from Inkscape::UI::Tools::ToolBase
std::unique_ptr< MessageContext >	message_context

SelCue *	_selcue = nullptr

GrDrag *	_grdrag = nullptr

ShapeEditor *	shape_editor = nullptr

bool	_uses_snap = false

Static Public Attributes
static constexpr std::array< CanvasItemCtrlType, 4 >	ctrl_types

Protected Member Functions
void	set (Inkscape::Preferences::Entry const &val) override
	Callback that sets key to value in pen context.

bool	root_handler (CanvasEvent const &event) override
	Callback to handle all pen events.

bool	item_handler (SPItem *item, CanvasEvent const &event) override
	Handles item specific events.

Protected Member Functions inherited from Inkscape::UI::Tools::FreehandBase
void	_attachSelection ()

Protected Member Functions inherited from Inkscape::UI::Tools::ToolBase
void	setup_for_drag_start (ButtonPressEvent const &ev)

void	saveDragOrigin (Geom::Point const &pos)

bool	checkDragMoved (Geom::Point const &pos)
	Analyse the current position and return true once it has moved farther than tolerance from the drag origin (indicating they intend to move the object, not click).

void	grabCanvasEvents (EventMask mask=EventType::KEY_PRESS\|EventType::BUTTON_RELEASE\|EventType::MOTION\|EventType::BUTTON_PRESS)
	Grab events from the Canvas Catchall.

void	ungrabCanvasEvents ()
	Ungrab events from the Canvas Catchall.

bool	sp_event_context_knot_mouseover () const
	Returns true if we're hovering above a knot (needed because we don't want to pre-snap in that case).

void	set_high_motion_precision (bool high_precision=true)
	Enable (or disable) high precision for motion events.

Private Member Functions
bool	_handleButtonPress (ButtonPressEvent const &event)
	Handle mouse single button press event.

bool	_handle2ButtonPress (ButtonPressEvent const &event)
	Handle mouse double button press event.

bool	_handleMotionNotify (MotionEvent const &event)
	Handle motion_notify event.

bool	_handleButtonRelease (ButtonReleaseEvent const &event)
	Handle mouse button release event.

bool	_handleKeyPress (KeyPressEvent const &event)

void	_bsplineSpiroColor ()

void	_bsplineSpiro (bool shift)

void	_bsplineSpiroOn ()

void	_bsplineSpiroOff ()

void	_bsplineSpiroStartAnchor (bool shift)

void	_bsplineSpiroStartAnchorOn ()

void	_bsplineSpiroStartAnchorOff ()

void	_bsplineSpiroMotion (guint const state)

void	_bsplineSpiroEndAnchorOn ()

void	_bsplineSpiroEndAnchorOff ()

void	_bsplineSpiroBuild ()

void	_setInitialPoint (Geom::Point const p)

void	_setSubsequentPoint (Geom::Point const p, bool statusbar, guint status=0)

void	_setCtrl (Geom::Point const p, guint state)

void	_finishSegment (Geom::Point p, guint state)

bool	_undoLastPoint (bool user_undo=false)

bool	_redoLastPoint ()
	Re-add the last undone point to the path being drawn.

void	_finish (bool closed)

void	_resetColors ()

void	_disableEvents ()

void	_enableEvents ()

void	_setToNearestHorizVert (Geom::Point &pt, guint const state) const

void	_setAngleDistanceStatusMessage (Geom::Point const p, int pc_point_to_compare, gchar const *message)
	Show the status message for the current line/curve segment.

void	_lastpointToLine ()

void	_lastpointToCurve ()

void	_lastpointMoveScreen (gdouble x, gdouble y)

void	_lastpointMove (gdouble x, gdouble y)

void	_redrawAll ()

void	_endpointSnapHandle (Geom::Point &p, guint const state)
	Snaps new node's handle relative to the new node.

void	_endpointSnap (Geom::Point &p, guint const state)
	Snaps new node relative to the previous node.

void	_cancel ()

Private Attributes
sigc::connection	_desktop_destroy

std::vector< Geom::PathVector >	_redo_stack
	History of undone events.

bool	_did_redo = false

Util::ActionAccel	_acc_to_line

Util::ActionAccel	_acc_to_curve

Util::ActionAccel	_acc_to_guides

Additional Inherited Members
Protected Attributes inherited from Inkscape::UI::Tools::FreehandBase
uint32_t	red_color = 0xff00007f

uint32_t	blue_color = 0x0000ff7f

uint32_t	green_color = 0x00ff007f

uint32_t	highlight_color = 0x0000007f

Protected Attributes inherited from Inkscape::UI::Tools::ToolBase
Glib::RefPtr< Gdk::Cursor >	_cursor

std::string	_cursor_filename = "select.svg"

std::string	_cursor_default = "select.svg"

Geom::IntPoint	xyp
	where drag started

bool	dragging = false
	are we dragging?

int	tolerance = 0

bool	within_tolerance = false
	are we still within tolerance of origin

bool	_button1on = false

bool	_button2on = false

bool	_button3on = false

SPItem *	item_to_select = nullptr
	the item where mouse_press occurred, to be selected if this is a click not drag

SPDesktop *	_desktop = nullptr

Util::ActionAccel	_acc_undo

Util::ActionAccel	_acc_redo

Util::ActionAccel	_acc_quick_preview

Util::ActionAccel	_acc_quick_zoom

Util::ActionAccel	_acc_quick_pan

Detailed Description

PenTool: a context for pen tool events.

Definition at line 37 of file pen-tool.h.

Member Enumeration Documentation

◆ Mode

enum Inkscape::UI::Tools::PenTool::Mode

Enumerator
MODE_CLICK
MODE_DRAG

Definition at line 45 of file pen-tool.h.

◆ State

enum Inkscape::UI::Tools::PenTool::State

Enumerator
POINT
CONTROL
CLOSE
STOP
DEAD

Definition at line 50 of file pen-tool.h.

Constructor & Destructor Documentation

◆ PenTool()

Inkscape::UI::Tools::PenTool::PenTool	(	SPDesktop *	desktop,
		std::string &&	prefs_path = `"/tools/freehand/pen"`,
		std::string &&	cursor_filename = `"pen.svg"`
	)

◆ ~PenTool()

Inkscape::UI::Tools::PenTool::~PenTool ( )

override

Definition at line 97 of file pen-tool.cpp.

References _desktop_destroy, _finish(), c, cl0, cl1, ctrl, DEAD, Inkscape::UI::Tools::ToolBase::discard_delayed_snap_event(), Inkscape::UI::Tools::FreehandBase::ea, expecting_clicks_for_LPE, npoints, SPLPEItem::removeCurrentPathEffect(), state, and waiting_item.

Member Function Documentation

◆ _bsplineSpiro()

void Inkscape::UI::Tools::PenTool::_bsplineSpiro ( bool shift )

private

Definition at line 1214 of file pen-tool.cpp.

References _bsplineSpiroBuild(), _bsplineSpiroOff(), _bsplineSpiroOn(), bspline, and spiro.

Referenced by _finishSegment().

◆ _bsplineSpiroBuild()

void Inkscape::UI::Tools::PenTool::_bsplineSpiroBuild ( )

private

Definition at line 1521 of file pen-tool.cpp.

Referenced by _bsplineSpiro(), _bsplineSpiroMotion(), _redoLastPoint(), _redrawAll(), and _undoLastPoint().

◆ _bsplineSpiroColor()

void Inkscape::UI::Tools::PenTool::_bsplineSpiroColor ( )

private

◆ _bsplineSpiroEndAnchorOff()

void Inkscape::UI::Tools::PenTool::_bsplineSpiroEndAnchorOff ( )

private

Definition at line 1479 of file pen-tool.cpp.

References Geom::Path::appendNew(), backspace(), Geom::PathVector::curveCount(), Geom::PathVector::finalPoint(), get_last_segment(), Inkscape::UI::Tools::FreehandBase::green_anchor, Inkscape::UI::Tools::FreehandBase::green_curve, Geom::Curve::initialPoint(), p_array, pathvector_append_continuous(), Geom::PathVector::reverse(), Geom::PathVector::reversed(), Inkscape::UI::Tools::FreehandBase::sa, and Inkscape::UI::Tools::FreehandBase::sa_overwrited.

Referenced by _bsplineSpiroMotion().

◆ _bsplineSpiroEndAnchorOn()

void Inkscape::UI::Tools::PenTool::_bsplineSpiroEndAnchorOn ( )

private

◆ _bsplineSpiroMotion()

void Inkscape::UI::Tools::PenTool::_bsplineSpiroMotion ( guint const state )

private

Definition at line 1331 of file pen-tool.cpp.

Referenced by _bsplineSpiroOn(), and _handleMotionNotify().

◆ _bsplineSpiroOff()

void Inkscape::UI::Tools::PenTool::_bsplineSpiroOff ( )

private

Definition at line 1235 of file pen-tool.cpp.

References Geom::PathVector::curveCount(), Geom::Curve::finalPoint(), get_first_segment(), Geom::PathVector::initialPoint(), npoints, p_array, and Inkscape::UI::Tools::FreehandBase::red_curve.

Referenced by _bsplineSpiro().

◆ _bsplineSpiroOn()

void Inkscape::UI::Tools::PenTool::_bsplineSpiroOn ( )

private

Definition at line 1224 of file pen-tool.cpp.

References _bsplineSpiroMotion(), Geom::PathVector::curveCount(), Geom::Curve::finalPoint(), get_first_segment(), Geom::PathVector::initialPoint(), npoints, p_array, and Inkscape::UI::Tools::FreehandBase::red_curve.

Referenced by _bsplineSpiro().

◆ _bsplineSpiroStartAnchor()

void Inkscape::UI::Tools::PenTool::_bsplineSpiroStartAnchor ( bool shift )

private

Definition at line 1245 of file pen-tool.cpp.

References _bsplineSpiroColor(), _bsplineSpiroStartAnchorOff(), _bsplineSpiroStartAnchorOn(), Inkscape::LivePathEffect::BSPLINE, bspline, SPDrawAnchor::curve, LivePathEffectObject::get_lpe(), Inkscape::LivePathEffect::Effect::getLPEObj(), Inkscape::UI::Tools::FreehandBase::sa, Inkscape::LivePathEffect::SPIRO, spiro, and Inkscape::UI::Tools::FreehandBase::white_item.

Referenced by _handleButtonPress(), _lastpointToCurve(), and _lastpointToLine().

◆ _bsplineSpiroStartAnchorOff()

void Inkscape::UI::Tools::PenTool::_bsplineSpiroStartAnchorOff ( )

private

Definition at line 1314 of file pen-tool.cpp.

References Geom::Path::appendNew(), backspace(), get_last_segment(), pathvector_append_continuous(), and Inkscape::UI::Tools::FreehandBase::sa_overwrited.

Referenced by _bsplineSpiroStartAnchor().

◆ _bsplineSpiroStartAnchorOn()

void Inkscape::UI::Tools::PenTool::_bsplineSpiroStartAnchorOn ( )

private

Definition at line 1290 of file pen-tool.cpp.

References backspace(), get_last_segment(), Geom::Curve::initialPoint(), pathvector_append_continuous(), Inkscape::UI::Tools::FreehandBase::sa_overwrited, Geom::X, and Geom::Y.

Referenced by _bsplineSpiroStartAnchor().

◆ _cancel()

void Inkscape::UI::Tools::PenTool::_cancel ( )

private

Definition at line 136 of file pen-tool.cpp.

References _redo_stack, _resetColors(), c, cl0, cl1, ctrl, Inkscape::UI::Tools::ToolBase::message_context, Inkscape::NORMAL_MESSAGE, state, and STOP.

Referenced by _handleKeyPress(), and _undoLastPoint().

◆ _disableEvents()

void Inkscape::UI::Tools::PenTool::_disableEvents ( )

private

Definition at line 1886 of file pen-tool.cpp.

References events_disabled.

Referenced by _finish().

◆ _enableEvents()

void Inkscape::UI::Tools::PenTool::_enableEvents ( )

private

Definition at line 1890 of file pen-tool.cpp.

References events_disabled.

Referenced by _finish().

◆ _endpointSnap()

void Inkscape::UI::Tools::PenTool::_endpointSnap	(	Geom::Point &	p,
		guint const	state
	)

private

Snaps new node relative to the previous node.

Definition at line 173 of file pen-tool.cpp.

References _setToNearestHorizVert(), Inkscape::UI::Tools::FreehandBase::green_curve, npoints, origin, p_array, polylines_paraxial, Inkscape::UI::Tools::spdc_endpoint_snap_free(), Inkscape::UI::Tools::spdc_endpoint_snap_rotation(), and state.

Referenced by _handleButtonPress(), _handleButtonRelease(), and _handleMotionNotify().

◆ _endpointSnapHandle()

void Inkscape::UI::Tools::PenTool::_endpointSnapHandle	(	Geom::Point &	p,
		guint const	state
	)

private

Snaps new node's handle relative to the new node.

Definition at line 203 of file pen-tool.cpp.

References npoints, origin, p_array, Inkscape::UI::Tools::spdc_endpoint_snap_free(), Inkscape::UI::Tools::spdc_endpoint_snap_rotation(), and state.

Referenced by _handleMotionNotify().

◆ _finish()

void Inkscape::UI::Tools::PenTool::_finish ( bool closed )

private

◆ _finishSegment()

void Inkscape::UI::Tools::PenTool::_finishSegment	(	Geom::Point	p,
		guint	state
	)

private

◆ _handle2ButtonPress()

bool Inkscape::UI::Tools::PenTool::_handle2ButtonPress ( ButtonPressEvent const & event )

private

Handle mouse double button press event.

Definition at line 452 of file pen-tool.cpp.

References _finish(), Inkscape::ButtonEvent::button, CLOSE, npoints, and state.

◆ _handleButtonPress()

bool Inkscape::UI::Tools::PenTool::_handleButtonPress ( ButtonPressEvent const & event )

private

Handle mouse single button press event.

Definition at line 267 of file pen-tool.cpp.

Referenced by item_handler().

◆ _handleButtonRelease()

bool Inkscape::UI::Tools::PenTool::_handleButtonRelease ( ButtonReleaseEvent const & event )

private

Handle mouse button release event.

Definition at line 633 of file pen-tool.cpp.

References Inkscape::UI::Tools::ToolBase::_desktop, _endpointSnap(), _finish(), _finishSegment(), Inkscape::LivePathEffect::Effect::acceptParamPath(), Inkscape::Selection::add(), bspline, Inkscape::ButtonEvent::button, CLOSE, CONTROL, ctrl, SPDrawAnchor::dp, Inkscape::UI::Tools::FreehandBase::ea, events_disabled, expecting_clicks_for_LPE, SPDesktop::getSelection(), Inkscape::UI::Tools::FreehandBase::green_closed, hasWaitingLPE(), mode, MODE_CLICK, MODE_DRAG, Inkscape::CanvasEvent::modifiers, npoints, p_array, POINT, Inkscape::ButtonEvent::pos, Inkscape::UI::Tools::FreehandBase::sa, Inkscape::UI::Tools::FreehandBase::selection, setPolylineMode(), Inkscape::ObjectSet::singleItem(), Inkscape::UI::Tools::spdc_test_inside(), spiro, state, STOP, Inkscape::UI::Tools::ToolBase::ungrabCanvasEvents(), SPDesktop::w2d(), waiting_item, and waiting_LPE.

Referenced by item_handler(), and root_handler().

◆ _handleKeyPress()

bool Inkscape::UI::Tools::PenTool::_handleKeyPress ( KeyPressEvent const & event )

private

Definition at line 952 of file pen-tool.cpp.

References Inkscape::UI::Tools::ToolBase::_acc_redo, _acc_to_curve, _acc_to_guides, _acc_to_line, Inkscape::UI::Tools::ToolBase::_acc_undo, _cancel(), Inkscape::UI::Tools::ToolBase::_desktop, _finish(), _finishSegment(), _lastpointMove(), _lastpointMoveScreen(), _lastpointToCurve(), _lastpointToLine(), _redoLastPoint(), _undoLastPoint(), Geom::PathVector::curveCount(), Inkscape::UI::Tools::FreehandBase::ea, Inkscape::Preferences::get(), Inkscape::UI::Tools::get_latin_keyval(), SPDesktop::getSelection(), Inkscape::Util::ActionAccel::isTriggeredBy(), Inkscape::mod_alt(), Inkscape::mod_ctrl(), Inkscape::mod_shift(), Inkscape::mod_shift_only(), npoints, Geom::PathVector::push_back(), Inkscape::UI::Tools::FreehandBase::red_curve, and Inkscape::ObjectSet::toGuides().

Referenced by root_handler().

◆ _handleMotionNotify()

bool Inkscape::UI::Tools::PenTool::_handleMotionNotify ( MotionEvent const & event )

private

Handle motion_notify event.

Definition at line 465 of file pen-tool.cpp.

Referenced by root_handler().

◆ _lastpointMove()

void Inkscape::UI::Tools::PenTool::_lastpointMove	(	gdouble	x,
		gdouble	y
	)

private

Definition at line 815 of file pen-tool.cpp.

References Inkscape::UI::Tools::ToolBase::_desktop, _redrawAll(), SPDesktop::current_rotation(), delta, Inkscape::Preferences::get(), Inkscape::UI::Tools::FreehandBase::green_anchor, Inkscape::UI::Tools::FreehandBase::green_curve, Geom::Rotate::inverse(), last_point_additive_move(), npoints, p_array, and SPDesktop::yaxisdir().

Referenced by _handleKeyPress(), and _lastpointMoveScreen().

◆ _lastpointMoveScreen()

void Inkscape::UI::Tools::PenTool::_lastpointMoveScreen	(	gdouble	x,
		gdouble	y
	)

private

Definition at line 846 of file pen-tool.cpp.

References Inkscape::UI::Tools::ToolBase::_desktop, _lastpointMove(), and SPDesktop::current_zoom().

Referenced by _handleKeyPress().

◆ _lastpointToCurve()

void Inkscape::UI::Tools::PenTool::_lastpointToCurve ( )

private

Definition at line 851 of file pen-tool.cpp.

References _bsplineSpiroStartAnchor(), _redrawAll(), backspace(), bspline, SPDrawAnchor::curve, D, Geom::PathVector::finalPoint(), get_last_segment(), Inkscape::UI::Tools::FreehandBase::green_curve, Geom::Curve::initialPoint(), npoints, p_array, pathvector_append_continuous(), previous, Inkscape::UI::Tools::FreehandBase::red_curve, Inkscape::UI::Tools::FreehandBase::sa, and spiro.

Referenced by _handleKeyPress().

◆ _lastpointToLine()

void Inkscape::UI::Tools::PenTool::_lastpointToLine ( )

private

Definition at line 906 of file pen-tool.cpp.

References _bsplineSpiroStartAnchor(), _redrawAll(), backspace(), bspline, SPDrawAnchor::curve, D, get_last_segment(), Inkscape::UI::Tools::FreehandBase::green_curve, Geom::Curve::initialPoint(), npoints, p_array, pathvector_append_continuous(), previous, Inkscape::UI::Tools::FreehandBase::sa, and spiro.

Referenced by _handleKeyPress().

◆ _redoLastPoint()

bool Inkscape::UI::Tools::PenTool::_redoLastPoint ( )

private

Re-add the last undone point to the path being drawn.

Definition at line 1825 of file pen-tool.cpp.

References _bsplineSpiroBuild(), Inkscape::UI::Tools::ToolBase::_desktop, _did_redo, _redo_stack, _setSubsequentPoint(), Geom::Path::append(), get_last_segment(), SPDesktop::getCanvasSketch(), Inkscape::UI::Tools::FreehandBase::green_bpaths, Inkscape::UI::Tools::FreehandBase::green_color, Inkscape::UI::Tools::FreehandBase::green_curve, p_array, and SP_WIND_RULE_NONZERO.

Referenced by _handleKeyPress().

◆ _redrawAll()

void Inkscape::UI::Tools::PenTool::_redrawAll ( )

private

◆ _resetColors()

void Inkscape::UI::Tools::PenTool::_resetColors ( )

private

Definition at line 1103 of file pen-tool.cpp.

Referenced by _cancel().

◆ _setAngleDistanceStatusMessage()

void Inkscape::UI::Tools::PenTool::_setAngleDistanceStatusMessage	(	Geom::Point const	p,
		int	pc_point_to_compare,
		gchar const *	message
	)

private

Show the status message for the current line/curve segment.

This type of message always shows angle/distance as the last two parameters ("angle %3.2f°, distance %s").

Definition at line 1144 of file pen-tool.cpp.

References Inkscape::UI::Tools::ToolBase::_desktop, SPNamedView::display_units, Inkscape::Preferences::get(), Inkscape::Preferences::getBool(), SPDesktop::getNamedView(), Inkscape::IMMEDIATE_MESSAGE, SPDesktop::is_yaxisdown(), Geom::L2(), Inkscape::UI::Tools::ToolBase::message_context, p_array, Inkscape::Util::Quantity::string(), Geom::X, and Geom::Y.

Referenced by _setCtrl(), and _setSubsequentPoint().

◆ _setCtrl()

void Inkscape::UI::Tools::PenTool::_setCtrl	(	Geom::Point const	p,
		guint	state
	)

private

Definition at line 1645 of file pen-tool.cpp.

References _setAngleDistanceStatusMessage(), Geom::Path::appendNew(), Geom::PathVector::back(), c, cl0, cl1, ctrl, delta, Inkscape::UI::Tools::FreehandBase::green_curve, mode, MODE_CLICK, MODE_DRAG, npoints, p_array, Inkscape::UI::Tools::FreehandBase::red_bpath, and Inkscape::UI::Tools::FreehandBase::red_curve.

Referenced by _handleMotionNotify().

◆ _setInitialPoint()

void Inkscape::UI::Tools::PenTool::_setInitialPoint ( Geom::Point const p )

private

Definition at line 1129 of file pen-tool.cpp.

References npoints, p_array, and Inkscape::UI::Tools::FreehandBase::red_bpath.

Referenced by _handleButtonPress().

◆ _setSubsequentPoint()

void Inkscape::UI::Tools::PenTool::_setSubsequentPoint	(	Geom::Point const	p,
		bool	statusbar,
		guint	status = `0`
	)

private

Definition at line 1592 of file pen-tool.cpp.

References _setAngleDistanceStatusMessage(), _setToNearestHorizVert(), Geom::Path::appendNew(), Geom::PathVector::back(), bspline, npoints, origin, p_array, polylines_paraxial, Inkscape::UI::Tools::FreehandBase::red_bpath, Inkscape::UI::Tools::FreehandBase::red_curve, spiro, Geom::X, and Geom::Y.

Referenced by _handleButtonPress(), _handleMotionNotify(), _redoLastPoint(), and _undoLastPoint().

◆ _setToNearestHorizVert()

void Inkscape::UI::Tools::PenTool::_setToNearestHorizVert	(	Geom::Point &	pt,
		guint const	state
	)		const

private

◆ _undoLastPoint()

bool Inkscape::UI::Tools::PenTool::_undoLastPoint ( bool user_undo = false )

private

Definition at line 1735 of file pen-tool.cpp.

References _bsplineSpiroBuild(), _cancel(), _did_redo, _redo_stack, _setSubsequentPoint(), _setToNearestHorizVert(), backspace(), bspline, c, cl0, cl1, Geom::PathVector::clear(), ctrl, Geom::PathVector::curveCount(), Geom::Point::cw(), get_last_segment(), Inkscape::UI::Tools::FreehandBase::green_bpaths, Inkscape::UI::Tools::FreehandBase::green_curve, npoints, p_array, paraxial_angle, POINT, polylines_paraxial, Inkscape::UI::Tools::FreehandBase::red_curve, spiro, state, Geom::X, and Geom::Y.

Referenced by _handleKeyPress().

◆ hasWaitingLPE()

bool Inkscape::UI::Tools::PenTool::hasWaitingLPE ( )

Definition at line 164 of file pen-tool.cpp.

References Inkscape::LivePathEffect::INVALID_LPE, waiting_LPE, and Inkscape::UI::Tools::FreehandBase::waiting_LPE_type.

Referenced by _handleButtonPress(), _handleButtonRelease(), and Inkscape::UI::Tools::LpeTool::root_handler().

◆ item_handler()

bool Inkscape::UI::Tools::PenTool::item_handler	(	SPItem *	item,
		CanvasEvent const &	event
	)

overrideprotectedvirtual

Handles item specific events.

Gets called from Gdk.

Only reacts to right mouse button at the moment.

Todo:: Fixme: do context sensitive popup menu on items.

Reimplemented from Inkscape::UI::Tools::ToolBase.

Definition at line 217 of file pen-tool.cpp.

References _handleButtonPress(), _handleButtonRelease(), Inkscape::inspect_event(), item, and Inkscape::UI::Tools::ToolBase::item_handler().

Referenced by Inkscape::UI::Tools::LpeTool::item_handler().

◆ nextParaxialDirection()

void Inkscape::UI::Tools::PenTool::nextParaxialDirection	(	Geom::Point const &	pt,
		Geom::Point const &	origin,
		guint	state
	)

Definition at line 1906 of file pen-tool.cpp.

References Geom::Point::ccw(), Inkscape::UI::Tools::FreehandBase::green_curve, origin, paraxial_angle, and state.

Referenced by _finishSegment().

◆ root_handler()

bool Inkscape::UI::Tools::PenTool::root_handler ( CanvasEvent const & event )

overrideprotectedvirtual

Callback to handle all pen events.

Reimplemented from Inkscape::UI::Tools::FreehandBase.

Definition at line 237 of file pen-tool.cpp.

References _handleButtonRelease(), _handleKeyPress(), _handleMotionNotify(), Inkscape::inspect_event(), and Inkscape::UI::Tools::FreehandBase::root_handler().

Referenced by Inkscape::UI::Tools::LpeTool::root_handler().

◆ set()

void Inkscape::UI::Tools::PenTool::set ( Inkscape::Preferences::Entry const & val )

overrideprotectedvirtual

Callback that sets key to value in pen context.

Reimplemented from Inkscape::UI::Tools::ToolBase.

Definition at line 152 of file pen-tool.cpp.

References Inkscape::Preferences::Entry::getEntryName(), Inkscape::Preferences::Entry::getString(), mode, MODE_CLICK, MODE_DRAG, and name.

◆ setPolylineMode()

void Inkscape::UI::Tools::PenTool::setPolylineMode ( )

Definition at line 121 of file pen-tool.cpp.

References _bsplineSpiroColor(), _redrawAll(), bspline, Inkscape::Preferences::get(), Inkscape::Preferences::getInt(), Inkscape::UI::Tools::FreehandBase::green_bpaths, mode, polylines_only, polylines_paraxial, and spiro.

Referenced by _handleButtonRelease(), and PenTool().

◆ waitForLPEMouseClicks()

void Inkscape::UI::Tools::PenTool::waitForLPEMouseClicks	(	Inkscape::LivePathEffect::EffectType	effect_type,
		unsigned int	num_clicks,
		bool	use_polylines = `true`
	)

Definition at line 1896 of file pen-tool.cpp.

References expecting_clicks_for_LPE, Inkscape::LivePathEffect::INVALID_LPE, polylines_only, polylines_paraxial, and Inkscape::UI::Tools::FreehandBase::waiting_LPE_type.

Referenced by Inkscape::UI::Tools::LpeTool::root_handler().

Member Data Documentation

◆ _acc_to_curve

Util::ActionAccel Inkscape::UI::Tools::PenTool::_acc_to_curve

private

Definition at line 163 of file pen-tool.h.

Referenced by _handleKeyPress().

◆ _acc_to_guides

Util::ActionAccel Inkscape::UI::Tools::PenTool::_acc_to_guides

private

Definition at line 164 of file pen-tool.h.

Referenced by _handleKeyPress().

◆ _acc_to_line

Util::ActionAccel Inkscape::UI::Tools::PenTool::_acc_to_line

private

Definition at line 162 of file pen-tool.h.

Referenced by _handleKeyPress().

◆ _desktop_destroy

sigc::connection Inkscape::UI::Tools::PenTool::_desktop_destroy

private

Definition at line 156 of file pen-tool.h.

Referenced by PenTool(), and ~PenTool().

◆ _did_redo

bool Inkscape::UI::Tools::PenTool::_did_redo = false

private

Definition at line 160 of file pen-tool.h.

Referenced by _redoLastPoint(), and _undoLastPoint().

◆ _redo_stack

std::vector<Geom::PathVector> Inkscape::UI::Tools::PenTool::_redo_stack

private

History of undone events.

Definition at line 159 of file pen-tool.h.

Referenced by _cancel(), _finish(), _finishSegment(), _redoLastPoint(), and _undoLastPoint().

◆ bspline

bool Inkscape::UI::Tools::PenTool::bspline = false

Definition at line 71 of file pen-tool.h.

Referenced by _bsplineSpiro(), _bsplineSpiroBuild(), _bsplineSpiroColor(), _bsplineSpiroEndAnchorOn(), _bsplineSpiroMotion(), _bsplineSpiroStartAnchor(), _handleButtonPress(), _handleButtonRelease(), _handleMotionNotify(), _lastpointToCurve(), _lastpointToLine(), _redrawAll(), _setSubsequentPoint(), _undoLastPoint(), and setPolylineMode().

◆ cl0

CanvasItemPtr<CanvasItemCurve> Inkscape::UI::Tools::PenTool::cl0

Definition at line 82 of file pen-tool.h.

Referenced by _bsplineSpiroBuild(), _cancel(), _finish(), _redrawAll(), _setCtrl(), _undoLastPoint(), PenTool(), and ~PenTool().

◆ cl1

CanvasItemPtr<CanvasItemCurve> Inkscape::UI::Tools::PenTool::cl1

Definition at line 83 of file pen-tool.h.

Referenced by _bsplineSpiroBuild(), _cancel(), _finish(), _redrawAll(), _setCtrl(), _undoLastPoint(), PenTool(), and ~PenTool().

◆ ctrl

CanvasItemPtr<CanvasItemCtrl> Inkscape::UI::Tools::PenTool::ctrl[4]

Definition at line 77 of file pen-tool.h.

Referenced by _bsplineSpiroBuild(), _cancel(), _finish(), _handleButtonRelease(), _redrawAll(), _setCtrl(), _undoLastPoint(), PenTool(), and ~PenTool().

◆ ctrl_types

constexpr std::array<CanvasItemCtrlType, 4> Inkscape::UI::Tools::PenTool::ctrl_types

staticconstexpr

Initial value:

= {
        CANVAS_ITEM_CTRL_TYPE_NODE_SMOOTH, CANVAS_ITEM_CTRL_TYPE_ROTATE,
        CANVAS_ITEM_CTRL_TYPE_ROTATE, CANVAS_ITEM_CTRL_TYPE_NODE_SMOOTH}

Definition at line 78 of file pen-tool.h.

Referenced by PenTool().

◆ events_disabled

bool Inkscape::UI::Tools::PenTool::events_disabled = false

Definition at line 85 of file pen-tool.h.

Referenced by _disableEvents(), _enableEvents(), _handleButtonPress(), _handleButtonRelease(), and _handleMotionNotify().

◆ expecting_clicks_for_LPE

unsigned int Inkscape::UI::Tools::PenTool::expecting_clicks_for_LPE = 0

Definition at line 73 of file pen-tool.h.

Referenced by _finish(), _handleButtonPress(), _handleButtonRelease(), waitForLPEMouseClicks(), and ~PenTool().

◆ mode

Mode Inkscape::UI::Tools::PenTool::mode = MODE_CLICK

Definition at line 64 of file pen-tool.h.

Referenced by _handleButtonPress(), _handleButtonRelease(), _handleMotionNotify(), _setCtrl(), set(), Inkscape::UI::Tools::LpeTool::set(), and setPolylineMode().

◆ npoints

gint Inkscape::UI::Tools::PenTool::npoints = 0

\invar npoints in {0, 2, 5}.

Definition at line 62 of file pen-tool.h.

Referenced by _bsplineSpiroMotion(), _bsplineSpiroOff(), _bsplineSpiroOn(), _endpointSnap(), _endpointSnapHandle(), _finish(), _finishSegment(), _handle2ButtonPress(), _handleButtonPress(), _handleButtonRelease(), _handleKeyPress(), _handleMotionNotify(), _lastpointMove(), _lastpointToCurve(), _lastpointToLine(), _redrawAll(), _resetColors(), _setCtrl(), _setInitialPoint(), _setSubsequentPoint(), _undoLastPoint(), and ~PenTool().

◆ p_array

Geom::Point Inkscape::UI::Tools::PenTool::p_array[5]

◆ paraxial_angle

Geom::Point Inkscape::UI::Tools::PenTool::paraxial_angle

Definition at line 68 of file pen-tool.h.

Referenced by _setToNearestHorizVert(), _undoLastPoint(), and nextParaxialDirection().

◆ polylines_only

bool Inkscape::UI::Tools::PenTool::polylines_only = false

Definition at line 66 of file pen-tool.h.

Referenced by _handleButtonPress(), _handleMotionNotify(), setPolylineMode(), and waitForLPEMouseClicks().

◆ polylines_paraxial

bool Inkscape::UI::Tools::PenTool::polylines_paraxial = false

Definition at line 67 of file pen-tool.h.

Referenced by _endpointSnap(), _finishSegment(), _handleButtonPress(), _setSubsequentPoint(), _undoLastPoint(), setPolylineMode(), and waitForLPEMouseClicks().

◆ previous

Geom::Point Inkscape::UI::Tools::PenTool::previous

Definition at line 59 of file pen-tool.h.

Referenced by _bsplineSpiroBuild(), _bsplineSpiroMotion(), _lastpointToCurve(), and _lastpointToLine().

◆ spiro

bool Inkscape::UI::Tools::PenTool::spiro = false

Definition at line 70 of file pen-tool.h.

Referenced by _bsplineSpiro(), _bsplineSpiroBuild(), _bsplineSpiroColor(), _bsplineSpiroMotion(), _bsplineSpiroStartAnchor(), _handleButtonPress(), _handleButtonRelease(), _handleMotionNotify(), _lastpointToCurve(), _lastpointToLine(), _redrawAll(), _setSubsequentPoint(), _undoLastPoint(), and setPolylineMode().

◆ state

State Inkscape::UI::Tools::PenTool::state = POINT

Definition at line 65 of file pen-tool.h.

Referenced by _bsplineSpiroMotion(), _cancel(), _endpointSnap(), _endpointSnapHandle(), _finish(), _finishSegment(), _handle2ButtonPress(), _handleButtonPress(), _handleButtonRelease(), _handleMotionNotify(), _setToNearestHorizVert(), _undoLastPoint(), nextParaxialDirection(), PenTool(), and ~PenTool().

◆ waiting_item

SPLPEItem* Inkscape::UI::Tools::PenTool::waiting_item = nullptr

Definition at line 75 of file pen-tool.h.

Referenced by _handleButtonRelease(), and ~PenTool().

◆ waiting_LPE

Inkscape::LivePathEffect::Effect* Inkscape::UI::Tools::PenTool::waiting_LPE = nullptr

Definition at line 74 of file pen-tool.h.

Referenced by _handleButtonRelease(), and hasWaitingLPE().

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

/builds/inkscape/inkscape/src/ui/tools/pen-tool.h
/builds/inkscape/inkscape/src/ui/tools/pen-tool.cpp

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Mode

◆ State

Constructor & Destructor Documentation

◆ PenTool()

◆ ~PenTool()

Member Function Documentation

◆ _bsplineSpiro()

◆ _bsplineSpiroBuild()

◆ _bsplineSpiroColor()

◆ _bsplineSpiroEndAnchorOff()

◆ _bsplineSpiroEndAnchorOn()

◆ _bsplineSpiroMotion()

◆ _bsplineSpiroOff()

◆ _bsplineSpiroOn()

◆ _bsplineSpiroStartAnchor()

◆ _bsplineSpiroStartAnchorOff()

◆ _bsplineSpiroStartAnchorOn()

◆ _cancel()

◆ _disableEvents()

◆ _enableEvents()

◆ _endpointSnap()

◆ _endpointSnapHandle()

◆ _finish()

◆ _finishSegment()

◆ _handle2ButtonPress()

◆ _handleButtonPress()

◆ _handleButtonRelease()

◆ _handleKeyPress()

◆ _handleMotionNotify()

◆ _lastpointMove()

◆ _lastpointMoveScreen()

◆ _lastpointToCurve()

◆ _lastpointToLine()

◆ _redoLastPoint()

◆ _redrawAll()

◆ _resetColors()

◆ _setAngleDistanceStatusMessage()

◆ _setCtrl()

◆ _setInitialPoint()

◆ _setSubsequentPoint()

◆ _setToNearestHorizVert()

◆ _undoLastPoint()

◆ hasWaitingLPE()

◆ item_handler()

◆ nextParaxialDirection()

◆ root_handler()

◆ set()

◆ setPolylineMode()

◆ waitForLPEMouseClicks()

Member Data Documentation

◆ _acc_to_curve

◆ _acc_to_guides

◆ _acc_to_line

◆ _desktop_destroy

◆ _did_redo

◆ _redo_stack

◆ bspline

◆ cl0

◆ cl1

◆ ctrl

◆ ctrl_types

◆ events_disabled

◆ expecting_clicks_for_LPE

◆ mode

◆ npoints

◆ p_array

◆ paraxial_angle

◆ polylines_only

◆ polylines_paraxial

◆ previous