Inkscape::LivePathEffect::LPEAttachPath Class Reference

#include <lpe-attach-path.h>

Inheritance diagram for Inkscape::LivePathEffect::LPEAttachPath:

Public Member Functions
	LPEAttachPath (LivePathEffectObject *lpeobject)
	~LPEAttachPath () override
void	doEffect (Geom::PathVector &curve) override
void	resetDefaults (SPItem const *item) override
	Sets all parameters to their default values and writes them to SVG.
void	doBeforeEffect (SPLPEItem const *lpeitem) override
	Is performed each time before the effect is updated.
bool	doOnOpen (SPLPEItem const *lpeitem) override
	Is performed on load document or revert If the item is fixed legacy return true.
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 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
	LPEAttachPath (const LPEAttachPath &)=delete
LPEAttachPath &	operator= (const LPEAttachPath &)=delete

Private Attributes
Geom::Point	curve_start_previous_origin
Geom::Point	curve_end_previous_origin
OriginalPathParam	start_path
ScalarParam	start_path_position
TransformedPointParam	start_path_curve_start
VectorParam	start_path_curve_end
OriginalPathParam	end_path
ScalarParam	end_path_position
TransformedPointParam	end_path_curve_start
VectorParam	end_path_curve_end

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 24 of file lpe-attach-path.h.

Constructor & Destructor Documentation

LPEAttachPath() [1/2]

Inkscape::LivePathEffect::LPEAttachPath::LPEAttachPath

(

LivePathEffectObject *

lpeobject

)

Definition at line 22 of file lpe-attach-path.cpp.

References curve_end_previous_origin, curve_start_previous_origin, end_path, end_path_curve_end, end_path_curve_start, end_path_position, Inkscape::LivePathEffect::VectorParam::getOrigin(), Inkscape::LivePathEffect::Effect::registerParameter(), Inkscape::LivePathEffect::Parameter::setUpdating(), Inkscape::LivePathEffect::Effect::show_orig_path, start_path, start_path_curve_end, start_path_curve_start, and start_path_position.

~LPEAttachPath()

Inkscape::LivePathEffect::LPEAttachPath::~LPEAttachPath ( )

overridedefault

LPEAttachPath() [2/2]

Inkscape::LivePathEffect::LPEAttachPath::LPEAttachPath ( const LPEAttachPath &  )

privatedelete

Member Function Documentation

doBeforeEffect()

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

overridevirtual

Is performed each time before the effect is updated.

Reimplemented from Inkscape::LivePathEffect::Effect.

Definition at line 61 of file lpe-attach-path.cpp.

References Inkscape::LivePathEffect::Parameter::connect_selection_changed(), end_path, Inkscape::LivePathEffect::OriginalPathParam::getObject(), Inkscape::LivePathEffect::Effect::is_load, item, SPObject::requestDisplayUpdate(), Inkscape::LivePathEffect::Parameter::setUpdating(), Inkscape::LivePathEffect::PathParam::start_listening(), and start_path.

doEffect()

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

overridevirtual

Reimplemented from Inkscape::LivePathEffect::Effect.

Definition at line 95 of file lpe-attach-path.cpp.

References SPObject::_tmpsuccessor, Geom::are_near(), Geom::PathTime::asFlatTime(), Geom::Path::at(), Geom::atan2(), Geom::Path::back(), c, Geom::cos(), curve_end_previous_origin, curve_start_previous_origin, Geom::PathVector::empty(), end_path, end_path_curve_end, end_path_curve_start, end_path_position, Geom::PathVector::front(), Inkscape::LivePathEffect::PathParam::get_pathvector(), Inkscape::LivePathEffect::OriginalPathParam::getObject(), Inkscape::LivePathEffect::VectorParam::getOrigin(), SPItem::getRelativeTransform(), Inkscape::LivePathEffect::TransformedPointParam::getVector(), Inkscape::LivePathEffect::VectorParam::getVector(), Geom::Curve::initialPoint(), Geom::Point::length(), Geom::length(), curve::length, Inkscape::LivePathEffect::OriginalPathParam::linksToPath(), Geom::Path::nearestTime(), Inkscape::LivePathEffect::ScalarParam::param_set_value(), Geom::Curve::pointAndDerivatives(), Inkscape::LivePathEffect::TransformedPointParam::setOrigin(), Inkscape::LivePathEffect::VectorParam::setOrigin(), Geom::sin(), Geom::Path::size(), Inkscape::LivePathEffect::Effect::sp_lpe_item, start_path, start_path_curve_end, start_path_curve_start, start_path_position, Geom::Point::x(), and Geom::Point::y().

doOnOpen()

bool Inkscape::LivePathEffect::LPEAttachPath::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 81 of file lpe-attach-path.cpp.

References Inkscape::LivePathEffect::Parameter::connect_selection_changed(), end_path, Inkscape::LivePathEffect::OriginalPathParam::getObject(), Inkscape::LivePathEffect::Effect::is_applied, Inkscape::LivePathEffect::Effect::is_load, Inkscape::LivePathEffect::Parameter::setUpdating(), Inkscape::LivePathEffect::PathParam::start_listening(), and start_path.

operator=()

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

privatedelete

resetDefaults()

void Inkscape::LivePathEffect::LPEAttachPath::resetDefaults ( SPItem const *  item )

overridevirtual

Sets all parameters to their default values and writes them to SVG.

Reimplemented from Inkscape::LivePathEffect::Effect.

Definition at line 53 of file lpe-attach-path.cpp.

References curve_end_previous_origin, curve_start_previous_origin, end_path_curve_end, Inkscape::LivePathEffect::VectorParam::getOrigin(), Inkscape::LivePathEffect::Effect::resetDefaults(), and start_path_curve_end.

Member Data Documentation

curve_end_previous_origin

Geom::Point Inkscape::LivePathEffect::LPEAttachPath::curve_end_previous_origin

private

Definition at line 39 of file lpe-attach-path.h.

Referenced by doEffect(), LPEAttachPath(), and resetDefaults().

curve_start_previous_origin

Geom::Point Inkscape::LivePathEffect::LPEAttachPath::curve_start_previous_origin

private

Definition at line 38 of file lpe-attach-path.h.

Referenced by doEffect(), LPEAttachPath(), and resetDefaults().

end_path

OriginalPathParam Inkscape::LivePathEffect::LPEAttachPath::end_path

private

Definition at line 46 of file lpe-attach-path.h.

Referenced by doBeforeEffect(), doEffect(), doOnOpen(), and LPEAttachPath().

end_path_curve_end

VectorParam Inkscape::LivePathEffect::LPEAttachPath::end_path_curve_end

private

Definition at line 49 of file lpe-attach-path.h.

Referenced by doEffect(), LPEAttachPath(), and resetDefaults().

end_path_curve_start

TransformedPointParam Inkscape::LivePathEffect::LPEAttachPath::end_path_curve_start

private

Definition at line 48 of file lpe-attach-path.h.

Referenced by doEffect(), and LPEAttachPath().

end_path_position

ScalarParam Inkscape::LivePathEffect::LPEAttachPath::end_path_position

private

Definition at line 47 of file lpe-attach-path.h.

Referenced by doEffect(), and LPEAttachPath().

start_path

OriginalPathParam Inkscape::LivePathEffect::LPEAttachPath::start_path

private

Definition at line 41 of file lpe-attach-path.h.

Referenced by doBeforeEffect(), doEffect(), doOnOpen(), and LPEAttachPath().

start_path_curve_end

VectorParam Inkscape::LivePathEffect::LPEAttachPath::start_path_curve_end

private

Definition at line 44 of file lpe-attach-path.h.

Referenced by doEffect(), LPEAttachPath(), and resetDefaults().

start_path_curve_start

TransformedPointParam Inkscape::LivePathEffect::LPEAttachPath::start_path_curve_start

private

Definition at line 43 of file lpe-attach-path.h.

Referenced by doEffect(), and LPEAttachPath().

start_path_position

ScalarParam Inkscape::LivePathEffect::LPEAttachPath::start_path_position

private

Definition at line 42 of file lpe-attach-path.h.

Referenced by doEffect(), and LPEAttachPath().

---

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

• /builds/inkscape/inkscape/src/live_effects/lpe-attach-path.h
• /builds/inkscape/inkscape/src/live_effects/lpe-attach-path.cpp