Inkscape: Inkscape::LivePathEffect::LPEPatternAlongPath Class Reference

Searching...

No Matches

#include <lpe-patternalongpath.h>

Inheritance diagram for Inkscape::LivePathEffect::LPEPatternAlongPath:

Public Member Functions
	LPEPatternAlongPath (LivePathEffectObject *lpeobject)

	~LPEPatternAlongPath () override

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

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

bool	doOnOpen (SPLPEItem const *lpeitem) override
	Is performed on load document or revert If the item is fixed legacy return true.

void	transform_multiply (Geom::Affine const &postmul, bool set) override
	Overridden function to apply transforms for example to powerstroke, jointtype or tapperstroke.

void	addCanvasIndicators (SPLPEItem const *, std::vector< Geom::PathVector > &hp_vec) override
	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.

void	addKnotHolderEntities (KnotHolder knotholder, SPItem item) override

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 Gtk::Widget *	newWidget ()
	This creates a managed widget.

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 ()

Public Attributes
PathParam	pattern

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 Attributes
double	original_height

ScalarParam	prop_scale

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

Private Member Functions
void	on_pattern_pasted ()

	LPEPatternAlongPath (const LPEPatternAlongPath &)

LPEPatternAlongPath &	operator= (const LPEPatternAlongPath &)

Friends
class	WPAP::KnotHolderEntityWidthPatternAlongPath

class	Inkscape::UI::Toolbar::PencilToolbar

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)

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 ()

Detailed Description

Definition at line 39 of file lpe-patternalongpath.h.

Constructor & Destructor Documentation

◆ LPEPatternAlongPath() [1/2]

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

Definition at line 72 of file lpe-patternalongpath.cpp.

References _knotholder, Inkscape::LivePathEffect::Effect::_provides_knotholder_entities, copytype, fuse_tolerance, hide_knot, normal_offset, Inkscape::LivePathEffect::ScalarParam::param_set_digits(), Inkscape::LivePathEffect::ScalarParam::param_set_increments(), pattern, prop_scale, prop_units, Inkscape::LivePathEffect::Effect::registerParameter(), scale_y_rel, spacing, tang_offset, and vertical_pattern.

◆ ~LPEPatternAlongPath()

Inkscape::LivePathEffect::LPEPatternAlongPath::~LPEPatternAlongPath ( )

override

Definition at line 114 of file lpe-patternalongpath.cpp.

References _knotholder, and KnotHolder::clear().

◆ LPEPatternAlongPath() [2/2]

Inkscape::LivePathEffect::LPEPatternAlongPath::LPEPatternAlongPath ( const LPEPatternAlongPath & )

private

Member Function Documentation

◆ addCanvasIndicators()

void Inkscape::LivePathEffect::LPEPatternAlongPath::addCanvasIndicators	(	SPLPEItem const *	lpeitem,
		std::vector< Geom::PathVector > &	hp_vec
	)

overridevirtual

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.

Reimplemented from Inkscape::LivePathEffect::Effect.

Definition at line 293 of file lpe-patternalongpath.cpp.

References helper_path.

◆ addKnotHolderEntities()

void Inkscape::LivePathEffect::LPEPatternAlongPath::addKnotHolderEntities	(	KnotHolder *	knotholder,
		SPItem *	item
	)

overridevirtual

Reimplemented from Inkscape::LivePathEffect::Effect.

Definition at line 300 of file lpe-patternalongpath.cpp.

References _knotholder, KnotHolder::add(), Inkscape::CANVAS_ITEM_CTRL_TYPE_LPE, KnotHolderEntity::create(), SPKnot::hide(), hide_knot, item, KnotHolderEntity::knot, KnotHolderEntity::update_knot(), and WPAP::KnotHolderEntityWidthPatternAlongPath.

◆ doBeforeEffect()

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

overridevirtual

Is performed each time before the effect is updated.

Reimplemented from Inkscape::LivePathEffect::Effect.

Definition at line 139 of file lpe-patternalongpath.cpp.

References _knotholder, Geom::PathVector::boundsFast(), Geom::PathVector::clear(), KnotHolder::entity, Inkscape::LivePathEffect::PathParam::get_pathvector(), helper_path, hide_knot, Inkscape::LivePathEffect::Effect::is_load, original_height, pattern, Inkscape::LivePathEffect::PathParam::reload(), KnotHolder::update_knots(), and Geom::Y.

◆ doEffect_pwd2()

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

overridevirtual

Reimplemented from Inkscape::LivePathEffect::Effect.

Definition at line 161 of file lpe-patternalongpath.cpp.

◆ doOnOpen()

bool Inkscape::LivePathEffect::LPEPatternAlongPath::doOnOpen ( SPLPEItem const * lpeitem )

overridevirtual

Is performed on load document or revert If the item is fixed legacy return true.

Reimplemented from Inkscape::LivePathEffect::Effect.

Definition at line 122 of file lpe-patternalongpath.cpp.

References Inkscape::LivePathEffect::Effect::is_applied, Inkscape::LivePathEffect::Effect::is_load, pattern, and Inkscape::LivePathEffect::PathParam::reload().

◆ on_pattern_pasted()

void Inkscape::LivePathEffect::LPEPatternAlongPath::on_pattern_pasted ( )

private

◆ operator=()

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

private

◆ transform_multiply()

void Inkscape::LivePathEffect::LPEPatternAlongPath::transform_multiply	(	Geom::Affine const &	postmul,
		bool	set
	)

overridevirtual

Overridden function to apply transforms for example to powerstroke, jointtype or tapperstroke.

Reimplemented from Inkscape::LivePathEffect::Effect.

Definition at line 131 of file lpe-patternalongpath.cpp.

References SPLPEItem::optimizeTransforms(), Inkscape::LivePathEffect::PathParam::param_transform_multiply(), SPLPEItem::pathEffectsEnabled(), pattern, and Inkscape::LivePathEffect::Effect::sp_lpe_item.

Friends And Related Symbol Documentation

◆ Inkscape::UI::Toolbar::PencilToolbar

friend class Inkscape::UI::Toolbar::PencilToolbar

friend

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

◆ WPAP::KnotHolderEntityWidthPatternAlongPath

friend class WPAP::KnotHolderEntityWidthPatternAlongPath

friend

Definition at line 52 of file lpe-patternalongpath.h.

Referenced by addKnotHolderEntities().

Member Data Documentation

◆ _knotholder

KnotHolder* Inkscape::LivePathEffect::LPEPatternAlongPath::_knotholder

private

Definition at line 69 of file lpe-patternalongpath.h.

Referenced by addKnotHolderEntities(), doBeforeEffect(), LPEPatternAlongPath(), and ~LPEPatternAlongPath().

◆ copytype

EnumParam<PAPCopyType> Inkscape::LivePathEffect::LPEPatternAlongPath::copytype

private

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

Referenced by doEffect_pwd2(), and LPEPatternAlongPath().

◆ fuse_tolerance

ScalarParam Inkscape::LivePathEffect::LPEPatternAlongPath::fuse_tolerance

private

Definition at line 68 of file lpe-patternalongpath.h.

Referenced by doEffect_pwd2(), and LPEPatternAlongPath().

◆ helper_path

Geom::PathVector Inkscape::LivePathEffect::LPEPatternAlongPath::helper_path

private

Definition at line 70 of file lpe-patternalongpath.h.

Referenced by addCanvasIndicators(), and doBeforeEffect().

◆ hide_knot

BoolParam Inkscape::LivePathEffect::LPEPatternAlongPath::hide_knot

private

Definition at line 67 of file lpe-patternalongpath.h.

Referenced by addKnotHolderEntities(), doBeforeEffect(), and LPEPatternAlongPath().

◆ normal_offset

ScalarParam Inkscape::LivePathEffect::LPEPatternAlongPath::normal_offset

private

Definition at line 63 of file lpe-patternalongpath.h.

Referenced by doEffect_pwd2(), and LPEPatternAlongPath().

◆ original_height

double Inkscape::LivePathEffect::LPEPatternAlongPath::original_height

protected

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

Referenced by doBeforeEffect().

◆ pattern

PathParam Inkscape::LivePathEffect::LPEPatternAlongPath::pattern

Definition at line 51 of file lpe-patternalongpath.h.

Referenced by doBeforeEffect(), doEffect_pwd2(), doOnOpen(), LPEPatternAlongPath(), and transform_multiply().

◆ prop_scale

ScalarParam Inkscape::LivePathEffect::LPEPatternAlongPath::prop_scale

protected

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

Referenced by doEffect_pwd2(), and LPEPatternAlongPath().

◆ prop_units

BoolParam Inkscape::LivePathEffect::LPEPatternAlongPath::prop_units

private

Definition at line 65 of file lpe-patternalongpath.h.

Referenced by doEffect_pwd2(), and LPEPatternAlongPath().

◆ scale_y_rel

BoolParam Inkscape::LivePathEffect::LPEPatternAlongPath::scale_y_rel

private

Definition at line 61 of file lpe-patternalongpath.h.

Referenced by doEffect_pwd2(), and LPEPatternAlongPath().

◆ spacing

ScalarParam Inkscape::LivePathEffect::LPEPatternAlongPath::spacing

private

Definition at line 62 of file lpe-patternalongpath.h.

Referenced by doEffect_pwd2(), and LPEPatternAlongPath().

◆ tang_offset

ScalarParam Inkscape::LivePathEffect::LPEPatternAlongPath::tang_offset

private

Definition at line 64 of file lpe-patternalongpath.h.

Referenced by doEffect_pwd2(), and LPEPatternAlongPath().

◆ vertical_pattern

BoolParam Inkscape::LivePathEffect::LPEPatternAlongPath::vertical_pattern

private

Definition at line 66 of file lpe-patternalongpath.h.

Referenced by doEffect_pwd2(), and LPEPatternAlongPath().

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

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

Private Attributes
EnumParam< PAPCopyType >	copytype

BoolParam	scale_y_rel

ScalarParam	spacing

ScalarParam	normal_offset

ScalarParam	tang_offset

BoolParam	prop_units

BoolParam	vertical_pattern

BoolParam	hide_knot

ScalarParam	fuse_tolerance

KnotHolder *	_knotholder

Geom::PathVector	helper_path

Public Member Functions

Public Attributes

Protected Attributes

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ LPEPatternAlongPath() [1/2]

◆ ~LPEPatternAlongPath()

◆ LPEPatternAlongPath() [2/2]

Member Function Documentation

◆ addCanvasIndicators()

◆ addKnotHolderEntities()

◆ doBeforeEffect()

◆ doEffect_pwd2()

◆ doOnOpen()

◆ on_pattern_pasted()

◆ operator=()

◆ transform_multiply()

Friends And Related Symbol Documentation

◆ Inkscape::UI::Toolbar::PencilToolbar

◆ WPAP::KnotHolderEntityWidthPatternAlongPath

Member Data Documentation

◆ _knotholder

◆ copytype

◆ fuse_tolerance

◆ helper_path

◆ hide_knot

◆ normal_offset

◆ original_height

◆ pattern

◆ prop_scale

◆ prop_units

◆ scale_y_rel

◆ spacing

◆ tang_offset

◆ vertical_pattern