Inkscape: Inkscape::LivePathEffect::LPESketch Class Reference

Searching...

No Matches

#include <lpe-sketch.h>

Inheritance diagram for Inkscape::LivePathEffect::LPESketch:

Public Member Functions
	LPESketch (LivePathEffectObject *lpeobject)

	~LPESketch () override

Geom::Piecewise< Geom::D2< Geom::SBasis > >	doEffect_pwd2 (Geom::Piecewise< Geom::D2< Geom::SBasis > > const &pwd2_in) override

void	doBeforeEffect (SPLPEItem const *lpeitem) override
	Is performed each time before the effect is updated.

Gtk::Widget *	newWidget () override
	This creates a managed widget.

Public Member Functions inherited from Inkscape::LivePathEffect::Effect
virtual	~Effect ()

	Effect (const Effect &)=delete

Effect &	operator= (const Effect &)=delete

EffectType	effectType () const

void	doAfterEffect_impl (SPLPEItem const lpeitem, Geom::PathVector curve)

void	doOnApply_impl (SPLPEItem const *lpeitem)

void	doBeforeEffect_impl (SPLPEItem const *lpeitem)

void	doOnOpen_impl ()
	Is performed on document open allow things like fix legacy LPE in a undo insensitive way.

void	doOnRemove_impl (SPLPEItem const *lpeitem)

void	transform_multiply_impl (Geom::Affine const &postmul, SPLPEItem *)

void	doOnBeforeCommit ()

void	read_from_SVG ()

void	setCurrentZoom (double cZ)

void	setSelectedNodePoints (std::vector< Geom::Point > sNP)

bool	isNodePointSelected (Geom::Point const &nodePoint) const

bool	isOnClipboard ()
	The lpe is on clipboard.

std::vector< SPLPEItem * >	getCurrrentLPEItems () const

void	update_satellites ()

virtual void	doOnException (SPLPEItem const *lpeitem)

virtual void	doOnVisibilityToggled (SPLPEItem const *lpeitem)

virtual void	adjustForNewPath ()

void	writeParamsToSVG ()

std::vector< SPObject * >	effect_get_satellites (bool force=true)

virtual void	acceptParamPath (SPPath const *param_path)
	If the effect expects a path parameter (specified by a number of mouse clicks) before it is applied, this is the method that processes the resulting path.

int	acceptsNumClicks () const

SPShape *	getCurrentShape () const

void	setCurrentShape (SPShape *shape)

virtual void	processObjects (LPEAction lpe_action)

void	makeUndoDone (Glib::ustring message)

bool	isReady () const

void	setReady (bool ready=true)

virtual void	doEffect (Geom::PathVector &curve)

virtual void	resetDefaults (SPItem const *item)
	Sets all parameters to their default values and writes them to SVG.

bool	providesKnotholder () const

virtual LPEPathFlashType	pathFlashType () const

void	addHandles (KnotHolder knotholder, SPItem item)
	Add all registered LPE knotholder handles to the knotholder.

std::vector< Geom::PathVector >	getCanvasIndicators (SPLPEItem const *lpeitem)
	Return a vector of PathVectors which contain all canvas indicators for this effect.

void	update_helperpath ()
	Call to a method on nodetool to update the helper path from the effect.

bool	providesOwnFlashPaths () const

bool	showOrigPath () const

Glib::ustring	getName () const

Inkscape::XML::Node *	getRepr ()

SPDocument *	getSPDoc ()

LivePathEffectObject *	getLPEObj ()

LivePathEffectObject const *	getLPEObj () const

Parameter *	getParameter (const char *key)

void	readallParameters (Inkscape::XML::Node const *repr)

void	setParameter (const gchar key, const gchar new_value)

bool	isVisible () const

void	editNextParamOncanvas (SPItem item, SPDesktop desktop)

void	setLPEAction (LPEAction lpe_action)

void	setDefaultParameters ()
	Set this LPE defaults.

void	resetDefaultParameters ()
	Reset this LPE defaults.

bool	hasDefaultParameters ()
	Get LPE has defaults.

virtual bool	getHolderRemove ()

Private Member Functions
	LPESketch (const LPESketch &)=delete

LPESketch &	operator= (const LPESketch &)=delete

Geom::Piecewise< Geom::D2< Geom::SBasis > >	computePerturbation (double s0, double s1)

Additional Inherited Members
Static Public Member Functions inherited from Inkscape::LivePathEffect::Effect
static Effect *	New (EffectType lpenr, LivePathEffectObject *lpeobj)

static void	createAndApply (const char name, SPDocument doc, SPItem *item)

static void	createAndApply (EffectType type, SPDocument doc, SPItem item)

static int	acceptsNumClicks (EffectType type)

Public Attributes inherited from Inkscape::LivePathEffect::Effect
bool	has_exception

bool	apply_to_clippath_and_mask

bool	keep_paths

bool	is_load

bool	is_applied

bool	on_remove_all

bool	refresh_widgets

bool	finishiddle = false

bool	satellitestoclipboard = false

bool	helperLineSatellites = false

gint	spinbutton_width_chars = 7

BoolParam	is_visible

HiddenParam	lpeversion

Geom::PathVector	pathvector_before_effect

Geom::PathVector	pathvector_after_effect

SPLPEItem *	sp_lpe_item = nullptr

SPShape *	current_shape

std::vector< Parameter * >	param_vector

Protected Member Functions inherited from Inkscape::LivePathEffect::Effect
	Effect (LivePathEffectObject *lpeobject)

virtual Geom::PathVector	doEffect_path (Geom::PathVector const &path_in)

void	registerParameter (Parameter *param)

Parameter *	getNextOncanvasEditableParam ()

virtual void	addKnotHolderEntities (KnotHolder , SPItem )

virtual void	addCanvasIndicators (SPLPEItem const *lpeitem, std::vector< Geom::PathVector > &hp_vec)
	Add possible canvas indicators (i.e., helperpaths other than the original path) to hp_vec This function should be overwritten by derived effects if they want to provide their own helperpaths.

Protected Attributes inherited from Inkscape::LivePathEffect::Effect
bool	_adjust_path = false

bool	_provides_knotholder_entities

bool	_provides_path_adjustment = false

LPEAction	_lpe_action = LPE_NONE

int	oncanvasedit_it

bool	show_orig_path

bool	concatenate_before_pwd2

double	current_zoom

std::vector< Geom::Point >	selectedNodesPoints

Inkscape::UI::Widget::Registry	wr

Detailed Description

Definition at line 28 of file lpe-sketch.h.

Constructor & Destructor Documentation

◆ LPESketch() [1/2]

Inkscape::LivePathEffect::LPESketch::LPESketch ( LivePathEffectObject * lpeobject )

◆ ~LPESketch()

Inkscape::LivePathEffect::LPESketch::~LPESketch ( )

override

◆ LPESketch() [2/2]

Inkscape::LivePathEffect::LPESketch::LPESketch ( const LPESketch & )

privatedelete

Member Function Documentation

◆ computePerturbation()

Geom::Piecewise< Geom::D2< Geom::SBasis > > Inkscape::LivePathEffect::LPESketch::computePerturbation	(	double	s0,
		double	s1
	)

private

Definition at line 175 of file lpe-sketch.cpp.

References Geom::Piecewise< T >::concat(), offset, and Geom::Piecewise< T >::setDomain().

◆ doBeforeEffect()

void Inkscape::LivePathEffect::LPESketch::doBeforeEffect ( SPLPEItem const * lpeitem )

overridevirtual

Is performed each time before the effect is updated.

Reimplemented from Inkscape::LivePathEffect::Effect.

Definition at line 378 of file lpe-sketch.cpp.

◆ doEffect_pwd2()

Geom::Piecewise< Geom::D2< Geom::SBasis > > Inkscape::LivePathEffect::LPESketch::doEffect_pwd2 ( Geom::Piecewise< Geom::D2< Geom::SBasis > > const & pwd2_in )

overridevirtual

!the root solver might miss s1==piece_total_length...

Reimplemented from Inkscape::LivePathEffect::Effect.

Definition at line 217 of file lpe-sketch.cpp.

References Geom::abs(), Geom::arcLengthSb(), Geom::bounds_exact(), compose(), Geom::Piecewise< T >::concat(), Geom::cross(), curvature(), Geom::derivative(), Geom::Piecewise< T >::firstValue(), integral(), Geom::Piecewise< T >::lastValue(), Geom::portion(), Geom::Piecewise< T >::push(), Geom::Piecewise< T >::push_cut(), Geom::roots(), Geom::Piecewise< T >::segs, Geom::split_at_discontinuities(), and Geom::sqrt().

◆ newWidget()

Gtk::Widget * Inkscape::LivePathEffect::LPESketch::newWidget ( )

overridevirtual

This creates a managed widget.

Deletion should be done by the eventual parent, or otherwise the caller.

Reimplemented from Inkscape::LivePathEffect::Effect.

◆ operator=()

LPESketch & Inkscape::LivePathEffect::LPESketch::operator= ( const LPESketch & )

privatedelete

Member Data Documentation

◆ ends_tolerance

RandomParam Inkscape::LivePathEffect::LPESketch::ends_tolerance

private

Definition at line 47 of file lpe-sketch.h.

◆ max_curvature

ScalarParam Inkscape::LivePathEffect::LPESketch::max_curvature

private

Definition at line 60 of file lpe-sketch.h.

◆ min_curvature

ScalarParam Inkscape::LivePathEffect::LPESketch::min_curvature

private

Definition at line 59 of file lpe-sketch.h.

◆ nbiter_approxstrokes

ScalarParam Inkscape::LivePathEffect::LPESketch::nbiter_approxstrokes

private

Definition at line 42 of file lpe-sketch.h.

◆ nbtangents

ScalarParam Inkscape::LivePathEffect::LPESketch::nbtangents

private

Definition at line 53 of file lpe-sketch.h.

◆ parallel_offset

RandomParam Inkscape::LivePathEffect::LPESketch::parallel_offset

private

Definition at line 48 of file lpe-sketch.h.

◆ strokelength

ScalarParam Inkscape::LivePathEffect::LPESketch::strokelength

private

Definition at line 43 of file lpe-sketch.h.

◆ strokelength_rdm

RandomParam Inkscape::LivePathEffect::LPESketch::strokelength_rdm

private

Definition at line 44 of file lpe-sketch.h.

◆ strokeoverlap

ScalarParam Inkscape::LivePathEffect::LPESketch::strokeoverlap

private

Definition at line 45 of file lpe-sketch.h.

◆ strokeoverlap_rdm

RandomParam Inkscape::LivePathEffect::LPESketch::strokeoverlap_rdm

private

Definition at line 46 of file lpe-sketch.h.

◆ tgt_places_rdmness

RandomParam Inkscape::LivePathEffect::LPESketch::tgt_places_rdmness

private

Definition at line 57 of file lpe-sketch.h.

◆ tgtlength

ScalarParam Inkscape::LivePathEffect::LPESketch::tgtlength

private

Definition at line 55 of file lpe-sketch.h.

◆ tgtlength_rdm

RandomParam Inkscape::LivePathEffect::LPESketch::tgtlength_rdm

private

Definition at line 56 of file lpe-sketch.h.

◆ tgtscale

ScalarParam Inkscape::LivePathEffect::LPESketch::tgtscale

private

Definition at line 54 of file lpe-sketch.h.

◆ tremble_frequency

ScalarParam Inkscape::LivePathEffect::LPESketch::tremble_frequency

private

Definition at line 50 of file lpe-sketch.h.

◆ tremble_size

RandomParam Inkscape::LivePathEffect::LPESketch::tremble_size

private

Definition at line 49 of file lpe-sketch.h.

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

/builds/inkscape/inkscape/src/live_effects/lpe-sketch.h
/builds/inkscape/inkscape/src/live_effects/lpe-sketch.cpp

Private Attributes
ScalarParam	nbiter_approxstrokes

ScalarParam	strokelength

RandomParam	strokelength_rdm

ScalarParam	strokeoverlap

RandomParam	strokeoverlap_rdm

RandomParam	ends_tolerance

RandomParam	parallel_offset

RandomParam	tremble_size

ScalarParam	tremble_frequency

ScalarParam	nbtangents

ScalarParam	tgtscale

ScalarParam	tgtlength

RandomParam	tgtlength_rdm

RandomParam	tgt_places_rdmness

ScalarParam	min_curvature

ScalarParam	max_curvature

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ LPESketch() [1/2]

◆ ~LPESketch()

◆ LPESketch() [2/2]

Member Function Documentation

◆ computePerturbation()

◆ doBeforeEffect()

◆ doEffect_pwd2()

◆ newWidget()

◆ operator=()

Member Data Documentation

◆ ends_tolerance

◆ max_curvature

◆ min_curvature

◆ nbiter_approxstrokes

◆ nbtangents

◆ parallel_offset

◆ strokelength

◆ strokelength_rdm

◆ strokeoverlap

◆ strokeoverlap_rdm

◆ tgt_places_rdmness

◆ tgtlength

◆ tgtlength_rdm

◆ tgtscale

◆ tremble_frequency

◆ tremble_size