Inkscape::LivePathEffect::ArrayParam< StorageType > Class Template Reference

#include <array.h>

Inheritance diagram for Inkscape::LivePathEffect::ArrayParam< StorageType >:

Public Member Functions
	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< StorageType > const &	data () const
Gtk::Widget *	param_newWidget () override
bool	param_readSVGValue (char const *const strvalue) override
void	param_update_default (char const *default_value) override
Glib::ustring	param_getSVGValue () const override
Glib::ustring	param_getDefaultSVGValue () const override
void	param_setValue (std::vector< StorageType > const &new_vector)
void	param_set_default () override
void	param_set_and_write_new_value (std::vector< StorageType > const &new_vector)
ParamType	paramType () const override
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 ()

Protected Member Functions
void	writesvg (SVGOStringStream &str, std::vector< StorageType > 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
StorageType	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
std::vector< StorageType >	_vector
std::size_t	_default_size
Protected Attributes inherited from Inkscape::LivePathEffect::Parameter
bool	_updating = false
Inkscape::Display::TemporaryItem *	ownerlocator = nullptr
Effect *	param_effect

Friends
class	TpS::KnotHolderEntityAttachBegin
class	TpS::KnotHolderEntityAttachEnd

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

Detailed Description

template<typename StorageType>
class Inkscape::LivePathEffect::ArrayParam< StorageType >

Definition at line 33 of file array.h.

Constructor & Destructor Documentation

ArrayParam() [1/2]

template<typename StorageType >

Inkscape::LivePathEffect::ArrayParam< StorageType >::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  )

inline

Definition at line 35 of file array.h.

ArrayParam() [2/2]

template<typename StorageType >

Inkscape::LivePathEffect::ArrayParam< StorageType >::ArrayParam

(

const ArrayParam< StorageType > &

)

Member Function Documentation

data()

template<typename StorageType >

std::vector< StorageType > const & Inkscape::LivePathEffect::ArrayParam< StorageType >::data ( ) const

inline

Definition at line 48 of file array.h.

References Inkscape::LivePathEffect::ArrayParam< StorageType >::_vector.

Referenced by Inkscape::LivePathEffect::LPETiling::doAfterEffect(), Inkscape::LivePathEffect::LPECopyRotate::doAfterEffect(), Inkscape::LivePathEffect::LPEMirrorSymmetry::doAfterEffect(), Inkscape::LivePathEffect::LPESlice::doAfterEffect(), Inkscape::LivePathEffect::LPETiling::doBeforeEffect(), Inkscape::LivePathEffect::LPECopyRotate::doBeforeEffect(), Inkscape::LivePathEffect::LPEFilletChamfer::doBeforeEffect(), Inkscape::LivePathEffect::LPEKnot::doBeforeEffect(), Inkscape::LivePathEffect::LPEMeasureSegments::doBeforeEffect(), Inkscape::LivePathEffect::LPEMirrorSymmetry::doBeforeEffect(), Inkscape::LivePathEffect::LPESlice::doBeforeEffect(), Inkscape::LivePathEffect::LPETaperStroke::doBeforeEffect(), Inkscape::LivePathEffect::LPEPowerStroke::doEffect_path(), Inkscape::LivePathEffect::LPEPowerStroke::doOnApply(), Inkscape::LivePathEffect::Effect::doOnBeforeCommit(), Inkscape::LivePathEffect::LPESlice::doOnVisibilityToggled(), Inkscape::LivePathEffect::LPESlice::split(), Inkscape::LivePathEffect::LPECopyRotate::toItem(), Inkscape::LivePathEffect::LPETiling::toItem(), and Inkscape::LivePathEffect::LPEMirrorSymmetry::toMirror().

operator=()

template<typename StorageType >

ArrayParam & Inkscape::LivePathEffect::ArrayParam< StorageType >::operator=

(

const ArrayParam< StorageType > &

)

param_getDefaultSVGValue()

template<typename StorageType >

Glib::ustring Inkscape::LivePathEffect::ArrayParam< StorageType >::param_getDefaultSVGValue ( ) const

inlineoverridevirtual

Implements Inkscape::LivePathEffect::Parameter.

Reimplemented in Inkscape::LivePathEffect::EnumArrayParam, and Inkscape::LivePathEffect::ScalarArrayParam.

Definition at line 80 of file array.h.

param_getSVGValue()

template<typename StorageType >

Glib::ustring Inkscape::LivePathEffect::ArrayParam< StorageType >::param_getSVGValue ( ) const

inlineoverridevirtual

Implements Inkscape::LivePathEffect::Parameter.

Definition at line 74 of file array.h.

References Inkscape::LivePathEffect::ArrayParam< StorageType >::_vector, Inkscape::SVGOStringStream::str(), and Inkscape::LivePathEffect::ArrayParam< StorageType >::writesvg().

param_newWidget()

template<typename StorageType >

Gtk::Widget * Inkscape::LivePathEffect::ArrayParam< StorageType >::param_newWidget ( )

inlineoverridevirtual

Implements Inkscape::LivePathEffect::Parameter.

Reimplemented in Inkscape::LivePathEffect::EnumArrayParam, Inkscape::LivePathEffect::NodeSatelliteArrayParam, Inkscape::LivePathEffect::PowerStrokePointArrayParam, Inkscape::LivePathEffect::SatelliteArrayParam, and Inkscape::LivePathEffect::ScalarArrayParam.

Definition at line 52 of file array.h.

param_readSVGValue()

template<typename StorageType >

bool Inkscape::LivePathEffect::ArrayParam< StorageType >::param_readSVGValue ( char const *const  strvalue )

inlineoverridevirtual

Implements Inkscape::LivePathEffect::Parameter.

Reimplemented in Inkscape::LivePathEffect::SatelliteArrayParam.

Definition at line 56 of file array.h.

References Inkscape::LivePathEffect::ArrayParam< StorageType >::_vector, and Inkscape::LivePathEffect::ArrayParam< StorageType >::readsvg().

Referenced by Inkscape::LivePathEffect::SatelliteArrayParam::param_readSVGValue().

param_set_and_write_new_value()

template<typename StorageType >

void Inkscape::LivePathEffect::ArrayParam< StorageType >::param_set_and_write_new_value ( std::vector< StorageType > const &  new_vector )

inline

Definition at line 92 of file array.h.

References Inkscape::LivePathEffect::Parameter::param_write_to_repr(), Inkscape::SVGOStringStream::str(), and Inkscape::LivePathEffect::ArrayParam< StorageType >::writesvg().

Referenced by Inkscape::UI::Tools::PencilTool::addPowerStrokePencil(), Inkscape::LivePathEffect::LPETaperStroke::doBeforeEffect(), Inkscape::LivePathEffect::LPEPowerStroke::doOnApply(), and Inkscape::LivePathEffect::PowerStrokePointArrayParamKnotHolderEntity::knot_click().

param_set_default()

template<typename StorageType >

void Inkscape::LivePathEffect::ArrayParam< StorageType >::param_set_default ( )

inlineoverridevirtual

Implements Inkscape::LivePathEffect::Parameter.

Reimplemented in Inkscape::LivePathEffect::EnumArrayParam, and Inkscape::LivePathEffect::ScalarArrayParam.

Definition at line 88 of file array.h.

References Inkscape::LivePathEffect::ArrayParam< StorageType >::_default_size, and Inkscape::LivePathEffect::ArrayParam< StorageType >::param_setValue().

param_setValue()

template<typename StorageType >

void Inkscape::LivePathEffect::ArrayParam< StorageType >::param_setValue ( std::vector< StorageType > const &  new_vector )

inline

Definition at line 84 of file array.h.

References Inkscape::LivePathEffect::ArrayParam< StorageType >::_vector.

Referenced by Inkscape::LivePathEffect::LPEKnot::doBeforeEffect(), and Inkscape::LivePathEffect::ArrayParam< StorageType >::param_set_default().

param_update_default()

template<typename StorageType >

void Inkscape::LivePathEffect::ArrayParam< StorageType >::param_update_default ( char const *  default_value )

inlineoverridevirtual

Implements Inkscape::LivePathEffect::Parameter.

Reimplemented in Inkscape::LivePathEffect::ScalarArrayParam.

Definition at line 72 of file array.h.

paramType()

template<typename StorageType >

ParamType Inkscape::LivePathEffect::ArrayParam< StorageType >::paramType ( ) const

inlineoverridevirtual

Implements Inkscape::LivePathEffect::Parameter.

Reimplemented in Inkscape::LivePathEffect::EnumArrayParam, Inkscape::LivePathEffect::NodeSatelliteArrayParam, Inkscape::LivePathEffect::PowerStrokePointArrayParam, Inkscape::LivePathEffect::SatelliteArrayParam, and Inkscape::LivePathEffect::ScalarArrayParam.

Definition at line 98 of file array.h.

References Inkscape::LivePathEffect::ARRAY.

readsvg() [1/7]

double Inkscape::LivePathEffect::ArrayParam< double >::readsvg ( char const *const  str )

protected

Definition at line 22 of file array.cpp.

References Geom::infinity(), and sp_svg_number_read_d().

readsvg() [2/7]

float Inkscape::LivePathEffect::ArrayParam< float >::readsvg ( char const *const  str )

protected

Definition at line 31 of file array.cpp.

References Geom::infinity(), and sp_svg_number_read_f().

readsvg() [3/7]

Glib::ustring Inkscape::LivePathEffect::ArrayParam< Glib::ustring >::readsvg ( char const *const  str )

protected

Definition at line 40 of file array.cpp.

readsvg() [4/7]

Geom::Point Inkscape::LivePathEffect::ArrayParam< Geom::Point >::readsvg ( char const *const  str )

protected

Definition at line 50 of file array.cpp.

References Geom::infinity(), and sp_svg_number_read_d().

readsvg() [5/7]

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

protected

Definition at line 65 of file array.cpp.

readsvg() [6/7]

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

protected

Definition at line 91 of file array.cpp.

References NodeSatellite::setNodeSatellitesType(), sp_svg_number_read_d(), and sp_svg_number_read_f().

readsvg() [7/7]

template<typename StorageType >

StorageType Inkscape::LivePathEffect::ArrayParam< StorageType >::readsvg ( char const *  str )

protected

Referenced by Inkscape::LivePathEffect::ArrayParam< StorageType >::param_readSVGValue().

valid_index()

template<typename StorageType >

bool Inkscape::LivePathEffect::ArrayParam< StorageType >::valid_index ( int  index ) const

inline

Definition at line 99 of file array.h.

References Inkscape::LivePathEffect::ArrayParam< StorageType >::_vector, and index.

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

writesvg()

template<typename StorageType >

void Inkscape::LivePathEffect::ArrayParam< StorageType >::writesvg ( SVGOStringStream &  str, std::vector< StorageType > const &  vector  ) const

inlineprotected

Definition at line 107 of file array.h.

References Inkscape::LivePathEffect::ArrayParam< StorageType >::writesvgData().

Referenced by Inkscape::LivePathEffect::ArrayParam< StorageType >::param_getSVGValue(), and Inkscape::LivePathEffect::ArrayParam< StorageType >::param_set_and_write_new_value().

writesvgData() [1/6]

template<typename StorageType >

void Inkscape::LivePathEffect::ArrayParam< StorageType >::writesvgData ( SVGOStringStream &  str, double const &  vector_data  ) const

inlineprotected

Definition at line 121 of file array.h.

writesvgData() [2/6]

template<typename StorageType >

void Inkscape::LivePathEffect::ArrayParam< StorageType >::writesvgData ( SVGOStringStream &  str, float const &  vector_data  ) const

inlineprotected

Definition at line 117 of file array.h.

Referenced by Inkscape::LivePathEffect::ArrayParam< StorageType >::writesvg().

writesvgData() [3/6]

template<typename StorageType >

void Inkscape::LivePathEffect::ArrayParam< StorageType >::writesvgData ( SVGOStringStream &  str, Geom::Point const &  vector_data  ) const

inlineprotected

Definition at line 129 of file array.h.

writesvgData() [4/6]

template<typename StorageType >

void Inkscape::LivePathEffect::ArrayParam< StorageType >::writesvgData ( SVGOStringStream &  str, Glib::ustring const &  vector_data  ) const

inlineprotected

Definition at line 125 of file array.h.

writesvgData() [5/6]

template<typename StorageType >

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

inlineprotected

Definition at line 133 of file array.h.

References Inkscape::SVGOStringStream::str().

writesvgData() [6/6]

template<typename StorageType >

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

inlineprotected

Definition at line 144 of file array.h.

Friends And Related Symbol Documentation

TpS::KnotHolderEntityAttachBegin

template<typename StorageType >

friend class TpS::KnotHolderEntityAttachBegin

friend

Definition at line 102 of file array.h.

TpS::KnotHolderEntityAttachEnd

template<typename StorageType >

friend class TpS::KnotHolderEntityAttachEnd

friend

Definition at line 103 of file array.h.

Member Data Documentation

_default_size

template<typename StorageType >

std::size_t Inkscape::LivePathEffect::ArrayParam< StorageType >::_default_size

protected

Definition at line 105 of file array.h.

Referenced by Inkscape::LivePathEffect::ArrayParam< StorageType >::param_set_default().

_vector

template<typename StorageType >

std::vector<StorageType> Inkscape::LivePathEffect::ArrayParam< StorageType >::_vector

protected

Definition at line 104 of file array.h.

Referenced by Inkscape::LivePathEffect::LPETaperStroke::addKnotHolderEntities(), Inkscape::LivePathEffect::ArrayParam< StorageType >::data(), Inkscape::LivePathEffect::LPETaperStroke::doBeforeEffect(), Inkscape::LivePathEffect::FilletChamferKnotHolderEntity::knot_click(), Inkscape::LivePathEffect::PowerStrokePointArrayParamKnotHolderEntity::knot_click(), Inkscape::LivePathEffect::FilletChamferKnotHolderEntity::knot_get(), Inkscape::LivePathEffect::FilletChamferKnotHolderEntity::knot_set(), Inkscape::LivePathEffect::PowerStrokePointArrayParamKnotHolderEntity::knot_set(), Inkscape::LivePathEffect::PowerStrokePointArrayParamKnotHolderEntity::knot_set_offset(), Inkscape::LivePathEffect::FilletChamferKnotHolderEntity::knot_set_offset(), Inkscape::LivePathEffect::ArrayParam< StorageType >::param_getSVGValue(), Inkscape::LivePathEffect::ArrayParam< StorageType >::param_readSVGValue(), Inkscape::LivePathEffect::ArrayParam< StorageType >::param_setValue(), Inkscape::LivePathEffect::ArrayParam< StorageType >::valid_index(), Inkscape::LivePathEffect::FilletChamferKnotHolderEntity::valid_index(), and Inkscape::LivePathEffect::PowerStrokePointArrayParamKnotHolderEntity::valid_index().

---

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

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