de.javagl.geom

Class ArrowCreator

java.lang.Object

de.javagl.geom.ArrowCreator

public final class ArrowCreator
extends Object

A class for creating shapes of arrows

Method Summary

Modifier and Type	Method and Description
Shape	buildHeadShape(double x0, double y0, double x1, double y1, double shaftWidth) Build the shape of an arrow head, based on the current settings of this arrow creator
Shape	buildLines(double x0, double y0, double x1, double y1) Build a simple arrow that only consists of lines, from the start to the end, and from the head tips to the end.
Shape	buildLines(Line2D line) Build a simple arrow that only consists of lines, from the start to the end, and from the head tips to the end.
Shape	buildLines(Point2D p0, Point2D p1) Build a simple arrow that only consists of lines, from the start to the end, and from the head tips to the end.
Shape	buildShape(double x0, double y0, double x1, double y1, double shaftWidth) Build the shape of an arrow, based on the current settings of this arrow creator
Shape	buildShape(Line2D line, double shaftWidth) Build the shape of an arrow, based on the current settings of this arrow creator
Shape	buildShape(Point2D p0, Point2D p1, double shaftWidth) Build the shape of an arrow, based on the current settings of this arrow creator
ArrowCreator	setAbsoluteHeadLength(double headLength) Set the absolute length of the arrow head
ArrowCreator	setAbsoluteHeadWidth(double headWidth) Set the absolute width of the arrow head
ArrowCreator	setHeadBasePosition(double headBasePosition) Set the position of the head base, as a value between 0 and 1.
ArrowCreator	setRelativeHeadLength(double headLength) Set the head length, relative to the length of the arrow, usually as a value between 0 and 1
ArrowCreator	setRelativeHeadLength(double headLength, double minAbsolute, double maxAbsolute) Set the head length, relative to the length of the arrow, usually as a value between 0 and 1, but with the given absolute bounds
ArrowCreator	setRelativeHeadWidth(double headWidth) Set the head width, relative to the length of the arrow, usually as a value between 0 and 1
ArrowCreator	setRelativeHeadWidth(double headWidth, double minAbsolute, double maxAbsolute) Set the head width, relative to the width of the arrow, usually as a value between 0 and 1, but with the given absolute bounds

Methods inherited from class java.lang.Object

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

Method Detail

setAbsoluteHeadLength

public ArrowCreator setAbsoluteHeadLength(double headLength)

Set the absolute length of the arrow head

Parameters:

headLength - The head length

Returns:

This instance

setRelativeHeadLength

public ArrowCreator setRelativeHeadLength(double headLength)

Set the head length, relative to the length of the arrow, usually as a value between 0 and 1

Parameters:

headLength - The head length

Returns:

This instance

setRelativeHeadLength

public ArrowCreator setRelativeHeadLength(double headLength,
                                          double minAbsolute,
                                          double maxAbsolute)

Set the head length, relative to the length of the arrow, usually as a value between 0 and 1, but with the given absolute bounds

Parameters:

headLength - The head length

minAbsolute - The minimum head length

maxAbsolute - The maximum head length

Returns:

This instance

setAbsoluteHeadWidth

public ArrowCreator setAbsoluteHeadWidth(double headWidth)

Set the absolute width of the arrow head

Parameters:

headWidth - The head width

Returns:

This instance

setRelativeHeadWidth

public ArrowCreator setRelativeHeadWidth(double headWidth)

Set the head width, relative to the length of the arrow, usually as a value between 0 and 1

Parameters:

headWidth - The head width

Returns:

This instance

setRelativeHeadWidth

public ArrowCreator setRelativeHeadWidth(double headWidth,
                                         double minAbsolute,
                                         double maxAbsolute)

Set the head width, relative to the width of the arrow, usually as a value between 0 and 1, but with the given absolute bounds

Parameters:

headWidth - The head width

minAbsolute - The minimum head width

maxAbsolute - The maximum head width

Returns:

This instance

setHeadBasePosition

public ArrowCreator setHeadBasePosition(double headBasePosition)

Set the position of the head base, as a value between 0 and 1. In this image, "B" represents the base position, between "0" and "1":

               __
               \ \__ 
                \   \__
                 \     \_
 --------------0--B-----1
                 /   __/
                / __/
               /_/   
 

Parameters:

headBasePosition - The head base position

Returns:

This instance

buildShape

public Shape buildShape(Line2D line,
                        double shaftWidth)

Build the shape of an arrow, based on the current settings of this arrow creator

Parameters:

line - The line for the arrow

shaftWidth - The width of the shaft

Returns:

The arrow shape

buildShape

public Shape buildShape(Point2D p0,
                        Point2D p1,
                        double shaftWidth)

Build the shape of an arrow, based on the current settings of this arrow creator

Parameters:

p0 - The start point of the arrow

p1 - The end point of the arrow

shaftWidth - The width of the shaft

Returns:

The arrow shape

buildShape

public Shape buildShape(double x0,
                        double y0,
                        double x1,
                        double y1,
                        double shaftWidth)

Build the shape of an arrow, based on the current settings of this arrow creator

Parameters:

x0 - The x-coordinate of the start point of the arrow

y0 - The y-coordinate of the start point of the arrow

x1 - The x-coordinate of the end point of the arrow

y1 - The y-coordinate of the end point of the arrow

shaftWidth - The width of the shaft

Returns:

The arrow shape

buildHeadShape

public Shape buildHeadShape(double x0,
                            double y0,
                            double x1,
                            double y1,
                            double shaftWidth)

Build the shape of an arrow head, based on the current settings of this arrow creator

Parameters:

x0 - The x-coordinate of the start point of the arrow

y0 - The y-coordinate of the start point of the arrow

x1 - The x-coordinate of the end point of the arrow

y1 - The y-coordinate of the end point of the arrow

shaftWidth - The width of the shaft

Returns:

The arrow head shape

buildLines

public Shape buildLines(Line2D line)

Build a simple arrow that only consists of lines, from the start to the end, and from the head tips to the end.

Parameters:

line - The line for the arrow

Returns:

The shape, only consisting of lines

buildLines

public Shape buildLines(Point2D p0,
                        Point2D p1)

Build a simple arrow that only consists of lines, from the start to the end, and from the head tips to the end.

Parameters:

p0 - The start point of the arrow

p1 - The end point of the arrow

Returns:

The shape, only consisting of lines

buildLines

public Shape buildLines(double x0,
                        double y0,
                        double x1,
                        double y1)

Build a simple arrow that only consists of lines, from the start to the end, and from the head tips to the end.

Parameters:

x0 - The x-coordinate of the start point of the arrow

y0 - The y-coordinate of the start point of the arrow

x1 - The x-coordinate of the end point of the arrow

y1 - The y-coordinate of the end point of the arrow

Returns:

The shape, only consisting of lines