How to Use Layers

From TrainzOnline
(Difference between revisions)
Jump to: navigation, search
m (The "route-layer")
m (Route Layers vs Session Layers)
(203 intermediate revisions by one user not shown)
Line 1: Line 1:
 +
The information in this Wiki Page applies to both '''TANE''' and '''TRS19'''.
  
 
+
__TOC__
<table>
+
='''What Are Layers?'''=
<tr>
+
<table cellpadding="4" bgcolor=#c1e7e7>
<td align="center">[[file:Under Construction.JPG]]</td>
+
<tr valign="top">
 +
<td colspan=2><font size=3><b>In Summary:</b></font></td>
 
</tr>
 
</tr>
</table>
 
 
----
 
<table>
 
 
<tr valign="top">
 
<tr valign="top">
 
<td>[[file:DotPoint.JPG]]</td>
 
<td>[[file:DotPoint.JPG]]</td>
Line 18: Line 16:
 
</tr>
 
</tr>
 
</table>
 
</table>
----
+
 
 +
Layers can contain any objects, visible and invisible, that can be placed into a layout using the Surveyor '''Object''', '''Track''' and '''Train''' tools. The layers and their contents can be hidden from view or locked against alteration whenever required. Their main use is in the development of a Route and a Session but they can also be used as a way of providing some additional novelty during a Driver session.
 +
<br>
  
 
='''The Layers Tool'''=
 
='''The Layers Tool'''=
Line 28: Line 28:
 
<td>Click the '''Layers Tool''' to open up its properties.<br>
 
<td>Click the '''Layers Tool''' to open up its properties.<br>
 
[[file:LayersTools.JPG|480px]]</td>
 
[[file:LayersTools.JPG|480px]]</td>
 +
<td><br><br>
 +
<table cellpadding="4" bgcolor=#ffffb0>
 +
<tr valign="top">
 +
<td>[[file:NotePad.PNG]]</td>
 +
<td><font size="3">'''Notes:'''</font><br>
 +
The layers are organised into two groups:-
 +
*'''Route Layers''' in the top group, and
 +
*'''Session Layers''' in the lower group.
 +
Each group can contain multiple layers - the scroll bars next to the layer names shown on the left indicate that there are more layers in each group than can fit into the display window area.</td>
 +
</tr>
 +
</table></td>
 
</tr>
 
</tr>
 
</table>
 
</table>
 
<br>
 
<br>
The layers are organised into two groups:-
 
*'''Route Layers''' in the top group, and
 
*'''Session Layers''' in the lower group.
 
With the '''Layer Tools''' (Add, Delete, Merge and Lock) below them.
 
  
Each group can contain multiple layers - the scroll bars next to the layer names in the example above indicates that there are more layers in each group.
+
==Loading a Route and Loading a Session==
  
=='''Loading a Route and Loading a Session'''==
+
The layers you see will depend on whether you have loaded a '''Route''' by itself (with no "child" Session) or a '''Session''' and its "parent" Route.
The layers you will see will depend on whether you have loaded into Surveyor a '''Route''' by itself (with no "child" Session) or a '''Session''' and its "parent" Route.
+
  
 
<table>
 
<table>
Line 46: Line 52:
 
<td>[[file:LayersToolsSession.JPG]]</td>
 
<td>[[file:LayersToolsSession.JPG]]</td>
 
<td><br>
 
<td><br>
*The image on the left gives an example of the layers that can appear if a '''Route only''' is loaded into Surveyor. These are the layers that are saved with the Route. '''Note that a default "session-layer" is present'''. An '''empty''' default "session-layer" is always added when only the Route is loaded into Surveyor.
+
*The first image on the left gives an example of the layers that can appear if a '''Route only''' is loaded into Surveyor. These are the layers that are saved with the Route. '''Note that a default "session-layer" is present'''.  
*The image on the right gives an example of the layers that can appear if a '''Session based on that Route''' is loaded into Surveyor. It shows Route Layers and Session Layers.<br><br>
+
<table cellpadding="4" bgcolor=#c1e7e7>
 +
<tr valign="top">
 +
<td>[[file:DotPoint.JPG]]</td>
 +
<td>'''An empty default "session-layer" is always created in the Session Layers Group when only the Route is loaded into Surveyor.'''<td>
 +
</tr>
 +
</table>
 +
*The second image on the left gives an example of the layers that can appear if a '''Session based on that Route''' is loaded into Surveyor. It shows Route Layers and Session Layers.<br><br>
  
In both cases, the '''Route Layers''' are identical because the same Route has been loaded. A Session contains its own layers, the '''Session Layers''', that are saved with the Session but are not saved with the Route.
+
In both cases, the '''Route Layers''' are identical because the same Route has been loaded. A Session contains its own layers, the '''Session Layers''', that are loaded and saved with the Session but are not loaded or saved with the Route.
 
<br><br>
 
<br><br>
----
+
<table cellpadding="4" bgcolor=#c1e7e7 width="730">
<table>
+
<tr valign="top">
 +
<td colspan=2><font size=3><b>In Summary:</b></font></td>
 +
</tr>
 
<tr valign="top">
 
<tr valign="top">
 
<td>[[file:DotPoint.JPG]]</td>
 
<td>[[file:DotPoint.JPG]]</td>
Line 63: Line 77:
 
<tr valign="top">
 
<tr valign="top">
 
<td>[[file:DotPoint.JPG]]</td>
 
<td>[[file:DotPoint.JPG]]</td>
<td>'''If you load just the Route and edit its "session-layer" then those edits will not appear the next time you load just the Route''' because an empty "session-layer" is created each time a Route is loaded without a Session.<td>
+
<td>'''If you load just the Route and edit its "session-layer" then those edits will not appear the next time you load just the Route''' because an empty "session-layer" is created each time a Route is loaded without a Session.<br><br>
</tr>
+
</table>
+
----
+
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
 
 
<br>
 
<br>
 
+
<table cellpadding="4" bgcolor=#fcbcbc>
<table>
+
<tr>
+
<td colspan="2"><font size="3">An important lesson here is:-</font><br><br></td>
+
</tr>
+
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:DotPoint.JPG]]</td>
+
<td>[[file:Stop.PNG]]</td>
<td><font size="4">
+
<td><font size=3><b>WARNING:</b></font></td>
'''If you load a <u>ROUTE</u> without a SESSION then only <u>edit the Route Layers</u>'''</font><br><br></td>
+
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:DotPoint.JPG]]</td>
+
<td></td>
<td><font size="4">
+
<td><font size="4">'''If you load a <u>ROUTE</u> without a SESSION then only <u>edit the Route Layers</u>'''</font></td>
'''If you load a <u>SESSION</u> then you can <u>edit the Route Layers AND the Session Layers</u></font>'''<td>
+
</tr>
 +
</table>
 +
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
 
<br>
 
<br>
  
=='''Creating a New Route'''==
+
==Creating a New Route==
When a brand new route is created it will come with two layers, a single "route-layer" and a single "session-layer".
+
 
 
<table>
 
<table>
 
<tr valign="top">
 
<tr valign="top">
 
<td>[[file:LayersNewRoute.JPG]]</td>
 
<td>[[file:LayersNewRoute.JPG]]</td>
 
<td>
 
<td>
 +
<table cellpadding="4" bgcolor=#ffffb0>
 +
<tr valign="top">
 +
<td>[[file:NotePad.PNG]]</td>
 +
<td><font size="3">'''Notes:'''</font><br>
 +
*When a brand new route is created it will come with two layers, a single "route-layer" and a single "session-layer".
 
*Both layers will be empty (the baseboard with its grid is saved with the route but is not in any layer).
 
*Both layers will be empty (the baseboard with its grid is saved with the route but is not in any layer).
*A layer can be renamed at anytime by double clicking on its name with the left mouse button and typing a new name.
+
</td>
<br>
+
</tr>
----
+
</table>
<table>
+
<table cellpadding="4" bgcolor=#ffffb0>
 +
<tr valign="top">
 +
<td>[[file:PencilTips.PNG]]</td>
 +
<td>'''A layer can be renamed at anytime by double clicking on its name with the left mouse button and typing a new name.'''</td>
 +
</tr>
 +
</table></td>
 +
</tr>
 +
</table>
 +
 
 +
==The "Active Layer"==
 +
<table cellpadding="4" bgcolor=#c1e7e7>
 +
<tr valign="top">
 +
<td colspan=2><font size=3><b>In Summary:</b></font></td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[file:DotPoint.JPG]]</td>
 +
<td>'''The ''Active Layer'' is the selected (highlighted) layer.'''</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[file:DotPoint.JPG]]</td>
 +
<td>When you load the '''Route only''' into Surveyor, the '''first Route layer''' will be the '''Active Layer'''</td>
 +
</tr>
 
<tr valign="top">
 
<tr valign="top">
 
<td>[[file:DotPoint.JPG]]</td>
 
<td>[[file:DotPoint.JPG]]</td>
<td>The '''Active Layer''' is the highlighted layer. You can change the '''Active Layer''' by clicking on the name of another layer.</td>
+
<td>When you load a '''Session''' into Surveyor, the '''first Session layer''' will be the '''Active Layer'''</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
----
+
In the image above, the '''route-layer''' is the '''Active Layer'''. You can change the '''Active Layer''' at any time by clicking on the name of another layer.
 
<br>
 
<br>
The Active Layer is the "working layer" which is:-
+
<table cellpadding="4" bgcolor=#ffffb0 width="480">
 +
<tr valign="top">
 +
<td>[[file:NotePad.PNG]]</td>
 +
<td><font size="3">'''Notes:'''</font><br>
 +
The '''Active Layer''' is the "working layer" which is:-
 
*where new objects will be added to the layout
 
*where new objects will be added to the layout
*the layer selected for merging and deleting
+
*the layer that is automatically selected for merging and deleting</td>
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
 +
<table cellpadding="4" bgcolor=#fcbcbc width="480">
 +
<tr valign="top">
 +
<td colspan=2><font size=3><b>Caution:</b></font></td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[file:Stop.PNG]]</td>
 +
<td>'''TRS19/TANE''' do not identify which is the '''Active Layer''' in Surveyor and this often leads to problems such as objects being added to the wrong layer.<br>
 +
See [[file:PageLink.PNG]] '''[[#Adding Objects To Layers|Adding Objects To Layers]]''' below for more information.</td>
 +
</tr>
 +
</table>
 +
<br>
  
=='''Adding a New Layer'''==
+
==Adding a New Layer==
  
 
<table>
 
<table>
Line 124: Line 171:
 
</table>
 
</table>
  
A '''New Layer''' dialogue window will appear.  
+
An '''Add layer''' dialogue window will appear.  
  
 
<table>
 
<table>
Line 130: Line 177:
 
<td>[[file:LayersAddLayer.JPG]]</td>
 
<td>[[file:LayersAddLayer.JPG]]</td>
 
<td>
 
<td>
*Enter a name for the new layer and select the layer group, '''Route''' or '''Session''', where it will be placed.
+
<table cellpadding="4" bgcolor=#ffffff>
*You can easily move the layer to the other layer group later if you change your mind.
+
<tr>
*A layer can be renamed at anytime by double clicking on its name in the layer list and typing a new name.</td>
+
<td colspan="2">
 +
----</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[file:Steps.PNG]]</td>
 +
<td><font size="3">'''Steps:'''</font><br>
 +
#Enter a name for the new layer
 +
#Select the layer group, '''Route''' or '''Session''', where it will be placed
 +
#Click the [[file:Tick.PNG]] icon</td>
 +
</tr>
 +
<tr>
 +
<td colspan="2">
 +
----</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
Click the '''Tick''' button to accept the changes.
+
<table cellpadding="4" bgcolor=#ffffb0>
 +
<tr valign="top">
 +
<td>[[file:PencilTips.PNG]]</td>
 +
<td>You can easily rename the layer or move it to the other layer group later if you change your mind.</td>
 +
</tr>
 +
</table></td>
 +
</tr>
 +
</table>
 +
 
 +
==Deleting a Layer==
  
=='''Deleting a Layer'''==
 
 
<table>
 
<table>
 
<tr>
 
<tr>
 
<td>[[file:LayersToolButtonsDELETE.JPG]]</td>
 
<td>[[file:LayersToolButtonsDELETE.JPG]]</td>
<td>Select the layer to be deleted and click the '''Delete Button'''</td>
+
<td>Select the layer to be deleted and click the '''Delete Button'''. If you don't select a layer to delete then '''TRS19/TANE''' will select the current '''Active Layer'''.</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
----
+
<br>
<table>
+
<table cellpadding="4" bgcolor=#fcbcbc>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:DotPoint.JPG]]</td>
+
<td colspan=2><font size=3><b>Warning:</b></font></td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[file:Stop.PNG]]</td>
 
<td>'''Deleting a layer will delete ALL the objects placed in that layer''' except objects that are "Bound" to that layer.</td>
 
<td>'''Deleting a layer will delete ALL the objects placed in that layer''' except objects that are "Bound" to that layer.</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
----
 
  
 
If the layer being deleted is empty, then the following dialogue window will appear:-
 
If the layer being deleted is empty, then the following dialogue window will appear:-
Line 158: Line 227:
 
<tr>
 
<tr>
 
<td>[[file:LayerDeleteEmpty.JPG]]</td>
 
<td>[[file:LayerDeleteEmpty.JPG]]</td>
 +
<td>
 +
<table cellpadding="4" bgcolor=#ffffff>
 +
<tr>
 +
<td colspan="2">
 +
----</td>
 
</tr>
 
</tr>
</table>
+
<tr valign="top">
 +
<td>[[file:Choices.PNG]]</td>
 +
<td><font size="3">'''Choices:'''</font><br>
 
*Click '''Yes''' to delete the layer
 
*Click '''Yes''' to delete the layer
*Click '''No''' to cancel the delete operation
+
*Click '''No''' to cancel the delete operation</td>
 +
</tr>
 +
<tr>
 +
<td colspan="2">
 +
----</td>
 +
</tr>
 +
</table></td>
 +
</tr>
 +
</table>
  
 
If the layer being deleted is NOT empty, then the following dialogue window will appear:-
 
If the layer being deleted is NOT empty, then the following dialogue window will appear:-
Line 168: Line 252:
 
<tr>
 
<tr>
 
<td>[[file:LayerDeleteNotEmpty.JPG]]</td>
 
<td>[[file:LayerDeleteNotEmpty.JPG]]</td>
 +
<td>
 +
<table cellpadding="4" bgcolor=#ffffff>
 +
<tr>
 +
<td colspan="2">
 +
----</td>
 
</tr>
 
</tr>
</table>
+
<tr valign="top">
 +
<td>[[file:Choices.PNG]]</td>
 +
<td><font size="3">'''Choices:'''</font><br>
 
*Click '''Merge''' to merge this layer and its contents into another layer. See '''Merging Layers''' below for more information  
 
*Click '''Merge''' to merge this layer and its contents into another layer. See '''Merging Layers''' below for more information  
 
*Click '''Delete''' to delete the layer and its contents. '''This cannot be undone'''
 
*Click '''Delete''' to delete the layer and its contents. '''This cannot be undone'''
*Click '''Cancel''' to cancel the delete operation
+
*Click '''Cancel''' to cancel the delete operation</td>
 +
</tr>
 +
<tr>
 +
<td colspan="2">
 +
----</td>
 +
</tr>
 +
</table></td>
 +
</tr>
 +
</table>
 +
 
 +
==Merging Layers==
  
=='''Merging Layers'''==
 
 
<table>
 
<table>
 
<tr>
 
<tr>
 
<td>[[file:LayersToolButtonsMERGE.JPG]]</td>
 
<td>[[file:LayersToolButtonsMERGE.JPG]]</td>
<td>Select the layer to be merged into another layer and click the '''Merge Button'''</td>
+
<td>Select the layer to be merged into another layer and click the '''Merge Button'''. If you don't select a layer to merge then '''TRS19/TANE''' will select the current '''Active Layer'''.</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
----
+
<table cellpadding="4" bgcolor=#c1e7e7>
<table>
+
<tr valign="top">
 +
<td colspan=2><font size=3><b>In Summary:</b></font></td>
 +
</tr>
 
<tr valign="top">
 
<tr valign="top">
 
<td>[[file:DotPoint.JPG]]</td>
 
<td>[[file:DotPoint.JPG]]</td>
Line 192: Line 294:
 
</tr>
 
</tr>
 
</table>
 
</table>
----
 
 
The program will '''assume''' that the currently selected '''Active Layer''' is the layer that will be merged into another layer.
 
  
 
The layer merge dialogue window will appear as shown below:-
 
The layer merge dialogue window will appear as shown below:-
Line 202: Line 301:
 
<td>[[file:LayersMergeInto.JPG]]</td>
 
<td>[[file:LayersMergeInto.JPG]]</td>
 
<td>
 
<td>
*Select the '''destination layer''' for the merge and then click the '''Tick'''
+
<table cellpadding="4" bgcolor=#ffffff>
*The '''Merge into:''' list shows all the available layers with no distinction between Route Layers and Session Layers<br>
+
<tr>
 +
<td colspan="2">
 +
----</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[file:Steps.PNG]]</td>
 +
<td><font size="3">'''Steps:'''</font><br>
 +
#Select the '''destination layer''' for the merge
 +
#Click the [[file:Tick.PNG]] icon
 +
The '''Merge into:''' list shows all the available layers with no distinction between Route Layers and Session Layers</td>
 +
</tr>
 +
<tr>
 +
<td colspan="2">
 +
----</td>
 +
</tr>
 +
</table>
 +
<br>
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
=='''Locking Layers'''==
+
==Locking Layers==
  
----
+
<table cellpadding="4" bgcolor=#ffffb0>
<table>
+
<tr valign="top">
 +
<td>[[file:PencilTips.PNG]]</td>
 +
<td>It is good practice to '''LOCK ALL LAYERS that you are not currently editing.''' This will avoid the all too common problem of accidentally adding objects to the wrong layer.</td>
 +
</tr>
 +
</table>
 +
<br>
 +
<table cellpadding="4" bgcolor=#c1e7e7>
 
<tr valign="top">
 
<tr valign="top">
 
<td>[[file:DotPoint.JPG]]</td>
 
<td>[[file:DotPoint.JPG]]</td>
<td>It is good practice to '''LOCK ALL LAYERS that you are not working with.''' This will avoid the all too common problem of accidentally adding objects to the wrong layer.</td>
+
<td>If you '''LOCK''' or '''UNLOCK''' a Route Layer while editing a Session then you will have made a change to the Route and will be asked to save both the Route and the Session when you exit Surveyor.</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
----
+
<br>
 
+
Note that if you LOCK or UNLOCK a Route Layer while editing a Session then you will have made a change to the Route and will be asked to save both the Route and the Session when you exit Surveyor.
+
 
+
 
===Locking Individual Layers===
 
===Locking Individual Layers===
'''To LOCK an individual layer, click on the ''Open Padlock'' icon next to its name.''' The objects in a LOCKED layer cannot be moved or deleted.
+
 
 +
'''To LOCK an individual layer, click on the ''Open Padlock'' icon next to its name.''' The layer being locked does not have to be the current '''Active Layer'''.
 +
<table cellpadding="4" bgcolor=#c1e7e7>
 +
<tr valign="top">
 +
<td>[[file:DotPoint.JPG]]</td>
 +
<td>'''The objects in a LOCKED layer cannot be moved or deleted''' but they can be moved to other layers.</td>
 +
</tr>
 +
</table>
  
 
<table>
 
<table>
Line 229: Line 354:
 
<td>[[file:LayersRouteTreesActiveLocked.JPG]]</td>
 
<td>[[file:LayersRouteTreesActiveLocked.JPG]]</td>
 
<td><br>
 
<td><br>
*The image on the left shows two Route Layers, both UNLOCKED with their Padlock icons '''Open'''. One layer, "Trees", is highlighted showing that it is the currently active layer.
+
*The first image on the left shows two Route Layers, both UNLOCKED with their Padlock icons '''Open'''. One layer, "Trees", is highlighted showing that it is the currently active layer.
*The image on the right shows the same two layers after the "Trees" layer has been LOCKED. It can be UNLOCKED by clicking its Closed Padlock icon.<br><br>
+
*The second image on the left shows the same two layers after the "Trees" layer has been LOCKED.  
 +
*A locked layer can be UNLOCKED by clicking its Closed Padlock icon.<br><br>
 
</td>
 
</td>
 
</tr>
 
</tr>
Line 238: Line 364:
 
<tr valign="top">
 
<tr valign="top">
 
<td>[[file:LayersRouteTreesActiveLockedError.JPG]]<br>
 
<td>[[file:LayersRouteTreesActiveLockedError.JPG]]<br>
Clicking the '''Tick''' button will UNLOCK the layer</td>
+
*Click the [[file:Tick.PNG]] icon to UNLOCK the layer</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
 
===Locking ALL Route Layers===
 
===Locking ALL Route Layers===
 +
 
<table>
 
<table>
 
<tr>
 
<tr>
Line 254: Line 381:
 
The Route Layers Group can be UNLOCKED by clicking the '''Lock Button''' again.
 
The Route Layers Group can be UNLOCKED by clicking the '''Lock Button''' again.
  
=='''Moving a Layer'''==
+
==Moving a Layer==
To move a layer simply select it, hold the left mouse button down and drag the layer up or down to its new position.
+
<table cellpadding="4" bgcolor=#c1e7e7>
 +
<tr valign="top">
 +
<td colspan=2><font size=3><b>Main Points:</b></font></td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[file:DotPoint.JPG]]</td>
 +
<td>Layers can be moved up or down<br>
 +
* within the same layer group (e.g. '''Route''' or '''Session''')
 +
* between the two groups</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[file:DotPoint.JPG]]</td>
 +
<td>A layer containing track objects (e.g. signals, switches, etc) '''CANNOT''' be placed above the layer containing the track</td>
 +
</tr>
 +
</table>
  
In the example show below a layer created in the Route Layers Group is being moved into the Session Layers Group.
+
In the example shown below a layer created in the Route Layers Group is being moved into the Session Layers Group.
 
<table>
 
<table>
 
<tr valign="top">
 
<tr valign="top">
Line 263: Line 404:
 
<td>[[file:LayersMove3.JPG]]</td>
 
<td>[[file:LayersMove3.JPG]]</td>
 
<td>
 
<td>
 +
<table cellpadding="4" bgcolor=#ffffff>
 +
<tr>
 +
<td colspan="2">
 +
----</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[file:Steps.PNG]]</td>
 +
<td><font size="3">'''Steps:'''</font><br>
 +
#Select the layer to be moved and hold down the left mouse button
 +
#Drag the layer up or down to its new position
 +
</td>
 +
</tr>
 +
<tr>
 +
<td colspan="2">
 +
----</td>
 +
</tr>
 +
</table>
 +
 
*The move can be between layer groups as shown left or within groups to move the layer to a higher or lower position in the group.
 
*The move can be between layer groups as shown left or within groups to move the layer to a higher or lower position in the group.
 
*The only situation where layer order within a layer group makes any difference is when adding track objects (e.g. signals, track signs, etc) to a track.
 
*The only situation where layer order within a layer group makes any difference is when adding track objects (e.g. signals, track signs, etc) to a track.
 
<br>
 
<br>
----
+
<table cellpadding="4" bgcolor=#c1e7e7>
<table>
+
 
<tr valign="top">
 
<tr valign="top">
 
<td>[[file:DotPoint.JPG]]</td>
 
<td>[[file:DotPoint.JPG]]</td>
<td>When adding track objects to a track, the '''track must be in the same layer or in a higher layer''' than the object that is being added</td>
+
<td>When adding track objects to a track, the '''object being added must be in the same layer or in a layer below''' the layer containing the track. For more information, see the section [[file:PageLink.PNG]] '''[[#The "route-layer"|The "route-layer"]]''' below.</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[file:DotPoint.JPG]]</td>
 +
<td>If you attempt to move a layer containing track objects, such as signals, to a position above the layer containing the track, you will get an error message.</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
----
 
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
=='''Hiding Layers'''==
+
==Hiding Layers==
 +
 
 
To hide or show a layer click the '''Eye Icon''' next to its name.
 
To hide or show a layer click the '''Eye Icon''' next to its name.
  
Line 286: Line 448:
 
<td>
 
<td>
 
*In the image shown left the two trees are in different Route Layers
 
*In the image shown left the two trees are in different Route Layers
*Both layers have their '''Eye Icons''' set to '''Show'''
+
*All the layers have their '''Eye Icons''' set to '''Show'''
 
</td>
 
</td>
 
</tr>
 
</tr>
Line 292: Line 454:
 
<td>[[file:LayersHideTree.JPG]]</td>
 
<td>[[file:LayersHideTree.JPG]]</td>
 
<td>
 
<td>
*In the image shown left the '''Trees''' layer has its '''Eye Icon''' set to '''Hide'''
+
*In the image shown left the '''Trees''' layer has its '''Eye Icon''' set to '''Hide'''<br><br>
 +
<table cellpadding="4" bgcolor=#c1e7e7>
 +
<tr valign="top">
 +
<td>[[file:DotPoint.JPG]]</td>
 +
<td>'''If you attempt to add an object to a hidden layer you will receive a warning message.'''</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[file:DotPoint.JPG]]</td>
 +
<td>'''Layers that are hidden when saved in ''Surveyor'' will also be hidden when loaded in ''Driver''.'''<td>
 +
</tr>
 +
</table>
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
 +
<br>
  
 
='''Route Layers vs Session Layers'''=
 
='''Route Layers vs Session Layers'''=
Line 301: Line 474:
 
This topic has filled endless threads in the '''Trainz Forums''' with arguments raging on both sides.
 
This topic has filled endless threads in the '''Trainz Forums''' with arguments raging on both sides.
  
There are no "cast iron" rules that dictate what should be placed in the '''Route Layers Group''' and what should be placed in the '''Session Layers Group'''. Each Route and Session will be different and different creators have different ways of working. The main question to be asked is how many different '''Sessions''' will be created using a particular '''Route'''?
+
<table cellpadding="4" bgcolor=#c1e7e7>
 
+
<tr valign="top">
 +
<td colspan=2><font size=3><b>In Summary:</b></font></td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[file:DotPoint.JPG]]</td>
 +
<td>There are no "cast iron" rules that dictate what should be placed in the '''Route Layers Group''' and what should be placed in the '''Session Layers Group'''. Each Route and Session will be different and different creators have different ways of working. The main question to be asked is how many different '''Sessions''' will be created using a particular '''Route'''?</td>
 +
</tr>
 +
</table>
 +
<br>
 +
<table cellpadding="4" bgcolor=#ffffb0>
 +
<tr valign="top">
 +
<td>[[file:NotePad.PNG]]</td>
 +
<td><font size="3">'''Notes:'''</font><br>
 
*'''For a Route with only a single Session''' - everything can safely go into the '''Route Layers Group'''
 
*'''For a Route with only a single Session''' - everything can safely go into the '''Route Layers Group'''
:Many creators only ever build a single Session for each of their Routes so they do not use Session Layers at all.
+
:Many creators only ever build a single Session for each of their Routes and do not use Session Layers at all (but they still have to save the session separately from the route).  
 
*'''For a Route with multiple (2 or more) Sessions''' - certain things will probably need to go into the '''Session Layers Group''' for each Session.
 
*'''For a Route with multiple (2 or more) Sessions''' - certain things will probably need to go into the '''Session Layers Group''' for each Session.
:Many creators build multiple Sessions for each Route and rely on the Session Layers to provide the differences between their Sessions.  
+
:Many creators build multiple Sessions for each Route and rely on the Session Layers to create the differences between their Sessions.  
===The Route Layer Group===
+
</td>
----
+
</tr>
<table>
+
</table>
 +
<br>
 +
==The Route Layers Group==
 +
<table cellpadding="4" bgcolor=#c1e7e7>
 
<tr valign="top">
 
<tr valign="top">
 
<td>[[file:DotPoint.JPG]]</td>
 
<td>[[file:DotPoint.JPG]]</td>
<td>The '''Route Layer Group''' should be used for everything that will always appear in '''Driver Mode''' regardless of which Session is playing.</td>
+
<td>The '''Route Layer Group''' should be used for everything that will always appear in '''Driver Mode''' regardless of which Session is playing.''' </td>
 
</tr>
 
</tr>
 
</table>
 
</table>
----
+
There is nothing stopping you from placing everything in the "route-layer" of the '''Route Layers Group''' and never having to worry about dealing with layers ever again - some creators prefer to work this way. However, layers do provide you with a way of organising your scenery objects to make them more manageable, particularly in more complicated layouts. Some examples:-
There is nothing stopping you from placing everything in the "route-layer" and never having to worry about dealing with layers ever again - some creators prefer to work this way. However, layers do provide you with a way of organising your scenery objects to make them more manageable, particularly in more complicated Routes. Some examples:-
+
*A '''Special Objects''' layer or layers that can be used to hold certain scenery objects. For example all the trees or a particular building. This can be very useful when you need to hide those objects to locate or place other objects. Trackside cameras in particular can be very difficult to find when placed in a forest.
*A '''Special Objects''' layer or layers that can be used to hold a certain type or types of scenery objects. For example all the trees. This can be very useful when you need to hide those objects to locate or place other objects. Trackside cameras in particular can be very difficult to find when placed in a forest.
+
 
*A '''Platform Objects''' layer can be used to hold all platform items such as seats, luggage, luggage trolleys, people, lamp posts, etc. Because these items are placed on top of a platform object they can be very difficult to move or delete without first moving the platform. The layer containing the platform can be locked allowing these objects to be easily moved or deleted.
 
*A '''Platform Objects''' layer can be used to hold all platform items such as seats, luggage, luggage trolleys, people, lamp posts, etc. Because these items are placed on top of a platform object they can be very difficult to move or delete without first moving the platform. The layer containing the platform can be locked allowing these objects to be easily moved or deleted.
*'''Hiding and Showing Objects''' in '''Driver Mode'''. There is a Session Rule that can hide and show layers during the running of a Session. For example: a rail worker can be shown standing next to a track lever while shunting operations are underway but can be removed by hiding that layer when shunting has been completed.
+
*'''Hiding and Showing Objects''' in '''Driver Mode'''. There is a Session Rule and a Driver Command that can hide and show layers during the running of a Session. For example: a rail worker can be placed in a separate layer and positioned next to a track lever while shunting operations are underway but can be removed from the scene by hiding that layer when shunting has been completed.
*'''Test Layer'''. Not sure if a particular object is right for your layout? Place it in a temporary layer which you can hide and show to see the difference it makes. This is particularly useful if you are deciding between different types of grasses, for example, placed throughout the layout. If the objects prove to be unsuitable then they can all be deleted by deleting the layer. If they are suitable then the layer can be merged with another.
+
*A '''Test Layer''' for experimenting. Not sure if a particular object is right for your layout? Place it in a temporary layer which you can hide and show to see any differences it makes. This is particularly useful if you are deciding between different types of grasses, for example, placed throughout the layout. If the objects prove to be unsuitable then they can all be deleted by deleting the layer. If they are suitable then the layer can be merged with another or left as a new layer.
  
====The "route-layer"====
+
<table cellpadding="4" bgcolor=#ffffb0>
 +
<tr valign="top">
 +
<td>[[file:PencilTips.PNG]]</td>
 +
<td>'''It is a good idea to place ALL the consists in the same layer''' particularly if they are going to be coupled together during the running of a Session.</td>
 +
</tr>
 +
</table>
  
 +
===The "route-layer"===
 +
 +
<table cellpadding="4" bgcolor=#c1e7e7>
 +
<tr valign="top">
 +
<td>[[file:DotPoint.JPG]]</td>
 +
<td>'''To avoid any confusion over which layer is the original "route-layer", this is one layer that should not be renamed or moved from the top position.'''</td>
 +
</tr>
 +
</table>
 +
<br>
 
While all layers are equal, the "route-layer" is special.
 
While all layers are equal, the "route-layer" is special.
  
It is recommended that the following objects should be placed in the "route-layer":-
+
<table cellpadding="4" bgcolor=#fcbcbc>
 +
<tr valign="top">
 +
<td colspan=2><font size=3><b>Warning:</b></font></td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[file:Stop.PNG]]</td>
 +
<td>'''Track objects''', such as signals, junctions and track signs, ''cannot'' be placed in any layer that is above the layer containing the track that they are attached to. If the '''route-layer''' is used for all the track and track objects and this layer is left as the top layer then this will never be a problem.</td>
 +
</tr>
 +
</table>
 +
<br>
 +
<table cellpadding="4" bgcolor=#ffffb0>
 +
<tr valign="top">
 +
<td>[[file:PencilTips.PNG]]</td>
 +
<td>It is recommended that the following objects should be placed in the "route-layer":-
 
*Track and interactive industries with track
 
*Track and interactive industries with track
 
*Track infrastructure (turntables, bridges, tunnels)
 
*Track infrastructure (turntables, bridges, tunnels)
Line 332: Line 546:
 
*Junctions and switches
 
*Junctions and switches
 
*Track signs (speed limits, warnings, etc)
 
*Track signs (speed limits, warnings, etc)
 +
..and that the "route-layer" be placed at the top of the '''Route Layers Group'''.</td>
 +
</tr>
 +
</table>
 
<br>
 
<br>
..and that the "route-layer" be placed at the top of the '''Route Layers Group'''.
 
  
----
+
==The Session Layers Group==
<table>
+
<table cellpadding="4" bgcolor=#c1e7e7>
 
<tr valign="top">
 
<tr valign="top">
 
<td>[[file:DotPoint.JPG]]</td>
 
<td>[[file:DotPoint.JPG]]</td>
<td>To avoid any confusion over which layer is the original "route-layer", this is one layer that should not be renamed or moved.</td>
+
<td>The '''Session Layers Group''' should be used for everything that will only be seen in the '''''currently loaded Session'''''.</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
----
 
  
===The Session Layer Group===
+
If you are creating more than one Session based around a particular Route, then you will probably make use of the Session Layers.
----
+
 
<table>
+
<table cellpadding="4" bgcolor=#ffffb0>
 +
<tr valign="top">
 +
<td>[[file:NotePad.PNG]]</td>
 +
<td><font size="3">'''Notes:'''</font><br>
 +
Session Layers can contain:-
 +
*Scenery objects that will only appear in one or some of the Sessions.
 +
:For example: If you have placed human figures and equipment for a track work crew alongside the track and want them to be seen in a daylight Session but not in a night Session, then place them in one of the Session Layers of the daylight Session only. Likewise, station staff holding lamps would be placed in one of the Session Layers of the night Session only.
 +
*Consists used in a Session.
 +
</td>
 +
</tr>
 +
</table>
 +
<table cellpadding="4" bgcolor=#ffffb0>
 +
<tr valign="top">
 +
<td>[[file:PencilTips.PNG]]</td>
 +
<td>
 +
*'''It is a good idea to place ALL the consists in the same Session Layer''' particularly if they are going to be coupled together during the running of a Session.
 +
*'''When you first save a Session, give it a distinctive and informative name.''' Avoid the temptation to use '''Default''' as the name of your Session as you can easily end up with several Sessions under the same Route all called '''Default'''.</td>
 +
</tr>
 +
</table>
 +
<br>
 +
 
 +
='''Adding Objects To Layers'''=
 +
 
 +
When an object (such as a scenery item, consist, track or track object) is added to the layout it is automatically placed in the currently '''Active Layer'''.  Unfortunately, '''TRS19/TANE''' do not indicate which layer is the '''Active Layer''' unless you open the Layers Tool to look. This can lead to objects being placed into the wrong layers and while these objects can later be moved to another layer (see the section [[file:PageLink.PNG]] '''[[#Moving Objects To Other Layers|Moving Objects To Other Layers]]''' below) it would be better to correctly set the '''Active Layer''' first.
 +
<br><br>
 +
<table cellpadding="4" bgcolor=#ffffb0>
 +
<tr valign="top">
 +
<td>[[file:PencilTips.PNG]]</td>
 +
<td>It is good practice to '''LOCK ALL LAYERS that you are not currently editing.''' This will avoid the all too common problem of accidentally adding objects to the wrong layer.</td>
 +
</tr>
 +
</table>
 +
<br>
 +
<table cellpadding="4" bgcolor=#c1e7e7>
 
<tr valign="top">
 
<tr valign="top">
 
<td>[[file:DotPoint.JPG]]</td>
 
<td>[[file:DotPoint.JPG]]</td>
<td>The '''Session Layer Group''' should be used for everything that will only be seen in the '''''currently loaded Session'''''.</td>
+
<td>'''You cannot add objects to a layer that is LOCKED.'''</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
----
+
 
*Scenery objects that will only appear in one or some Sessions should be placed into the Session Layers Group of those Sessions where they will be needed.
+
If you attempt to add a scenery object to a locked layer you will receive the following message:-
:For example: If you have placed human figures and equipment for a track work crew alongside the track and want them to be seen in a daylight Session but not in a night Session, then place them in one of the Session Layers of the daylight Session.
+
*If you are creating multiple Sessions using different consists, then the consists should be placed into the Session Layers Group.
+
:Consists that will appear in several or even all the Sessions should be placed in the Session Layers Group.
+
----
+
 
<table>
 
<table>
 +
<tr valign="top">
 +
<td>[[file:LayersRouteTreesActiveLockedError.JPG]]<br>
 +
*Click the [[file:Tick.PNG]] icon to '''UNLOCK the layer'''.</td>
 +
</tr>
 +
</table>
 +
<br>
 +
<table cellpadding="4" bgcolor=#c1e7e7>
 
<tr valign="top">
 
<tr valign="top">
 
<td>[[file:DotPoint.JPG]]</td>
 
<td>[[file:DotPoint.JPG]]</td>
<td>'''It is a good idea to place all your consists into the same layer''' particularly if they are going to be coupled together during the running of a Session.</td>
+
<td>When adding track objects (signals, speed signs, etc) to a track, the '''objects being added must be in the same layer as the track or in a layer below the track layer'''. For more information, see the section [[file:PageLink.PNG]] '''[[#The "route-layer"|The "route-layer"]]''' above.</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
----
+
<br>
 +
<table cellpadding="4" bgcolor=#ffffb0>
 +
<tr valign="top">
 +
<td>[[file:NotePad.PNG]]</td>
 +
<td><font size="3">'''Notes:'''</font><br>
 +
There are many features of Trainz Routes and Sessions that are '''NOT stored in layers'''. These include:-
 +
<div style="column-count:2;-moz-column-count:2;-webkit-column-count:2">
 +
*landforms
 +
*textures
 +
*trackside camera positions and settings
 +
*weather conditions
 +
*time of day
 +
*session rules and driver commands
 +
*signal and junctions settings
 +
*rolling stock loads
 +
*industry settings
 +
*portal settings
 +
*passenger station settings
 +
*navigation points
 +
*interlocking tower settings'''^'''
 +
</div>
 +
Landforms, textures and trackside cameras are saved as part of the '''Route''' while all the others are saved as part of a '''Session'''.
 +
<br>
 +
'''^''' A bug has been reported in the Interlocking Towers (and the Enhanced Interlocking Towers) where the path and settings are initially saved in the Route but any later edits and changes are then saved in the Session. The workaround for this is to always load the Session when working with ITs and EITs.
 +
</td>
 +
</tr>
 +
</table>
 +
<br>
  
===Layer Hierarchy===
+
='''Deleting Objects From Layers'''=
 +
<table cellpadding="4" bgcolor=#ffffb0>
 +
<tr valign="top">
 +
<td>[[file:PencilTips.PNG]]</td>
 +
<td>It is good practice to '''LOCK ALL LAYERS that you are not currently editing.''' This will avoid the all too common problem of accidentally deleting objects from the wrong layer.</td>
 +
</tr>
 +
</table>
 +
<br>
 +
<table cellpadding="4" bgcolor=#c1e7e7>
 +
<tr valign="top">
 +
<td>[[file:DotPoint.JPG]]</td>
 +
<td>'''You cannot delete objects from a layer that is LOCKED.'''</td>
 +
</tr>
 +
</table>
  
='''Adding Objects To Layers'''=
+
Unfortunately '''TRS19/TANE''' does not give you a warning message when you attempt to delete an object from a locked layer, the object just refuses to be deleted.
  
='''Deleting Objects From Layers'''=
+
<table cellpadding="4" bgcolor=#ffffb0>
 +
<tr valign="top">
 +
<td>[[file:PencilTips.PNG]]</td>
 +
<td>If you cannot delete an object then check:-
 +
*that the objects layer and bound layer (if set) are unlocked
 +
*that you are using the correct delete tool (e.g. such as attempting to delete a tree with the spline, signal or rolling stock delete tool) - it happens!</td>
 +
</tr>
 +
</table>
 +
<br>
  
 
='''Moving Objects To Other Layers'''=
 
='''Moving Objects To Other Layers'''=
  
 +
<table>
 +
<tr valign="top">
 +
<td>[[file:LayersObjectProperties.JPG]]</td>
 +
<td>
 +
<table cellpadding="4" bgcolor=#ffffff>
 +
<tr valign="top">
 +
<td>[[file:Steps.PNG]]</td>
 +
<td><font size="3">'''Steps:'''</font><br>
 +
To move individual objects from one layer to another:-
 +
#Open the '''Properties''' window ('''?''' button in the '''Object Tools''') of the object to be moved
 +
#Click the '''Layer''' or one of the '''scroll buttons'''
 +
#Select the new layer
 +
#Click the [[file:Tick.PNG]] icon
 +
</td>
 +
</tr>
 +
<tr>
 +
<td colspan="2">
 +
----</td>
 +
</tr>
 +
</table>
 +
<br>
 +
<table cellpadding="4" bgcolor=#c1e7e7>
 +
<tr valign="top">
 +
<td>[[file:DotPoint.JPG]]</td>
 +
<td>'''You can move an object into and out of a locked layer'''</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[file:DotPoint.JPG]]</td>
 +
<td>Multiple scenery objects can be moved to another layer by using the '''Bulk Asset Update/Replacement''' tool from the ''Surveyor Main Menu''</td>
 +
</tr>
 +
</table></td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[file:LayersObjectPropertiesChangeLayer.JPG]]</td>
 +
</tr>
 +
</table>
 +
<br>
  
 
='''The Bound Layer'''=
 
='''The Bound Layer'''=
 +
 +
This is a little used and probably little understood layer feature. It allows you to attach an object to two different layers so it can have the properties (locked/unlocked and show/hide) of both layers. The bound layer was introduced as a development tool, its sole use is as a tool in the building of routes and sessions.
 +
 +
<table cellpadding="4" bgcolor=#c1e7e7>
 +
<tr valign="top">
 +
<td>[[file:DotPoint.JPG]]</td>
 +
<td>'''An object will be LOCKED and cannot be deleted or moved if its layer OR its <u>bound layer</u> is locked.'''
 +
</tr>
 +
<tr valign="top">
 +
<td>[[file:DotPoint.JPG]]</td>
 +
<td>'''An object will be HIDDEN if its layer OR its <u>bound layer</u> is hidden.'''
 +
</tr>
 +
</table>
 +
<br>
 +
Some applications:-
 +
*Temporarily locking an object by binding it to a locked layer while allowing other objects in the same unlocked layer to be moved or deleted. A simple but very effective development technique is to create a Route layer called "Locked" and then lock it. If you need to temporarily stop an object from being deleted or moved then it can be bound to the "Locked" layer.
 +
*Temporarily hiding an object by binding it to a hidden layer (this will require the hidden layer to be made visible so the object can be unbound).
 +
 +
<table>
 +
<tr valign="top">
 +
<td>[[file:LayersBoundLayer.JPG]]</td>
 +
<td><br>
 +
<table cellpadding="4" bgcolor=#ffffff>
 +
<tr>
 +
<td colspan="2">
 +
----</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[file:Steps.PNG]]</td>
 +
<td><font size="3">'''Steps:'''</font><br>
 +
In the '''Properties Window''' of an object:-
 +
#Click the '''Bound Layer''' box or one of its '''scroll buttons'''
 +
#Select the layer to be used as the '''Bound Layer''' for the object (an object cannot be bound to its own layer)
 +
<br>
 +
The effects of the binding can be reversed by setting the '''Bound Layer''' back to '''''<none>'''''.</td>
 +
</tr>
 +
<tr>
 +
<td colspan="2">
 +
----</td>
 +
</tr>
 +
</table></td>
 +
</tr>
 +
</table>
 +
<br>
 +
<table cellpadding="4" bgcolor=#c1e7e7>
 +
<tr valign="top">
 +
<td>[[file:DotPoint.JPG]]</td>
 +
<td>'''When a layer is deleted any objects bound to that layer will have their ''Bound Layer'' reset to ''<none>'''''
 +
</tr>
 +
</table>
 +
<br>
 +
<table cellpadding="4" bgcolor=#ffffb0>
 +
<tr valign="top">
 +
<td>[[file:PencilTips.PNG]]</td>
 +
<td>If you are going to be working with multiple objects that will be bound to a locked or hidden layer then a simple strategy is to:-
 +
*Create a new empty layer called "Locked" or "Hidden" and lock or hide that layer, according to your needs
 +
*Bind the individual objects to that layer as required
 +
*When editing, testing or whatever you are doing has been completed simply delete the new layer. All objects that have been bound to that layer will have their '''Bound Layer''' property reset to '''none''' so the hidden objects will reappear and the locked objects will be unlocked.</td>
 +
</tr>
 +
</table>
 +
<br>
  
 
='''Layers in Driver Mode'''=
 
='''Layers in Driver Mode'''=
 +
 +
During the running of a Session in '''Driver Mode''' visible layers can be hidden and invisible layers revealled according to the events that occur during the Session.
 +
 +
<table>
 +
<tr valign="top">
 +
<td>[[file:LayersDriveShow.JPG]][[file:LayersDriveHide.JPG]]</td>
 +
<td>The two '''Driver Mode''' scenes shown on the left illustrate this feature.
 +
*In the first image on the left, all layers are visible
 +
*In the second image on the left, two of the layers have been hidden
 +
 +
The trigger for this change was the arrival of a train at the platform.</td>
 +
</tr>
 +
</table>
 +
 +
This effect could be achieved in two different ways:-
 +
#'''A Driver Command''' - specific to a particular driver, or
 +
#'''A Session Rule''' - specific to a particular driver, consist, or any driver/consist<br>
 +
=='''Using a Driver Command'''==
 +
The driver command '''Layer Control''' hides and shows named layers.<br>
 +
[[file:LayerControlExample.png]]<br>
 +
=='''Using Session Rules'''==
 +
<br>
 +
<table cellpadding="4" bgcolor=#ffffff>
 +
<tr valign="top">
 +
<td width="58">[[file:RulesWiki.PNG]]</td>
 +
<td width="640"><font size="3">'''Rules Used:'''</font><br>
 +
----</td>
 +
</tr>
 +
</table>
 +
*'''[[Session_Rule_List_with_Parameters#Show/Trackside_Check_Rule|Trackside Check Rule]]''' - to trigger the event
 +
*'''[[Session_Rule_List_with_Parameters#Show/Hide_Layer_Rule|Show/Hide Layer Rule]]''' - to hide layers
 +
*'''[[Session_Rule_List_with_Parameters#Message_Popup_Rule|Message Popup Rule]]''' - to open a browser window with a message
 +
<br>
 +
<table cellpadding="4" bgcolor=#ffffff>
 +
<tr valign="top">
 +
<td width="58">[[file:screenshot.PNG]]</td>
 +
<td width="640"><font size="3">'''Session Editor Screenshot:'''</font><br>
 +
----</td>
 +
</tr>
 +
</table>
 +
<table>
 +
<tr>
 +
<td>[[file:LayersDriveHideRules.JPG]]</td>
 +
</tr>
 +
</table>
 +
<br>
 +
<table cellpadding="4" bgcolor=#ffffff>
 +
<tr valign="top">
 +
<td width="58">[[file:explanation.PNG]]</td>
 +
<td width="640"><font size="3">'''Description:'''</font><br>
 +
----</td>
 +
</tr>
 +
</table>
 +
In this example:-
 +
*The '''Trackside Check Rule''' is triggered when a specific train comes to a stop at a trackmark. This then executes the following rules:-
 +
**The '''Show/Hide Layer Rule''' is used to hide the layer named "People". Four passengers (three standing and one seated) are hidden.
 +
**The '''Show/Hide Layer Rule''' is used to hide the layer named "CNJCartsFull". The boxes and mail bags on the three platform trolleys are hidden.
 +
**The '''Message Popup Rule''' is used to place a message on the screen informing the player that the passengers and mail have been loaded.
 +
----
 +
----
 +
<br>
 +
 +
='''Trainz Wiki'''=
 +
<table cellpadding="4" bgcolor=#ffffff>
 +
<tr valign="top">
 +
<td>[[file:TrainzWiki.png]]</td>
 +
<td>
 +
<font size="3">'''More Tutorials and Guides to Using Trainz'''</font><br>
 +
*'''<span class="plainlinks">[http://online.ts2009.com/mediaWiki/index.php/HowTo How to Guides]</span>'''
 +
*'''[[Driver Commands List]]'''
 +
*'''[[Session Rule List with Parameters|Session Rules List (Alphabetical) with Parameters]]'''
 +
*'''[[Session Rules By Categories With Properties|Session Rules List (Categories) With Parameters]]'''
 +
</td>
 +
</tr>
 +
</table>
 +
 +
[[Category:How-to guides]]

Revision as of 15:32, 21 June 2019

The information in this Wiki Page applies to both TANE and TRS19.

Contents

What Are Layers?

In Summary:
DotPoint.JPG Layers are a Surveyor tool that allows you to better manage the objects that are placed in your Trainz World.
DotPoint.JPG Layers are a Driver tool that allows you to change what the players see as they drive around your Trainz World.

Layers can contain any objects, visible and invisible, that can be placed into a layout using the Surveyor Object, Track and Train tools. The layers and their contents can be hidden from view or locked against alteration whenever required. Their main use is in the development of a Route and a Session but they can also be used as a way of providing some additional novelty during a Driver session.

The Layers Tool

SurveyorToolMenuLayers.JPG












RightArrowRed.JPG
Click the Layers Tool to open up its properties.
LayersTools.JPG


NotePad.PNG Notes:

The layers are organised into two groups:-

  • Route Layers in the top group, and
  • Session Layers in the lower group.
Each group can contain multiple layers - the scroll bars next to the layer names shown on the left indicate that there are more layers in each group than can fit into the display window area.


Loading a Route and Loading a Session

The layers you see will depend on whether you have loaded a Route by itself (with no "child" Session) or a Session and its "parent" Route.

LayersToolsRoute.JPG LayersToolsSession.JPG
  • The first image on the left gives an example of the layers that can appear if a Route only is loaded into Surveyor. These are the layers that are saved with the Route. Note that a default "session-layer" is present.
DotPoint.JPG An empty default "session-layer" is always created in the Session Layers Group when only the Route is loaded into Surveyor.
  • The second image on the left gives an example of the layers that can appear if a Session based on that Route is loaded into Surveyor. It shows Route Layers and Session Layers.

In both cases, the Route Layers are identical because the same Route has been loaded. A Session contains its own layers, the Session Layers, that are loaded and saved with the Session but are not loaded or saved with the Route.

In Summary:
DotPoint.JPG Route Layers are saved with the Route. Session Layers are saved with the Session.
DotPoint.JPG If you edit a Session Layer and later load just the Route then those edits will not appear.
DotPoint.JPG If you load just the Route and edit its "session-layer" then those edits will not appear the next time you load just the Route because an empty "session-layer" is created each time a Route is loaded without a Session.


Stop.PNG WARNING:
If you load a ROUTE without a SESSION then only edit the Route Layers


Creating a New Route

LayersNewRoute.JPG
NotePad.PNG Notes:
  • When a brand new route is created it will come with two layers, a single "route-layer" and a single "session-layer".
  • Both layers will be empty (the baseboard with its grid is saved with the route but is not in any layer).
PencilTips.PNG A layer can be renamed at anytime by double clicking on its name with the left mouse button and typing a new name.

The "Active Layer"

In Summary:
DotPoint.JPG The Active Layer is the selected (highlighted) layer.
DotPoint.JPG When you load the Route only into Surveyor, the first Route layer will be the Active Layer
DotPoint.JPG When you load a Session into Surveyor, the first Session layer will be the Active Layer

In the image above, the route-layer is the Active Layer. You can change the Active Layer at any time by clicking on the name of another layer.

NotePad.PNG Notes:

The Active Layer is the "working layer" which is:-

  • where new objects will be added to the layout
  • the layer that is automatically selected for merging and deleting
Caution:
Stop.PNG TRS19/TANE do not identify which is the Active Layer in Surveyor and this often leads to problems such as objects being added to the wrong layer.
See PageLink.PNG Adding Objects To Layers below for more information.


Adding a New Layer

LayersToolButtonsADD.JPG Click the Add Button

An Add layer dialogue window will appear.

LayersAddLayer.JPG

Steps.PNG Steps:
  1. Enter a name for the new layer
  2. Select the layer group, Route or Session, where it will be placed
  3. Click the Tick.PNG icon

PencilTips.PNG You can easily rename the layer or move it to the other layer group later if you change your mind.

Deleting a Layer

LayersToolButtonsDELETE.JPG Select the layer to be deleted and click the Delete Button. If you don't select a layer to delete then TRS19/TANE will select the current Active Layer.


Warning:
Stop.PNG Deleting a layer will delete ALL the objects placed in that layer except objects that are "Bound" to that layer.

If the layer being deleted is empty, then the following dialogue window will appear:-

LayerDeleteEmpty.JPG

Choices.PNG Choices:
  • Click Yes to delete the layer
  • Click No to cancel the delete operation

If the layer being deleted is NOT empty, then the following dialogue window will appear:-

LayerDeleteNotEmpty.JPG

Choices.PNG Choices:
  • Click Merge to merge this layer and its contents into another layer. See Merging Layers below for more information
  • Click Delete to delete the layer and its contents. This cannot be undone
  • Click Cancel to cancel the delete operation

Merging Layers

LayersToolButtonsMERGE.JPG Select the layer to be merged into another layer and click the Merge Button. If you don't select a layer to merge then TRS19/TANE will select the current Active Layer.
In Summary:
DotPoint.JPG Merging a layer into another layer will move ALL the objects from the first layer into the second layer. The first layer, which is now empty, will then be deleted.
DotPoint.JPG Once layers have been merged they cannot be separated.

The layer merge dialogue window will appear as shown below:-

LayersMergeInto.JPG

Steps.PNG Steps:
  1. Select the destination layer for the merge
  2. Click the Tick.PNG icon
The Merge into: list shows all the available layers with no distinction between Route Layers and Session Layers


Locking Layers

PencilTips.PNG It is good practice to LOCK ALL LAYERS that you are not currently editing. This will avoid the all too common problem of accidentally adding objects to the wrong layer.


DotPoint.JPG If you LOCK or UNLOCK a Route Layer while editing a Session then you will have made a change to the Route and will be asked to save both the Route and the Session when you exit Surveyor.


Locking Individual Layers

To LOCK an individual layer, click on the Open Padlock icon next to its name. The layer being locked does not have to be the current Active Layer.

DotPoint.JPG The objects in a LOCKED layer cannot be moved or deleted but they can be moved to other layers.
LayersRouteTreesActive.JPG LayersRouteTreesActiveLocked.JPG
  • The first image on the left shows two Route Layers, both UNLOCKED with their Padlock icons Open. One layer, "Trees", is highlighted showing that it is the currently active layer.
  • The second image on the left shows the same two layers after the "Trees" layer has been LOCKED.
  • A locked layer can be UNLOCKED by clicking its Closed Padlock icon.

If you attempt to add a scenery object to a locked layer you will receive the following message:-

LayersRouteTreesActiveLockedError.JPG
  • Click the Tick.PNG icon to UNLOCK the layer

Locking ALL Route Layers

LayersToolButtonsLOCKALL.JPG Click the Lock Button

This will LOCK ALL the layers in the Route Layers Group. The Session Layers Group will not be affected.

The Route Layers Group can be UNLOCKED by clicking the Lock Button again.

Moving a Layer

Main Points:
DotPoint.JPG Layers can be moved up or down
  • within the same layer group (e.g. Route or Session)
  • between the two groups
DotPoint.JPG A layer containing track objects (e.g. signals, switches, etc) CANNOT be placed above the layer containing the track

In the example shown below a layer created in the Route Layers Group is being moved into the Session Layers Group.

LayersMove1.JPG LayersMove3.JPG

Steps.PNG Steps:
  1. Select the layer to be moved and hold down the left mouse button
  2. Drag the layer up or down to its new position

  • The move can be between layer groups as shown left or within groups to move the layer to a higher or lower position in the group.
  • The only situation where layer order within a layer group makes any difference is when adding track objects (e.g. signals, track signs, etc) to a track.


DotPoint.JPG When adding track objects to a track, the object being added must be in the same layer or in a layer below the layer containing the track. For more information, see the section PageLink.PNG The "route-layer" below.
DotPoint.JPG If you attempt to move a layer containing track objects, such as signals, to a position above the layer containing the track, you will get an error message.

Hiding Layers

To hide or show a layer click the Eye Icon next to its name.

LayersHideNone.JPG
  • In the image shown left the two trees are in different Route Layers
  • All the layers have their Eye Icons set to Show
LayersHideTree.JPG
  • In the image shown left the Trees layer has its Eye Icon set to Hide

DotPoint.JPG If you attempt to add an object to a hidden layer you will receive a warning message.
DotPoint.JPG Layers that are hidden when saved in Surveyor will also be hidden when loaded in Driver.


Route Layers vs Session Layers

This topic has filled endless threads in the Trainz Forums with arguments raging on both sides.

In Summary:
DotPoint.JPG There are no "cast iron" rules that dictate what should be placed in the Route Layers Group and what should be placed in the Session Layers Group. Each Route and Session will be different and different creators have different ways of working. The main question to be asked is how many different Sessions will be created using a particular Route?


NotePad.PNG Notes:
  • For a Route with only a single Session - everything can safely go into the Route Layers Group
Many creators only ever build a single Session for each of their Routes and do not use Session Layers at all (but they still have to save the session separately from the route).
  • For a Route with multiple (2 or more) Sessions - certain things will probably need to go into the Session Layers Group for each Session.
Many creators build multiple Sessions for each Route and rely on the Session Layers to create the differences between their Sessions.


The Route Layers Group

DotPoint.JPG The Route Layer Group should be used for everything that will always appear in Driver Mode regardless of which Session is playing.

There is nothing stopping you from placing everything in the "route-layer" of the Route Layers Group and never having to worry about dealing with layers ever again - some creators prefer to work this way. However, layers do provide you with a way of organising your scenery objects to make them more manageable, particularly in more complicated layouts. Some examples:-

  • A Special Objects layer or layers that can be used to hold certain scenery objects. For example all the trees or a particular building. This can be very useful when you need to hide those objects to locate or place other objects. Trackside cameras in particular can be very difficult to find when placed in a forest.
  • A Platform Objects layer can be used to hold all platform items such as seats, luggage, luggage trolleys, people, lamp posts, etc. Because these items are placed on top of a platform object they can be very difficult to move or delete without first moving the platform. The layer containing the platform can be locked allowing these objects to be easily moved or deleted.
  • Hiding and Showing Objects in Driver Mode. There is a Session Rule and a Driver Command that can hide and show layers during the running of a Session. For example: a rail worker can be placed in a separate layer and positioned next to a track lever while shunting operations are underway but can be removed from the scene by hiding that layer when shunting has been completed.
  • A Test Layer for experimenting. Not sure if a particular object is right for your layout? Place it in a temporary layer which you can hide and show to see any differences it makes. This is particularly useful if you are deciding between different types of grasses, for example, placed throughout the layout. If the objects prove to be unsuitable then they can all be deleted by deleting the layer. If they are suitable then the layer can be merged with another or left as a new layer.
PencilTips.PNG It is a good idea to place ALL the consists in the same layer particularly if they are going to be coupled together during the running of a Session.

The "route-layer"

DotPoint.JPG To avoid any confusion over which layer is the original "route-layer", this is one layer that should not be renamed or moved from the top position.


While all layers are equal, the "route-layer" is special.

Warning:
Stop.PNG Track objects, such as signals, junctions and track signs, cannot be placed in any layer that is above the layer containing the track that they are attached to. If the route-layer is used for all the track and track objects and this layer is left as the top layer then this will never be a problem.


PencilTips.PNG It is recommended that the following objects should be placed in the "route-layer":-
  • Track and interactive industries with track
  • Track infrastructure (turntables, bridges, tunnels)
  • Signals
  • Junctions and switches
  • Track signs (speed limits, warnings, etc)
..and that the "route-layer" be placed at the top of the Route Layers Group.


The Session Layers Group

DotPoint.JPG The Session Layers Group should be used for everything that will only be seen in the currently loaded Session.

If you are creating more than one Session based around a particular Route, then you will probably make use of the Session Layers.

NotePad.PNG Notes:

Session Layers can contain:-

  • Scenery objects that will only appear in one or some of the Sessions.
For example: If you have placed human figures and equipment for a track work crew alongside the track and want them to be seen in a daylight Session but not in a night Session, then place them in one of the Session Layers of the daylight Session only. Likewise, station staff holding lamps would be placed in one of the Session Layers of the night Session only.
  • Consists used in a Session.
PencilTips.PNG
  • It is a good idea to place ALL the consists in the same Session Layer particularly if they are going to be coupled together during the running of a Session.
  • When you first save a Session, give it a distinctive and informative name. Avoid the temptation to use Default as the name of your Session as you can easily end up with several Sessions under the same Route all called Default.


Adding Objects To Layers

When an object (such as a scenery item, consist, track or track object) is added to the layout it is automatically placed in the currently Active Layer. Unfortunately, TRS19/TANE do not indicate which layer is the Active Layer unless you open the Layers Tool to look. This can lead to objects being placed into the wrong layers and while these objects can later be moved to another layer (see the section PageLink.PNG Moving Objects To Other Layers below) it would be better to correctly set the Active Layer first.

PencilTips.PNG It is good practice to LOCK ALL LAYERS that you are not currently editing. This will avoid the all too common problem of accidentally adding objects to the wrong layer.


DotPoint.JPG You cannot add objects to a layer that is LOCKED.

If you attempt to add a scenery object to a locked layer you will receive the following message:-

LayersRouteTreesActiveLockedError.JPG
  • Click the Tick.PNG icon to UNLOCK the layer.


DotPoint.JPG When adding track objects (signals, speed signs, etc) to a track, the objects being added must be in the same layer as the track or in a layer below the track layer. For more information, see the section PageLink.PNG The "route-layer" above.


NotePad.PNG Notes:

There are many features of Trainz Routes and Sessions that are NOT stored in layers. These include:-

  • landforms
  • textures
  • trackside camera positions and settings
  • weather conditions
  • time of day
  • session rules and driver commands
  • signal and junctions settings
  • rolling stock loads
  • industry settings
  • portal settings
  • passenger station settings
  • navigation points
  • interlocking tower settings^

Landforms, textures and trackside cameras are saved as part of the Route while all the others are saved as part of a Session.
^ A bug has been reported in the Interlocking Towers (and the Enhanced Interlocking Towers) where the path and settings are initially saved in the Route but any later edits and changes are then saved in the Session. The workaround for this is to always load the Session when working with ITs and EITs.


Deleting Objects From Layers

PencilTips.PNG It is good practice to LOCK ALL LAYERS that you are not currently editing. This will avoid the all too common problem of accidentally deleting objects from the wrong layer.


DotPoint.JPG You cannot delete objects from a layer that is LOCKED.

Unfortunately TRS19/TANE does not give you a warning message when you attempt to delete an object from a locked layer, the object just refuses to be deleted.

PencilTips.PNG If you cannot delete an object then check:-
  • that the objects layer and bound layer (if set) are unlocked
  • that you are using the correct delete tool (e.g. such as attempting to delete a tree with the spline, signal or rolling stock delete tool) - it happens!


Moving Objects To Other Layers

LayersObjectProperties.JPG
Steps.PNG Steps:

To move individual objects from one layer to another:-

  1. Open the Properties window (? button in the Object Tools) of the object to be moved
  2. Click the Layer or one of the scroll buttons
  3. Select the new layer
  4. Click the Tick.PNG icon


DotPoint.JPG You can move an object into and out of a locked layer
DotPoint.JPG Multiple scenery objects can be moved to another layer by using the Bulk Asset Update/Replacement tool from the Surveyor Main Menu
LayersObjectPropertiesChangeLayer.JPG


The Bound Layer

This is a little used and probably little understood layer feature. It allows you to attach an object to two different layers so it can have the properties (locked/unlocked and show/hide) of both layers. The bound layer was introduced as a development tool, its sole use is as a tool in the building of routes and sessions.

DotPoint.JPG An object will be LOCKED and cannot be deleted or moved if its layer OR its bound layer is locked.
DotPoint.JPG An object will be HIDDEN if its layer OR its bound layer is hidden.


Some applications:-

  • Temporarily locking an object by binding it to a locked layer while allowing other objects in the same unlocked layer to be moved or deleted. A simple but very effective development technique is to create a Route layer called "Locked" and then lock it. If you need to temporarily stop an object from being deleted or moved then it can be bound to the "Locked" layer.
  • Temporarily hiding an object by binding it to a hidden layer (this will require the hidden layer to be made visible so the object can be unbound).
LayersBoundLayer.JPG

Steps.PNG Steps:

In the Properties Window of an object:-

  1. Click the Bound Layer box or one of its scroll buttons
  2. Select the layer to be used as the Bound Layer for the object (an object cannot be bound to its own layer)


The effects of the binding can be reversed by setting the Bound Layer back to <none>.


DotPoint.JPG When a layer is deleted any objects bound to that layer will have their Bound Layer reset to <none>


PencilTips.PNG If you are going to be working with multiple objects that will be bound to a locked or hidden layer then a simple strategy is to:-
  • Create a new empty layer called "Locked" or "Hidden" and lock or hide that layer, according to your needs
  • Bind the individual objects to that layer as required
  • When editing, testing or whatever you are doing has been completed simply delete the new layer. All objects that have been bound to that layer will have their Bound Layer property reset to none so the hidden objects will reappear and the locked objects will be unlocked.


Layers in Driver Mode

During the running of a Session in Driver Mode visible layers can be hidden and invisible layers revealled according to the events that occur during the Session.

LayersDriveShow.JPGLayersDriveHide.JPG The two Driver Mode scenes shown on the left illustrate this feature.
  • In the first image on the left, all layers are visible
  • In the second image on the left, two of the layers have been hidden
The trigger for this change was the arrival of a train at the platform.

This effect could be achieved in two different ways:-

  1. A Driver Command - specific to a particular driver, or
  2. A Session Rule - specific to a particular driver, consist, or any driver/consist

Using a Driver Command

The driver command Layer Control hides and shows named layers.
LayerControlExample.png

Using Session Rules


RulesWiki.PNG Rules Used:


Screenshot.PNG Session Editor Screenshot:

LayersDriveHideRules.JPG


Explanation.PNG Description:

In this example:-

  • The Trackside Check Rule is triggered when a specific train comes to a stop at a trackmark. This then executes the following rules:-
    • The Show/Hide Layer Rule is used to hide the layer named "People". Four passengers (three standing and one seated) are hidden.
    • The Show/Hide Layer Rule is used to hide the layer named "CNJCartsFull". The boxes and mail bags on the three platform trolleys are hidden.
    • The Message Popup Rule is used to place a message on the screen informing the player that the passengers and mail have been loaded.



Trainz Wiki

TrainzWiki.png

More Tutorials and Guides to Using Trainz

Personal tools