de.saxsys.svgfx.core.path.commands

Class PathCommand

java.lang.Object

de.saxsys.svgfx.core.path.commands.PathCommand

Direct Known Subclasses:

BezierCurveCommand, CloseCommand, HorizontalLineCommand, LineCommand, VerticalLineCommand

public abstract class PathCommand
extends Object

This represents a basic path command. All literal operation in this class are supposed to be case insensitive.

Author:

Xyanid on 01.04.2017.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PathCommand(boolean isAbsolute) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
protected javafx.geometry.Point2D	addPoints(javafx.geometry.Point2D first, javafx.geometry.Point2D second) Combines the two given points based on hte isAbsolute.
abstract javafx.geometry.Point2D	getAbsoluteEndPoint(javafx.geometry.Point2D absoluteCurrentPoint) Gets the next possible absoluteCurrentPoint based on the internal state of the command and the provided absoluteCurrentPoint.
abstract Optional<javafx.scene.shape.Rectangle>	getBoundingBox(javafx.geometry.Point2D absoluteCurrentPoint) Gets the bounding box which would result of using the given absoluteCurrentPoint as the starting point and then applying the internal state of the command.
protected double	getDistanceX(javafx.geometry.Point2D first, javafx.geometry.Point2D second) Returns the x distance between the two points. if one of the points is null, then then 0.0 will be returned.
protected double	getDistanceY(javafx.geometry.Point2D first, javafx.geometry.Point2D second) Returns the y distance between the two points. if one of the points is null, then then 0.0 will be returned.
protected double	getMinX(javafx.geometry.Point2D first, javafx.geometry.Point2D second) Returns the minimum x of the two points.
protected double	getMinY(javafx.geometry.Point2D first, javafx.geometry.Point2D second) Returns the minimum y of the two points.
protected <T,R> R	getValueOrFail(T first, T second, Function<T,R> valueProvider, BiFunction<T,T,R> resolver) Ensures to always return a value of the given values, even if either of the provided values is null.
boolean	isAbsolute() Returns isAbsolute.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PathCommand

protected PathCommand(boolean isAbsolute)

Creates a new instance.

Parameters:

isAbsolute - determines if the command is absolute or not.

Method Detail

isAbsolute

public boolean isAbsolute()

Returns isAbsolute.

Returns:

isAbsolute.

getAbsoluteEndPoint

public abstract javafx.geometry.Point2D getAbsoluteEndPoint(javafx.geometry.Point2D absoluteCurrentPoint)
                                                     throws PathException

Gets the next possible absoluteCurrentPoint based on the internal state of the command and the provided absoluteCurrentPoint.

Parameters:

absoluteCurrentPoint - the absoluteCurrentPoint from which to start.

Returns:

a new Point2D describing the absoluteCurrentPoint that is reached after this command has been applied.

Throws:

PathException - if the next absoluteCurrentPoint can not be determined.

getBoundingBox

public abstract Optional<javafx.scene.shape.Rectangle> getBoundingBox(javafx.geometry.Point2D absoluteCurrentPoint)
                                                               throws PathException

Gets the bounding box which would result of using the given absoluteCurrentPoint as the starting point and then applying the internal state of the command.

Parameters:

absoluteCurrentPoint - the absoluteCurrentPoint to be use as the starting point.

Returns:

a Optional describing the resulting bounding box.

Throws:

PathException - if the bounding box can not be determined.

addPoints

protected javafx.geometry.Point2D addPoints(javafx.geometry.Point2D first,
                                            javafx.geometry.Point2D second)
                                     throws PathException

Combines the two given points based on hte isAbsolute. If the command is absolute, the second point will be returned. Otherwise second point will be added to the first.

Parameters:

first - the first point to use, may be null of the command is absolute.

second - the second point.

Returns:

either the second point if the command is absolute or the result of adding the second point to the first one.

Throws:

PathException - if the command is not absolute the first point is null.

getDistanceX

protected double getDistanceX(javafx.geometry.Point2D first,
                              javafx.geometry.Point2D second)
                       throws PathException

Returns the x distance between the two points. if one of the points is null, then then 0.0 will be returned.

Parameters:

first - the first point.

second - the second point.

Returns:

the distance x between the two points, or 0.0 if either of the points is null.

Throws:

PathException - if both points are null.

getMinX

protected double getMinX(javafx.geometry.Point2D first,
                         javafx.geometry.Point2D second)
                  throws PathException

Returns the minimum x of the two points. If either of the points is null, then then x of the other point will be returned.

Parameters:

first - the first point.

second - the second point.

Returns:

the minimum x between the two points.

Throws:

PathException - if both points are null.

getDistanceY

protected double getDistanceY(javafx.geometry.Point2D first,
                              javafx.geometry.Point2D second)
                       throws PathException

Returns the y distance between the two points. if one of the points is null, then then 0.0 will be returned.

Parameters:

first - the first point.

second - the second point.

Returns:

the distance y between the two points, or 0.0 if either of the points is null.

Throws:

PathException - if both points are null.

getMinY

protected double getMinY(javafx.geometry.Point2D first,
                         javafx.geometry.Point2D second)
                  throws PathException

Returns the minimum y of the two points. If either of the points is null, then then y of the other point will be returned.

Parameters:

first - the first point.

second - the second point.

Returns:

the minimum y between the two points.

Throws:

PathException - if both points are null.

getValueOrFail

protected <T,R> R getValueOrFail(T first,
                                 T second,
                                 Function<T,R> valueProvider,
                                 BiFunction<T,T,R> resolver)
                          throws PathException

Ensures to always return a value of the given values, even if either of the provided values is null. So if both values are given the resolver is called. If one of the values is null, the valueProvider will provide the result based on the value that was not null.

Type Parameters:

T - the type of the values.

R - the type of the resulting value.

Parameters:

first - the first value to use.

second - the second value to use.

valueProvider - the Function to be called when one of the given values was null.

resolver - the BiFunction to be called when both values are not null.

Returns:

• if first and second are not null = the value of the resolver is returned.
• if first or second is null = the value of the valueProvider is returned, for the value that is not null

Throws:

PathException - if both values are null.