Inkscape: Inkscape::LivePathEffect::LPEEnvelope Class Reference

Searching...

No Matches

#include <lpe-envelope.h>

Inheritance diagram for Inkscape::LivePathEffect::LPEEnvelope:

Public Member Functions
	LPEEnvelope (LivePathEffectObject *lpeobject)

	~LPEEnvelope () override

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

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

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

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

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

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.

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

	LPEEnvelope (const LPEEnvelope &)

LPEEnvelope &	operator= (const LPEEnvelope &)

Private Member Functions inherited from Inkscape::LivePathEffect::GroupBBoxEffect
Geom::OptRect	clip_mask_bbox (SPLPEItem *item, Geom::Affine transform)
	Updates the `boundingbox_X` and `boundingbox_Y` values from the geometric bounding box of `lpeitem`.

void	original_bbox (SPLPEItem const *lpeitem, bool absolute=false, bool clip_mask=false, Geom::Affine base_transform=Geom::identity())

Private Attributes
PathParam	bend_path1

PathParam	bend_path2

PathParam	bend_path3

PathParam	bend_path4

BoolParam	xx

BoolParam	yy

Private Attributes inherited from Inkscape::LivePathEffect::GroupBBoxEffect
Geom::Interval	boundingbox_X

Geom::Interval	boundingbox_Y

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 30 of file lpe-envelope.h.

Constructor & Destructor Documentation

◆ LPEEnvelope() [1/2]

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

Definition at line 19 of file lpe-envelope.cpp.

References Inkscape::LivePathEffect::Effect::apply_to_clippath_and_mask, bend_path1, bend_path2, bend_path3, bend_path4, Inkscape::LivePathEffect::Effect::concatenate_before_pwd2, Inkscape::LivePathEffect::Effect::registerParameter(), xx, and yy.

◆ ~LPEEnvelope()

Inkscape::LivePathEffect::LPEEnvelope::~LPEEnvelope ( )

overridedefault

◆ LPEEnvelope() [2/2]

Inkscape::LivePathEffect::LPEEnvelope::LPEEnvelope ( const LPEEnvelope & )

private

Member Function Documentation

◆ doBeforeEffect()

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

overridevirtual

Is performed each time before the effect is updated.

Reimplemented from Inkscape::LivePathEffect::Effect.

Definition at line 64 of file lpe-envelope.cpp.

References bend_path1, bend_path2, bend_path3, bend_path4, Inkscape::LivePathEffect::Effect::is_load, Inkscape::LivePathEffect::GroupBBoxEffect::original_bbox(), and Inkscape::LivePathEffect::PathParam::reload().

◆ doEffect_pwd2()

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