Inkscape: Inkscape::LivePathEffect::ScalarArrayParam Class Reference

Searching...

No Matches

#include <scalararray.h>

Inheritance diagram for Inkscape::LivePathEffect::ScalarArrayParam:

Public Member Functions
	ScalarArrayParam (Glib::ustring const &label, Glib::ustring const &tip, Glib::ustring const &key, Inkscape::UI::Widget::Registry wr, Effect effect, double default_value=0.0, bool visible=true, size_t n=0)

	ScalarArrayParam (const ScalarArrayParam &)=delete

ScalarArrayParam &	operator= (const ScalarArrayParam &)=delete

Gtk::Widget *	param_newWidget () override

void	param_setActive (size_t index)

Glib::ustring	param_getDefaultSVGValue () const override

void	param_set_default () override

void	param_update_default (double default_value)

void	param_update_default (char const *default_value) override

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	addSlider (bool add_slider_widget)

void	on_value_changed (Inkscape::UI::Widget::RegisteredScalar *rsu)

double	param_get_min () const

double	param_get_max () const

void	param_set_undo (bool set_undo)

ParamType	paramType () const override

Public Member Functions inherited from Inkscape::LivePathEffect::ArrayParam< double >
	ArrayParam (const Glib::ustring &label, const Glib::ustring &tip, const Glib::ustring &key, Inkscape::UI::Widget::Registry wr, Effect effect, std::size_t n=0)

	ArrayParam (const ArrayParam &)

ArrayParam &	operator= (const ArrayParam &)

std::vector< double > const &	data () const

bool	param_readSVGValue (char const *const strvalue) override

Glib::ustring	param_getSVGValue () const override

void	param_setValue (std::vector< double > const &new_vector)

void	param_set_and_write_new_value (std::vector< double > const &new_vector)

bool	valid_index (int index) 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 void	param_transform_multiply (Geom::Affine const &, bool set)

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

Private Attributes
size_t	_active_index = 0

double	min

double	max

bool	integer

unsigned	digits

double	inc_step

double	inc_page

bool	add_slider

bool	_set_undo

double	defvalue

Friends
class	LPETaperStroke

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::ArrayParam< double >
void	writesvg (SVGOStringStream &str, std::vector< double > const &vector) const

void	writesvgData (SVGOStringStream &str, float const &vector_data) const

void	writesvgData (SVGOStringStream &str, double const &vector_data) const

void	writesvgData (SVGOStringStream &str, Glib::ustring const &vector_data) const

void	writesvgData (SVGOStringStream &str, Geom::Point const &vector_data) const

void	writesvgData (SVGOStringStream &str, std::shared_ptr< SatelliteReference > const &vector_data) const

void	writesvgData (SVGOStringStream &str, std::vector< NodeSatellite > const &vector_data) const

double	readsvg (char const *str)

double	readsvg (char const *const str)

float	readsvg (char const *const str)

Glib::ustring	readsvg (char const *const str)

Geom::Point	readsvg (char const *const str)

std::shared_ptr< SatelliteReference >	readsvg (char const *const str)

std::vector< NodeSatellite >	readsvg (char const *const str)

Protected Member Functions inherited from Inkscape::LivePathEffect::Parameter
void	param_write_to_repr (const char *svgd)

Protected Attributes inherited from Inkscape::LivePathEffect::ArrayParam< double >
std::vector< double >	_vector

std::size_t	_default_size

Protected Attributes inherited from Inkscape::LivePathEffect::Parameter
bool	_updating = false

Inkscape::Display::TemporaryItem *	ownerlocator = nullptr

Effect *	param_effect

Detailed Description

Definition at line 20 of file scalararray.h.

Constructor & Destructor Documentation

◆ ScalarArrayParam() [1/2]

Inkscape::LivePathEffect::ScalarArrayParam::ScalarArrayParam	(	Glib::ustring const &	label,
		Glib::ustring const &	tip,
		Glib::ustring const &	key,
		Inkscape::UI::Widget::Registry *	wr,
		Effect *	effect,
		double	default_value = `0.0`,
		bool	visible = `true`,
		size_t	n = `0`
	)

Definition at line 23 of file scalararray.cpp.

References Geom::max(), Geom::min(), visible, and Inkscape::LivePathEffect::Parameter::widget_is_visible.

◆ ScalarArrayParam() [2/2]

Inkscape::LivePathEffect::ScalarArrayParam::ScalarArrayParam ( const ScalarArrayParam & )

delete

Member Function Documentation

◆ addSlider()

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

inline

Definition at line 50 of file scalararray.h.

References add_slider.

◆ on_value_changed()

void Inkscape::LivePathEffect::ScalarArrayParam::on_value_changed ( Inkscape::UI::Widget::RegisteredScalar * rsu )

Definition at line 76 of file scalararray.cpp.

References _active_index, Inkscape::LivePathEffect::ArrayParam< double >::_vector, Inkscape::UI::Widget::Scalar::getValue(), Inkscape::LivePathEffect::ArrayParam< double >::param_set_and_write_new_value(), and Inkscape::UI::Widget::Scalar::setProgrammatically.

Referenced by param_newWidget().

◆ operator=()

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

delete

◆ param_get_max()

double Inkscape::LivePathEffect::ScalarArrayParam::param_get_max ( ) const

inline

Definition at line 54 of file scalararray.h.

References max.

◆ param_get_min()

double Inkscape::LivePathEffect::ScalarArrayParam::param_get_min ( ) const

inline

Definition at line 53 of file scalararray.h.

References min.

◆ param_getDefaultSVGValue()

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

overridevirtual

Reimplemented from Inkscape::LivePathEffect::ArrayParam< double >.

Definition at line 90 of file scalararray.cpp.

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

◆ param_make_integer()

void Inkscape::LivePathEffect::ScalarArrayParam::param_make_integer ( bool yes = true )

Definition at line 135 of file scalararray.cpp.

References digits, inc_page, inc_step, and integer.

◆ param_newWidget()

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

overridevirtual

◆ param_set_default()

void Inkscape::LivePathEffect::ScalarArrayParam::param_set_default ( )

overridevirtual

Reimplemented from Inkscape::LivePathEffect::ArrayParam< double >.

Definition at line 98 of file scalararray.cpp.

References Inkscape::LivePathEffect::ArrayParam< double >::_vector, and defvalue.

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

◆ param_set_digits()

void Inkscape::LivePathEffect::ScalarArrayParam::param_set_digits ( unsigned digits )

Definition at line 145 of file scalararray.cpp.

References digits.

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

◆ param_set_increments()

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

Definition at line 147 of file scalararray.cpp.

References inc_page, inc_step, and page.

◆ param_set_range()

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

Definition at line 115 of file scalararray.cpp.

References max, min, Inkscape::LivePathEffect::Parameter::param_effect, Inkscape::LivePathEffect::Effect::refresh_widgets, and SCALARPARAM_G_MAXDOUBLE.

◆ param_set_undo()

void Inkscape::LivePathEffect::ScalarArrayParam::param_set_undo ( bool set_undo )

Definition at line 143 of file scalararray.cpp.

References _set_undo.

◆ param_setActive()

void Inkscape::LivePathEffect::ScalarArrayParam::param_setActive ( size_t index )

inline

Definition at line 36 of file scalararray.h.

References _active_index, index, Inkscape::LivePathEffect::Parameter::param_effect, and Inkscape::LivePathEffect::Effect::refresh_widgets.

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

◆ param_update_default() [1/2]

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

overridevirtual

Reimplemented from Inkscape::LivePathEffect::ArrayParam< double >.

Definition at line 106 of file scalararray.cpp.

References param_update_default(), and sp_svg_number_read_d().

◆ param_update_default() [2/2]

void Inkscape::LivePathEffect::ScalarArrayParam::param_update_default ( double default_value )

Definition at line 104 of file scalararray.cpp.

References defvalue.

Referenced by param_update_default().

◆ paramType()

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

inlineoverridevirtual

Reimplemented from Inkscape::LivePathEffect::ArrayParam< double >.

Definition at line 57 of file scalararray.h.

References Inkscape::LivePathEffect::SCALAR_ARRAY.

Friends And Related Symbol Documentation

◆ LPETaperStroke

friend class LPETaperStroke

friend

Definition at line 60 of file scalararray.h.

Member Data Documentation

◆ _active_index

size_t Inkscape::LivePathEffect::ScalarArrayParam::_active_index = 0

private

Definition at line 62 of file scalararray.h.

Referenced by on_value_changed(), param_newWidget(), and param_setActive().

◆ _set_undo

bool Inkscape::LivePathEffect::ScalarArrayParam::_set_undo

private

Definition at line 70 of file scalararray.h.

Referenced by param_newWidget(), and param_set_undo().

◆ add_slider

bool Inkscape::LivePathEffect::ScalarArrayParam::add_slider

private

Definition at line 69 of file scalararray.h.

Referenced by addSlider(), and param_newWidget().

◆ defvalue

double Inkscape::LivePathEffect::ScalarArrayParam::defvalue

private

Definition at line 71 of file scalararray.h.

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

◆ digits

unsigned Inkscape::LivePathEffect::ScalarArrayParam::digits

private

Definition at line 66 of file scalararray.h.

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

◆ inc_page

double Inkscape::LivePathEffect::ScalarArrayParam::inc_page

private

Definition at line 68 of file scalararray.h.

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

◆ inc_step

double Inkscape::LivePathEffect::ScalarArrayParam::inc_step

private

Definition at line 67 of file scalararray.h.

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

◆ integer

bool Inkscape::LivePathEffect::ScalarArrayParam::integer

private

Definition at line 65 of file scalararray.h.

Referenced by param_make_integer().

◆ max

double Inkscape::LivePathEffect::ScalarArrayParam::max

private

Definition at line 64 of file scalararray.h.

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

◆ min

double Inkscape::LivePathEffect::ScalarArrayParam::min

private

Definition at line 63 of file scalararray.h.

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

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

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

Public Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ScalarArrayParam() [1/2]

◆ ScalarArrayParam() [2/2]

Member Function Documentation

◆ addSlider()

◆ on_value_changed()

◆ operator=()

◆ param_get_max()

◆ param_get_min()

◆ param_getDefaultSVGValue()

◆ param_make_integer()

◆ param_newWidget()

◆ param_set_default()

◆ param_set_digits()

◆ param_set_increments()

◆ param_set_range()

◆ param_set_undo()

◆ param_setActive()

◆ param_update_default() [1/2]

◆ param_update_default() [2/2]

◆ paramType()

Friends And Related Symbol Documentation

◆ LPETaperStroke

Member Data Documentation

◆ _active_index

◆ _set_undo

◆ add_slider

◆ defvalue

◆ digits

◆ inc_page

◆ inc_step

◆ integer

◆ max

◆ min