Package org.openstreetmap.josm.gui.draw

Enum SymbolShape

java.lang.Object

java.lang.Enum<SymbolShape>

org.openstreetmap.josm.gui.draw.SymbolShape

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SymbolShape>

public enum SymbolShape
extends java.lang.Enum<SymbolShape>

A list of possible symbol shapes.

Since:

10875

Enum Constant Summary

Enum Constants

Enum Constant	Description
CIRCLE	A circle
DECAGON	A decagon
HEPTAGON	A heptagon
HEXAGON	A hexagon
NONAGON	a nonagon
OCTAGON	An octagon
PENTAGON	A pentagon
SQUARE	A square
TRIANGLE	A triangle with sides of equal length

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.String	name
(package private) double	rotation
(package private) int	sides

Constructor Summary

Constructors

Modifier	Constructor	Description
private	SymbolShape(java.lang.String name, int sides, double rotation)

Method Summary

Modifier and Type	Method	Description
private java.awt.Shape	buildPolygon(double cx, double cy, double radius)
static java.util.Optional<SymbolShape>	forName(java.lang.String val)	Get the shape with the given name
java.lang.String	getName()	Get the MapCSS name for this shape
double	getRotation()	Gets the rotation of the first point of this symbol.
int	getSides()	Gets the number of normally straight sides this symbol has.
java.awt.Shape	shapeAround(double x, double y, double size)	Create the path for this shape around the given position
static SymbolShape	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static SymbolShape[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SQUARE

public static final SymbolShape SQUARE

A square

CIRCLE

public static final SymbolShape CIRCLE

A circle

TRIANGLE

public static final SymbolShape TRIANGLE

A triangle with sides of equal length

PENTAGON

public static final SymbolShape PENTAGON

A pentagon

HEXAGON

public static final SymbolShape HEXAGON

A hexagon

HEPTAGON

public static final SymbolShape HEPTAGON

A heptagon

OCTAGON

public static final SymbolShape OCTAGON

An octagon

NONAGON

public static final SymbolShape NONAGON

a nonagon

DECAGON

public static final SymbolShape DECAGON

A decagon

Field Detail

name

private final java.lang.String name

sides

final int sides

rotation

final double rotation

Constructor Detail

SymbolShape

private SymbolShape(java.lang.String name,
                    int sides,
                    double rotation)

Method Detail

values

public static SymbolShape[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SymbolShape c : SymbolShape.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SymbolShape valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

shapeAround

public java.awt.Shape shapeAround(double x,
                                  double y,
                                  double size)

Create the path for this shape around the given position

Parameters:

x - The x position

y - The y position

size - The size (width for rect, diameter for rest)

Returns:

The symbol.

Since:

10875

buildPolygon

private java.awt.Shape buildPolygon(double cx,
                                    double cy,
                                    double radius)

getSides

public int getSides()

Gets the number of normally straight sides this symbol has. Returns 1 for a circle.

Returns:

The sides of the symbol

getRotation

public double getRotation()

Gets the rotation of the first point of this symbol.

Returns:

The rotation

getName

public java.lang.String getName()

Get the MapCSS name for this shape

Returns:

The name

forName

public static java.util.Optional<SymbolShape> forName(java.lang.String val)

Get the shape with the given name

Parameters:

val - The name to search

Returns:

The shape as optional