Inkscape
Vector Graphics Editor
Loading...
Searching...
No Matches
Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
Inkscape::LivePathEffect::VectorParam Class Reference

#include <vector.h>

Inheritance diagram for Inkscape::LivePathEffect::VectorParam:
Inkscape::LivePathEffect::Parameter

Public Member Functions

 VectorParam (const Glib::ustring &label, const Glib::ustring &tip, const Glib::ustring &key, Inkscape::UI::Widget::Registry *wr, Effect *effect, Geom::Point default_vector=Geom::Point(1, 0))
 
 ~VectorParam () override
 
Gtk::Widget * param_newWidget () override
 
const gchar * handleTip () const
 
bool param_readSVGValue (const gchar *strvalue) override
 
Glib::ustring param_getSVGValue () const override
 
Glib::ustring param_getDefaultSVGValue () const override
 
Geom::Point getVector () const
 
Geom::Point getOrigin () const
 
void setValues (Geom::Point const &new_origin, Geom::Point const &new_vector)
 
void setVector (Geom::Point const &new_vector)
 
void setOrigin (Geom::Point const &new_origin)
 
void param_set_default () override
 
void set_and_write_new_values (Geom::Point const &new_origin, Geom::Point const &new_vector)
 
void param_transform_multiply (Geom::Affine const &postmul, bool set) override
 
void set_vector_oncanvas_looks (CanvasItemCtrlShape shape, uint32_t color)
 
void set_origin_oncanvas_looks (CanvasItemCtrlShape shape, uint32_t color)
 
void set_oncanvas_color (guint32 color)
 
void param_update_default (Geom::Point default_point)
 
void param_update_default (const gchar *default_point) override
 
bool providesKnotHolderEntities () const override
 
void addKnotHolderEntities (KnotHolder *knotholder, SPItem *item) override
 
ParamType paramType () const override
 
- 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 bool param_readSVGValue (char const *strvalue)=0
 
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
 
virtual void param_update_default (char const *default_value)=0
 
Glib::ustring const * param_getTooltip () const
 
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 ()
 

Private Member Functions

 VectorParam (const VectorParam &)=delete
 
VectorParam & operator= (const VectorParam &)=delete
 

Private Attributes

Geom::Point defvalue
 
Geom::Point origin
 
Geom::Point vector
 
Inkscape::CanvasItemCtrlShape vec_knot_shape = Inkscape::CANVAS_ITEM_CTRL_SHAPE_DIAMOND
 The looks of the vector and origin knots oncanvas.
 
uint32_t vec_knot_color = 0xffffb500
 
Inkscape::CanvasItemCtrlShape ori_knot_shape = Inkscape::CANVAS_ITEM_CTRL_SHAPE_CIRCLE
 
uint32_t ori_knot_color = 0xffffb500
 

Friends

class VectorParamKnotHolderEntity_Origin
 
class VectorParamKnotHolderEntity_Vector
 

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)
 
- Protected Attributes inherited from Inkscape::LivePathEffect::Parameter
bool _updating = false
 
Inkscape::Display::TemporaryItem * ownerlocator = nullptr
 
Effect * param_effect
 

Detailed Description

Definition at line 24 of file vector.h.

Constructor & Destructor Documentation

◆ VectorParam() [1/2]

Inkscape::LivePathEffect::VectorParam::VectorParam ( const Glib::ustring &  label,
const Glib::ustring &  tip,
const Glib::ustring &  key,
Inkscape::UI::Widget::Registry *  wr,
Effect *  effect,
Geom::Point  default_vector = Geom::Point(1,0) 
)

Definition at line 25 of file vector.cpp.

◆ ~VectorParam()

Inkscape::LivePathEffect::VectorParam::~VectorParam ( )
overridedefault

◆ VectorParam() [2/2]

Inkscape::LivePathEffect::VectorParam::VectorParam ( const VectorParam &  )
privatedelete

Member Function Documentation

◆ addKnotHolderEntities()

void Inkscape::LivePathEffect::VectorParam::addKnotHolderEntities ( KnotHolder *  knotholder,
SPItem *  item 
)
overridevirtual

Reimplemented from Inkscape::LivePathEffect::Parameter.

Definition at line 208 of file vector.cpp.

References KnotHolder::add(), Inkscape::CANVAS_ITEM_CTRL_TYPE_LPE, handleTip(), item, ori_knot_color, vec_knot_color, VectorParamKnotHolderEntity_Origin, and VectorParamKnotHolderEntity_Vector.

◆ getOrigin()

Geom::Point Inkscape::LivePathEffect::VectorParam::getOrigin ( ) const
inline

Definition at line 42 of file vector.h.

References origin.

Referenced by Inkscape::LivePathEffect::LPEAttachPath::doEffect(), Inkscape::LivePathEffect::LPERoughHatches::doEffect_pwd2(), Inkscape::LivePathEffect::LPEAttachPath::LPEAttachPath(), and Inkscape::LivePathEffect::LPEAttachPath::resetDefaults().

◆ getVector()

Geom::Point Inkscape::LivePathEffect::VectorParam::getVector ( ) const
inline

Definition at line 41 of file vector.h.

References vector.

Referenced by Inkscape::LivePathEffect::LPEAttachPath::doEffect(), Inkscape::LivePathEffect::LPEExtrude::doEffect_pwd2(), and Inkscape::LivePathEffect::LPERoughHatches::doEffect_pwd2().

◆ handleTip()

const gchar * Inkscape::LivePathEffect::VectorParam::handleTip ( ) const
inline

Definition at line 35 of file vector.h.

References Inkscape::LivePathEffect::Parameter::param_tooltip.

Referenced by addKnotHolderEntities().

◆ operator=()

VectorParam & Inkscape::LivePathEffect::VectorParam::operator= ( const VectorParam &  )
privatedelete

◆ param_getDefaultSVGValue()

Glib::ustring Inkscape::LivePathEffect::VectorParam::param_getDefaultSVGValue ( ) const
overridevirtual

Implements Inkscape::LivePathEffect::Parameter.

Definition at line 97 of file vector.cpp.

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

◆ param_getSVGValue()

Glib::ustring Inkscape::LivePathEffect::VectorParam::param_getSVGValue ( ) const
overridevirtual

Implements Inkscape::LivePathEffect::Parameter.

Definition at line 89 of file vector.cpp.

References origin, Inkscape::SVGOStringStream::str(), and vector.

Referenced by set_and_write_new_values().

◆ param_newWidget()

Gtk::Widget * Inkscape::LivePathEffect::VectorParam::param_newWidget ( )
overridevirtual

Implements Inkscape::LivePathEffect::Parameter.

Definition at line 105 of file vector.cpp.

References Inkscape::LivePathEffect::Effect::getRepr(), Inkscape::LivePathEffect::Effect::getSPDoc(), origin, Inkscape::UI::pack_start(), 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, and vector.

◆ param_readSVGValue()

bool Inkscape::LivePathEffect::VectorParam::param_readSVGValue ( const gchar *  strvalue)
override

Definition at line 64 of file vector.cpp.

References setOrigin(), setVector(), and sp_svg_number_read_d().

◆ param_set_default()

void Inkscape::LivePathEffect::VectorParam::param_set_default ( )
overridevirtual

Implements Inkscape::LivePathEffect::Parameter.

Definition at line 38 of file vector.cpp.

References defvalue, setOrigin(), and setVector().

◆ param_transform_multiply()

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

Reimplemented from Inkscape::LivePathEffect::Parameter.

Definition at line 131 of file vector.cpp.

References origin, set_and_write_new_values(), vector, and Geom::Affine::withoutTranslation().

◆ param_update_default() [1/2]

void Inkscape::LivePathEffect::VectorParam::param_update_default ( const gchar *  default_point)
override

Definition at line 51 of file vector.cpp.

References param_update_default(), and sp_svg_number_read_d().

◆ param_update_default() [2/2]

void Inkscape::LivePathEffect::VectorParam::param_update_default ( Geom::Point  default_point)

Definition at line 45 of file vector.cpp.

References defvalue.

Referenced by param_update_default().

◆ paramType()

ParamType Inkscape::LivePathEffect::VectorParam::paramType ( ) const
inlineoverridevirtual

Implements Inkscape::LivePathEffect::Parameter.

Definition at line 59 of file vector.h.

References Inkscape::LivePathEffect::VECTOR.

◆ providesKnotHolderEntities()

bool Inkscape::LivePathEffect::VectorParam::providesKnotHolderEntities ( ) const
inlineoverridevirtual

Reimplemented from Inkscape::LivePathEffect::Parameter.

Definition at line 57 of file vector.h.

◆ set_and_write_new_values()

void Inkscape::LivePathEffect::VectorParam::set_and_write_new_values ( Geom::Point const &  new_origin,
Geom::Point const &  new_vector 
)

Definition at line 124 of file vector.cpp.

References param_getSVGValue(), Inkscape::LivePathEffect::Parameter::param_write_to_repr(), and setValues().

Referenced by param_transform_multiply(), Inkscape::LivePathEffect::LPEExtrude::resetDefaults(), and Inkscape::LivePathEffect::LPERoughHatches::resetDefaults().

◆ set_oncanvas_color()

void Inkscape::LivePathEffect::VectorParam::set_oncanvas_color ( guint32  color)

Definition at line 148 of file vector.cpp.

References ori_knot_color, and vec_knot_color.

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

◆ set_origin_oncanvas_looks()

void Inkscape::LivePathEffect::VectorParam::set_origin_oncanvas_looks ( CanvasItemCtrlShape  shape,
uint32_t  color 
)

Definition at line 142 of file vector.cpp.

References ori_knot_color, and ori_knot_shape.

◆ set_vector_oncanvas_looks()

void Inkscape::LivePathEffect::VectorParam::set_vector_oncanvas_looks ( CanvasItemCtrlShape  shape,
uint32_t  color 
)

Definition at line 136 of file vector.cpp.

References vec_knot_color, and vec_knot_shape.

◆ setOrigin()

void Inkscape::LivePathEffect::VectorParam::setOrigin ( Geom::Point const &  new_origin)
inline

Definition at line 45 of file vector.h.

References origin.

Referenced by Inkscape::LivePathEffect::LPEAttachPath::doEffect(), param_readSVGValue(), param_set_default(), and setValues().

◆ setValues()

void Inkscape::LivePathEffect::VectorParam::setValues ( Geom::Point const &  new_origin,
Geom::Point const &  new_vector 
)
inline

Definition at line 43 of file vector.h.

References setOrigin(), and setVector().

Referenced by set_and_write_new_values().

◆ setVector()

void Inkscape::LivePathEffect::VectorParam::setVector ( Geom::Point const &  new_vector)
inline

Definition at line 44 of file vector.h.

References vector.

Referenced by param_readSVGValue(), param_set_default(), and setValues().

Friends And Related Symbol Documentation

◆ VectorParamKnotHolderEntity_Origin

friend class VectorParamKnotHolderEntity_Origin
friend

Definition at line 75 of file vector.h.

Referenced by addKnotHolderEntities().

◆ VectorParamKnotHolderEntity_Vector

friend class VectorParamKnotHolderEntity_Vector
friend

Definition at line 76 of file vector.h.

Referenced by addKnotHolderEntities().

Member Data Documentation

◆ defvalue

Geom::Point Inkscape::LivePathEffect::VectorParam::defvalue
private

Definition at line 64 of file vector.h.

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

◆ ori_knot_color

uint32_t Inkscape::LivePathEffect::VectorParam::ori_knot_color = 0xffffb500
private

Definition at line 73 of file vector.h.

Referenced by addKnotHolderEntities(), set_oncanvas_color(), and set_origin_oncanvas_looks().

◆ ori_knot_shape

Inkscape::CanvasItemCtrlShape Inkscape::LivePathEffect::VectorParam::ori_knot_shape = Inkscape::CANVAS_ITEM_CTRL_SHAPE_CIRCLE
private

Definition at line 72 of file vector.h.

Referenced by set_origin_oncanvas_looks().

◆ origin

Geom::Point Inkscape::LivePathEffect::VectorParam::origin
private

Definition at line 66 of file vector.h.

Referenced by getOrigin(), param_getSVGValue(), param_newWidget(), param_transform_multiply(), and setOrigin().

◆ vec_knot_color

uint32_t Inkscape::LivePathEffect::VectorParam::vec_knot_color = 0xffffb500
private

Definition at line 71 of file vector.h.

Referenced by addKnotHolderEntities(), set_oncanvas_color(), and set_vector_oncanvas_looks().

◆ vec_knot_shape

Inkscape::CanvasItemCtrlShape Inkscape::LivePathEffect::VectorParam::vec_knot_shape = Inkscape::CANVAS_ITEM_CTRL_SHAPE_DIAMOND
private

The looks of the vector and origin knots oncanvas.

Definition at line 70 of file vector.h.

Referenced by set_vector_oncanvas_looks().

◆ vector

Geom::Point Inkscape::LivePathEffect::VectorParam::vector
private

Definition at line 67 of file vector.h.

Referenced by getVector(), param_getSVGValue(), param_newWidget(), param_transform_multiply(), and setVector().

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