Package jmri.jmrit.display.layoutEditor

Class LayoutTraverserView

java.lang.Object

jmri.jmrit.display.layoutEditor.LayoutTrackView

jmri.jmrit.display.layoutEditor.LayoutTraverserView

All Implemented Interfaces:

InlineLogixNG

public class LayoutTraverserView
extends LayoutTrackView

MVC View component for the LayoutTraverser class.

Field Summary

Fields

Modifier and Type	Field	Description
String	tLayoutBlockName

Fields inherited from class jmri.jmrit.display.layoutEditor.LayoutTrackView

decorations, layoutEditor, NUM_ARROW_TYPES

Constructor Summary

Constructors

Constructor	Description
LayoutTraverserView(LayoutTraverser traverser, Point2D c, LayoutEditor layoutEditor)	Constructor method.

Method Summary

Modifier and Type	Method	Description
boolean	canRemove()	Check for active block boundaries.
List<HitPointType>	checkForFreeConnections()	return a list of the available connections for this layout track
void	checkForNonContiguousBlocks(HashMap<String,List<Set<String>>> blockNamesToTrackNameSetsMap)	check this track and its neighbors for non-contiguous blocks
boolean	checkForUnAssignedBlocks()	determine if all the appropriate blocks have been assigned to this track
void	collectContiguousTracksNamesInBlockNamed(String blockName, Set<String> TrackNameSet)	recursive routine to check for all contiguous tracks in this blockName
void	dispose()
protected void	draw1(Graphics2D g2, boolean isMain, boolean isBlock)	draw one line (Ballast, ties, center or 3rd rail, block lines)
protected void	draw2(Graphics2D g2, boolean isMain, float railDisplacement)	draw two lines (rails)
protected void	drawDecorations(Graphics2D g2)	Draw track decorations
protected void	drawEditControls(Graphics2D g2)	draw the edit controls
protected void	drawTurnoutControls(Graphics2D g2)	Draw the turnout controls
protected HitPointType	findHitPointType(Point2D hitPoint, boolean useRectangles, boolean requireUnconnected)	find the hit (location) type for a point
String	getBlockName()
Rectangle2D	getBounds()
LayoutTrack	getConnection(HitPointType connectionType)	get the LayoutTrack connected at the specified connection type
Point2D	getCoordsForConnectionType(HitPointType connectionType)	return the coordinates for a specified connection type (abstract: should be overridden by ALL subclasses)
double	getDeckLength()
LayoutBlock	getLayoutBlock()
protected List<LayoutConnectivity>	getLayoutConnectivity()	get the layout connectivity for this track
int	getNumberSlots()
int	getOrientation()
int	getPosition()
TrackSegment	getSlotConnectIndexed(int index)
TrackSegment	getSlotConnectOrdered(int i)
Point2D	getSlotCoordsIndexed(int index)
Point2D	getSlotCoordsOrdered(int i)
int	getSlotIndex(int i)
List<LayoutTraverser.SlotTrack>	getSlotList()
double	getSlotOffsetValue(int i)
Turnout	getSlotTurnout(int i)
String	getSlotTurnoutName(int i)
int	getSlotTurnoutState(int i)
final LayoutTraverser	getTraverser()
protected void	highlightUnconnected(Graphics2D g2, HitPointType specificType)	highlight unconnected connections
boolean	isActive()
boolean	isMainlineIndexed(int index)
boolean	isMainlineOrdered(int i)
boolean	isSlotDisabled(int i)
boolean	isSlotDisabledWhenOccupied(int i)
boolean	isTurnoutControlled()
protected void	reCheckBlockBoundary()	abstract method... subclasses should implement _IF_ they need to recheck their block boundaries
void	remove()
void	rotateCoords(double angleDEG)	rotate this LayoutTrack's coordinates by angleDEG's
void	scaleCoords(double xFactor, double yFactor)	scale this LayoutTrack's coordinates by the x and y factors
void	setAllLayoutBlocks(LayoutBlock layoutBlock)	Assign all the layout blocks in this track
void	setConnection(HitPointType connectionType, LayoutTrack o, HitPointType type)	set the LayoutTrack connected at the specified connection type
void	setLayoutBlock(LayoutBlock newLayoutBlock)	Set up a LayoutBlock for this LayoutTraverser.
void	setLayoutBlockByName(String name)	Set up a LayoutBlock for this LayoutTraverser.
void	setOrientation(int o)
void	setPosition(int index)
void	setSlotConnect(TrackSegment ts, int index)
void	setSlotCoordsIndexed(double x, double y, int index)
void	setSlotCoordsIndexed(Point2D point, int index)
void	setSlotDisabled(int i, boolean boo)
void	setSlotDisabledWhenOccupied(int i, boolean boo)
void	setSlotTurnout(int index, String turnoutName, int state)
void	setTurnoutControlled(boolean boo)
protected JPopupMenu	showPopup(JmriMouseEvent mouseEvent)	show the popup menu for this layout track
protected void	showSlotPopUp(JmriMouseEvent e, int index)
String	toString()	Get a string that represents this object.
void	translateCoords(double xFactor, double yFactor)	translate this LayoutTrack's coordinates by the x and y factors

Methods inherited from class jmri.jmrit.display.layoutEditor.LayoutTrackView

addCommonPopupItems, displayRemoveWarningDialog, drawHidden, drawLayoutTrackText, findHitPointType, findHitPointType, getColorForTrackBlock, getColorForTrackBlock, getCoordsCenter, getDecorations, getEditorName, getId, getLayoutEditor, getLayoutEditorToolBarPanel, getLayoutTrack, getLogixNG, getName, getNameString, getTurnoutStateString, getTypeName, getX, getY, hasDecorations, highlightUnconnected, isDisconnected, isHidden, loadArrowImageToJCBItem, removeInlineLogixNG, rotatePoint, setColorForTrackBlock, setColorForTrackBlock, setCoordsCenter, setDecorations, setHidden, setIdent, setLogixNG, setLogixNG_SystemName, setLogixNGPositionableMenu, setupLogixNG, showPopup, showPopup, trackControlCircleAt, trackControlCircleRectAt, trackEditControlCircleAt

Methods inherited from class java.lang.Object

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

Field Details

tLayoutBlockName

public String tLayoutBlockName

Constructor Details

LayoutTraverserView

public LayoutTraverserView(@Nonnull
 LayoutTraverser traverser,
 @Nonnull
 Point2D c,
 @Nonnull
 LayoutEditor layoutEditor)

Constructor method.

Parameters:

traverser - the layout traverser to create view for.

c - where to put it

layoutEditor - what layout editor panel to put it in

Method Details

getTraverser

public final LayoutTraverser getTraverser()

toString

public String toString()

Get a string that represents this object. This should only be used for debugging.

Overrides:

toString in class Object

Returns:

the string

getDeckLength

public double getDeckLength()

getOrientation

public int getOrientation()

setOrientation

public void setOrientation(int o)

getBlockName

@Nonnull
public String getBlockName()

Returns:

the layout block name

getLayoutBlock

public LayoutBlock getLayoutBlock()

Returns:

the layout block

setLayoutBlock

public void setLayoutBlock(@CheckForNull
 LayoutBlock newLayoutBlock)

Set up a LayoutBlock for this LayoutTraverser.

Parameters:

newLayoutBlock - the LayoutBlock to set

setLayoutBlockByName

public void setLayoutBlockByName(@CheckForNull
 String name)

Set up a LayoutBlock for this LayoutTraverser.

Parameters:

name - the name of the new LayoutBlock

getBounds

public Rectangle2D getBounds()

Specified by:

getBounds in class LayoutTrackView

Returns:

the bounds of this traverser.

getSlotConnectIndexed

public TrackSegment getSlotConnectIndexed(int index)

getSlotConnectOrdered

public TrackSegment getSlotConnectOrdered(int i)

setSlotConnect

public void setSlotConnect(TrackSegment ts,
 int index)

getSlotList

public List<LayoutTraverser.SlotTrack> getSlotList()

getNumberSlots

public int getNumberSlots()

getSlotIndex

public int getSlotIndex(int i)

getSlotOffsetValue

public double getSlotOffsetValue(int i)

setSlotTurnout

public void setSlotTurnout(int index,
 String turnoutName,
 int state)

getSlotTurnoutName

public String getSlotTurnoutName(int i)

getSlotTurnout

public Turnout getSlotTurnout(int i)

getSlotTurnoutState

public int getSlotTurnoutState(int i)

isSlotDisabled

public boolean isSlotDisabled(int i)

setSlotDisabled

public void setSlotDisabled(int i,
 boolean boo)

isSlotDisabledWhenOccupied

public boolean isSlotDisabledWhenOccupied(int i)

setSlotDisabledWhenOccupied

public void setSlotDisabledWhenOccupied(int i,
 boolean boo)

getSlotCoordsIndexed

public Point2D getSlotCoordsIndexed(int index)

getSlotCoordsOrdered

public Point2D getSlotCoordsOrdered(int i)

setSlotCoordsIndexed

public void setSlotCoordsIndexed(double x,
 double y,
 int index)

setSlotCoordsIndexed

public void setSlotCoordsIndexed(Point2D point,
 int index)

getCoordsForConnectionType

public Point2D getCoordsForConnectionType(HitPointType connectionType)

Description copied from class: LayoutTrackView

return the coordinates for a specified connection type (abstract: should be overridden by ALL subclasses)

Specified by:

getCoordsForConnectionType in class LayoutTrackView

Parameters:

connectionType - the connection type

Returns:

the coordinates for the specified connection type

getConnection

public LayoutTrack getConnection(HitPointType connectionType)
                          throws JmriException

Description copied from class: LayoutTrackView

get the LayoutTrack connected at the specified connection type

Specified by:

getConnection in class LayoutTrackView

Parameters:

connectionType - where on us to get the connection

Returns:

the LayoutTrack connected at the specified connection type

Throws:

JmriException - - if the connectionType is invalid

setConnection

public void setConnection(HitPointType connectionType,
 LayoutTrack o,
 HitPointType type)
                   throws JmriException

Description copied from class: LayoutTrackView

set the LayoutTrack connected at the specified connection type

Specified by:

setConnection in class LayoutTrackView

Parameters:

connectionType - where on us to set the connection

o - the LayoutTrack that is to be connected

type - where on the LayoutTrack we are connected

Throws:

JmriException - - if connectionType or type are invalid

isMainlineIndexed

public boolean isMainlineIndexed(int index)

isMainlineOrdered

public boolean isMainlineOrdered(int i)

scaleCoords

public void scaleCoords(double xFactor,
 double yFactor)

Description copied from class: LayoutTrackView

scale this LayoutTrack's coordinates by the x and y factors

Specified by:

scaleCoords in class LayoutTrackView

Parameters:

xFactor - the amount to scale X coordinates

yFactor - the amount to scale Y coordinates

translateCoords

public void translateCoords(double xFactor,
 double yFactor)

Description copied from class: LayoutTrackView

translate this LayoutTrack's coordinates by the x and y factors

Specified by:

translateCoords in class LayoutTrackView

Parameters:

xFactor - the amount to translate X coordinates

yFactor - the amount to translate Y coordinates

rotateCoords

public void rotateCoords(double angleDEG)

Description copied from class: LayoutTrackView

rotate this LayoutTrack's coordinates by angleDEG's

Specified by:

rotateCoords in class LayoutTrackView

Parameters:

angleDEG - the amount to rotate in degrees

findHitPointType

protected HitPointType findHitPointType(Point2D hitPoint,
 boolean useRectangles,
 boolean requireUnconnected)

Description copied from class: LayoutTrackView

find the hit (location) type for a point

Specified by:

findHitPointType in class LayoutTrackView

Parameters:

hitPoint - the point

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

requireUnconnected - whether to only return hit types for free connections

Returns:

the location type for the point (or NONE)

isTurnoutControlled

public boolean isTurnoutControlled()

setTurnoutControlled

public void setTurnoutControlled(boolean boo)

showPopup

@Nonnull
protected JPopupMenu showPopup(@Nonnull
 JmriMouseEvent mouseEvent)

Description copied from class: LayoutTrackView

show the popup menu for this layout track

Specified by:

showPopup in class LayoutTrackView

Parameters:

mouseEvent - the mouse down event that triggered this popup

Returns:

the popup menu for this layout track

showSlotPopUp

protected void showSlotPopUp(JmriMouseEvent e,
 int index)

setPosition

public void setPosition(int index)

getPosition

public int getPosition()

dispose

public void dispose()

remove

public void remove()

isActive

public boolean isActive()

drawDecorations

protected void drawDecorations(Graphics2D g2)

Description copied from class: LayoutTrackView

Draw track decorations

Specified by:

drawDecorations in class LayoutTrackView

Parameters:

g2 - the graphics context

draw1

protected void draw1(Graphics2D g2,
 boolean isMain,
 boolean isBlock)

Description copied from class: LayoutTrackView

draw one line (Ballast, ties, center or 3rd rail, block lines)

Specified by:

draw1 in class LayoutTrackView

Parameters:

g2 - the graphics context

isMain - true if drawing mainlines

isBlock - true if drawing block lines

draw2

protected void draw2(Graphics2D g2,
 boolean isMain,
 float railDisplacement)

Description copied from class: LayoutTrackView

draw two lines (rails)

Specified by:

draw2 in class LayoutTrackView

Parameters:

g2 - the graphics context

isMain - true if drawing mainlines

railDisplacement - the offset from center to draw the lines

highlightUnconnected

protected void highlightUnconnected(Graphics2D g2,
 HitPointType specificType)

Description copied from class: LayoutTrackView

highlight unconnected connections

Specified by:

highlightUnconnected in class LayoutTrackView

Parameters:

g2 - the graphics context

specificType - the specific connection to draw (or NONE for all)

drawTurnoutControls

protected void drawTurnoutControls(Graphics2D g2)

Description copied from class: LayoutTrackView

Draw the turnout controls

Specified by:

drawTurnoutControls in class LayoutTrackView

Parameters:

g2 - the graphics context

drawEditControls

protected void drawEditControls(Graphics2D g2)

Description copied from class: LayoutTrackView

draw the edit controls

Specified by:

drawEditControls in class LayoutTrackView

Parameters:

g2 - the graphics context

reCheckBlockBoundary

protected void reCheckBlockBoundary()

Description copied from class: LayoutTrackView

abstract method... subclasses should implement _IF_ they need to recheck their block boundaries

Specified by:

reCheckBlockBoundary in class LayoutTrackView

getLayoutConnectivity

protected List<LayoutConnectivity> getLayoutConnectivity()

Description copied from class: LayoutTrackView

get the layout connectivity for this track

Specified by:

getLayoutConnectivity in class LayoutTrackView

Returns:

the list of Layout Connectivity objects

checkForFreeConnections

public List<HitPointType> checkForFreeConnections()

Description copied from class: LayoutTrackView

return a list of the available connections for this layout track

Specified by:

checkForFreeConnections in class LayoutTrackView

Returns:

the list of available connections

checkForUnAssignedBlocks

public boolean checkForUnAssignedBlocks()

Description copied from class: LayoutTrackView

determine if all the appropriate blocks have been assigned to this track

Specified by:

checkForUnAssignedBlocks in class LayoutTrackView

Returns:

true if all appropriate blocks have been assigned

checkForNonContiguousBlocks

public void checkForNonContiguousBlocks(@Nonnull
 HashMap<String,List<Set<String>>> blockNamesToTrackNameSetsMap)

Description copied from class: LayoutTrackView

check this track and its neighbors for non-contiguous blocks

For each (non-null) blocks of this track do: #1) If it's got an entry in the blockNamesToTrackNameSetMap then #2) If this track is not in one of the TrackNameSets for this block #3) add a new set (with this block/track) to blockNamesToTrackNameSetMap and #4) check all the connections in this block (by calling the 2nd method below)

Basically, we're maintaining contiguous track sets for each block found (in blockNamesToTrackNameSetMap)

Specified by:

checkForNonContiguousBlocks in class LayoutTrackView

Parameters:

blockNamesToTrackNameSetsMap - hashmap of key:block names to lists of track name sets for those blocks

collectContiguousTracksNamesInBlockNamed

public void collectContiguousTracksNamesInBlockNamed(@Nonnull
 String blockName,
 @Nonnull
 Set<String> TrackNameSet)

Description copied from class: LayoutTrackView

recursive routine to check for all contiguous tracks in this blockName

Specified by:

collectContiguousTracksNamesInBlockNamed in class LayoutTrackView

Parameters:

blockName - the block that we're checking for

TrackNameSet - the set of track names in this block

setAllLayoutBlocks

public void setAllLayoutBlocks(LayoutBlock layoutBlock)

Description copied from class: LayoutTrackView

Assign all the layout blocks in this track

Specified by:

setAllLayoutBlocks in class LayoutTrackView

Parameters:

layoutBlock - to this layout block (used by the Tools menu's "Assign block to selection" item)

canRemove

public boolean canRemove()

Description copied from class: LayoutTrackView

Check for active block boundaries.

If any connection point of a layout track object has attached objects, such as signal masts, signal heads or NX sensors, the layout track object cannot be deleted.

Specified by:

canRemove in class LayoutTrackView

Returns:

true if the layout track object can be deleted.