Inkscape: Inkscape::LivePathEffect::PointParam Class Reference

Searching...

No Matches

#include <point.h>

Inheritance diagram for Inkscape::LivePathEffect::PointParam:

Public Member Functions
	PointParam (const Glib::ustring &label, const Glib::ustring &tip, const Glib::ustring &key, Inkscape::UI::Widget::Registry wr, Effect effect, std::optional< Glib::ustring > handle_tip={}, Geom::Point default_value=Geom::Point(0, 0), bool live_update=true)

	~PointParam () override

	PointParam (const PointParam &)=delete

PointParam &	operator= (const PointParam &)=delete

Gtk::Widget *	param_newWidget () final

bool	param_readSVGValue (char const *strvalue) final

Glib::ustring	param_getSVGValue () const final

Glib::ustring	param_getDefaultSVGValue () const final

char const *	handleTip () const

void	param_setValue (Geom::Point newpoint, bool write=false)

void	param_set_default () final

void	param_hide_knot (bool hide)

Geom::Point	param_get_default () const

void	param_set_liveupdate (bool live_update)

void	param_update_default (Geom::Point default_point)

void	param_update_default (char const *default_point) final

void	param_transform_multiply (Geom::Affine const &, bool set) final

void	set_oncanvas_looks (Inkscape::CanvasItemCtrlShape shape, std::uint32_t color)

bool	providesKnotHolderEntities () const final

void	addKnotHolderEntities (KnotHolder knotholder, SPItem item) final

ParamType	paramType () const final

Public Member Functions inherited from Geom::Point
Coord	operator[] (unsigned i) const

Coord &	operator[] (unsigned i)

constexpr Coord	operator[] (Dim2 d) const noexcept

constexpr Coord &	operator[] (Dim2 d) noexcept

constexpr Coord	x () const noexcept

constexpr Coord &	x () noexcept

constexpr Coord	y () const noexcept

constexpr Coord &	y () noexcept

template<size_t I>
constexpr Coord	get () const

template<size_t I>
constexpr Coord &	get ()

Coord	length () const
	Compute the distance from origin.

constexpr Coord	lengthSq () const

void	normalize ()
	Normalize the vector representing the point.

Point	normalized () const

constexpr Point	ccw () const
	Return a point like this point but rotated -90 degrees.

constexpr Point	cw () const
	Return a point like this point but rotated +90 degrees.

constexpr Point	operator- () const

constexpr Point &	operator+= (Point const &o)

constexpr Point &	operator-= (Point const &o)

constexpr Point &	operator*= (Coord s)

constexpr Point &	operator*= (Point const &o)

constexpr Point &	operator*= (IntPoint const &o)

constexpr Point &	operator/= (Coord s)

constexpr Point &	operator/= (Point const &o)

constexpr Point &	operator/= (IntPoint const &o)

Point &	operator*= (Affine const &m)
	Transform the point by the specified matrix.

Point &	operator*= (Translate const &t)

Point &	operator*= (Scale const &s)

Point &	operator*= (Rotate const &r)

Point &	operator*= (HShear const &s)

Point &	operator*= (VShear const &s)

Point &	operator*= (Zoom const &z)

IntPoint	round () const
	Round to nearest integer coordinates.

IntPoint	floor () const
	Round coordinates downwards.

IntPoint	ceil () const
	Round coordinates upwards.

bool	isFinite () const
	Check whether both coordinates are finite.

constexpr bool	isZero () const
	Check whether both coordinates are zero.

bool	isNormalized (Coord eps=EPSILON) const
	Check whether the length of the vector is close to 1.

constexpr bool	operator== (Point const &p) const
	Equality operator.

constexpr bool	operator< (Point const &p) const
	Lexicographical ordering for points.

constexpr	Point ()=default
	Construct a point at the origin.

constexpr	Point (Coord x, Coord y)
	Construct a point from its coordinates.

constexpr	Point (IntPoint const &p)
	Construct from integer point.

Public Member Functions inherited from Inkscape::LivePathEffect::Parameter
	Parameter (Glib::ustring label, Glib::ustring tip, Glib::ustring key, Inkscape::UI::Widget::Registry wr, Effect effect)

virtual	~Parameter ()

	Parameter (const Parameter &)=delete

Parameter &	operator= (const Parameter &)=delete

virtual void	param_widget_is_visible (bool is_visible)

virtual void	param_widget_is_enabled (bool is_enabled)

void	write_to_SVG ()

void	read_from_SVG ()

void	setUpdating (bool updating)

bool	getUpdating () const

Glib::ustring const *	param_getTooltip () const

virtual void	addCanvasIndicators (SPLPEItem const *, std::vector< Geom::PathVector > &)

virtual void	param_editOncanvas (SPItem , SPDesktop )

virtual void	param_setup_nodepath (Inkscape::NodePath::Path *)

virtual std::vector< SPObject * >	param_get_satellites ()

void	param_higlight (bool highlight)

void	change_selection (Inkscape::Selection *selection)

void	update_satellites ()

EffectType	effectType () const

void	connect_selection_changed ()

Private Member Functions
void	on_value_changed ()

Private Attributes
Geom::Point	defvalue

bool	liveupdate

KnotHolderEntity *	_knot_entity = nullptr

Inkscape::CanvasItemCtrlShape	knot_shape = Inkscape::CANVAS_ITEM_CTRL_SHAPE_DIAMOND

std::uint32_t	knot_color = 0xffffff00

std::optional< Glib::ustring >	handle_tip

Friends
class	PointParamKnotHolderEntity

Additional Inherited Members
Public Types inherited from Geom::Point
using	D1Value = Coord

using	D1Reference = Coord &

using	D1ConstReference = Coord const &

Static Public Member Functions inherited from Geom::Point
static Point	polar (Coord angle, Coord radius)
	Construct a point from its polar coordinates.

static Point	polar (Coord angle)
	Construct an unit vector from its angle.

Public Attributes inherited from Inkscape::LivePathEffect::Parameter
sigc::scoped_connection	selection_changed_connection

Glib::ustring	param_key

Glib::ustring	param_tooltip

Inkscape::UI::Widget::Registry *	param_wr

Glib::ustring	param_label

bool	oncanvas_editable

bool	widget_is_visible

bool	widget_is_enabled

Protected Member Functions inherited from Inkscape::LivePathEffect::Parameter
void	param_write_to_repr (const char *svgd)

Protected Attributes inherited from Inkscape::LivePathEffect::Parameter
bool	_updating = false

Inkscape::Display::TemporaryItem *	ownerlocator = nullptr

Effect *	param_effect

Related Symbols inherited from Geom::Point
std::ostream &	operator<< (std::ostream &out, Point const &p)
	Output operator for points.

Coord	L2 (Point const &p)
	Compute the second (Euclidean) norm of p.

constexpr Coord	L2sq (Point const &p)
	Compute the square of the Euclidean norm of p.

constexpr Point	rot90 (Point const &p)
	Returns p * Geom::rotate_degrees(90), but more efficient.

Point	lerp (Coord t, Point const &a, Point const &b)
	Linear interpolation between two points.

Point	middle_point (Point const &p1, Point const &p2)
	Return a point halfway between the specified ones.

constexpr Coord	dot (Point const &a, Point const &b)
	Compute the dot product of a and b.

constexpr Coord	cross (Point const &a, Point const &b)
	Compute the 2D cross product.

Coord	distance (Point const &a, Point const &b)
	Compute the (Euclidean) distance between points.

Coord	distanceSq (Point const &a, Point const &b)
	Compute the square of the distance between points.

bool	are_near (Point const &a, Point const &b, double eps=EPSILON)
	Test whether two points are no further apart than some threshold.

bool	are_collinear (Point const &p1, Point const &p2, Point const &p3, double eps=EPSILON)
	Test whether three points lie approximately on the same line.

Coord	L1 (Point const &p)
	Compute the first norm (Manhattan distance) of p.

Coord	LInfty (Point const &p)
	Compute the infinity norm (maximum norm) of p.

bool	is_zero (Point const &p)
	True if the point has both coordinates zero.

bool	is_unit_vector (Point const &p, Coord eps)
	True if the point has a length near 1.

Coord	atan2 (Point const &p)
	Return the angle between the point and the +X axis.

Coord	angle_between (Point const &a, Point const &b)
	Compute the angle between a and b relative to the origin.

Point	unit_vector (Point const &a)
	Create a normalized version of a point.

Point	abs (Point const &b)
	Return the "absolute value" of the point's vector.

Point	constrain_angle (Point const &A, Point const &B, unsigned int n, Point const &dir)
	Snap the angle B - A - dir to multiples of \(2\pi/n\).

Detailed Description

Definition at line 34 of file point.h.

Constructor & Destructor Documentation

◆ PointParam() [1/2]

Inkscape::LivePathEffect::PointParam::PointParam	(	const Glib::ustring &	label,
		const Glib::ustring &	tip,
		const Glib::ustring &	key,
		Inkscape::UI::Widget::Registry *	wr,
		Effect *	effect,
		std::optional< Glib::ustring >	handle_tip = `{}`,
		Geom::Point	default_value = `Geom::Point(0,0)`,
		bool	live_update = `true`
	)