#include <TTauri/Foundation/Path.hpp>

Public Member Functions
void	clear () noexcept
	Clear the path.

ssize_t	numberOfContours () const noexcept

ssize_t	numberOfLayers () const noexcept

bool	allLayersHaveSameColor () const noexcept

aarect	boundingBox () const noexcept
	Calculate bounding box.

void	tryRemoveLayers () noexcept

std::vector< BezierPoint >::const_iterator	beginContour (ssize_t contourNr) const noexcept

std::vector< BezierPoint >::const_iterator	endContour (ssize_t contourNr) const noexcept

ssize_t	beginLayer (ssize_t layerNr) const noexcept

ssize_t	endLayer (ssize_t layerNr) const noexcept

std::vector< BezierPoint >	getBezierPointsOfContour (ssize_t contourNr) const noexcept

std::vector< BezierCurve >	getBeziersOfContour (ssize_t contourNr) const noexcept

std::vector< BezierCurve >	getBeziers () const noexcept

std::pair< Path, vec >	getLayer (ssize_t layerNr) const noexcept

vec	getColorOfLayer (ssize_t layerNr) const noexcept

void	setColorOfLayer (ssize_t layerNr, vec fillColor) noexcept

bool	isContourOpen () const noexcept

void	closeContour () noexcept

bool	hasLayers () const noexcept

bool	isLayerOpen () const noexcept

void	closeLayer (vec fillColor) noexcept

void	optimizeLayers () noexcept
	Optimize layers.

vec	currentPosition () const noexcept

void	moveTo (vec position) noexcept

void	moveRelativeTo (vec direction) noexcept

void	lineTo (vec position) noexcept

void	lineRelativeTo (vec direction) noexcept

void	quadraticCurveTo (vec controlPosition, vec position) noexcept

void	quadraticCurveRelativeTo (vec controlDirection, vec direction) noexcept

void	cubicCurveTo (vec controlPosition1, vec controlPosition2, vec position) noexcept

void	cubicCurveRelativeTo (vec controlDirection1, vec controlDirection2, vec direction) noexcept

void	arcTo (float radius, vec position) noexcept

void	addRectangle (aarect r, vec corners={0.0f, 0.0f, 0.0f, 0.0f}) noexcept

void	addCircle (vec position, float radius) noexcept

void	addContour (std::vector< BezierCurve > const &contour) noexcept

void	addContour (std::vector< BezierPoint >::const_iterator const &begin, std::vector< BezierPoint >::const_iterator const &end) noexcept

void	addContour (std::vector< BezierPoint > const &contour) noexcept

void	addPath (Path const &path, vec fillColor) noexcept

void	addStroke (Path const &path, vec strokeColor, float strokeWidth, LineJoinStyle lineJoinStyle=LineJoinStyle::Miter, float tolerance=0.05f) noexcept

Path	toStroke (float strokeWidth=1.0f, LineJoinStyle lineJoinStyle=LineJoinStyle::Miter, float tolerance=0.05f) const noexcept

Path	centerScale (vec extent, float padding=0.0) const noexcept
	Center and scale a path inside the extent with padding.

Path &	operator+= (Path const &rhs) noexcept

template<typename M , std::enable_if_t< is_mat_v< M >, int > = 0>
Path &	*operator=** (M const &rhs) noexcept

Data Fields
std::vector< BezierPoint >	points

std::vector< ssize_t >	contourEndPoints

std::vector< std::pair< ssize_t, vec > >	layerEndContours

Friends
Path	operator+ (Path lhs, Path const &rhs) noexcept

template<typename M , std::enable_if_t< is_mat_v< M >, int > = 0>
Path	operator* (M const &lhs, Path rhs) noexcept

Detailed Description

A path is a vector graphics object. It represents:

a set of layers each with a different color.
a layer is a set of contours
a contour is a set of bezier point describing a closed set of bezier curves.

Member Function Documentation

◆ addCircle()

void tt::Path::addCircle	(	vec	position,
		float	radius )

noexcept

Draw a circle.

Parameters

position	position of the center of the circle.
radius	radius of the circle

◆ addContour() [1/3]

void tt::Path::addContour ( std::vector< BezierCurve > const & contour )

noexcept

Contour with the given bezier curves. The first anchor will be ignored.

◆ addContour() [2/3]

void tt::Path::addContour ( std::vector< BezierPoint > const & contour )

noexcept

Curve with the given bezier curve. The first anchor will be ignored.

◆ addContour() [3/3]

void tt::Path::addContour	(	std::vector< BezierPoint >::const_iterator const &	begin,
		std::vector< BezierPoint >::const_iterator const &	end )

noexcept

Curve with the given bezier curve. The first anchor will be ignored.

◆ addPath()

void tt::Path::addPath	(	Path const &	path,
		vec	fillColor )

noexcept

Add path and close layer.

◆ addRectangle()

void tt::Path::addRectangle	(	aarect	r,
		vec	corners = {0.0f, 0.0f, 0.0f, 0.0f} )

noexcept

Draw a rectangle.

Parameters

aarect	the offset and size of the rectangle.
corner	radius of <bottom-left, bottom-right, top-left, top-right> positive corner are rounded, negative curves are cut.

◆ addStroke()

void tt::Path::addStroke	(	Path const &	path,
		vec	strokeColor,
		float	strokeWidth,
		LineJoinStyle	lineJoinStyle = LineJoinStyle::Miter,
		float	tolerance = 0.05f )

noexcept

Stroke a path and close layer.

◆ allLayersHaveSameColor()

bool tt::Path::allLayersHaveSameColor ( ) const

noexcept

Check if all layers have the same color.

◆ arcTo()

void tt::Path::arcTo	(	float	radius,
		vec	position )

noexcept

Draw an circular arc. The arc is drawn from the current position to the position given in this method. A positive arc is drawn counter-clockwise.

Using method in: "Approximation of a cubic bezier curve by circular arcs and vice versa" – Aleksas Ri�kus (chapter 3, formulas 8 and 9, there are a few typos in the formulas)

Parameters

radius	positive radius means positive arc, negative radius is a negative arc.
position	end position of the arc.

◆ beginContour()

std::vector< BezierPoint >::const_iterator tt::Path::beginContour ( ssize_t contourNr ) const

noexcept

Return an iterator to the start point of a contour.

◆ boundingBox()

aarect tt::Path::boundingBox ( ) const

noexcept

Calculate bounding box.

◆ centerScale()

Path tt::Path::centerScale	(	vec	extent,
		float	padding = 0.0 ) const

noexcept

Center and scale a path inside the extent with padding.

◆ clear()

void tt::Path::clear ( )

inlinenoexcept

Clear the path.

◆ closeContour()

void tt::Path::closeContour ( )

noexcept

Close current contour. No operation if there is no open contour.

◆ closeLayer()

void tt::Path::closeLayer ( vec fillColor )

noexcept

Close current contour. No operation if there is no open layer.

◆ cubicCurveRelativeTo()

void tt::Path::cubicCurveRelativeTo	(	vec	controlDirection1,
		vec	controlDirection2,
		vec	direction )

noexcept

Draw curve from the current position to the new direction.

Parameters

controlDirection	control point of the curve relative from the start of the curve.
direction	end point of the curve relative from the start of the curve.

◆ currentPosition()

vec tt::Path::currentPosition ( ) const

noexcept

Get the currentPosition of the open contour. Returns {0, 0} when there is no contour open.

◆ hasLayers()

bool tt::Path::hasLayers ( ) const

noexcept

This path has layers.

◆ isContourOpen()

bool tt::Path::isContourOpen ( ) const

noexcept

Return true if there is an open contour.

◆ isLayerOpen()

bool tt::Path::isLayerOpen ( ) const

noexcept

Return true if there is an open layer.

◆ moveRelativeTo()

void tt::Path::moveRelativeTo ( vec direction )

noexcept

Start a new contour relative to current position. closes current subpath.

◆ moveTo()

void tt::Path::moveTo ( vec position )

noexcept

Start a new contour at position. closes current subpath.

◆ numberOfContours()

ssize_t tt::Path::numberOfContours ( ) const

noexcept

Return the number of closed contours.

◆ numberOfLayers()

ssize_t tt::Path::numberOfLayers ( ) const

noexcept

Return the number of closed layers.

◆ optimizeLayers()

void tt::Path::optimizeLayers ( )

noexcept

Optimize layers.

Merge contiguous layers with the same color.

◆ quadraticCurveRelativeTo()

void tt::Path::quadraticCurveRelativeTo	(	vec	controlDirection,
		vec	direction )

noexcept

Draw curve from the current position to the new direction.

Parameters

controlDirection	control point of the curve relative from the start of the curve.
direction	end point of the curve relative from the start of the curve.

◆ toStroke()

Path tt::Path::toStroke	(	float	strokeWidth = 1.0f,
		LineJoinStyle	lineJoinStyle = LineJoinStyle::Miter,
		float	tolerance = 0.05f ) const

noexcept

Convert path to stroke-path.

This function will create contours that are offset from the original path which creates a stroke. The path will first be subdivided until the curves are mostly flat, then the curves are converted into lines and offset, then the lines are connected to each other.

Parameters

strokeWidth	width of the stroke.
lineJoinStyle	the style of how outside corners of a stroke are drawn.
tolerance	Tolerance of how flat the curves in the path need to be.

◆ tryRemoveLayers()

void tt::Path::tryRemoveLayers ( )

noexcept

Try to move the layers in a path. Layers are removed if there are layers, and all the layers have the same color.

Field Documentation

◆ contourEndPoints

std::vector<ssize_t> tt::Path::contourEndPoints

An index into

See also: points where each contour ends.

◆ layerEndContours

std::vector<std::pair<ssize_t,vec> > tt::Path::layerEndContours

An color and index into

See also: contourEndPoints where each layer ends.

◆ points

std::vector<BezierPoint> tt::Path::points

A set of all bezier points describing all bezier curves, contours and layers.

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

hikogui/src/TTauri/Foundation/Path.hpp

Public Member Functions

Data Fields

Friends

Detailed Description

Member Function Documentation

◆ addCircle()

◆ addContour() [1/3]

◆ addContour() [2/3]

◆ addContour() [3/3]

◆ addPath()

◆ addRectangle()

◆ addStroke()

◆ allLayersHaveSameColor()

◆ arcTo()

◆ beginContour()

◆ boundingBox()

◆ centerScale()

◆ clear()

◆ closeContour()

◆ closeLayer()

◆ cubicCurveRelativeTo()

◆ currentPosition()

◆ hasLayers()

◆ isContourOpen()

◆ isLayerOpen()

◆ moveRelativeTo()

◆ moveTo()

◆ numberOfContours()

◆ numberOfLayers()

◆ optimizeLayers()

◆ quadraticCurveRelativeTo()

◆ toStroke()

◆ tryRemoveLayers()

Field Documentation

◆ contourEndPoints

◆ layerEndContours

◆ points