How to Use S20 Palettes

From TrainzOnline
(Difference between revisions)
Jump to: navigation, search
m (The Tools Palette)
m
Line 967: Line 967:
 
='''The Tools Palette'''=
 
='''The Tools Palette'''=
  
<table width=900 bgcolor=#000000>
+
<table width=1000 bgcolor=#000000>
 
<tr valign="top">
 
<tr valign="top">
 
<td>
 
<td>

Revision as of 08:56, 1 March 2023

The information in this Wiki Page applies to Surveyor 2.0 (S20) as found in Trainz Plus. The original refernce material for this document can be found at WikiLink.PNG Surveyor 2.0 Overview

Contents

 This document is still under construction 

S20 Palettes.png


  Top   Next Down Bottom

The Surveyor 2.0 World

When you start Trainz in Survayor 2.0 the world presented will look something like the following image, but what you actually see can be highly customised to your own preferences.

S20 SurveyorScreen.png

The grey boxes on the left and right of the screen are Palettes, where selections can be made, information displayed and controls set.

Shown in the image above are 5 Palettes:-
DotPoint.JPG Assets
DotPoint.JPG Layers
DotPoint.JPG Info
DotPoint.JPG Tools
DotPoint.JPG Tool Options
Not shown in the image above are 3 Palettes because they are currently hidden from view. They are:-
DotPointBlueSquare.png Scrapbook
DotPointBlueSquare.png Asset Preview
DotPointBlueSquare.png Content Packages


Hiding and Showing Palettes

Palettes are hidden and revealed using the Window Menu on the top Surveyor Menu bar.

The 5 visible and 3 hidden Palettes in the screenshot image shown above have had their visibility set by:-

Windows Menu
Steps:
DotPoint1.JPG open the Window Menu from the menu icons at the top of the screen
 
BulletTick.png visible palettes have ticks next to their names
BulletNoTick.png invisible (hidden) palettes have no ticks next to their names
DotPoint2.JPG To make a hidden palette visible or to hide a visible palete simply Left click on its name or on the BulletTick.png or BulletNoTick.png next to its name


Docking and Undocking Palettes

To Undock a palette from its normal position on either side of the screen:-

PalettesUndocking1 S20.png
Steps:
DotPoint1.JPG Move the mouse pointer onto the Title Bar of the palette to be undocked. The pointer will take the shape of a 4 headed arrow
PalettesUndocking2 S20.png DotPoint2.JPG Left Click and Drag the palette to any position on the screen
DotPoint3.JPG Release the mouse button


To reverse the process and dock a palette:-

PalettesDocking S20.png
Steps:
DotPoint1.JPG Move the mouse pointer onto the Title Bar of the free palette to be docked
 
DotPoint2.JPG Left Click and Drag the palette to the desired position on a docking area. A light grey area will show the palettes docking position
 
DotPoint3.JPG Release the mouse button and the palette
 
The palette does not have to be returned to its original position.


PencilTips.PNG Free floating (Undocked) palettes can be docked together to form a docked group that is still free floating


Resizing Palettes

Only palettes that are undocked can be resized.

PalettesResizing S20.png
Steps:
DotPoint1.JPG Move the mouse pointer onto a corner or an edge of the palette
 
DotPoint2.JPG Left Click and Drag the pointer to expand or reduce the size of the palette
 
DotPoint3.JPG Release the mouse button when the palette has reached the required size


NotePad.PNG Notes:

If a resized palette is reurned to a docking area its dimensions will return to its default (original) values


Closing Palettes

This is the same as hiding a palette. Once a palette has been undocked it can be closed (hidden) by a Left click on its Close DeleteIcon S20.png icon. The palette will not be deleted and can be shown again as described above at PageLink.PNG Hiding and Showing Palettes


  Top Next Up Next Down Bottom

The Info Palette

If the Info Palette is not visible on the screen then refer to PageLink.PNG Hiding and Showing Palettes at the top of this document. Some Info Palette functions will also require the Assets Palette and the Tool Options Palette.


S20 PaletteInfo.png
This palette can be easily overlooked but it has some very useful features:-
DotPoint.JPG providing precise data and control over the "focus" - the position of the cursor
DotPoint.JPG providing precise data and control over the position and orientation of objects (it can be used instead of the Free Move Tool and the Fine Adjustment Tool)
DotPoint.JPG identifying and setting the "home" layer and binding layer of a selected object
DotPoint.JPG used for locking and unlocking a selected objects layer

The Info Palette will appear as shown in the image below.
InfoPalette S20.png Each of the small arrowhead icons will open the palette to display more information and some controls.


NotePad.PNG Notes:

All the positional data and controls in the Info Palette are defined in the following ways:-

 X  is ALWAYS the  North-South  compass direction regardless of the direction that an object is facing
 Y  is ALWAYS the  East-West  compass direction regardless of the direction that an object is facing
 Z  is ALWAYS the  Vertical  direction (perpendicular to the compass directions) regardless of how an object has been rolled or tilted

DotPoint.JPG distances are measured in metres from the North-West corner of the first baseboard.
DotPoint.JPG  (+)  positive distances are in the  South  and  East  directions
DotPoint.JPG  (-)  negative distances are in the  North  and  West  directions. New boards added to the North of the first baseboard will have negative X coordinates and new boards added to the West of the first baseboard will have negative Y coordinates.


Focus Info and Controls

The Focus shows the current position and height of the Cursor object. Open up the Focus by Left clicking on its arrowhead icon.

PencilTips.PNG Before changing the cursor position with the Focus controls, set a Bookmark at its current position.


InfoPaletteFocus S20.png


The current cursor position is shown in the X, Y and Z text boxes. These values can be edited to move the cursor to a new position but CARE will be needed.

NotePad.PNG Notes:

If you enter an X or Y value that is "out in empty space" (beyond the edge of a boundary baseboard) then the cursor will be refocussed at a point on the baseboard edge that is the closest to the entered co-ordinates.


On the right of each box is a pair of Up/Down controls. Left Click and Drag up or down on these to adjust the cursor position in smaller increments down to centimetres


Next to the Z co-ordinate is a small white down arrowhead. Left click on the arrow to open its menu.

InfoPaletteFocusMenu S20.png There is only one item in the sub-menu.  Use Height for Brush 
Left click on the option to copy the current cursor height (Z) value from the Info Palette to the Tool Options Palette  Height  entry.


Asset Name Menu

You must have an object (or objects) selected for a name to be shown and the menu to be available.

InfoPaletteMulti S20.png If the selected objects are different then a count of the additional objects will be added. The (+2) shown in the object name in the image on the left indicates that "2" additional different objects are in the group of selected objects. The name and position data shown will be for the last selected object.


Next to the objects name is a small white Down Arrowhead. Left click on the arrowhead to open its menu.

InfoPaletteMenu S20.png The menu options are:-
 Copy  NOT WORKING (a known bug) - this option copies the objects details as text for pasting into a text editor
 Show Asset Details  opens a new window showing the image and description of the selected object
 List Assets in New Window  opens up Content Manager and lists all the selected objects
 Add to Picklist  adds selected objects to a Picklist
 Remove from Picklist  removes selected objects from a Picklist (objects must already be in a Picklist)
 Select in Assets Palette  highlights the selected object in the Assets Palette


Position Info and Controls

You must have an object (or objects) selected for the position data to be shown and edited. Open up the position data by Left clicking on its Pos: arrowhead icon.

InfoPalettePos S20.png The position of the selected object (or the last object if more than one is selected) is shown in the X, Y and Z text boxes. These values can be edited to move the object or objects to a new position but CARE will be needed.


NotePad.PNG Notes:

If you enter an X or Y value that is "out in empty space" (beyond the edge of a boundary baseboard) then the objects will be moved to that position and may vanish from view. The Undo command can be used to reverse the move or the Marquee Tool can be used to add a baseboard under the "floating" objects.


On the right of each box is a pair of Up/Down controls. Left Click and Drag up or down on these to adjust the position in smaller increments down to centimetres


Next to the Z co-ordinate is a small white down arrowhead. Left click on the arrow to open its menu.

InfoPalettePosMenu S20.png There is only one item in the sub-menu.  Use Height for Brush 
Left click on the option to copy the height (Z) value for the selected object from the Info Palette to the Tool Options Palette  Height  entry.


Rotation Info and Controls

You must have an object (or objects) selected for the rotation data to be shown and edited. Open up the rotation data by Left clicking on its Rot: arrowhead icon.

InfoPaletteRot S20.png The rotational orientation of the selected object (or the last object if more than one is selected) is shown in the R, P and Y text boxes. These values can be edited to rotate the object or objects in 3D space BUT not all objects can be rotated in certain directions.

On the right of each box is a pair of Up/Down controls. Left Click and Drag up or down on these to adjust the rotation angle in increments of 1°.


NotePad.PNG Notes:

The rotation data and controls are defined in the following ways:-

 R  ALWAYS rotates in the vertical plane around the  North-South  compass direction regardless of the object or objects orientation
 P  ALWAYS rotates in the vertical plane around the  East-West  compass direction regardless of the object or objects orientation
 Y  ALWAYS rotates in the horizontal plane around the  Vertical  direction (perpendicular to the compass directions) regardless of how the object or objects have been rolled or tilted

DotPoint.JPG all angles are measured in degrees
DotPoint.JPG  (+)  positive angles are clockwise when facing the primary direction ( North  or  East ) and around the  Vertical  axis
DotPoint.JPG  (-)  negative angles are anti-clockwise when facing the primary direction ( North  or  East ) and around the  Vertical  axis
DotPoint.JPG angles greater than ±360° can be entered but will give the same result as the corresponding angle less than 360°. For example: 450° is exactly the same angle as 90° (450-360=90)
DotPoint.JPG clockwise and anti-clockwise angles are complementary. For example: entering -270° (anti-clockwise) will give the same angle as entering 90° (clockwise)


Layer Info and Controls

You must have an object (or objects) selected for the layer data to be shown and edited. Open up the layer data by Left clicking on its Layer: arrowhead icon.

NotePad.PNG Notes:

DotPoint.JPG the Info Palette is best used to show and edit the layer and binding layer assignments of individual selected objects
DotPoint.JPG operations such as creating, deleting, merging, renaming, moving and hiding layers are performed using the Assets Palette
DotPoint.JPG layers can be Locked and Unlocked using the Info Palette or the Assets Palette but the Assets Palette is often the better choice for this


InfoPaletteLayer S20.png This will show the:-
DotPoint.JPG current layer assigned to the selected object
DotPoint.JPG its assigned Binding Layer (if any)
DotPoint.JPG the Locked/Unlocked status of the assigned layer
  InfoPaletteLockedLayerBtn S20.png Layer is currently Unlocked. Click this button to Lock the layer
  InfoPaletteUnlockedLayerBtn S20.png Layer is currently Locked. Click this button to Unlock the layer
  Using this button will also change the Locked/Unlocked padlock icon shown next to the layer name in the Assets Palette
AssetsPaletteLockedUnlockedLayers S20.png


InfoPaletteLayersMulti S20.png If multiple objects from different layers have been selected then no layer name will be shown in the Layer and Binding boxes. Instead they will be left "blank" as shown in the image on the left.

Both boxes can still be opened to assign layers to objects.


Assigning Objects to a Different Layer

A selected object or group of selected objects can be assigned to a different layer. If multiple objects have been selected then they do not have to all be in the same layer.

NotePad.PNG Notes:

Before changing any objects to another layer, make sure that the source layer (or source layers for multiple objects) and the destination layer are unlocked.

LayerUnLocked S20.png unlocked layers are shown in the Assets Palette with an open padlock icon
LayerLocked S20.png locked layers are shown in the Assets Palette with a closed padlock icon. Left click the icon to unlock the layer


InfoPaletteLayerDropBoxList S20.png
Stop.PNG This operation will TOTALLY FAIL if the destination layer is locked and it will FAIL for any object in a source layer that is locked


Steps: To change the assigned layer of an object or group of objects:-
DotPoint1.JPG Left click on the Layer drop down box. The layer containing the object (for a single selected object only) will be shown with a BulletTick.png in front of its name
DotPoint2.JPG Select the destination layer name from the drop down list
The layer reassignment will start the instant the destination layer is selected
DotPoint3.JPG If you see a Debugging Window on the screen as the task is processed, it will inform you when the task has been completed. You can then close the window


Once a target layer has been selected then the  Select Layer  button, which sets the Active Layer, may become active.

The Active Layer is the layer used by the Placement Tool when objects are added to a route (or session). This button gives you the opportunity to set the Active Layer to the same layer that you just used to assign to an object. Its use is optional.

You can also set the Active Layer by selecting its name from the list in the Layers Palette.


Ablue.png If the  Select Layer  button is greyed out
InfoPaletteLayerSelectBtnOff S20.png then the selected object is now assigned to the current Active Layer so there is no need to use this option
Bblue.png If it is NOT greyed out
InfoPaletteLayerSelectBtnOn S20.png then the selected object is now assigned to a layer that is not the current Active Layer. You have the option to Left click on this button to switch the Active Layer to the same layer as the object


Assigning Objects to a Binding Layer

The Binding Layer, or Bound Layer as it is also called, is a tool used in the development of a route or session. It allows you to temporarily assign an object to a second layer while it is still in its original layer. The object will then take on the properties (Locked/Unlocked, Hidden/Visible) of both layers.
So if the original layer or the binding layer of an object is:-
DotPoint.JPG LOCKED then the object will be LOCKED
DotPoint.JPG HIDDEN then the object will be HIDDEN


Some examples of using the Binding Layer:-
 Example 1: 
The problem: You need to stop an object from being selected so that you can you move other objects on or around it
The solution: The easiest solution is to use the Layers Palette to create a new empty layer and lock it. Set the Binding Layer of the object to the new locked layer. The object will then be locked so it cannot be selected or moved even though its original layer is unlocked. When the edit has been completed delete the empty locked layer you just created to unlock all its bound objects and remove all their bindings
 Example 2: 
The problem: A group of objects (e.g trees) are blocking access to another object.
The solution: The easiest solution is to use the Layers Palette to create a new empty layer and hide it. Set the Binding Layer of the blocking objects to the new hidden layer. The blocking objects will no longer be visible and cannot be selected even though their original layer is still visible. When the edit has been completed delete the empty hidden layer you just created to make all its bound objects visible and remove all their bindings


InfoPaletteBindingDropBox S20.png
Steps: To change the assigned binding layer of an object or group of objects:-
DotPoint1.JPG Left click on the Binding drop down box. If the object is already bound to a layer (for a single selected object only) the binding layer will be shown with a BulletTick.png in front of its name
DotPoint2.JPG Select the Binding layer name from the drop down list
The layer reassignment will start the instant the layer is selected
DotPoint3.JPG If you see a Debugging Window on the screen as the task is processed, it will inform you when the task has been completed. You can then close the window


As an example, the image below shows what you will see for a single object that has had:-
InfoPaletteLayerSetBindingSet S20.png
DotPoint.JPG its assigned layer changed (in the example from "route-layer" to "Station Buildings")
DotPoint.JPG its binding layer set (in the example to "Multi Industries")
DotPoint.JPG the newly assigned layer is not locked so you have the option to lock it
DotPoint.JPG the newly assigned layer is not the Active Layer so you have the option to make it the Active Layer


LinkWiki.PNG

More information on creating, editing and using Layers can be found on the Trainz Wiki at:-


  Top Next Up Next Down Bottom

The Tools Palette

If the Tools Palette is not visible on the screen then refer to PageLink.PNG Hiding and Showing Palettes at the top of this document


S20 PaletteTools.png
The Tools Palette is at the core of the new interface and takes the place of all the Tool Flyouts that have been the standard for Trainz Surveyor for many years. Some of the tools are new while others have been given a makeover and new abilities. The tools manipulate the Surveyor World you see in many different ways.


Tools and keymap for S20 The  Context Tool  is attached as an icon to a selected or newly placed object. The icon and its Context menu will vary according to the type of object.


For a detailed description of all the tools in the Tools Palette see the Trainz Wiki page WikiLink.PNG How to Use the Surveyor 2.0 Tools

Various brush tools make use of the Tool Options Palette, the Assets Palette, the Info Palette, the Layers Palette and the Scrapbook Palette. If a palette required by one of the brush tools is not visible on the screen then refer to PageLink.PNG Hiding and Showing Palettes at the top of this document.


The Brush Tool

S20 BrushToolIcon.png Keyboard Shortcut:  W  The  Brush Tool  "paints" the ground height, ground textures, effect layers and scrapbook scenes in a route


Brush Tools
The Brush Tool has two drop down menu lists.

The first drop down menu will set the "Brush Target" which is the type of brush.

The Targets are:-
BulletTick.png Ground Height
BulletTick.png Ground Texture
BulletTick.png Scrapbook Data
BulletTick.png <List of Effect Layers>
BulletTick.png Edit Effect Layers
BrushToolsGroundOptions S20.png
NotePad.PNG If you have any Effect Layers then they will appear as Targets in this drop down list. Select an Effect Layer to use the brush to paint with that layer.
The Brush Targets  Ground Height ,  Scrapbook Data  and  Effect Layers  have a second drop down menu that controls the Brush Action.
For a more detailed information on using the Brush Tool see the Trainz Wiki page WikiLink.PNG How to Use the Surveyor 2.0 Tools


The Placement Tool

S20 PlacementToolIcon.png Keyboard Shortcut:  E  The  Placement Tool  adds objects to a route


Placement Tools
The Placement Tool places all types of objects except textures and effect layers
SceneryMeshFilter S20.png all non-spline scenery assets   ScenerySplineFilter S20.png all spline scenery assets
TrackSplineFilter S20.png all track spline assets   TrackMeshFilter S20.png all track (non spline) assets (signals, etc)
TrainFilter S20.png all rolling stock assets  


For detailed information on using the Placement Tool see the Trainz Wiki page WikiLink.PNG How to Use the Surveyor 2.0 Tools


The Eyedropper Tool

S20 DropperToolIcon.png Keyboard Shortcut:  R  The  Eyedropper Tool  identifies and selects objects in a route


EyedropperTools S20.png
PencilTips.PNG The Eyedropper is also inside all the tools in this palette so you can quickly identify any object without having to switch to the Eyedropper Tool and back again.

Just hold down the  Alt  key as you move the pointer of your selected tool onto an object to reveal its name. Left click on the object while holding down the key to select it in the Assets Palette list. The left click will automatically select the Placement Tool with the asset selected for immediate placement.


For detailed information on using the Eyedropper Tool see the Trainz Wiki page WikiLink.PNG How to Use the Surveyor 2.0 Tools


The Free Move Tool

S20 FreeMoveToolIcon.png Keyboard Shortcut:  S  The  Free Move Tool  moves objects around a route


FreeMoveTools S20.png
NotePad.PNG Notes:

The Free Move Tool can move any selected object or objects (except Ground Textures and Effect Layers) in any direction horizontally. Vertical movements can be achieved by using the Height control in the Tool Options Palette.


For detailed information on using the Free Move Tool see the Trainz Wiki page WikiLink.PNG How to Use the Surveyor 2.0 Tools


The Fine Adjustment Tool

S20 FineAdjustmentToolIcon.png Keyboard Shortcut:  D  The  Fine Adjustment Tool  makes 3D adjustments (XYZ position and rotations) to objects in a route


Fine Adjustment Tools
The most obvious feature of the Fine Adjustment Tool is the 3D Anchor Frame it adds to a selected object. The frame is made of 3 straight and 3 curved coloured lines, called Anchors, which control position and orientation.
FineAdjust3DFrame S20.png The Anchor controls are:-
 The Horizontal and Vertical Anchors 
 Red   Green   Blue  move the object (forward and back) in the direction of the Anchor line
 The Rotational Anchors 
 Red   Green   Blue  rotate the object (clockwise and anti-clockwise) along the Anchor arc line
 The Object Anchor 
     (black central dot) moves the object in any horizontal direction


For detailed information on using the Fine Adjustment Tool see the Trainz Wiki page WikiLink.PNG How to Use the Surveyor 2.0 Tools


The Marquee Tool

S20 MarqueeToolIcon.png Keyboard Shortcut:  F  The  Marquee Tool  selects the content in areas of a route, creates and deletes baseboards and sets their properties. It can also be used in creating Scrapbooks


MarqueeTools S20.png
The Marquee Tool draws out a rectangular area, the Marquee Selection Area, on the route. Any objects (including Ground Heights, Ground Textures and Effect Layers) that are inside the Marquee Selection Area or touched by its boundary will be selected. The contents of the area can then be moved, rotated, deleted or copied to a Scrapbook.

It can also draw an area outside the boundaries of a route to add new baseboards.


For detailed information on using the Marquee Tool see the Trainz Wiki page WikiLink.PNG How to Use the Surveyor 2.0 Tools


  Top Next Up Next Down Bottom


The Tool Options Palette

This palette is used by various tools to set controls and parameters. For a detailed description of all the options presented by the Tools Palette for the different tools, see the Trainz Wiki page WikiLink.PNG How to Use the Surveyor 2.0 Tools


ToolOptionsPaletteNone S20.png All the Tool Options controls and settings are shown in the image on the left. The controls are shown as being "inactive".

Some examples of when the controls will become active are:-

Ablue.png A Brush Tool is selected then the painting controls will become active - shown with gold icons below. The controls will affect the behaviour of the brush tool. The exact controls that will be active will vary between the different brushes and brush actions. For example, selecting a specific type of brush and brush action as shown below.
BrushToolsHeightSet S20.png  Ground Height Brush  and  Set Height  action selected

In this example, only 3 of the controls will be active. They will set the terrain height under the brush to the value shown in the height setting. The controls are:-

 Radius  the brush radius (metres)
Range:  5m and above
 Height  the brush height (metres)
Range:  -3000m to 3000m
 Sensitivity  the rate at which the height changes
Range:  1% (very slowly) to 100% (very quickly)


Bblue.png A Track Spline Object is selected with the Free Move Tool or the Fine Adjustment Tool then certain controls that will affect the placement of the track will become active.
PlacementSplineTools S20.png
 Grade  spline gradient. The finishing endpoint of each spline segment will be set higher (for a positive grade) or lower (for a negative grade) than the starting endpoint
Range:  0% (flat) to ±100% (steep but not vertical)
 Condition  this applies to Track Spline objects and sets the track condition (or "ride comfort") for each segment
Range:  1% (terrible track condition) to 100% (perfect track condition)
PencilTips.PNG The Track Condition can also be set for each track segment in its Context Menu  Edit Properties  option


Cblue.png The Scrapbook Data Brush is selected to paint the current Scrapbook into the route. The controls that will affect the painting of the Scrapbook will depend on the brush action selected.
 Scrapbook Brush 
Brush options
 Scrapbook Clone 
Clone options

 Radius  the brush radius (metres)
Range:  5m and above
 Rotation  initial rotation angle (degrees)
Range:  0° to ±360° (larger angles can be entered)
 Scale  the scrapbook scaling factor
Range:  0.01% = smallest to 100% = full size
 Shape  brush shape
Options:  BrushToolsScrapShapes S20.png Circle and Square will set the brush to the selected shape
  Natural will set the brush to the same shape as the Marquee that created the scrapbook, which may be rectangular. The Radius setting will set the relative brush dimensions


  Top Next Up Next Down Bottom


The Assets Palette

This palette is used by various tools and other palettes to select and identify assets and objects. It includes a filter function to narrow down the search and selection process.


  Top Next Up Next Down Bottom

The Layers Palette

This palette is used to manage layers, both object (route and session) and effect (TurfFX, clutter and water) layers. It can create, rename, delete, move, hide/show and lock/unlock layers and set the Active Layer.


Layers Palette in S20 The Layers Palette will show all the layers in their groups (Effect, Route and Session) plus the Ground Height and Ground Textures special "layers". In the image on the left all the layer groups have been minimised (the arrowhead symbol to the left of each group name is pointing to the right).
DotPoint.JPG The Route Layers group, along with the Ground Height, Ground Textures and Effect Layers, are saved and loaded with the Route
DotPoint.JPG The Session Layers group is saved and loaded with the Session. A Session Layers group, but one without any stored objects, will be present in all routes


Lock the Route Layer Group

All the Route Layers can be locked against accidental alteration.


The Route Layers group has a open padlock icon next to its name - shown as LayerUnLocked S20.png (unlocked).

Steps: To lock/unlock all the route layers:-
DotPoint1.JPG Left click on the unlocked (open padlock) icon to lock ALL the route layers
The icon will change to LayerLocked S20.png (locked)
DotPoint2.JPG Left click on the locked (closed padlock) icon to unlock ALL the route layers
The icon will change to LayerUnLocked S20.png (unlocked)


Open a Layer Group

To the left of each group name is a small arrowhead pointing to the right. Left click on the arrowhead to open up the group.

Layers palette with session layers open The image on the left shows that the Session Layers is open and its individual layers are now displayed. To close or minimise the group Left click on the arrowhead again.

The image shows that the Session Layers contains 3 individual layers:-

DotPoint.JPG the top layer in the Session Layers group is always named session-layer. It is possible to rename this layer and move it to a new position but those actions are NOT recommended for the session-layer.
DotPoint.JPG likewise, the top layer in the Route Layers group is always named route-layer. It is also possible to rename this layer and move it to a new position but again those actions are NOT recommended for the route-layer.
DotPoint.JPG there are two additional user created layers in the Session Layers group. They are named Track Markers and Rail Workers - layer names are chosen by the creator and do not necessarily indicate their contents or purpose
DotPoint.JPG the Rail Workers layer is highlighted in blue which means that it has been selected by a Left click and is now the Active Layer where any newly placed assets will be added


Add a New Layer

You cannot create new layer groups but you can add new layers to a existing group.
Each layer group has a LayerAdd S20.png icon next to its name. Left click on the icon to add and name a new layer to that group. If you are adding a new Effect Layer then you will also have to identify the type of effect - TurfFX, Clutter or Water.

Renaming a Layer

LayerRename S20.png Right click on a layer name and select  Rename Layer..  from the popup menu.

You will be asked to enter a new name for the layer.


Deleting a Layer

LayerDelete S20.png
Steps: To delete a layer:-
DotPoint1.JPG Right click on a layer name and select  Delete Layer  from the popup menu.
You will be given a warning that you are about to delete a layer.
DotPoint2.JPG if you confirm the delete order then the layer and ALL of its contents will be deleted
DotPoint3.JPG depending on the contents of the layer and the size of the route, the process may take some time. You will be shown a progress bar in a message window during the delete operation
  LayersDelete S20.png
DotPoint4.JPG when the message  Operation complete, layers updated successfully  appears close the message window
The deleted layer and its contents can be restored (after the delete has completed) using the  Ctrl   Z  keys


Moving a Layer

Layers can be individually moved up and down within the same layer group or between the Route Layers and the Session Layers groups.

NotePad.PNG Notes:

DotPoint.JPG moving a layer between the Session Layers and the Route Layers groups will move the layer and its contents from one group to the other and this will affect where the layer and its contents are saved
DotPoint.JPG there is no advantage in moving a layer within the same layer group except if you are preparing for a layer merge operation (see Merging a Layer below)
DotPoint.JPG layers in the Effect Layers group cannot be moved
DotPoint.JPG layers from the other groups cannot be moved into the Effect Layers group
DotPoint.JPG the Ground Height and Texture layers are special single layers, not groups of layers, and cannot be moved or have other layers added to them


LayersMove1 S20.png
Moving the Rail Workers layer up one level
Steps: To move a layer:-
DotPoint1.JPG Left Click and Drag the layer name up or down to its new position.
DotPoint2.JPG release the layer in its new position.
DotPoint3.JPG depending on the contents of the layer and the size of the route, the process may take some time. You will be shown a progress bar in a message window during the move operation
DotPoint4.JPG at the conclusion, hopefully, you will be shown a message "Operation complete"
LayersMoveSuccess S20.png
DotPoint5.JPG close the progress message window
The move can be reversed (after it has completed) by using the  Ctrl   Z  keys


NotePad.PNG Notes: Moving Layers - What Could Possibly Go Wrong?

Well, a great deal it seems. You may get a different message during the layer move operation.
LayersMoveFailure S20.png
The most common error when moving layers is, as the message above states, an invalid hierarchy. This occurs when a layer is moved to an incorrect level for the type of objects it contains. It is Track Splines and Track Objects (e.g. signals, switches, speed signs, etc) that cause this problem.
The situation that created the error messages shown above is shown in the image below left:-
LayersMoveFail S20.png
DotPoint.JPG all the track splines, the  parent track  identified in the error messages, are in the route-layer
DotPoint.JPG track objects, in this case signals but any track objects could have been used, have been placed in the Signals layer. This layer, according to the order of the layers from the top to the bottom, is one layer below the route-layer that contains the track where the signals are attached. In this position, physically below the route-layer, the Signals layer and the track objects it contains will cause no problems
DotPoint.JPG the Signals layer is being moved up to a position shown by the dashed red line. The new position, again according to the order of the layers from the top to the bottom, is one layer above the route-layer.
PencilTips.PNG The final error message shown is confusing and, from a commonsense point of view, incorrect.

 Trackside objects cannot be in a layer below the layer their track is in. 
Best Advice: Ignore the word below and replace it with the word above so the message reads
 Trackside objects cannot be in a layer above the layer their track is in. 

Solutions to This Problem:

Ablue.png use the route-layer to hold the track splines and never move any layer containing track objects, or any layer at all to be absolutely safe, above this layer OR
Bblue.png use the route-layer to hold the track splines and ALL track objects
Track objects such as Trackmarks and Triggers that are needed for a session but not the route can still be placed in the Session Layers group as long as the layer used remains in the Session Layers group


Merging a Layer

LayerMerge S20.png Right click on a layer name and select  Merge Layer Up  from the popup menu.
DotPoint.JPG the selected layer will be merged with the layer immediately above it
DotPoint.JPG you may need to move the layer being merged into the correct position before the merge (see Moving a Layer above)
DotPoint.JPG depending on the contents of the layer, the process may take some time. You will be shown a progress bar in a message window during the merge operation
DotPoint.JPG the merged layers and their contents can be restored (after the merge has completed) back into two separate layers by using the  Ctrl   Z  keys
DotPoint.JPG layers in the Effect Layers Group cannot be merged. In place of  Merge Layer Up  the Effect Layers will have an  Edit Layer  command


Hiding Layers

Each individual layer has an Eye icon that controls the state (visible or hidden) of that layer. Left click on the icon to toggle its state between visible and hidden.
If the Eye icon is:-

LayerEyerOpen S20.png open then layer is visible in both Surveyor and Driver
LayerEyerClosed S20.png closed then layer is hidden in both Surveyor and Driver


Locking Layers

Each individual layer has a Padlock icon that controls the state (locked or unlocked) of that layer. Left click on the icon to toggle its state between locked and unlocked.
If the Padlock icon is:-

LayerUnLocked S20.png open then the layer is unlocked and can be edited
LayerLocked S20.png closed then the layer is locked and cannot be edited
NotePad.PNG Notes:

DotPoint.JPG Locking a layer will protect its contents from being individually selected, deleted and physically moved
DotPoint.JPG New assets cannot be added to a locked layer
DotPoint.JPG Locked layers can still be deleted, renamed, moved and merged


Setting the Active Layer

Active layer selected The Active Layer is the layer where new objects will be automatically added when using the Placement Tool. The active layer is shown in the palette with its name on a blue background. In the image on the left the Rail Workers layer is the current Active Layer.

The name of the current Active Layer is also shown in the Layer Palette Title Bar.

To set a new Active Layer, Left click on a layer name.


Move an Object to a New Layer

The Info Palette will show the layer assigned to the currently selected object. An object is selected by using the Free Move Tool (the  S  key) or the Fine Adjustment Tool (the  D  key) found in the Tools Palette.

Info palette

Layer control

Steps: To assign an object to a layer:-
DotPoint1.JPG Switch to the Info Palette. If this palette is not visible then refer to PageLink.PNG Hiding and Showing Palettes at the top of this document
DotPoint2.JPG Left click the small arrowhead next to the layer name. This will open the layer properties for the selected object
DotPoint3.JPG Left click the Layer drop down box to select a new layer for the object
DotPoint4.JPG if required, Left click the Binding drop down box to select a new binding layer for the object
DotPoint5.JPG if required, Left click the  Lock Layer  button to lock the selected layer. If the layer is already locked then this will be shown as an  Unlock Layer  button


  Top Next Up Next Down Bottom

The Scrapbook Palette

If the Scrapbook Palette is not visible on the screen then refer to PageLink.PNG Hiding and Showing Palettes at the top of this document.


This palette manages the Scrapbooks that you have created yourself, installed from other sources (such as the DLS) or came installed with Trainz. It also controls which parts of a scrapbook are pasted or painted into a route.


NotePad.PNG Notes:

Scrapbooks, when created, will contain:-
DotPoint.JPG Ground Heights
DotPoint.JPG Ground Textures
DotPoint.JPG Effect Layers - if present
DotPoint.JPG Selected Objects - scenery items, splines, track, signals, etc
 But NOT Rolling Stock (Trains) 
Ground heights, textures and effect layers are always included in a scrapbook but you can control which visible objects are added by manually selecting them or using the filter controls in the Assets Palette
NotePad.PNG Notes:

Scrapbooks, when painted or pasted, can contain any combinations of:-
DotPoint.JPG Ground Heights
DotPoint.JPG Ground Textures
DotPoint.JPG Effect Layers
DotPoint.JPG Scenery Objects (Meshes) - individual buildings, trees, signals, etc
DotPoint.JPG Scenery Splines - roads, track, fences, etc
You have options that will control which of these data categories are transferred and how they are transferred from the scrapbook into a route.


ScrapbookToolsTop S20.png
ScrapbookPinnedIcon S20.pngScrapbookUnPinnedIcon S20.png Left click on the pin icon to Lock (blue pin) and Unlock (white pin) the scrapbook. Locked scrapbooks are permanent (but can still be deleted). Unlocked scrapbooks will "expire" (self delete) after 5 days
DeleteIcon S20.png Left click on the delete icon to delete the current scrapbook - most scrapbooks can be deleted (see Notes: Deleting Built-in Scrapbooks below for the exceptions to this)
ScrapbookCounter S20.png Identifies the currently displayed scrapbook (the first number) and the total number of stored scrapbooks (the second number)
ScrapbookLeftRight S20.png Left click on the  <  or  >  to move forwards or backwards through the stored scrapbooks to select the scrapbook that will be added to the route
  The scrapbook name can be edited. Simply Left click inside the name box to edit or replace the current name. Left click on the image to make the name change permanent and pin (lock) the scrapbook


NotePad.PNG Notes: Deleting Built-in Scrapbooks

Some scrapbooks are installed with Trainz and cannot be deleted. These scrapbooks have the label Prefab at the front of their names (you may have to scroll to the front of the name to see it). While they cannot be deleted they can be "disabled" so that they won't appear as an installed scrapbook. Unlocking them will not cause them to "expire" - after 5 days they will just become locked again.
Steps:
DotPoint1.JPG Open Content Manager and locate the "permanent" scrapbook or scrapbooks.
Search Tips: Name: starts with "Prefab"; Status: is Built-in; Type: is Misc
DotPoint2.JPG Highlight (select) the Scrapbook assets
DotPoint3.JPG Open the Content menu and select Disable
You can reverse this and Enable any or all of these scrapbooks later if you need them.


Creating a New Scrapbook

A new scrapbook can be created by:-
Ablue.png Selecting one or more assets and pressing  Ctrl   C  OR
Bblue.png Drawing a Marquee Selection Area around one or more assets and either:-
DotPoint.JPG press  Ctrl   C  OR
DotPoint.JPG open the Trainz Edit Menu and select  Cut  or  Copy 


PencilTips.PNG You don't have to use the Marquee Tool to create a new Scrapbook. You can use the Free Move Tool or the Fine Adjustment Tool to select any number of objects and then press  Ctrl   C . The selected objects, along with the ground height, ground textures, and any effect layers, will be copied into a new Scrapbook


When a new Scrapbook is created by a  Cut  or  Copy , it will appear in the Scrapbook palette with some basic details.

ScrapbookNew S20.png
The newly created scrapbook will be given:-
DotPoint.JPG a name consisting of the date and time of its creation
DotPoint.JPG a thumbnail
PencilTips.PNG The thumbnail image will be taken using the current camera POV (point of view). To get a better image adjust the camera position and view to give the best possible shot of the Scrapbook objects before giving the  Cut  or  Copy  command
DotPoint.JPG a scrapbook number (it will be inserted as №1 scrapbook)
DotPoint.JPG an expiry date which will be set 5 days after its creation - this will countdown each day until 0 when the new scrapbook will be deleted


NotePad.PNG Notes:

Scrapbooks use very little memory so there is no real limit to how many you can store in the palette but finding the one you want will be more difficult as the list grows longer


PencilTips.PNG Most scrapbooks, old and new, can be deleted at any time by clicking the Delete DeleteIcon S20.png icon. See Notes: Deleting Built-in Scrapbooks in the section above for the exceptions


Deleting a Scrapbook after it has been pasted does not delete the objects that it pasted into the route


There are two changes that can be made to the new scrapbook:-
DotPoint.JPG Give it a name - Left click inside the Name Text Box and type a new name
DotPoint.JPG Make it permanent - Left click the white Pin icon (ScrapbookUnPinnedIcon S20.png). The scrapbook will no longer expire but it can still be deleted at any time
Pinned scrapbooks are always shown with a blue pin icon ScrapbookPinnedIcon S20.png and the words "pinned, no expiry" displayed next to their scrapbook №
PencilTips.PNG The Pinning of any scrapbook can be reversed so that it will then expire in 5 days time. Simply Left click the blue pin icon.
ScrapbookNewNamedPinned S20.png


Once a scrapbook has been Pinned it becomes an asset and will appear in Content Manager

ScrapbookEntryCM S20.png

The scrapbook can be uploaded to the DLS and saved as a CDP file.

PencilTips.PNG You can archive your scrapbooks as CDP files to keep the number of installed scrapbooks to a minimum. If an archived scrapbook is needed then you can use the Import Content Files option in Content Manager to add it to the Scrapbook Palette. It can be deleted from the palette later, when no longer needed.


Painting or Pasting a Scrapbook

Existing Scrapbooks can be painted into a route using the Brush Tool (see the Trainz Wiki page WikiLink.PNG How to Use the Surveyor 2.0 Tools) or Pasted into a route.

The current Scrapbook can be Pasted into a route at the cursor (the Compass Rose) position by:-
Ablue.png pressing  Ctrl   V , OR
Bblue.png selecting  Paste  from the Context Menu of a selected object
In both cases the scrapbook contents will be pasted using the original scrapbooks size. It will be pasted inside a Marquee Selection Area that can be moved and resized. The objects that are pasted and how they are pasted is controlled by the current Scrapbook Palette filter settings


Left click on the arrowhead next to the  Filters:  label below the scrapbook image to open the scrapbook filter controls. These filters will control which elements in the scrapbook will be added to the route and how thay will be added.

ScrapbookToolsBottom S20.png


For example: To paint a scrapbook asset onto a route with certain conditions set:-
 Ground Height:   None  ground height data will not be pasted and the ground heights already in the target area will be used
 Ground Texture:  Overwrite  textures present in the scrapbook will replace those already in the target area
 Meshes:  Add  scenery objects in the scrapbook will be added to those already in the target area
 Splines:  Add  scenery splines in the scrapbook will be added to those already in the target area
 Effect Layers:   None  effect layers in the scrapbook will not be pasted and any already in the target area will be used
 Scrapbook Painting/Pasting Options 
 What Data to Transfer 
    Ground Height  terrain height(s) used in the scrapbook
    Texture  textures used in the scrapbook
    Meshes  scenery objects (e.g. trees, buildings) used in the scrapbook
    Splines  spline objects used in the scrapbook
    Effect Layers  effect layers (TurfFX, Clutter) used in the scrapbook
 How to Transfer the Data
    None  do not paste this feature
    Add  add this feature to those already present
    Overwrite  use this feature to replace those already present
For the Ground Height:-
    Absolute  use the ground heights in the scrapbook to replace the existing ground heights
    Relative  modify the existing ground heights according to those used in the scrapbook (to ignore the scrapbook ground heights completely select the option None)


  Top Next Up Next Down Bottom

The Preview Palette

This palette gives a rotating 3D view of a selected asset


  Top Next Up   Bottom

The Packages Palette

This palette


  Top Next Up    


Trainz Wiki

TrainzWiki.png

More Tutorials and Guides to Using Trainz


This page was created by Trainz user pware in February 2023 and was last updated as shown below.


Personal tools