net.kolls.railworld.segment
Class TrackSegment

java.lang.Object
  extended by net.kolls.railworld.RailSegment
      extended by net.kolls.railworld.segment.TrackSegment
Direct Known Subclasses:
Crossing, EESegment, HiddenSegment, LUSegment

public class TrackSegment
extends RailSegment

A regular, straight-line segment of track.

Author:
Steve Kollmansberger

Nested Class Summary
 class TrackSegment.TSEP
          Track segment edit point.
 
Field Summary
protected  int cap
          How the segment is ended.
protected  java.awt.geom.Line2D coords
          The line connecting two points, on the map image.
static int POINT_BEGIN
          The begin segment
static int POINT_END
          The end segment
protected  java.awt.Stroke railBedStroke
          The rail bed pen
protected  java.awt.Stroke railStroke
          The rail line pen
 
Fields inherited from class net.kolls.railworld.RailSegment
dests, ec, MOUSE_NEAR, pts, RAIL_BED_WIDTH, RAIL_WIDTH, trains
 
Constructor Summary
TrackSegment(RailSegment bg, RailSegment en, java.awt.geom.Line2D crds)
          Create a track segment.
 
Method Summary
 boolean canErase()
          Can this segment be erased? In some cases, other segments must be erased first.
 SegmentEditPoint createSEP(int ptIdx, RailSegment anchor)
          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.Line2D getCoords()
           
 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.
protected  void setCap()
          Set the line end cap based on next segment...
 
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

cap

protected int cap
How the segment is ended. By default, segments end with a round cap, although in some cases (like with crossing or hidden segments) this is not desirable.


coords

protected java.awt.geom.Line2D coords
The line connecting two points, on the map image.


railBedStroke

protected java.awt.Stroke railBedStroke
The rail bed pen


railStroke

protected java.awt.Stroke railStroke
The rail line pen


POINT_BEGIN

public static final int POINT_BEGIN
The begin segment

See Also:
Constant Field Values

POINT_END

public static final int POINT_END
The end segment

See Also:
Constant Field Values
Constructor Detail

TrackSegment

public TrackSegment(RailSegment bg,
                    RailSegment en,
                    java.awt.geom.Line2D crds)
Create a track segment. The coordinates will be immediately converted to feet, so the distance information must be correct by the time this is called.

Parameters:
bg - Begin segment
en - End segment
crds - Line coords
Method Detail

getCoords

public java.awt.geom.Line2D getCoords()
Returns:
The coordinates of this line

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()

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

setCap

protected void setCap()
Set the line end cap based on next segment... Could be round or flat.


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.

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.

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

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()

createSEP

public SegmentEditPoint createSEP(int ptIdx,
                                  RailSegment anchor)
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.
anchor - 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.

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.

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.