Package jmri.jmrit.display.layoutEditor

Interface LayoutModels

All Known Implementing Classes:

LayoutEditor

public interface LayoutModels

This interface serves as a manager for the overall layout model via collections of i.e. LayoutTurnout, LayoutBlock, PositionablePoint, Track Segment, LayoutSlip and LevelXing objects along with their corresponding *View objects. (Having *View objects here, which are specific to a panel, may only be here as a temporary measure)

Provides a temporary setDirty()/isDirty() and redrawPanel() mechanism for marking changes. That may have to grow and/or change. For example, redrawPanel() (which could be renamed) might fire listeners to cause repaints.

See Also:

• LayoutEditorFindItems
• LayoutEditorAuxTools

Method Summary

Modifier and Type	Method	Description
void	addLayoutTrack(LayoutTrack trk, LayoutTrackView v)	Add a LayoutTrack and LayoutTrackView to the list of LayoutTrack family objects.
int	computeDirection(LayoutTrack trk1, HitPointType h1, LayoutTrack trk2, HitPointType h2)	Compute octagonal direction of vector from p1 to p2.
default int	computeDirectionAB(LayoutTurnout track)
default int	computeDirectionAC(LayoutTurnout track)
default int	computeDirectionAD(LayoutTurnout track)
default int	computeDirectionBC(LayoutTurnout track)
default int	computeDirectionBD(LayoutTurnout track)
default int	computeDirectionCD(LayoutTurnout track)
int	computeDirectionFromCenter(PositionablePoint p, LayoutTrack trk1, HitPointType h1)
int	computeDirectionToCenter(LayoutTrack trk1, HitPointType h1, PositionablePoint p)
default void	displayRemoveWarning(LayoutTrack track, List<String> itemList, String typeKey)	Invoked to display a warning about removal.
List<LayoutShape>	getLayoutShapes()
List<LayoutSlip>	getLayoutSlips()
List<LayoutTrack>	getLayoutTracks()	Read-only access to the list of LayoutTrack family objects.
Stream<LayoutTrack>	getLayoutTracksOfClass(Class<? extends LayoutTrack> layoutTrackClass)
LayoutTrackView	getLayoutTrackView(LayoutTrack trk)
List<LayoutTrackView>	getLayoutTrackViews()	Read-only access to the list of LayoutTrackView family objects.
Stream<LayoutTrackView>	getLayoutTrackViewsOfClass(Class<? extends LayoutTrackView> layoutTrackViewClass)
List<LayoutTurnout>	getLayoutTurnouts()
List<LayoutTurnout>	getLayoutTurnoutsAndSlips()
LayoutTurnoutView	getLayoutTurnoutView(LayoutTurnout to)
List<LayoutTurntable>	getLayoutTurntables()
LayoutTurntableView	getLayoutTurntableView(LayoutTurntable to)
LayoutEditorAuxTools	getLEAuxTools()
List<LevelXing>	getLevelXings()
LevelXingView	getLevelXingView(LevelXing xing)
List<LevelXingView>	getLevelXingViews()
List<PositionablePoint>	getPositionablePoints()
PositionablePointView	getPositionablePointView(PositionablePoint to)
List<PositionablePointView>	getPositionablePointViews()
List<TrackSegment>	getTrackSegments()
TrackSegmentView	getTrackSegmentView(TrackSegment to)
List<TrackSegmentView>	getTrackSegmentViews()
boolean	isDirty()	Check the dirty state
void	redrawPanel()	A change has happen that might not need to be stored, but should cause the presentation to be updated.
void	removeLayoutTrack(LayoutTrack trk)	If item present, delete from the list of LayoutTracks and force a dirty redraw.
void	setDirty()

Method Details

isDirty

boolean isDirty()

Check the dirty state

Returns:

true if contents of models have changed,

setDirty

void setDirty()

redrawPanel

void redrawPanel()

A change has happen that might not need to be stored, but should cause the presentation to be updated.

getLEAuxTools

@Nonnull
LayoutEditorAuxTools getLEAuxTools()

getLayoutTracksOfClass

@Nonnull
Stream<LayoutTrack> getLayoutTracksOfClass(Class<? extends LayoutTrack> layoutTrackClass)

getLayoutTrackViewsOfClass

@Nonnull
Stream<LayoutTrackView> getLayoutTrackViewsOfClass(Class<? extends LayoutTrackView> layoutTrackViewClass)

getPositionablePointViews

@Nonnull
List<PositionablePointView> getPositionablePointViews()

getPositionablePoints

@Nonnull
List<PositionablePoint> getPositionablePoints()

getLayoutSlips

@Nonnull
List<LayoutSlip> getLayoutSlips()

getTrackSegmentViews

@Nonnull
List<TrackSegmentView> getTrackSegmentViews()

getTrackSegments

@Nonnull
List<TrackSegment> getTrackSegments()

getLayoutTurnouts

@Nonnull
List<LayoutTurnout> getLayoutTurnouts()

getLayoutTurntables

@Nonnull
List<LayoutTurntable> getLayoutTurntables()

getLevelXings

@Nonnull
List<LevelXing> getLevelXings()

getLevelXingViews

@Nonnull
List<LevelXingView> getLevelXingViews()

getLayoutTracks

@Nonnull
List<LayoutTrack> getLayoutTracks()

Read-only access to the list of LayoutTrack family objects. The returned list will throw UnsupportedOperationException if you attempt to modify it.

Returns:

unmodifiable copy of layout track list.

getLayoutTrackViews

@Nonnull
List<LayoutTrackView> getLayoutTrackViews()

Read-only access to the list of LayoutTrackView family objects. The returned list will throw UnsupportedOperationException if you attempt to modify it.

Returns:

unmodifiable copy of track views.

getLayoutTrackView

LayoutTrackView getLayoutTrackView(LayoutTrack trk)

getLevelXingView

LevelXingView getLevelXingView(LevelXing xing)

getLayoutTurnoutView

LayoutTurnoutView getLayoutTurnoutView(LayoutTurnout to)

getLayoutTurntableView

LayoutTurntableView getLayoutTurntableView(LayoutTurntable to)

getTrackSegmentView

TrackSegmentView getTrackSegmentView(TrackSegment to)

getPositionablePointView

PositionablePointView getPositionablePointView(PositionablePoint to)

addLayoutTrack

void addLayoutTrack(@Nonnull
 LayoutTrack trk,
 @Nonnull
 LayoutTrackView v)

Add a LayoutTrack and LayoutTrackView to the list of LayoutTrack family objects.

Parameters:

trk - to be stored

v - corresponding view

removeLayoutTrack

void removeLayoutTrack(@Nonnull
 LayoutTrack trk)

If item present, delete from the list of LayoutTracks and force a dirty redraw.

Parameters:

trk - the layout track to remove.

getLayoutTurnoutsAndSlips

@Nonnull
List<LayoutTurnout> getLayoutTurnoutsAndSlips()

getLayoutShapes

@Nonnull
List<LayoutShape> getLayoutShapes()

computeDirection

int computeDirection(@Nonnull
 LayoutTrack trk1,
 @Nonnull
 HitPointType h1,
 @Nonnull
 LayoutTrack trk2,
 @Nonnull
 HitPointType h2)

Compute octagonal direction of vector from p1 to p2.

The octagonal (8) directions are: North, North-East, East, South-East, South, South-West, West and North-West; see Path for more on this.

This method must eventually be in terms _other_ than the screen geometry of the associated LayoutTrackView objects, as it's meant to be the track connectivity direction not the on the screen implementation.

Parameters:

trk1 - track at "from" end

h1 - the hit point for "from" end

trk2 - the track at the "to" end

h2 - the hit at the "to" end

Returns:

the octagonal direction from p1 to p2

computeDirectionToCenter

int computeDirectionToCenter(@Nonnull
 LayoutTrack trk1,
 @Nonnull
 HitPointType h1,
 @Nonnull
 PositionablePoint p)

computeDirectionFromCenter

int computeDirectionFromCenter(@Nonnull
 PositionablePoint p,
 @Nonnull
 LayoutTrack trk1,
 @Nonnull
 HitPointType h1)

computeDirectionAB

default int computeDirectionAB(@Nonnull
 LayoutTurnout track)

computeDirectionAC

default int computeDirectionAC(@Nonnull
 LayoutTurnout track)

computeDirectionAD

default int computeDirectionAD(@Nonnull
 LayoutTurnout track)

computeDirectionBC

default int computeDirectionBC(@Nonnull
 LayoutTurnout track)

computeDirectionBD

default int computeDirectionBD(@Nonnull
 LayoutTurnout track)

computeDirectionCD

default int computeDirectionCD(@Nonnull
 LayoutTurnout track)

displayRemoveWarning

default void displayRemoveWarning(LayoutTrack track,
 List<String> itemList,
 String typeKey)

Invoked to display a warning about removal. Lists the attached items that prevent removing the layout track item.

The default implementation refers this to a View object for displaying a Dialog.

Parameters:

track - The involved track

itemList - A list of the attached heads, masts and/or sensors.

typeKey - The object type such as Turnout, Level Crossing, etc.