gccv::Squiggle Class Reference

Squiggle line. More...

#include <squiggle.h>

Inheritance diagram for gccv::Squiggle:

Public Member Functions
	Squiggle (Canvas *canvas, double xstart, double ystart, double xend, double yend)
	Squiggle (Group *parent, double xstart, double ystart, double xend, double yend, ItemClient *client=NULL)
virtual	~Squiggle ()
void	SetPosition (double xstart, double ystart, double xend, double yend)
double	Distance (double x, double y, Item **item) const
void	Draw (cairo_t *cr, bool is_vector) const
void	Move (double x, double y)
void	SetWidth (double val)
double	GetWidth (void) const
void	SetStep (double val)
double	GetStep (void) const
Public Member Functions inherited from gccv::LineItem
	LineItem (Canvas *canvas)
	LineItem (Group *parent, ItemClient *client=NULL)
virtual	~LineItem ()
GOColor	GetEffectiveLineColor () const
void	ApplyLine (cairo_t *cr) const
void	SetDashes (double const *dashes, int num_dashes, double offset)
void	SetLineWidth (double val)
double	GetLineWidth (void) const
void	SetLineColor (GOColor val)
GOColor	GetLineColor (void) const
void	SetAutoColor (bool val)
bool	GetAutoColor (void) const
Public Member Functions inherited from gccv::Item
	Item (Canvas *canvas)
	Item (Group *parent, ItemClient *client=NULL)
virtual	~Item ()
void	GetBounds (double &x0, double &y0, double &x1, double &y1) const
void	Invalidate () const
void	SetVisible (bool visible)
virtual void	BuildPath (cairo_t *cr) const
virtual bool	Draw (cairo_t *cr, double x0, double y0, double x1, double y1, bool is_vector) const
bool	IsTopLevel () const
void	SetClient (ItemClient *val)
ItemClient *	GetClient (void)
Group const *	GetParent (void) const
bool	GetVisible (void) const
void	SetOperator (cairo_operator_t val)
cairo_operator_t	GetOperator (void) const

Protected Member Functions
void	UpdateBounds ()

Additional Inherited Members
Protected Attributes inherited from gccv::Item
double	m_x0
double	m_y0
double	m_x1
double	m_y1

Detailed Description

Squiggle line.

A Squiggle is a line oscillating periodically.

Definition at line 39 of file squiggle.h.

Constructor & Destructor Documentation

gccv::Squiggle::Squiggle	(	Canvas *	canvas,
		double	xstart,
		double	ystart,
		double	xend,
		double	yend
	)

Parameters

canvas	a Canvas.
xstart	the horizontal start position.
ystart	the vertical start position.
xend	the horizontal end position.
yend	the vertical end position.

Creates a new Squiggle sets it as a child of the root Group of canvas.

gccv::Squiggle::Squiggle	(	Group *	parent,
		double	xstart,
		double	ystart,
		double	xend,
		double	yend,
		ItemClient *	client = NULL
	)

Parameters

parent	the Group to which the new Squiggle will be added.
xstart	the horizontal start position.
ystart	the vertical start position.
xend	the horizontal end position.
yend	the vertical end position.
client	the ItemClient for the new Squiggle if any.

Creates a new Squiggle inside parent and sets client as its associated ItemClient.

virtual gccv::Squiggle::~Squiggle ( )

virtual

The destructor.

Member Function Documentation

double gccv::Squiggle::Distance ( double  x, double  y, Item **  item  ) const

virtual

Parameters

x	horizontal position
y	vertical position
item	where to store the Item.

Implementation of Item::Distance() for the Squiggle class. Sets item to this.

Reimplemented from gccv::Item.

void gccv::Squiggle::Draw ( cairo_t *  cr, bool  is_vector  ) const

virtual

Parameters

cr	a cairo_t.
is_vector	whether the cairo_t is a vectorial context.

Draws the Squiggle to cr.

Reimplemented from gccv::Item.

gccv::Squiggle::GetStep ( void  ) const

inline

Returns

the Squiggle line oscillations periodicity.

Definition at line 132 of file squiggle.h.

gccv::Squiggle::GetWidth ( void  ) const

inline

Returns

the Squiggle line oscillations amplitude.

Definition at line 123 of file squiggle.h.

void gccv::Squiggle::Move ( double  x, double  y  )

virtual

Parameters

x	the horizontal deplacement
y	the vertical deplacement

Moves the Squiggle.

Reimplemented from gccv::Item.

void gccv::Squiggle::SetPosition	(	double	xstart,
		double	ystart,
		double	xend,
		double	yend
	)

Parameters

xstart	the new horizontal start position.
ystart	the new vertical start position.
xend	the new horizontal end position.
yend	the new vertical end position.

Sets the Squiggle position.

gccv::Squiggle::SetStep ( double  step )

inline

Parameters

step	the periodicity.

Sets the Squiggle line oscillations periodicity.

Definition at line 132 of file squiggle.h.

gccv::Squiggle::SetWidth ( double  width )

inline

Parameters

width

the amplitude.

Sets the Squiggle line oscillations amplitude.

Definition at line 123 of file squiggle.h.

void gccv::Squiggle::UpdateBounds ( )

protectedvirtual

Evaluates the Squiggle bounds.

Reimplemented from gccv::Item.

---

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

• squiggle.h