net.kolls.railworld.segment
Class FourWay

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

public class FourWay
extends RailSegment

Track crossing itself without switching capabilities.

Author:
Steve Kollmansberger

Field Summary
static int POINT_BEGINA
          Starting segment of the first track
static int POINT_BEGINB
          Starting segment of the second track
static int POINT_ENDA
          Ending segment of the first track
static int POINT_ENDB
          Ending segment of the second track
 
Fields inherited from class net.kolls.railworld.RailSegment
dests, ec, MOUSE_NEAR, pts, RAIL_BED_WIDTH, RAIL_WIDTH, trains
 
Constructor Summary
FourWay(RailSegment ba, RailSegment ena, RailSegment bb, RailSegment enb, java.awt.geom.Point2D pos)
          Create a four way crossing
 
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.Point2D getPoint(RailSegment s, double pos)
           
 boolean isDynamic()
          Dynamic segments receive additional events while the game is running; non-dynamic segments are only asked to draw z levels 1 and 2 at draw static time.
 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.
 boolean singleton()
          Singleton segments may only have one train in them at a time.
 
Methods inherited from class net.kolls.railworld.RailSegment
carHidden, click, destNZ, enter, getDest, getDests, getPoint, getPoints, nearEditPoint, pixelStep, setDest, setPoint, step, trains, update, update
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

POINT_BEGINA

public static final int POINT_BEGINA
Starting segment of the first track

See Also:
Constant Field Values

POINT_ENDA

public static final int POINT_ENDA
Ending segment of the first track

See Also:
Constant Field Values

POINT_BEGINB

public static final int POINT_BEGINB
Starting segment of the second track

See Also:
Constant Field Values

POINT_ENDB

public static final int POINT_ENDB
Ending segment of the second track

See Also:
Constant Field Values
Constructor Detail

FourWay

public FourWay(RailSegment ba,
               RailSegment ena,
               RailSegment bb,
               RailSegment enb,
               java.awt.geom.Point2D pos)
Create a four way crossing

Parameters:
ba - Beginning segment of track A
ena - Ending segment of track A
bb - Beginning segment of track B
enb - Ending segment of track B
pos - Location on map
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

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 s,
                                      double pos)
Specified by:
getPoint in class RailSegment
Parameters:
s - The segment of origin
pos - Percentage (0-1) along the segment
Returns:
A Point2D indicating the actual point that location represents

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

isDynamic

public boolean isDynamic()
Description copied from class: RailSegment
Dynamic segments receive additional events while the game is running; non-dynamic segments are only asked to draw z levels 1 and 2 at draw static time. Defaults to false (not dynamic). Non-dynamic segments also may not receive notifications for various events.

Overrides:
isDynamic in class RailSegment
Returns:
Indicates if the segment should receive z=4 draw events and click events.
See Also:
RailSegment.draw(int, Graphics2D), RailSegment.click(Point2D, RailCanvas)

singleton

public boolean singleton()
Description copied from class: RailSegment
Singleton segments may only have one train in them at a time. If additional trains are detected, a rail accident occurs. Defaults to false (not a singleton).

Overrides:
singleton in class RailSegment
Returns:
If the segment may only have one train on it at a time

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.

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.