Inkscape::LivePathEffect::ScalarParam Class Reference

#include <parameter.h>

Inheritance diagram for Inkscape::LivePathEffect::ScalarParam:

Public Member Functions
	ScalarParam (const Glib::ustring &label, const Glib::ustring &tip, const Glib::ustring &key, Inkscape::UI::Widget::Registry *wr, Effect *effect, double default_value=1.0)
	ScalarParam (const ScalarParam &)=delete
ScalarParam &	operator= (const ScalarParam &)=delete
bool	param_readSVGValue (char const *strvalue) override
Glib::ustring	param_getSVGValue () const override
Glib::ustring	param_getDefaultSVGValue () const override
void	param_transform_multiply (Geom::Affine const &postmul, bool set) override
void	param_set_default () override
void	param_update_default (double default_value)
void	param_update_default (char const *default_value) override
void	param_set_value (double val)
void	param_make_integer (bool yes=true)
void	param_set_range (double min, double max)
void	param_set_digits (unsigned digits)
void	param_set_increments (double step, double page)
void	param_set_no_leading_zeros ()
void	param_set_width_chars (int width_chars)
void	addSlider (bool add_slider_widget)
double	param_get_max ()
double	param_get_min ()
void	param_set_undo (bool set_undo)
Gtk::Widget *	param_newWidget () override
ParamType	paramType () const override
	operator double () const
Public Member Functions inherited from Inkscape::LivePathEffect::Parameter
	Parameter (Glib::ustring label, Glib::ustring tip, Glib::ustring key, Inkscape::UI::Widget::Registry *wr, Effect *effect)
virtual	~Parameter ()
	Parameter (const Parameter &)=delete
Parameter &	operator= (const Parameter &)=delete
virtual void	param_widget_is_visible (bool is_visible)
virtual void	param_widget_is_enabled (bool is_enabled)
void	write_to_SVG ()
void	read_from_SVG ()
void	setUpdating (bool updating)
bool	getUpdating () const
Glib::ustring const *	param_getTooltip () const
virtual bool	providesKnotHolderEntities () const
virtual void	addKnotHolderEntities (KnotHolder *, SPItem *)
virtual void	addCanvasIndicators (SPLPEItem const *, std::vector< Geom::PathVector > &)
virtual void	param_editOncanvas (SPItem *, SPDesktop *)
virtual void	param_setup_nodepath (Inkscape::NodePath::Path *)
virtual std::vector< SPObject * >	param_get_satellites ()
void	param_higlight (bool highlight)
void	change_selection (Inkscape::Selection *selection)
void	update_satellites ()
EffectType	effectType () const
void	connect_selection_changed ()

Protected Attributes
double	value
double	min
double	max
bool	integer
double	defvalue
unsigned	digits
double	inc_step
double	inc_page
bool	add_slider
bool	_set_undo
bool	_no_leading_zeros
int	_width_chars
Protected Attributes inherited from Inkscape::LivePathEffect::Parameter
bool	_updating = false
Inkscape::Display::TemporaryItem *	ownerlocator = nullptr
Effect *	param_effect

Additional Inherited Members
Public Attributes inherited from Inkscape::LivePathEffect::Parameter
sigc::scoped_connection	selection_changed_connection
Glib::ustring	param_key
Glib::ustring	param_tooltip
Inkscape::UI::Widget::Registry *	param_wr
Glib::ustring	param_label
bool	oncanvas_editable
bool	widget_is_visible
bool	widget_is_enabled
Protected Member Functions inherited from Inkscape::LivePathEffect::Parameter
void	param_write_to_repr (const char *svgd)

Detailed Description

Definition at line 117 of file parameter.h.

Constructor & Destructor Documentation

ScalarParam() [1/2]

Inkscape::LivePathEffect::ScalarParam::ScalarParam	(	const Glib::ustring &	label,
		const Glib::ustring &	tip,
		const Glib::ustring &	key,
		Inkscape::UI::Widget::Registry *	wr,
		Effect *	effect,
		double	default_value = 1.0
	)

Definition at line 206 of file parameter.cpp.

References Geom::max(), and Geom::min().

ScalarParam() [2/2]

Inkscape::LivePathEffect::ScalarParam::ScalarParam ( const ScalarParam &  )

delete

Member Function Documentation

addSlider()

void Inkscape::LivePathEffect::ScalarParam::addSlider ( bool  add_slider_widget )

inline

Definition at line 140 of file parameter.h.

References add_slider.

Referenced by Inkscape::LivePathEffect::LPEPowerStroke::LPEPowerStroke(), and Inkscape::LivePathEffect::LPESimplify::LPESimplify().

operator double()

Inkscape::LivePathEffect::ScalarParam::operator double ( ) const

inline

Definition at line 146 of file parameter.h.

References value.

operator=()

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

delete

param_get_max()

double Inkscape::LivePathEffect::ScalarParam::param_get_max ( )

inline

Definition at line 141 of file parameter.h.

References max.

param_get_min()

double Inkscape::LivePathEffect::ScalarParam::param_get_min ( )

inline

Definition at line 142 of file parameter.h.

References min.

param_getDefaultSVGValue()

Glib::ustring Inkscape::LivePathEffect::ScalarParam::param_getDefaultSVGValue ( ) const

overridevirtual

Implements Inkscape::LivePathEffect::Parameter.

Definition at line 243 of file parameter.cpp.

References defvalue, and Inkscape::SVGOStringStream::str().

param_getSVGValue()

Glib::ustring Inkscape::LivePathEffect::ScalarParam::param_getSVGValue ( ) const

overridevirtual

Implements Inkscape::LivePathEffect::Parameter.

Definition at line 236 of file parameter.cpp.

References Inkscape::SVGOStringStream::str(), and value.

param_make_integer()

void Inkscape::LivePathEffect::ScalarParam::param_make_integer

(

bool

yes = true

)

Definition at line 305 of file parameter.cpp.

References digits, inc_page, inc_step, and integer.

Referenced by Inkscape::LivePathEffect::LPEConstructGrid::LPEConstructGrid(), Inkscape::LivePathEffect::LPECopyRotate::LPECopyRotate(), Inkscape::LivePathEffect::LPECurveStitch::LPECurveStitch(), Inkscape::LivePathEffect::LPEEmbroderyStitch::LPEEmbroderyStitch(), Inkscape::LivePathEffect::LPEFilletChamfer::LPEFilletChamfer(), Inkscape::LivePathEffect::LPEGears::LPEGears(), Inkscape::LivePathEffect::LPEInterpolate::LPEInterpolate(), Inkscape::LivePathEffect::LPEMeasureSegments::LPEMeasureSegments(), Inkscape::LivePathEffect::LPERecursiveSkeleton::LPERecursiveSkeleton(), Inkscape::LivePathEffect::LPERoughen::LPERoughen(), Inkscape::LivePathEffect::LPERuler::LPERuler(), Inkscape::LivePathEffect::LPETiling::LPETiling(), Inkscape::LivePathEffect::LPETransform2Pts::LPETransform2Pts(), and Inkscape::LivePathEffect::LPEVonKoch::LPEVonKoch().

param_newWidget()

Gtk::Widget * Inkscape::LivePathEffect::ScalarParam::param_newWidget ( )

overridevirtual

Implements Inkscape::LivePathEffect::Parameter.

Definition at line 323 of file parameter.cpp.

References _no_leading_zeros, _set_undo, _width_chars, add_slider, digits, Inkscape::LivePathEffect::Effect::getRepr(), Inkscape::LivePathEffect::Effect::getSPDoc(), inc_page, inc_step, max, min, Inkscape::LivePathEffect::Parameter::param_effect, Inkscape::LivePathEffect::Parameter::param_key, Inkscape::LivePathEffect::Parameter::param_label, Inkscape::LivePathEffect::Parameter::param_tooltip, Inkscape::LivePathEffect::Parameter::param_wr, value, and Inkscape::LivePathEffect::Parameter::widget_is_visible.

param_readSVGValue()

bool Inkscape::LivePathEffect::ScalarParam::param_readSVGValue ( char const *  strvalue )

overridevirtual

Implements Inkscape::LivePathEffect::Parameter.

Definition at line 225 of file parameter.cpp.

References param_set_value(), and sp_svg_number_read_d().

Referenced by Inkscape::LivePathEffect::LPETaperStroke::doBeforeEffect().

param_set_default()

void Inkscape::LivePathEffect::ScalarParam::param_set_default ( )

overridevirtual

Implements Inkscape::LivePathEffect::Parameter.

Definition at line 250 of file parameter.cpp.

References defvalue, and param_set_value().

param_set_digits()

void Inkscape::LivePathEffect::ScalarParam::param_set_digits

(

unsigned

digits

)

Definition at line 351 of file parameter.cpp.

References digits.

Referenced by Inkscape::LivePathEffect::LPEBendPath::LPEBendPath(), Inkscape::LivePathEffect::LPEBSpline::LPEBSpline(), Inkscape::LivePathEffect::LPECopyRotate::LPECopyRotate(), Inkscape::LivePathEffect::LPECurveStitch::LPECurveStitch(), Inkscape::LivePathEffect::LPEDashedStroke::LPEDashedStroke(), Inkscape::LivePathEffect::LPEEmbroderyStitch::LPEEmbroderyStitch(), Inkscape::LivePathEffect::LPEFilletChamfer::LPEFilletChamfer(), Inkscape::LivePathEffect::LPEMeasureSegments::LPEMeasureSegments(), Inkscape::LivePathEffect::LPEOffset::LPEOffset(), Inkscape::LivePathEffect::LPEPatternAlongPath::LPEPatternAlongPath(), Inkscape::LivePathEffect::LPEPowerStroke::LPEPowerStroke(), Inkscape::LivePathEffect::LPERoughen::LPERoughen(), Inkscape::LivePathEffect::LPERuler::LPERuler(), Inkscape::LivePathEffect::LPEShowHandles::LPEShowHandles(), Inkscape::LivePathEffect::LPESimplify::LPESimplify(), Inkscape::LivePathEffect::LPETaperStroke::LPETaperStroke(), Inkscape::LivePathEffect::LPETransform2Pts::LPETransform2Pts(), and Inkscape::LivePathEffect::LPESimplify::setVersioningData().

param_set_increments()

void Inkscape::LivePathEffect::ScalarParam::param_set_increments	(	double	step,
		double	page
	)

Definition at line 353 of file parameter.cpp.

References inc_page, inc_step, and page.

Referenced by Inkscape::LivePathEffect::LPECopyRotate::doBeforeEffect(), Inkscape::LivePathEffect::LPEBendPath::LPEBendPath(), Inkscape::LivePathEffect::LPEBSpline::LPEBSpline(), Inkscape::LivePathEffect::LPECopyRotate::LPECopyRotate(), Inkscape::LivePathEffect::LPECurveStitch::LPECurveStitch(), Inkscape::LivePathEffect::LPEDashedStroke::LPEDashedStroke(), Inkscape::LivePathEffect::LPEFilletChamfer::LPEFilletChamfer(), Inkscape::LivePathEffect::LPEMeasureSegments::LPEMeasureSegments(), Inkscape::LivePathEffect::LPEOffset::LPEOffset(), Inkscape::LivePathEffect::LPEPatternAlongPath::LPEPatternAlongPath(), Inkscape::LivePathEffect::LPEPowerStroke::LPEPowerStroke(), Inkscape::LivePathEffect::LPEPts2Ellipse::LPEPts2Ellipse(), Inkscape::LivePathEffect::LPERoughen::LPERoughen(), Inkscape::LivePathEffect::LPERuler::LPERuler(), Inkscape::LivePathEffect::LPEShowHandles::LPEShowHandles(), Inkscape::LivePathEffect::LPESimplify::LPESimplify(), Inkscape::LivePathEffect::LPETaperStroke::LPETaperStroke(), Inkscape::LivePathEffect::LPETiling::LPETiling(), Inkscape::LivePathEffect::LPETransform2Pts::LPETransform2Pts(), and Inkscape::LivePathEffect::LPESimplify::setVersioningData().

param_set_no_leading_zeros()

void Inkscape::LivePathEffect::ScalarParam::param_set_no_leading_zeros

(

)

Definition at line 313 of file parameter.cpp.

References _no_leading_zeros.

Referenced by Inkscape::LivePathEffect::LPESimplify::setVersioningData().

param_set_range()

void Inkscape::LivePathEffect::ScalarParam::param_set_range	(	double	min,
		double	max
	)

Definition at line 285 of file parameter.cpp.

References max, min, param_set_value(), SCALARPARAM_G_MAXDOUBLE, and value.

Referenced by Inkscape::LivePathEffect::LPETaperStroke::doBeforeEffect(), Inkscape::LivePathEffect::LPETransform2Pts::doBeforeEffect(), Inkscape::LivePathEffect::LPEBSpline::LPEBSpline(), Inkscape::LivePathEffect::LPEConstructGrid::LPEConstructGrid(), Inkscape::LivePathEffect::LPECopyRotate::LPECopyRotate(), Inkscape::LivePathEffect::LPECurveStitch::LPECurveStitch(), Inkscape::LivePathEffect::LPEDashedStroke::LPEDashedStroke(), Inkscape::LivePathEffect::LPEDynastroke::LPEDynastroke(), Inkscape::LivePathEffect::LPEEmbroderyStitch::LPEEmbroderyStitch(), Inkscape::LivePathEffect::LPEFilletChamfer::LPEFilletChamfer(), Inkscape::LivePathEffect::LPEGears::LPEGears(), Inkscape::LivePathEffect::LPEInterpolate::LPEInterpolate(), Inkscape::LivePathEffect::LPEMeasureSegments::LPEMeasureSegments(), Inkscape::LivePathEffect::LPEPowerStroke::LPEPowerStroke(), Inkscape::LivePathEffect::LPEPts2Ellipse::LPEPts2Ellipse(), Inkscape::LivePathEffect::LPERecursiveSkeleton::LPERecursiveSkeleton(), Inkscape::LivePathEffect::LPERoughen::LPERoughen(), Inkscape::LivePathEffect::LPERoughHatches::LPERoughHatches(), Inkscape::LivePathEffect::LPERuler::LPERuler(), Inkscape::LivePathEffect::LPEShowHandles::LPEShowHandles(), Inkscape::LivePathEffect::LPESimplify::LPESimplify(), Inkscape::LivePathEffect::LPETaperStroke::LPETaperStroke(), Inkscape::LivePathEffect::LPETiling::LPETiling(), Inkscape::LivePathEffect::LPETransform2Pts::LPETransform2Pts(), Inkscape::LivePathEffect::LPEVonKoch::LPEVonKoch(), Inkscape::LivePathEffect::LPETransform2Pts::reset(), and Inkscape::LivePathEffect::LPESimplify::setVersioningData().

param_set_undo()

void Inkscape::LivePathEffect::ScalarParam::param_set_undo

(

bool

set_undo

)

Definition at line 321 of file parameter.cpp.

References _set_undo.

Referenced by Inkscape::LivePathEffect::LPEOffset::doBeforeEffect().

param_set_value()

void Inkscape::LivePathEffect::ScalarParam::param_set_value

(

double

val

)

Definition at line 274 of file parameter.cpp.

References integer, max, min, and value.

Referenced by Inkscape::LivePathEffect::LPEPowerStroke::doAfterEffect(), Inkscape::LivePathEffect::LPETiling::doBeforeEffect(), Inkscape::LivePathEffect::LPECopyRotate::doBeforeEffect(), Inkscape::LivePathEffect::LPEOffset::doBeforeEffect(), Inkscape::LivePathEffect::LPETransform2Pts::doBeforeEffect(), Inkscape::LivePathEffect::LPEAttachPath::doEffect(), Inkscape::LivePathEffect::LPERuler::doEffect_pwd2(), Inkscape::LivePathEffect::LPEFilletChamfer::doOnApply(), Inkscape::LivePathEffect::LPEJoinType::doOnApply(), Inkscape::LivePathEffect::LPETaperStroke::doOnApply(), Inkscape::LivePathEffect::LPETransform2Pts::doOnApply(), param_readSVGValue(), param_set_default(), param_set_range(), param_transform_multiply(), Inkscape::LivePathEffect::LPETransform2Pts::reset(), and Inkscape::LivePathEffect::LPETransform2Pts::updateIndex().

param_set_width_chars()

void Inkscape::LivePathEffect::ScalarParam::param_set_width_chars

(

int

width_chars

)

Definition at line 317 of file parameter.cpp.

References _width_chars.

param_transform_multiply()

void Inkscape::LivePathEffect::ScalarParam::param_transform_multiply ( Geom::Affine const &  postmul, bool  set  )

overridevirtual

Reimplemented from Inkscape::LivePathEffect::Parameter.

Definition at line 263 of file parameter.cpp.

References Geom::Affine::descrim(), Inkscape::Preferences::get(), Inkscape::Preferences::getBool(), param_set_value(), set, value, and Inkscape::LivePathEffect::Parameter::write_to_SVG().

Referenced by Inkscape::LivePathEffect::LPEJoinType::transform_multiply(), Inkscape::LivePathEffect::LPEOffset::transform_multiply(), and Inkscape::LivePathEffect::LPETaperStroke::transform_multiply().

param_update_default() [1/2]

void Inkscape::LivePathEffect::ScalarParam::param_update_default ( char const *  default_value )

overridevirtual

Implements Inkscape::LivePathEffect::Parameter.

Definition at line 254 of file parameter.cpp.

References param_update_default(), and sp_svg_number_read_d().

param_update_default() [2/2]

void Inkscape::LivePathEffect::ScalarParam::param_update_default

(

double

default_value

)

Definition at line 252 of file parameter.cpp.

References defvalue.

Referenced by param_update_default().

paramType()

ParamType Inkscape::LivePathEffect::ScalarParam::paramType ( ) const

inlineoverridevirtual

Implements Inkscape::LivePathEffect::Parameter.

Definition at line 145 of file parameter.h.

References Inkscape::LivePathEffect::SCALAR.

Member Data Documentation

_no_leading_zeros

bool Inkscape::LivePathEffect::ScalarParam::_no_leading_zeros

protected

Definition at line 159 of file parameter.h.

Referenced by param_newWidget(), and param_set_no_leading_zeros().

_set_undo

bool Inkscape::LivePathEffect::ScalarParam::_set_undo

protected

Definition at line 158 of file parameter.h.

Referenced by param_newWidget(), and param_set_undo().

_width_chars

int Inkscape::LivePathEffect::ScalarParam::_width_chars

protected

Definition at line 160 of file parameter.h.

Referenced by param_newWidget(), and param_set_width_chars().

add_slider

bool Inkscape::LivePathEffect::ScalarParam::add_slider

protected

Definition at line 157 of file parameter.h.

Referenced by addSlider(), and param_newWidget().

defvalue

double Inkscape::LivePathEffect::ScalarParam::defvalue

protected

Definition at line 153 of file parameter.h.

Referenced by param_getDefaultSVGValue(), param_set_default(), and param_update_default().

digits

unsigned Inkscape::LivePathEffect::ScalarParam::digits

protected

Definition at line 154 of file parameter.h.

Referenced by param_make_integer(), param_newWidget(), and param_set_digits().

inc_page

double Inkscape::LivePathEffect::ScalarParam::inc_page

protected

Definition at line 156 of file parameter.h.

Referenced by param_make_integer(), param_newWidget(), and param_set_increments().

inc_step

double Inkscape::LivePathEffect::ScalarParam::inc_step

protected

Definition at line 155 of file parameter.h.

Referenced by param_make_integer(), param_newWidget(), and param_set_increments().

integer

bool Inkscape::LivePathEffect::ScalarParam::integer

protected

Definition at line 152 of file parameter.h.

Referenced by param_make_integer(), and param_set_value().

max

double Inkscape::LivePathEffect::ScalarParam::max

protected

Definition at line 151 of file parameter.h.

Referenced by param_get_max(), param_newWidget(), param_set_range(), and param_set_value().

min

double Inkscape::LivePathEffect::ScalarParam::min

protected

Definition at line 150 of file parameter.h.

Referenced by param_get_min(), param_newWidget(), param_set_range(), and param_set_value().

value

double Inkscape::LivePathEffect::ScalarParam::value

protected

Definition at line 149 of file parameter.h.

Referenced by operator double(), param_getSVGValue(), param_newWidget(), param_set_range(), param_set_value(), and param_transform_multiply().

---

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

• /builds/inkscape/inkscape/src/live_effects/parameter/parameter.h
• /builds/inkscape/inkscape/src/live_effects/parameter/parameter.cpp