net.kolls.railworld.segment
Class Label

java.lang.Object
  extended by net.kolls.railworld.RailSegment
      extended by net.kolls.railworld.segment.Label

public class Label
extends RailSegment

A label for displaying text.

Author:
Steve Kollmansberger

Field Summary
 double angle
          Rotation angle, in radians.
 java.awt.Color c
          The label's color
 boolean centered
          The coordinates refer to upper-left or the center of the label? By default this is true, meaning the coordinates are the center of the label.
 Distance size
          How tall is the label text
 java.lang.String value
          What the label says
 
Fields inherited from class net.kolls.railworld.RailSegment
dests, ec, MOUSE_NEAR, pts, RAIL_BED_WIDTH, RAIL_WIDTH, trains
 
Constructor Summary
Label(java.lang.String value, Distance size, java.awt.Color color, java.awt.geom.Point2D pos, double angle)
          Create a label
 
Method Summary
 boolean canErase()
          Can this segment be erased? In some cases, other segments must be erased first.
 SegmentEditPoint createSEP(int ptIdx, RailSegment attach)
          Given a point index in the pts array and possibly a railsegment to attach, return a segmenteditpoint if such attachment is possible.
 RailSegment dest(RailSegment source)
          Each rail segment must at the very least tell us where it comes from and where it goes, currently.
 void draw(int z, java.awt.Graphics2D gc)
          Draw the segment.
 javax.swing.JPanel editPanel()
          You are guaranteed that the variable RailSegment.ec will be set prior to this call.
 java.awt.geom.Point2D getPoint(RailSegment start, double myPos)
           
 Distance length()
          all segments have a length can be 0 for signals, etc.
 java.lang.String mouseOver(java.awt.geom.Point2D pos)
          Whenever a user mouses over the canvas, all dynamic segments receive this event.
 void recomp()
          Called when changes are made; recompute or update any associated values.
 
Methods inherited from class net.kolls.railworld.RailSegment
carHidden, click, destNZ, enter, getDest, getDests, getPoint, getPoints, isDynamic, nearEditPoint, pixelStep, setDest, setPoint, singleton, step, trains, update, update
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

value

public java.lang.String value
What the label says


c

public java.awt.Color c
The label's color


size

public Distance size
How tall is the label text


angle

public double angle
Rotation angle, in radians.


centered

public boolean centered
The coordinates refer to upper-left or the center of the label? By default this is true, meaning the coordinates are the center of the label.

Constructor Detail

Label

public Label(java.lang.String value,
             Distance size,
             java.awt.Color color,
             java.awt.geom.Point2D pos,
             double angle)
Create a label

Parameters:
value - Text value
size - Font size
color - Color
pos - Location on map (this is the center point)
angle - Angle, in radians
See Also:
RailCanvas.drawOutlineFont(Graphics2D, int, int, String, int, Color, double, boolean)
Method Detail

recomp

public void recomp()
Description copied from class: RailSegment
Called when changes are made; recompute or update any associated values.

Specified by:
recomp in class RailSegment

canErase

public boolean canErase()
Description copied from class: RailSegment
Can this segment be erased? In some cases, other segments must be erased first.

Specified by:
canErase in class RailSegment
Returns:
Indicates if the segment may be erased as-is.

mouseOver

public java.lang.String mouseOver(java.awt.geom.Point2D pos)
Description copied from class: RailSegment
Whenever a user mouses over the canvas, all dynamic segments receive this event. Check to see if the position is at your segment (as in click). Return a describe if applicable, otherwise null. Defaults to returning null.

Overrides:
mouseOver in class RailSegment
Parameters:
pos - The mouse position
Returns:
Description if applicable, otherwise null
See Also:
RailSegment.isDynamic()

dest

public RailSegment dest(RailSegment source)
Description copied from class: RailSegment
Each rail segment must at the very least tell us where it comes from and where it goes, currently. Indicate where you are coming from, it says where you're going. Null value means end of line. These values may be dynamic, as in a switch.

Specified by:
dest in class RailSegment
Parameters:
source - The rail segment of origin
Returns:
The destination rail segment, or null if there is none.

draw

public void draw(int z,
                 java.awt.Graphics2D gc)
Description copied from class: RailSegment
Draw the segment. Segments have several z-layers to allowed slightly overlaping pieces to still look nice. z = 1 is a static layer (lowest) z = 2 is a static layer (highest) z = 3 is reserved z = 4 is the dynamic layer. This is redrawn frequently, if requested by the segment.

Specified by:
draw in class RailSegment
Parameters:
z - The currently z-layer to draw
gc - A Graphics2D graphics context.
See Also:
RailSegment.isDynamic()

editPanel

public javax.swing.JPanel editPanel()
Description copied from class: RailSegment
You are guaranteed that the variable RailSegment.ec will be set prior to this call. So if you need to refresh the canvas or make any changes to it, you can use that variable.

Specified by:
editPanel in class RailSegment
Returns:
A JPanel to display in the sidebar to edit this segment's properties. Please keep width at 200 pixels top.

getPoint

public java.awt.geom.Point2D getPoint(RailSegment start,
                                      double myPos)
Specified by:
getPoint in class RailSegment
Parameters:
start - The segment of origin
myPos - Percentage (0-1) along the segment
Returns:
A Point2D indicating the actual point that location represents

createSEP

public SegmentEditPoint createSEP(int ptIdx,
                                  RailSegment attach)
Description copied from class: RailSegment
Given a point index in the pts array and possibly a railsegment to attach, return a segmenteditpoint if such attachment is possible. If the attach segment is null, no segment is attaching, just user editing.

Specified by:
createSEP in class RailSegment
Parameters:
ptIdx - The index into the pts array.
attach - The segment that desires to attach. (Note: do not attach the segment automatically; it will be called through the anchor method in the edit point).
Returns:
A SegmentEditPoint if possible, otherwise null.

length

public Distance length()
Description copied from class: RailSegment
all segments have a length can be 0 for signals, etc. length must be the same no mattter which 'way' you traverse the segment Distance may be a 0-foot distance, but not may be null.

Specified by:
length in class RailSegment
Returns:
The Distance of the segment.