Detailed Description

Represents a polygonal curve.

Used when constructing curves from input data. Has methods for assembling and modifying the curve point by point.

This class appears in the JavaScript interface, so many methods are exposed as Qt slots. All methods marked as Q_INVOKABLE can be referred to from JavaScript. All methods return 'this' as result, allowing for a fluent API.

See also: https://bitbucket.org/hrimfaxi/c-development/wiki/ScriptFiles.md

Note that this class has to live in the global namespace, rather than in the frechet::input namespace.

Author: Peter Schäfer

Definition at line 30 of file path.h.

#include <path.h>

Inherits QObject.

Public Slots
int	size () const

Path *	appendPath (Path *that)
	appends a copy of another Path More...

Path *	appendString (QString svg)
	appends a copy of an SVG path More...

Path *	M (QPointF p)
	append a new vertex at an absolute position More...

Path *	M (double x, double y)
	append a new vertex at an absolute position More...

Path *	H (double h)
	horizontal move to an absolute position More...

Path *	V (double v)
	vertical move to an absolute position More...

Path *	close ()
	return to the first vertex, creating a closed curve More...

Path *	Z ()
	return to the first vertex, creating a closed curve More...

Path *	undo ()
	remove the last vertex More...

Path *	ensureClosed ()
	make sure the curve is closed More...

Path *	m (QPointF p)
	append a new vertex, relative to the current position More...

Path *	m (double x, double y)
	append a new vertex, relative to the current position More...

Path *	h (double h)
	horizontal move, relative to the current position More...

Path *	v (double v)
	vertical move, relative to the current position More...

Path *	polar (double angle, double distance)
	append a new vertex, given by polar coordinates More...

Path *	map (QTransform tf)
	apply a transformation to all vertexes More...

Path *	map (QMatrix mx)
	apply a transformation to all vertexes More...

Path *	scale (double scale)
	scale the polygonal curve More...

Path *	scale (double scalex, double scaley)
	scale the polygonal curve More...

Path *	rotate (double angle)
	rotate the curve More...

Path *	translate (QPointF offset)
	translate the curve More...

Path *	translate (double dx, double dy)
	translate the curve More...

Path *	mirrorx ()
	mirror the curve about the x-axis More...

Path *	mirrory ()
	mirror the curve about the y-axis More...

Path *	revert ()
	revert the order of vertexes More...

Path *	left (double angle)
	turn the turtle's head to the left More...

Path *	right (double angle)
	turn the turtle's head to the right More...

Path *	reset (double angle=0.0)
	turn the turtle's head to a given angle More...

Path *	forward (double distance)
	append a new vertex, relative to the current position More...

void	lineStyle (int)
	change the style of grid lines More...

void	setDefaultLineStyle (int)
	change the default style of grid lines More...

void	outerLineStyle (int)
	set the style of outermost grid lines More...

Public Member Functions
Q_INVOKABLE	Path (QObject *parent=0)
	default constructor More...

Q_INVOKABLE	Path (const Path &that)
	copy constructor More...

Q_INVOKABLE	Path (const Path *that)
	copy constructor More...

Q_INVOKABLE	Path (QString svg, bool forceAbsolute=false, QObject *parent=0)
	constructor from SVG input string More...

const QPolygonF &	toCurve (int precision=0)
	convert to a QPolygonF object, ready for processing by the Frechet distance algorithms More...

Q_INVOKABLE Path &	operator= (const Path &that)
	assignment operator More...

Q_INVOKABLE Path &	operator+= (const Path &that)
	append operator More...

Q_INVOKABLE Path &	operator+= (QString svg)
	append operator with SVG input string More...

void	parseSvg (QString str, bool forceAbsolute=false)
	parse an SVG input string More...

void	parseIpe (QString str)
	pare an IPE input string More...

LineStyle	getDefaultLineStyle () const

const LineStyleVector &	getLineStyles () const

Static Public Member Functions
static Path	svgPath (QString str, bool forceAbsolute=false)
	static constructor from SVG input string More...

static Path	ipePath (QString str)
	static constructor from IPE input string More...

Private Member Functions
void	append (QPointF p, char opcode)

void	absolutize ()
	replace all relative movements by absolute positions More...

void	setPrecision (int precision)
	set the numerical precision for input data (default is unlimited) More...

void	removeDuplicates ()
	remove all duplicate points More...

Private Attributes
QPolygonF	points
	the list of vertexes More...

std::string	opcode
	used during assembly of a path: the next "move" operation More...

double	turtle_angle
	turtle_angle current direction of the turtle More...

LineStyle	defaultLineStyle
	default style for grid disaplay More...

LineStyleVector	lineStyles
	line styles for grid disaplay More...

Constructor & Destructor Documentation

◆ Path() [1/4]

Path::Path ( QObject * parent = 0 )

default constructor

Parameters

parent owning QObject, optional

Definition at line 7 of file path.cpp.

◆ Path() [2/4]

Path::Path ( const Path & that )

copy constructor

Parameters

that	object to copy from

Definition at line 15 of file path.cpp.

◆ Path() [3/4]

Path::Path ( const Path * that )

copy constructor

Parameters

that	object to copy from

Definition at line 23 of file path.cpp.

◆ Path() [4/4]

Path::Path	(	QString	svg,
		bool	forceAbsolute = `false`,
		QObject *	parent = `0`
	)

constructor from SVG input string

Parameters

svg	an svg-encoded polygonal path
forceAbsolute	assume all commands are absolute movements (no relative movements)
parent	owning QObject, optional

See also: SVG specification https://www.w3.org/TR/SVG/paths.html

Definition at line 27 of file path.cpp.

Member Function Documentation

◆ absolutize()

void Path::absolutize ( )

private

replace all relative movements by absolute positions

Definition at line 364 of file path.cpp.

◆ append()

void Path::append	(	QPointF	p,
		char	opcode
	)

private

append a point to the curve

Parameters

p	new point
opcode	path operation (move etc.)

Definition at line 354 of file path.cpp.

◆ appendPath

Path* Path::appendPath ( Path * that )

inlineslot

appends a copy of another Path

Parameters

that	object to copy from

Returns: this object, after appending a copy of the input

Definition at line 147 of file path.h.

◆ appendString

Path* Path::appendString ( QString svg )

inlineslot

appends a copy of an SVG path

Parameters

svg

See also: SVG specification https://www.w3.org/TR/SVG/paths.html

Returns: this object, after appending a copy of the input

Definition at line 154 of file path.h.

◆ close

Path * Path::close ( )

slot

return to the first vertex, creating a closed curve

Returns: this object, after appending one more vertex

Definition at line 90 of file path.cpp.

◆ ensureClosed

Path * Path::ensureClosed ( )

slot

make sure the curve is closed

Returns: this object, appending one more vertex, if necessary

Definition at line 108 of file path.cpp.

◆ forward

Path * Path::forward ( double distance )

slot

append a new vertex, relative to the current position

Parameters

distance distance to move

Returns: this object, after appending a new vertex

Definition at line 207 of file path.cpp.

◆ getDefaultLineStyle()

LineStyle Path::getDefaultLineStyle ( ) const

inline

Returns: current default grid line style

Definition at line 361 of file path.h.

◆ getLineStyles()

const LineStyleVector& Path::getLineStyles ( ) const

inline

Returns: line styles for drawing the grid

Definition at line 363 of file path.h.

◆ H

Path* Path::H ( double h )

inlineslot

horizontal move to an absolute position

Parameters

h	x-coordinate of next vertex

Returns: this object, after appending one more vertex

Definition at line 178 of file path.h.

◆ h

Path* Path::h ( double h )

inlineslot

horizontal move, relative to the current position

Parameters

h	horizontal offset

Returns: this object, after appending one more vertex

Definition at line 228 of file path.h.

◆ ipePath()

Path Path::ipePath ( QString str )

static

static constructor from IPE input string

Parameters

str	an IPE-encoded polygonal curve

Returns: a Path object, constructed from IPE input

Definition at line 40 of file path.cpp.

◆ left

Path * Path::left ( double angle )

slot

turn the turtle's head to the left

Parameters

angle in degrees

Returns: this object

Definition at line 192 of file path.cpp.

◆ lineStyle

void Path::lineStyle ( int style )

slot

change the style of grid lines

See also: LineStyle

Definition at line 218 of file path.cpp.

◆ M [1/2]

Path* Path::M ( QPointF p )

inlineslot

append a new vertex at an absolute position

Parameters

p	next vertex

Returns: this object, after appending one more vertex

Definition at line 165 of file path.h.

◆ M [2/2]

Path* Path::M	(	double	x,
		double	y
	)

inlineslot

append a new vertex at an absolute position

Parameters

x	x-coordinate of next vertex
y	y-coordinate of next vertex

Returns: this object, after appending one more vertex

Definition at line 172 of file path.h.

◆ m [1/2]

Path* Path::m ( QPointF p )

inlineslot

append a new vertex, relative to the current position

Parameters

p	offset to next vertex

Returns: this object, after appending one more vertex

Definition at line 215 of file path.h.

◆ m [2/2]

Path* Path::m	(	double	x,
		double	y
	)

inlineslot

append a new vertex, relative to the current position

Parameters

x	x-offset to next vertex
y	y-offset to next vertex

Returns: this object, after appending one more vertex

Definition at line 222 of file path.h.

◆ map [1/2]

Path * Path::map ( QTransform tf )

slot

apply a transformation to all vertexes

Parameters

tf	an affine transformation

Returns: this object, after applying the transformation

Definition at line 121 of file path.cpp.

◆ map [2/2]

Path * Path::map ( QMatrix mx )

slot

apply a transformation to all vertexes

Parameters

mx	an affine transformation

Returns: this object, after applying the transformation

Definition at line 127 of file path.cpp.

◆ mirrorx

Path * Path::mirrorx ( )

slot

mirror the curve about the x-axis

Returns: this object, after applying the mirror transformation

Definition at line 157 of file path.cpp.

◆ mirrory

Path * Path::mirrory ( )

slot

mirror the curve about the y-axis

Returns: this object, after applying the mirror transformation

Definition at line 162 of file path.cpp.

◆ operator+=() [1/2]

Path & Path::operator+= ( const Path & that )

append operator

Parameters

that	object to copy from

Returns: this object, after appending a copy of the input

Definition at line 66 of file path.cpp.

◆ operator+=() [2/2]

Path & Path::operator+= ( QString svg )

append operator with SVG input string

Parameters

svg	an svg-encoded polygonal path

See also: SVG specification https://www.w3.org/TR/SVG/paths.html

Returns: this object, after appending a copy of the input

Definition at line 85 of file path.cpp.

◆ operator=()

Path & Path::operator= ( const Path & that )

assignment operator

Parameters

that	object to copy from

Returns: this object, containing a copy of the input

Definition at line 57 of file path.cpp.

◆ outerLineStyle

void Path::outerLineStyle ( int style )

slot

set the style of outermost grid lines

See also: LineStyle

Definition at line 229 of file path.cpp.

◆ parseIpe()

void Path::parseIpe ( QString str )

pare an IPE input string

Definition at line 300 of file path.cpp.

◆ parseSvg()

void Path::parseSvg	(	QString	str,
		bool	forceAbsolute = `false`
	)

parse an SVG input string

Definition at line 236 of file path.cpp.

◆ polar

Path * Path::polar	(	double	angle,
		double	distance
	)

slot

append a new vertex, given by polar coordinates

Parameters

angle	direction of movement
distance	distance from current position

Returns: this object, after appending one more vertex

Definition at line 116 of file path.cpp.

◆ removeDuplicates()

void Path::removeDuplicates ( )

private

remove all duplicate points

Duplicates are not forbidden per se, but they are meaningless w.r.t. the Fréchet distance. Besides, duplicates create confusion in many polygon algorithms, so better remove them on input.

Definition at line 413 of file path.cpp.

◆ reset

Path * Path::reset ( double angle = 0.0 )

slot

turn the turtle's head to a given angle

Parameters

angle new direction

Returns: this object

Definition at line 202 of file path.cpp.

◆ revert

Path * Path::revert ( )

slot

revert the order of vertexes

Returns: this object, after reverting the order of vertexes

Definition at line 179 of file path.cpp.

◆ right

Path * Path::right ( double angle )

slot

turn the turtle's head to the right

Parameters

angle in degrees

Returns: this object

Definition at line 197 of file path.cpp.

◆ rotate

Path * Path::rotate ( double angle )

slot

rotate the curve

Parameters

angle rotation angle (in degrees)

Returns: this object, after applying the rotation

Definition at line 141 of file path.cpp.

◆ scale [1/2]

Path * Path::scale ( double scale )

slot

scale the polygonal curve

Parameters

scale scaling factor

Returns: this object, after applying the scaling

Definition at line 131 of file path.cpp.

◆ scale [2/2]

Path * Path::scale	(	double	scalex,
		double	scaley
	)

slot

scale the polygonal curve

Parameters

scalex	horizontal scaling factor
scaley	vertital scaling factor

Returns: this object, after applying the scaling

Definition at line 135 of file path.cpp.

◆ setDefaultLineStyle

void Path::setDefaultLineStyle ( int style )

slot

change the default style of grid lines

See also: LineStyle

Definition at line 211 of file path.cpp.

◆ setPrecision()

void Path::setPrecision ( int precision )

private

set the numerical precision for input data (default is unlimited)

Definition at line 398 of file path.cpp.

◆ size

int Path::size ( ) const

inlineslot

Returns: number of vertexes in the polygonal curve

Definition at line 136 of file path.h.

◆ svgPath()

Path Path::svgPath	(	QString	str,
		bool	forceAbsolute = `false`
	)

static

static constructor from SVG input string

Parameters

str	an svg-encoded polygonal path
forceAbsolute	assume all commands are absolute movements (no relative movements)

See also: SVG specification https://www.w3.org/TR/SVG/paths.html

Returns: a Path object, constructed from SVG input

Definition at line 33 of file path.cpp.

◆ toCurve()

const QPolygonF & Path::toCurve ( int precision = 0 )

convert to a QPolygonF object, ready for processing by the Frechet distance algorithms

Parameters

precision limit numerical precision (optional, default is most precise)

Returns: a polygonal curve with absolute vertex data

Definition at line 47 of file path.cpp.

◆ translate [1/2]

Path * Path::translate ( QPointF offset )

slot

translate the curve

Parameters

offset translation offset

Returns: this object, after applying the translation

Definition at line 147 of file path.cpp.

◆ translate [2/2]

Path * Path::translate	(	double	dx,
		double	dy
	)

slot

translate the curve

Parameters

dx	horizontal translation offset
dy	vertical translation offset

Returns: this object, after applying the translation

Definition at line 151 of file path.cpp.

◆ undo

Path * Path::undo ( )

slot

remove the last vertex

Returns: this object, after remove one vertex

Definition at line 100 of file path.cpp.

◆ V

Path* Path::V ( double v )

inlineslot

vertical move to an absolute position

Parameters

v	y-coordinate of next vertex

Returns: this object, after appending one more vertex

Definition at line 184 of file path.h.

◆ v

Path* Path::v ( double v )

inlineslot

vertical move, relative to the current position

Parameters

v	vertical offset

Returns: this object, after appending one more vertex

Definition at line 234 of file path.h.

◆ Z

Path * Path::Z ( )

slot

return to the first vertex, creating a closed curve

Returns: this object, after appending one more vertex

Definition at line 96 of file path.cpp.

Member Data Documentation

◆ defaultLineStyle

LineStyle Path::defaultLineStyle

private

default style for grid disaplay

See also: setDefaultLineStyle

Definition at line 42 of file path.h.

◆ lineStyles

LineStyleVector Path::lineStyles

private

line styles for grid disaplay

See also: lineStyle

Definition at line 45 of file path.h.

◆ opcode

std::string Path::opcode

private

used during assembly of a path: the next "move" operation

Definition at line 36 of file path.h.

◆ points

QPolygonF Path::points

private

the list of vertexes

Definition at line 34 of file path.h.

◆ turtle_angle

double Path::turtle_angle

private

turtle_angle current direction of the turtle

Definition at line 38 of file path.h.

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

include/frechet/input/path.h
src/frechet/input/path.cpp

Detailed Description

Public Slots

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Constructor & Destructor Documentation

◆ Path() [1/4]

◆ Path() [2/4]

◆ Path() [3/4]

◆ Path() [4/4]

Member Function Documentation

◆ absolutize()

◆ append()

◆ appendPath

◆ appendString

◆ close

◆ ensureClosed

◆ forward

◆ getDefaultLineStyle()

◆ getLineStyles()

◆ H

◆ h

◆ ipePath()

◆ left

◆ lineStyle

◆ M [1/2]

◆ M [2/2]

◆ m [1/2]

◆ m [2/2]

◆ map [1/2]

◆ map [2/2]

◆ mirrorx

◆ mirrory

◆ operator+=() [1/2]

◆ operator+=() [2/2]

◆ operator=()

◆ outerLineStyle

◆ parseIpe()

◆ parseSvg()

◆ polar

◆ removeDuplicates()

◆ reset

◆ revert

◆ right

◆ rotate

◆ scale [1/2]

◆ scale [2/2]

◆ setDefaultLineStyle

◆ setPrecision()

◆ size

◆ svgPath()

◆ toCurve()

◆ translate [1/2]

◆ translate [2/2]

◆ undo

◆ V

◆ v

◆ Z

Member Data Documentation

◆ defaultLineStyle

◆ lineStyles

◆ opcode

◆ points

◆ turtle_angle