Package jmri.jmrit.display.layoutEditor

Class LayoutShape

java.lang.Object

jmri.jmrit.display.layoutEditor.LayoutShape

public class LayoutShape
extends Object

A LayoutShape is a set of LayoutShapePoint used to draw a shape. Each point can ether be a point on the shape or a control point that defines a curve that's part of the shape. The shape can be open (end points not connected) or closed (end points connected)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LayoutShape.LayoutShapePoint	These are the points that make up the outline of the shape.
static enum	LayoutShape.LayoutShapePointType	enum LayoutShapePointType Straight, Curve
static enum	LayoutShape.LayoutShapeType	enum LayoutShapeType

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_LINEWIDTH

Constructor Summary

Constructors

Constructor	Description
LayoutShape(String name, Point2D c, LayoutEditor layoutEditor)	constructor method (used by LayoutEditor)
LayoutShape(String name, LayoutEditor layoutEditor)	constructor method (used by XML loading code)
LayoutShape(String name, LayoutShape.LayoutShapeType t, LayoutEditor layoutEditor)	constructor method (used by XML loading code)
LayoutShape(LayoutShape layoutShape)	constructor method (used by duplicate)

Method Summary

Modifier and Type	Method	Description
void	addPoint(Point2D p)	add point
void	addPoint(Point2D p, int nearIndex)	add point
void	addPoint(LayoutShape.LayoutShapePointType t, Point2D p)	add point
(package private) void	dispose()	Clean up when this object is no longer needed.
protected void	draw(Graphics2D g2)
protected void	drawEditControls(Graphics2D g2)
protected HitPointType	findHitPointType(Point2D hitPoint, boolean useRectangles)	find the hit (location) type for a point
Rectangle2D	getBounds()	getBounds() - return the bounds of this shape
Point2D	getCoordsCenter()	get coordinates of center point of shape
String	getDisplayName()
Color	getFillColor()
LayoutEditor	getLayoutEditor()
int	getLevel()
Color	getLineColor()
int	getLineWidth()
int	getMaxNumberPoints()	get the maximum number of points
String	getName()	accessor methods
int	getNumberPoints()	get the number of points
Point2D	getPoint(int idx)	Get point.
ArrayList<LayoutShape.LayoutShapePoint>	getPoints()
LayoutShape.LayoutShapeType	getType()
boolean	isHidden()
static boolean	isShapeHitPointType(HitPointType t)
(package private) void	remove()	Removes this object from display and persistence
(package private) void	removeShape()
void	rotateCoords(double angleDEG)	rotate this LayoutTrack's coordinates by angleDEG's
void	scaleCoords(double xFactor, double yFactor)	scale this shapes coordinates by the x and y factors
void	setCoordsCenter(Point2D p)	set center coordinates
void	setFillColor(Color color)
void	setHidden(boolean hidden)
void	setLevel(int l)
void	setLineColor(Color color)
void	setLineWidth(int w)
void	setName(String n)
void	setPoint(int idx, Point2D p)	set point
void	setType(LayoutShape.LayoutShapeType t)
protected JPopupMenu	showShapePopUp(JmriMouseEvent mouseEvent, HitPointType hitPointType)
String	toString()
Ellipse2D	trackControlCircleAt(Point2D inPoint)
Ellipse2D	trackEditControlCircleAt(Point2D inPoint)
void	translateCoords(double xFactor, double yFactor)	translate this shapes coordinates by the x and y factors

Methods inherited from class java.lang.Object

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

Field Details

MAX_LINEWIDTH

public static final int MAX_LINEWIDTH

See Also:

• Constant Field Values

Constructor Details

LayoutShape

public LayoutShape(String name,
 LayoutEditor layoutEditor)

constructor method (used by XML loading code)

Parameters:

name - the name of the shape

layoutEditor - reference to the LayoutEditor this shape is in

LayoutShape

public LayoutShape(String name,
 LayoutShape.LayoutShapeType t,
 LayoutEditor layoutEditor)

constructor method (used by XML loading code)

Parameters:

name - the name of the shape

t - the layout shape type.

layoutEditor - reference to the LayoutEditor this shape is in

LayoutShape

public LayoutShape(String name,
 Point2D c,
 LayoutEditor layoutEditor)

constructor method (used by LayoutEditor)

Parameters:

name - the name of the shape

c - the Point2D for the initial point

layoutEditor - reference to the LayoutEditor this shape is in

LayoutShape

public LayoutShape(LayoutShape layoutShape)

constructor method (used by duplicate)

Parameters:

layoutShape - to duplicate (deep copy)

Method Details

toString

public String toString()

Overrides:

toString in class Object

getDisplayName

public String getDisplayName()

getName

public String getName()

accessor methods

Returns:

the name of this shape

setName

public void setName(String n)

getType

public LayoutShape.LayoutShapeType getType()

setType

public void setType(LayoutShape.LayoutShapeType t)

getLineWidth

public int getLineWidth()

setLineWidth

public void setLineWidth(int w)

getLineColor

public Color getLineColor()

setLineColor

public void setLineColor(Color color)

getFillColor

public Color getFillColor()

setFillColor

public void setFillColor(Color color)

getLevel

public int getLevel()

setLevel

public void setLevel(int l)

setHidden

public void setHidden(boolean hidden)

isHidden

public boolean isHidden()

getLayoutEditor

public LayoutEditor getLayoutEditor()

addPoint

public void addPoint(Point2D p)

add point

Parameters:

p - the point to add

addPoint

public void addPoint(Point2D p,
 int nearIndex)

add point

Parameters:

p - the point to add

nearIndex - the index of the existing point to add it near note: "near" is defined as before or after depending on closest neighbor

addPoint

public void addPoint(LayoutShape.LayoutShapePointType t,
 Point2D p)

add point

Parameters:

t - the type of point to add

p - the point to add

setPoint

public void setPoint(int idx,
 Point2D p)

set point

Parameters:

idx - the index of the point to add

p - the point to add

getPoint

public Point2D getPoint(int idx)

Get point.

Parameters:

idx - the index of the point to add.

Returns:

the 2D point of the ID, MathUtil.zeroPoint2D if no result.

getPoints

public ArrayList<LayoutShape.LayoutShapePoint> getPoints()

getNumberPoints

public int getNumberPoints()

get the number of points

Returns:

the number of points

getMaxNumberPoints

public int getMaxNumberPoints()

get the maximum number of points

Returns:

the maximum number of points

getBounds

public Rectangle2D getBounds()

getBounds() - return the bounds of this shape

Returns:

Rectangle2D as bound of this shape

findHitPointType

protected HitPointType findHitPointType(@Nonnull
 Point2D hitPoint,
 boolean useRectangles)

find the hit (location) type for a point

Parameters:

hitPoint - the point

useRectangles - whether to use (larger) rectangles or (smaller) circles for hit testing

Returns:

the hit point type for the point (or NONE)

isShapeHitPointType

public static boolean isShapeHitPointType(HitPointType t)

getCoordsCenter

public Point2D getCoordsCenter()

get coordinates of center point of shape

Returns:

Point2D coordinates of center point of shape

setCoordsCenter

public void setCoordsCenter(@Nonnull
 Point2D p)

set center coordinates

Parameters:

p - the coordinates to set

scaleCoords

public void scaleCoords(double xFactor,
 double yFactor)

scale this shapes coordinates by the x and y factors

Parameters:

xFactor - the amount to scale X coordinates

yFactor - the amount to scale Y coordinates

translateCoords

public void translateCoords(double xFactor,
 double yFactor)

translate this shapes coordinates by the x and y factors

Parameters:

xFactor - the amount to translate X coordinates

yFactor - the amount to translate Y coordinates

rotateCoords

public void rotateCoords(double angleDEG)

rotate this LayoutTrack's coordinates by angleDEG's

Parameters:

angleDEG - the amount to rotate in degrees

showShapePopUp

@Nonnull
protected JPopupMenu showShapePopUp(@CheckForNull
 JmriMouseEvent mouseEvent,
 HitPointType hitPointType)

removeShape

void removeShape()

dispose

void dispose()

Clean up when this object is no longer needed. Should not be called while the object is still displayed; see remove()

remove

void remove()

Removes this object from display and persistence

draw

protected void draw(Graphics2D g2)

drawEditControls

protected void drawEditControls(Graphics2D g2)

trackEditControlCircleAt

public Ellipse2D trackEditControlCircleAt(@Nonnull
 Point2D inPoint)

trackControlCircleAt

public Ellipse2D trackControlCircleAt(@Nonnull
 Point2D inPoint)