-
Notifications
You must be signed in to change notification settings - Fork 331
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
c7b4a49
commit b4501e6
Showing
2 changed files
with
109 additions
and
0 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
109 changes: 109 additions & 0 deletions
109
java/src/jmri/jmrit/display/layoutEditor/package-info.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,109 @@ | ||
| /** | ||
| * The Layout Editor represents both structure and graphical display through a single set of objects. | ||
| * <p> | ||
| * A small sample layout:<br> | ||
| * <a href="doc-files/SidingImage.png"><img src="doc-files/SidingImage.png" alt="Simple layout example" height="25%" width="25%"></a> | ||
| * This is coded and stored as the following: (Some graphical attributes removed, reordered)<br> | ||
| <pre> | ||
| <layoutturnout ident="TO1" type="1" continuing="2" ver="1" connectaname="T3" connectbname="T2" connectcname="T1" class="jmri.jmrit.display.layoutEditor.configurexml.LayoutTurnoutXml" /> | ||
| <layoutturnout ident="TO2" type="2" continuing="2" ver="1" connectaname="T4" connectbname="T2" connectcname="T1" class="jmri.jmrit.display.layoutEditor.configurexml.LayoutTurnoutXml" /> | ||
| <tracksegment ident="T1" connect1name="TO1" type1="TURNOUT_C" connect2name="TO2" type2="TURNOUT_C" class="jmri.jmrit.display.layoutEditor.configurexml.TrackSegmentXml" /> | ||
| <tracksegment ident="T2" connect1name="TO1" type1="TURNOUT_B" connect2name="TO2" type2="TURNOUT_B" class="jmri.jmrit.display.layoutEditor.configurexml.TrackSegmentXml" /> | ||
| <tracksegment ident="T3" connect1name="EB1" type1="POS_POINT" connect2name="TO1" type2="TURNOUT_A" class="jmri.jmrit.display.layoutEditor.configurexml.TrackSegmentXml" /> | ||
| <tracksegment ident="T4" connect1name="TO2" type1="TURNOUT_A" connect2name="EC1" type2="POS_POINT" class="jmri.jmrit.display.layoutEditor.configurexml.TrackSegmentXml" /> | ||
| <positionablepoint ident="EB1" type="2" connect1name="T3" class="jmri.jmrit.display.layoutEditor.configurexml.PositionablePointXml" /> | ||
| <positionablepoint ident="EC1" type="3" connect1name="T4" linkedpanel="" linkpointid="" class="jmri.jmrit.display.layoutEditor.configurexml.PositionablePointXml" /> | ||
| </pre> | ||
| <p> | ||
| * <a href="doc-files/SidingConnections.png"><img src="doc-files/SidingConnections.png" alt="UML class diagram for package" height="33%" width="33%"></a> | ||
| * <p> | ||
| * For TrackSegment objects, a connection is represented by the name of the other end, and the type (in <code>type2</code> or <code>type2</code>) of the connection at the other end. | ||
| * For example, a connection in object T1 to a turnout might give the turnouts TO1 name, and that the connection is to the TURNOUT_C leg of that turnout. | ||
| * <p> | ||
| * Connections to END BUMPERs and EDGE CONNECTORs don't quite fit that. The far end sees the connection to the EB and EC as to a POS_POINT, not | ||
| * specifically a END BUMPER or EDGE CONNECTOR. There's no <code>type1</code> value representing the far end of the connection <u>from</u> the EB and EC either. | ||
| * But the EB and EC PositionablePoint knows what itself is through | ||
| * its <code>type</code> variable, and that can be queried by following the link as there's only one connection to a PositionablePoint. | ||
| * <p> | ||
| * Turnouts also have a <code>type</code> variable to represent at least whether they're RH or LH. | ||
| * <p> | ||
| * User-level documentation is available | ||
| * <a href="https://www.jmri.org/help/en/package/jmri/jmrit/display/LayoutEditor.shtml">here</a>. | ||
| * <!-- Put @see and @since tags down here. --> | ||
| * | ||
| */ | ||
| // include empty DefaultAnnotation to avoid excessive recompilation | ||
| @edu.umd.cs.findbugs.annotations.DefaultAnnotation(value={}) | ||
| package jmri.jmrit.display.layoutEditor; | ||
|
|
||
| /* | ||
| @startuml java/src/jmri/jmrit/display/layoutEditor/doc-files/SidingConnections.png | ||
| object TO1 { | ||
| type="1" | ||
| continuing="2" | ||
| ver="1" | ||
| connectaname="T3" | ||
| connectbname="T2" | ||
| connectcname="T1" | ||
| } | ||
| object TO2 { | ||
| type="2" | ||
| continuing="2" | ||
| ver="1" c | ||
| onnectaname="T4" | ||
| connectbname="T2" | ||
| connectcname="T1" | ||
| } | ||
| object T1 { | ||
| connect1name="TO1" | ||
| type1="TURNOUT_C" | ||
| connect2name="TO2" | ||
| type2="TURNOUT_C" | ||
| } | ||
| object T2 { | ||
| connect1name="TO1" | ||
| type1="TURNOUT_B" | ||
| connect2name="TO2" | ||
| type2="TURNOUT_B" | ||
| } | ||
| object T3 { | ||
| connect1name="EB1" | ||
| type1="POS_POINT" | ||
| connect2name="TO1" | ||
| type2="TURNOUT_A" | ||
| } | ||
| object T4 { | ||
| connect1name="TO2" | ||
| type1="TURNOUT_A" | ||
| connect2name="EC1" | ||
| type2="POS_POINT" | ||
| } | ||
| object EB1 { | ||
| type="2" | ||
| connect1name="T3" | ||
| } | ||
| object EC1 { | ||
| type="3" | ||
| connect1name="T4" | ||
| } | ||
| TO1 "C" o--o "C" T1 | ||
| TO1 "B" o--o "B" T2 | ||
| TO2 "C" o--o "C" T1 | ||
| TO2 "B" o--o "B" T2 | ||
| T3 "2" o--o "A" TO1 | ||
| T4 "1" o--o "A" TO2 | ||
| T3 "1" o--o EB1 | ||
| T4 "2" o--o EC1 | ||
| @end | ||
| */ | ||
|
|