Inkscape: Inkscape::LivePathEffect::LPEPowerMask Class Reference

Searching...

No Matches

#include <lpe-powermask.h>

Inheritance diagram for Inkscape::LivePathEffect::LPEPowerMask:

Public Member Functions
	LPEPowerMask (LivePathEffectObject *lpeobject)

	~LPEPowerMask () override

void	doOnApply (SPLPEItem const *lpeitem) override
	Is performed a single time when the effect is freshly applied to a path.

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

void	doEffect (Geom::PathVector &curve) override

void	doOnRemove (SPLPEItem const *) override

void	doOnVisibilityToggled (SPLPEItem const *lpeitem) override

void	toggleMaskVisibility ()

void	tryForkMask ()

Glib::ustring	getId ()

void	setMask ()

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

Private Attributes
HiddenParam	uri

BoolParam	invert

BoolParam	hide_mask

BoolParam	background

ColorPickerParam	background_color

std::optional< Colors::Color >	previous_color

Geom::Path	mask_box

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)

virtual Geom::Piecewise< Geom::D2< Geom::SBasis > >	doEffect_pwd2 (Geom::Piecewise< Geom::D2< Geom::SBasis > > const &pwd2_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 19 of file lpe-powermask.h.

Constructor & Destructor Documentation

◆ LPEPowerMask()

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

Definition at line 31 of file lpe-powermask.cpp.

References background, background_color, Inkscape::LivePathEffect::ColorPickerParam::get_value(), hide_mask, invert, previous_color, Inkscape::LivePathEffect::Effect::registerParameter(), and uri.

◆ ~LPEPowerMask()

Inkscape::LivePathEffect::LPEPowerMask::~LPEPowerMask ( )

overridedefault

Member Function Documentation

◆ doBeforeEffect()

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

overridevirtual

Is performed each time before the effect is updated.

Reimplemented from Inkscape::LivePathEffect::Effect.

Definition at line 106 of file lpe-powermask.cpp.

References background_color, Geom::Path::clear(), Inkscape::URIReference::detach(), Geom::GenericRect< C >::expandBy(), extract_uri(), Inkscape::LivePathEffect::ColorPickerParam::get_value(), SPObject::getAttribute(), SPItem::getMaskObject(), SPItem::getMaskRef(), Inkscape::LivePathEffect::Effect::getSPDoc(), hide_mask, item, mask_box, Inkscape::LivePathEffect::HiddenParam::param_getSVGValue(), Inkscape::LivePathEffect::HiddenParam::param_setValue(), previous_color, setMask(), Inkscape::LivePathEffect::Effect::sp_lpe_item, Inkscape::URIReference::try_attach(), tryForkMask(), uri, and SPItem::visualBounds().

Referenced by doOnVisibilityToggled().

◆ doEffect()

void Inkscape::LivePathEffect::LPEPowerMask::doEffect ( Geom::PathVector & curve )

overridevirtual

Reimplemented from Inkscape::LivePathEffect::Effect.

Definition at line 274 of file lpe-powermask.cpp.

◆ doOnApply()

void Inkscape::LivePathEffect::LPEPowerMask::doOnApply ( SPLPEItem const * lpeitem )

overridevirtual

Is performed a single time when the effect is freshly applied to a path.

Todo:: Investigate the cause of this. For example, this happens when copy pasting an object with LPE applied. Probably because the object is pasted while the effect is not yet pasted to defs, and cannot be found.

Reimplemented from Inkscape::LivePathEffect::Effect.

Definition at line 53 of file lpe-powermask.cpp.

References LivePathEffectObject::effecttype, getId(), SPItem::getMaskObject(), SPLPEItem::hasPathEffect(), item, Inkscape::LivePathEffect::Effect::lpeobj, Inkscape::LivePathEffect::LPETypeConverter, SPLPEItem::path_effect_list, SPLPEItem::pathEffectsEnabled(), SPObject::setAttribute(), and uri.