Inkscape
Vector Graphics Editor
Loading...
Searching...
No Matches
Inkscape::LivePathEffect::LPERoughen Class Reference

#include <lpe-roughen.h>

Inheritance diagram for Inkscape::LivePathEffect::LPERoughen:
Inkscape::LivePathEffect::Effect

Public Member Functions

 LPERoughen (LivePathEffectObject *lpeobject)
 
 ~LPERoughen () override
 
void doOnApply (SPLPEItem const *lpeitem) override
 Is performed a single time when the effect is freshly applied to a path.
 
void doEffect (Geom::PathVector &curve) override
 
virtual double sign (double randNumber)
 
virtual Geom::Point randomize (double max_length, bool is_node=false)
 
void doBeforeEffect (SPLPEItem const *lpeitem) override
 Is performed each time before the effect is updated.
 
virtual Geom::Point tPoint (Geom::Point A, Geom::Point B, double t=0.5)
 
Gtk::Widget * newWidget () override
 This creates a managed widget.
 
- Public Member Functions inherited from Inkscape::LivePathEffect::Effect
virtual ~Effect ()
 
 Effect (const Effect &)=delete
 
Effectoperator= (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
 
SPShapegetCurrentShape () 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 void resetDefaults (SPItem const *item)
 Sets all parameters to their default values and writes them to SVG.
 
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::PathVectorgetCanvasIndicators (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::NodegetRepr ()
 
SPDocumentgetSPDoc ()
 
LivePathEffectObjectgetLPEObj ()
 
LivePathEffectObject const * getLPEObj () const
 
ParametergetParameter (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

Geom::Path addNodesAndJitter (Geom::Curve const &A, Geom::Point &prev, Geom::Point &last_move, double t, bool last)
 
Geom::Path jitter (Geom::Curve const &A, Geom::Point &prev, Geom::Point &last_move)
 
 LPERoughen (const LPERoughen &)=delete
 
LPERoughenoperator= (const LPERoughen &)=delete
 

Private Attributes

EnumParam< DivisionMethodmethod
 
ScalarParam max_segment_size
 
ScalarParam segments
 
RandomParam displace_x
 
RandomParam displace_y
 
RandomParam global_randomize
 
EnumParam< HandlesMethodhandles
 
BoolParam shift_nodes
 
BoolParam fixed_displacement
 
BoolParam spray_tool_friendly
 
long seed
 

Additional Inherited Members

- Static Public Member Functions inherited from Inkscape::LivePathEffect::Effect
static EffectNew (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
 
SPLPEItemsp_lpe_item = nullptr
 
SPShapecurrent_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)
 
ParametergetNextOncanvasEditableParam ()
 
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::PointselectedNodesPoints
 
Inkscape::UI::Widget::Registry wr
 

Detailed Description

Definition at line 42 of file lpe-roughen.h.

Constructor & Destructor Documentation

◆ LPERoughen() [1/2]

◆ ~LPERoughen()

Inkscape::LivePathEffect::LPERoughen::~LPERoughen ( )
overridedefault

◆ LPERoughen() [2/2]

Inkscape::LivePathEffect::LPERoughen::LPERoughen ( const LPERoughen )
privatedelete

Member Function Documentation

◆ addNodesAndJitter()

◆ doBeforeEffect()

◆ doEffect()

◆ doOnApply()

◆ jitter()

◆ newWidget()

Gtk::Widget * Inkscape::LivePathEffect::LPERoughen::newWidget ( )
overridevirtual

◆ operator=()

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

◆ randomize()

Geom::Point Inkscape::LivePathEffect::LPERoughen::randomize ( double  max_length,
bool  is_node = false 
)
virtual

◆ sign()

double Inkscape::LivePathEffect::LPERoughen::sign ( double  randNumber)
virtual

◆ tPoint()

Geom::Point Inkscape::LivePathEffect::LPERoughen::tPoint ( Geom::Point  A,
Geom::Point  B,
double  t = 0.5 
)
virtual

Definition at line 534 of file lpe-roughen.cpp.

References Geom::X, and Geom::Y.

Member Data Documentation

◆ displace_x

RandomParam Inkscape::LivePathEffect::LPERoughen::displace_x
private

Definition at line 64 of file lpe-roughen.h.

Referenced by doBeforeEffect(), LPERoughen(), and randomize().

◆ displace_y

RandomParam Inkscape::LivePathEffect::LPERoughen::displace_y
private

Definition at line 65 of file lpe-roughen.h.

Referenced by doBeforeEffect(), LPERoughen(), and randomize().

◆ fixed_displacement

BoolParam Inkscape::LivePathEffect::LPERoughen::fixed_displacement
private

Definition at line 69 of file lpe-roughen.h.

Referenced by addNodesAndJitter(), LPERoughen(), and randomize().

◆ global_randomize

RandomParam Inkscape::LivePathEffect::LPERoughen::global_randomize
private

Definition at line 66 of file lpe-roughen.h.

Referenced by doBeforeEffect(), LPERoughen(), and randomize().

◆ handles

EnumParam<HandlesMethod> Inkscape::LivePathEffect::LPERoughen::handles
private

Definition at line 67 of file lpe-roughen.h.

Referenced by addNodesAndJitter(), doEffect(), jitter(), and LPERoughen().

◆ max_segment_size

ScalarParam Inkscape::LivePathEffect::LPERoughen::max_segment_size
private

Definition at line 62 of file lpe-roughen.h.

Referenced by doEffect(), and LPERoughen().

◆ method

EnumParam<DivisionMethod> Inkscape::LivePathEffect::LPERoughen::method
private

Definition at line 61 of file lpe-roughen.h.

Referenced by doEffect(), and LPERoughen().

◆ seed

long Inkscape::LivePathEffect::LPERoughen::seed
private

Definition at line 71 of file lpe-roughen.h.

Referenced by doBeforeEffect(), and LPERoughen().

◆ segments

ScalarParam Inkscape::LivePathEffect::LPERoughen::segments
private

Definition at line 63 of file lpe-roughen.h.

Referenced by doEffect(), and LPERoughen().

◆ shift_nodes

BoolParam Inkscape::LivePathEffect::LPERoughen::shift_nodes
private

Definition at line 68 of file lpe-roughen.h.

Referenced by addNodesAndJitter(), jitter(), and LPERoughen().

◆ spray_tool_friendly

BoolParam Inkscape::LivePathEffect::LPERoughen::spray_tool_friendly
private

Definition at line 70 of file lpe-roughen.h.

Referenced by doBeforeEffect(), and LPERoughen().


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