Package org.locationtech.jts.geom.util

Class SineStarFactory

java.lang.Object

org.locationtech.jts.util.GeometricShapeFactory

org.locationtech.jts.geom.util.SineStarFactory

public class SineStarFactory
extends GeometricShapeFactory

Creates geometries which are shaped like multi-armed stars with each arm shaped like a sine wave. These kinds of geometries are useful as a more complex geometry for testing algorithms.

Author:

Martin Davis

Constructor Summary

Constructors

Constructor	Description
SineStarFactory()	Creates a factory which will create sine stars using the default GeometryFactory.
SineStarFactory(GeometryFactory geomFact)	Creates a factory which will create sine stars using the given GeometryFactory.

Method Summary

Modifier and Type	Method	Description
Geometry	createSineStar()	Generates the geometry for the sine star
void	setArmLengthRatio(double armLengthRatio)	Sets the ration of the length of each arm to the distance from the tip of the arm to the centre of the star.
void	setNumArms(int numArms)	Sets the number of arms in the star

Methods inherited from class org.locationtech.jts.util.GeometricShapeFactory

createArc, createArcPolygon, createCircle, createEllipse, createRectangle, createSquircle, createSupercircle, setBase, setCentre, setEnvelope, setHeight, setNumPoints, setRotation, setSize, setWidth

Methods inherited from class java.lang.Object

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

Constructor Detail

SineStarFactory

public SineStarFactory()

Creates a factory which will create sine stars using the default GeometryFactory.

SineStarFactory

public SineStarFactory(GeometryFactory geomFact)

Creates a factory which will create sine stars using the given GeometryFactory.

Parameters:

geomFact - the factory to use

Method Detail

setNumArms

public void setNumArms(int numArms)

Sets the number of arms in the star

Parameters:

numArms - the number of arms to generate

setArmLengthRatio

public void setArmLengthRatio(double armLengthRatio)

Sets the ration of the length of each arm to the distance from the tip of the arm to the centre of the star. Value should be between 0.0 and 1.0

Parameters:

armLengthRatio -

createSineStar

public Geometry createSineStar()

Generates the geometry for the sine star

Returns:

the geometry representing the sine star