How to Use S20 Tools

From TrainzOnline
(Difference between revisions)
Jump to: navigation, search
(fixed heading levels)
m (added internal links)
Line 40: Line 40:
 
<td>[[image:Tools_S20.png|link=|alt=Tools and keymap for S20]]</td>
 
<td>[[image:Tools_S20.png|link=|alt=Tools and keymap for S20]]</td>
 
<td>
 
<td>
 +
<span id="Notes_Palettes"></span>
 
<table bgcolor=#000000 width=500 cellpadding=2>
 
<table bgcolor=#000000 width=500 cellpadding=2>
 
<tr valign="top">
 
<tr valign="top">
Line 78: Line 79:
 
<tr valign="top">
 
<tr valign="top">
 
<td>3. </td>
 
<td>3. </td>
−
<td>make sure that the '''Tools Options Palette''' is also visible</td>
+
<td>make sure that the '''Tool Options Palette''' is also visible</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
Line 148: Line 149:
 
=='''<span style="color: white; background-color: blue;">&#160;Ground Height&#160;</span>'''==
 
=='''<span style="color: white; background-color: blue;">&#160;Ground Height&#160;</span>'''==
  
−
This brush tool uses the '''Tools Options Palette'''. If this palette is not visible on the screen then refer to '''Notes: Palettes''' at the top of this document.<br>
+
This brush tool uses the '''Tool Options Palette'''. If this palette is not visible on the screen then refer to [[image:PageLink.PNG|link=]]&nbsp;'''[[#Notes_Palettes|Notes: Palettes]]''' at the top of this document.<br>
  
 
<table width=700>
 
<table width=700>
Line 168: Line 169:
 
<table width=1000>
 
<table width=1000>
 
<tr valign="top">
 
<tr valign="top">
−
<td colspan=4>The available brush tool options are shown in the '''Tools Options Palette''' with a <span style="font-size: 15px; font-weight: 700; color: gold; background-color: black;">&#160;Gold&#160;</span> coloured icon next to their names. Those options that have their icon greyed out will be ignored, but they can still be edited.</td>
+
<td colspan=4>The available brush tool options are shown in the '''Tool Options Palette''' with a <span style="font-size: 15px; font-weight: 700; color: gold; background-color: black;">&#160;Gold&#160;</span> coloured icon next to their names. Those options that have their icon greyed out will be ignored, but they can still be edited.</td>
 
</tr>
 
</tr>
 
<tr valign="top" align="center">
 
<tr valign="top" align="center">
Line 287: Line 288:
 
=='''<span style="color: white; background-color: blue;">&#160;Ground Texture&#160;</span>'''==
 
=='''<span style="color: white; background-color: blue;">&#160;Ground Texture&#160;</span>'''==
  
−
This brush tool uses the '''Tools Options Palette'''. If this palette is not visible on the screen then refer to '''Notes: Palettes''' at the top of this document.<br>
+
This brush tool uses the '''Tool Options Palette'''. If this palette is not visible on the screen then refer to [[image:PageLink.PNG|link=]]&nbsp;'''[[#Notes_Palettes|Notes: Palettes]]''' at the top of this document.<br>
  
 
When the '''Ground Texture Target''' is selected, the second drop down box will be disabled - there are no brush texture tool choices.<br>
 
When the '''Ground Texture Target''' is selected, the second drop down box will be disabled - there are no brush texture tool choices.<br>
  
−
The available brush tool options are shown in the '''Tools Options Palette''' with a <span style="font-size: 15px; font-weight: 700; color: gold; background-color: black;">&#160;Gold&#160;</span> coloured icon next to their names. Those options that have their icon greyed out will be ignored, but they can still be edited.<br>
+
The available brush tool options are shown in the '''Tool Options Palette''' with a <span style="font-size: 15px; font-weight: 700; color: gold; background-color: black;">&#160;Gold&#160;</span> coloured icon next to their names. Those options that have their icon greyed out will be ignored, but they can still be edited.<br>
  
 
<table width=700>
 
<table width=700>
Line 407: Line 408:
 
=='''<span style="color: white; background-color: blue;">&#160;Scrapbook Data&#160;</span>'''==
 
=='''<span style="color: white; background-color: blue;">&#160;Scrapbook Data&#160;</span>'''==
  
−
This brush tool uses both the '''Tools Options Palette''' and the '''Scrapbook Palette'''. If these palettes are not visible on the screen then refer to '''Notes: Palettes''' at the top of this document.<br>
+
This brush tool uses both the '''Tool Options Palette''' and the '''Scrapbook Palette'''. If these palettes are not visible on the screen then refer to [[image:PageLink.PNG|link=]]&nbsp;'''[[#Notes_Palettes|Notes: Palettes]]''' at the top of this document.<br>
  
 
<table width=700>
 
<table width=700>
Line 434: Line 435:
 
*If the brush is large then the contents will be spaced further apart
 
*If the brush is large then the contents will be spaced further apart
 
*Every '''Left Click''' will paste another complete scrapbook copy
 
*Every '''Left Click''' will paste another complete scrapbook copy
−
*The '''Scale''' control in the '''Tools Options Palette''' is ignored.<br></td>
+
*The '''Scale''' control in the '''Tool Options Palette''' is ignored.<br></td>
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
Line 450: Line 451:
 
<table width=900>
 
<table width=900>
 
<tr valign="top">
 
<tr valign="top">
−
<td colspan=3>The available brush tool options are shown in the '''Tools Options Palette''' with a <span style="font-size: 15px; font-weight: 700; color: gold; background-color: black;">&#160;Gold&#160;</span> coloured icon next to their names. Those options that have their icon greyed out will be ignored, but they can still be edited.</td>
+
<td colspan=3>The available brush tool options are shown in the '''Tool Options Palette''' with a <span style="font-size: 15px; font-weight: 700; color: gold; background-color: black;">&#160;Gold&#160;</span> coloured icon next to their names. Those options that have their icon greyed out will be ignored, but they can still be edited.</td>
 
</tr>
 
</tr>
 
<tr valign="top" align="center">
 
<tr valign="top" align="center">
Line 683: Line 684:
 
The '''Placement Tool''' is used to add assets to the route.  
 
The '''Placement Tool''' is used to add assets to the route.  
  
−
This tool uses the '''Assets Palette'''. If this palette is not visible on the screen then refer to '''Notes: Palettes''' at the top of this document.<br>
+
This tool uses the '''Assets Palette'''. If this palette is not visible on the screen then refer to [[image:PageLink.PNG|link=]]&nbsp;'''[[#Notes_Palettes|Notes: Palettes]]''' at the top of this document.<br>
  
 
The first step is to identify and select the particular asset that you want to add to the route.<br>
 
The first step is to identify and select the particular asset that you want to add to the route.<br>
Line 845: Line 846:
 
The '''Eyedropper Tool''' is used to identify objects that are in the route. The objects can be textures, effect layers, scenery, rolling stock, track. track equipment, and splines.<br>
 
The '''Eyedropper Tool''' is used to identify objects that are in the route. The objects can be textures, effect layers, scenery, rolling stock, track. track equipment, and splines.<br>
  
−
This tool uses the '''Assets Palette'''. If this palette is not visible on the screen then refer to '''Notes: Palettes''' at the top of this document.<br>
+
This tool uses the '''Assets Palette'''. If this palette is not visible on the screen then refer to [[image:PageLink.PNG|link=]]&nbsp;'''[[#Notes_Palettes|Notes: Palettes]]''' at the top of this document.<br>
  
 
=='''Quick Steps'''==
 
=='''Quick Steps'''==
Line 1,003: Line 1,004:
 
</table>
 
</table>
  
−
The '''Free Move Tool''' is used to move objects in the route.  
+
The '''Free Move Tool''' is used to move objects around the route. Movements are in the XY (horizontal) axes only. The objects height is fixed to the terrain height.<br>
 +
 
 +
This tool does not need any other palettes. None of the controls in the '''Tool Options Palette''' are active. However it will display position data in the '''Info Palette'''. If this palette is not visible on the screen then refer to [[image:PageLink.PNG|link=]]&nbsp;'''[[#Notes_Palettes|Notes: Palettes]]''' at the top of this document.<br>
 +
 
 +
 
 +
 
 +
 
 
<table> <!-- BEGIN Nav Buttons Table -->
 
<table> <!-- BEGIN Nav Buttons Table -->
 
<tr valign="top">
 
<tr valign="top">

Revision as of 09:17, 9 January 2023

The information in this Wiki Page applies to Surveyor 2.0 (S20) as found in Trainz Plus.

This document is  under development 

Contents
In Summary:
DotPoint.JPG
DotPoint.JPG
  Top   Next Down Bottom

The Tools Palette

Tools and keymap for S20

NotePad.PNG Notes: Palettes

If the Tools Palette is not shown on the screen, then:-

Windows Menu
1. open the Window Menu from the menu icons at the top of the screen
 
  • visible palettes with have ticks next to their names
2. Left click on the item Tools Palette
 
  • this will add a tick and make the Tools Palette visible
3. make sure that the Tool Options Palette is also visible

The Brush Tool

S20 BrushToolIcon.png Keyboard Shortcut:  W 

The Brush Tool is used for painting the route. It can:-

  • adjust the height of the terrain
  • add ground textures
  • add Effect Layers
  • add Scrapbook scenes

When selected, the Brush Tool will show two drop down menu lists.

Brush Tools
The first drop down menu will set the Brush Target, the type of brush.
The Targets are:-
  • Ground Height
  • Ground Texture
  • Scrapbook Data
  • <List of Effect Layers>
  • 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 effect.


 Ground Height 

This brush tool uses the Tool Options Palette. If this palette is not visible on the screen then refer to PageLink.PNG Notes: Palettes at the top of this document.

When the Ground Height Target is selected, the second drop down box will give a choice of several Ground Height tools.
The choices are:-
  • Height Up
  • Height Down
  • Set Height
  • Grade
BrushToolsHeightOptions S20.png
The available brush tool options are shown in the Tool Options Palette with a  Gold  coloured icon next to their names. Those options that have their icon greyed out will be ignored, but they can still be edited.
 Height Up/Height Down 
Up/Down brush options		  Set Height 
Height brush options		  Grade 
Grade brush options
 Radius  the brush radius (metres) - see Notes: below
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 fast)
 Grade  slope gradient - see Notes: below
Range:  0% = flat ("Plateau" in Classic) to
  ±100% = steep (but not vertical)
 Angle  grade direction (compass degrees)
Range:  0° (North) to ±359°
a negative value reverses the grade
NotePad.PNG Notes:
DotPoint.JPG Unlike Surveyor Classic, there appears to be no upper limit to the brush  Radius . Brushes of hundreds of metres (even kilometres) in size are possible. However, if you are using the brush to set an entire baseboard, or many baseboards, to a specific height then the Marquee Tool may be a better choice.
DotPoint.JPG The  Grade  may cause some confusion. It is defined as height (vertical) over distance (horizontal) converted to a percentage figure. So a grade of 100% (the maximum allowed) would mean a slope formed by the height and distance both being the same value (e.g. a height increase of 50m over a distance of 50m). A vertical slope (a cliff) would have an infinite grade which is currently impossible in Surveyor.


 Ground Texture 

This brush tool uses the Tool Options Palette. If this palette is not visible on the screen then refer to PageLink.PNG Notes: Palettes at the top of this document.

When the Ground Texture Target is selected, the second drop down box will be disabled - there are no brush texture tool choices.

The available brush tool options are shown in the Tool Options Palette with a  Gold  coloured icon next to their names. Those options that have their icon greyed out will be ignored, but they can still be edited.

Texture brush options
 Radius  the brush radius (metres) - see Notes: below
Range:  5m and above
 Sensitivity  texture transparency
Range:  1% = almost transparent to
  100% = solid (opaque)
 Rotation  initial rotation angle - see Notes: below
Range:  0° to ±360° (larger angles can be entered)
 Scale  the texture pattern scaling factor
Range:  0.01% = smallest to 100% = full size
NotePad.PNG Notes:
DotPoint.JPG Unlike Surveyor Classic, there appears to be no upper limit to the brush  Radius . Brushes of hundreds of metres (even kilometres) in size are possible. If you are using the brush to paint an entire baseboard, or many baseboards, then the Marquee Tool will be quicker but it will not give the options of changing the scale and rotation.
DotPoint.JPG The  Rotation  controls the starting angle for the texture when painting and is often used to avoid pattern repetition. As in Surveyor Classic, holding down the  [  or  ]  keys while painting will continuously change the rotation angle.
Stop.PNG Warning: Changing the rotation angle during painting is not recommended for PBR Textures as this will significantly increase the memory useage (each rotation will load in another copy of the PBR texture).


 Scrapbook Data 

This brush tool uses both the Tool Options Palette and the Scrapbook Palette. If these palettes are not visible on the screen then refer to PageLink.PNG Notes: Palettes at the top of this document.

 The Scrapbook Brush 

When the Scrapbook Data Target is selected, the second drop down box will give a choice of two Scrapbook Data tools.

The choices are:-
  • Scrapbook Brush
  • Scrapbook Clone
BrushToolsScrapbookOptions S20.png


 Scrapbook Brush  will resize the scrapbook contents to fit the selected brush shape and size.
  • If the brush is small then the scrapbook contents will be compressed closer together
  • If the brush is large then the contents will be spaced further apart
  • Every Left Click will paste another complete scrapbook copy
  • The Scale control in the Tool Options Palette is ignored.
 Scrapbook Clone  will paste the scrapbook at its original size - subject to the Scale setting.
  • If the brush is the same size as the original scrapbook then a single exact copy will be pasted
  • If the brush is smaller than the original scrapbook size then only the central part of the scrapbook will be revealed and more will be added when the brush is moved around until the "painted" area reaches the size of the original. Further painting will clone or tile the scrapbook contents
  • If the brush is larger than the original scrapbook size then the contents will be cloned or tiled to fill the set brush size
  • The Scale control is not ignored but selecting extremes (e.g. a very large brush and a very small scale value) can cause problems (e.g. system "lockup" while it attempts to scale and clone the scrapbook contents)


The available brush tool options are shown in the Tool Options Palette with a  Gold  coloured icon next to their names. Those options that have their icon greyed out will be ignored, but they can still be edited.
 Scrapbook Brush 
Brush options		  Scrapbook Clone 
Clone options
 Radius  the brush radius (metres) - see Notes: below
Range:  5m and above
 Rotation  initial rotation angle (degrees) - see Notes: below
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
NotePad.PNG Notes:
DotPoint.JPG Unlike Surveyor Classic, there appears to be no upper limit to the brush  Radius . Brushes of hundreds of metres (even kilometres) in size are possible.
DotPoint.JPG The  Rotation  controls the starting angle for pasting the scrapbook objects. In Surveyor Classic you could only rotate and paste in 90° increments. In S20 you can rotate and paste at any angle.


 The Scrapbook Palette 
Scrapbook palette tools
 Scrapbook Pasting Options 
 What Features to Paste 
    Ground Height  terrain height(s) used in the scrapbook
    Texture  textures used in the scrapbook
    Meshes  scenery assets (e.g. trees, buildings) used in the scrapbook
    Splines  spline assets used in the scrapbook
    Effect Layers  effect layers (TurfFX, Clutter) used in the scrapbook
 How to Paste Each Feature
    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 feature:-
    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)


 Edit Effect Layers... 

When this Target is selected, the Edit Effect Layers options will appear. This is the same as selecting Edit Effect Layers ... from the Trainz Edit Menu.

Open effect layers
  • If no Effect Layers are present then you can create a new one
New effect layer
  • If Effect Layers are present then select one to edit
Edit effect alyers


LinkWiki.PNG

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


  Top Next Up Next Down Bottom

The Placement Tool

S20 PlacementToolIcon.png Keyboard Shortcut:  E 

The Placement Tool is used to add assets to the route.

This tool uses the Assets Palette. If this palette is not visible on the screen then refer to PageLink.PNG Notes: Palettes at the top of this document.

The first step is to identify and select the particular asset that you want to add to the route.

DotPoint1.JPG In the Asset Palette either:-

Ablue.png Left click on an asset selection icon

Filter Icons

GroundTextureFilter S20.png all ground textures
SceneryMeshFilter S20.png all non-spline scenery objects
ScenerySplineFilter S20.png all spline scenery objects
TrackSplineFilter S20.png all track spline objects
TrackMeshFilter S20.png all track objects (signals, etc)
TrainFilter S20.png all rolling stock
PresetFilter S20.png all Effect Layer presets
OR
Bblue.png Left click the Content Drop-down Box

Filter List
Then select Track Objects
Track Objects

PencilTips.PNG  Shortcut 

If you already have the same asset placed in your route then:-

  1. select the Eyedropper Tool in the Tools Palette (or press the  R  key)
  2. Left click on the existing asset object

This will instantly select that particular asset in the filter list.

Jump to Step DotPoint5.JPG below.


DotPoint2.JPG To narrow down the filter list type part of the asset name into the Search Text Box. For example if you have selected Track Objects and want to find "Trackmarks", then type "mark" (UPPER/lower case does not matter).

Text search
DotPoint3.JPG This will list all the Track Objects containing the text "mark" in the filter list.
Filtered list DotPoint4.JPG Select the item Track Mark.

If you are not sure about an asset then double-click on the name to bring up its image and description.
DotPoint5.JPG The final step is to place the selected object into the route.
  1. Click the Placement Tool or press the  E  key
  2. Click on the spot where you want to place the object
NotePad.PNG The Placement Tool will remain on and active until another tool has been selected. So everytime you click another copy of the asset (or another asset if you change your selection) will be added to the route.


NotePad.PNG Notes:

To delete an asset:-

  • if the asset is not already selected (highlighted in green) then:-
    1. select either the:-
      • Free Move Tool (or press  S ) or
      • Fine Adjustment Tool (or press  D )
    2. Left click on the asset to be deleted
  • press the  Delete  key
  Top Next Up Next Down Bottom

The Eyedropper Tool

S20 DropperToolIcon.png Keyboard Shortcut:  R 


The Eyedropper Tool is used to identify objects that are in the route. The objects can be textures, effect layers, scenery, rolling stock, track. track equipment, and splines.

This tool uses the Assets Palette. If this palette is not visible on the screen then refer to PageLink.PNG Notes: Palettes at the top of this document.

Quick Steps

DotPoint1.JPG With the Eyedropper Tool selected, move the mouse pointer (which will now be an eyedropper symbol) onto any object in view.

Eyedropper

Eyedropper

The object will be identified by its asset name appearing in a  ToolTip  below the mouse pointer (image shown left).

Leave the mouse pointer in place for a few seconds and additional information about the asset will be shown, its <kuid> code and Author (image shown below left).


DotPoint2.JPG Left click on the asset to select it in the Filter List.

Asset filter set by the Eyedropper in S20
The type of asset and its name will be automatically selected in all the Asset Palette filters as shown in the image left.


The asset is now ready for use by the Placement Tool

Narrowing the Search

Sometimes (or often) a scene will be too crowded with different scenery assets to be able to use the Eyedropper Tool to easily select a single object. In these cases additional options are available to help "remove the clutter".

At the top of the Assets Palette is a drop down box which controls how the Eyedropper Tool works with the filters that you set.

Assets palette

The drop down box will provide three options:-

  • Filter List
  • Filter Selection
  • Filter Visibility
AssetsPaletteFilterOptions S20.png


These options work with the Asset Filters to help narrow the search for a specific asset or type of asset that is in the route.

 Filter List  this option will have no effect on the operation of the Eyedropper Tool or on the assets displayed on the screen. It is the default setting and any selections made with the eyedropper will be shown in the Assets Palette as described in the section Quick Steps above.
 Filter Selection  this option will restrict the Eyedropper Tool to only working on those assets that are in the filtered list. Assets that are not in the filtered list cannot be selected and will not have their details (name, <kuid>, author) displayed on the screen.
 Filter Visibility  this option will hide all assets that are not in the filtered list. The only exceptions are Ground Textures and Effect Layers which will be visible but, unless they are also in the filtered list, cannot be selected.

As an example the following images show the progressive application of a Visibility Filter.

AssetFilterScene1 S20.png AssestFilteredScene1.png

DotPoint1Blue.png No filter has been applied.

All the assets are visible on the Surveyor screen.

ALL assets can be selected by the Eyedropper Tool

AssetFilterScene2 S20.png AssestFilteredScene2.png

DotPoint2Blue.png The Visibility Filter option has been applied and the filtered list has been set to display only Scenery Splines.

All assets except Scenery Splines, Ground Textures and Effect Layers are now hidden.

Only Scenery Splines can be selected by the Eyedropper Tool.

AssetFilterScene3 S20.png AssestFilteredScene3.png

DotPoint3Blue.png An additional filter has been applied. The word "fence" has been added to the search text box.

All Scenery Splines that do not have the text "fence" in their names have now been hidden.

Only the remaining visible Scenery Splines can be selected by the Eyedropper Tool.

  Top Next Up Next Down Bottom

The Free Move Tool

S20 FreeMoveToolIcon.png Keyboard Shortcut:  S 

The Free Move Tool is used to move objects around the route. Movements are in the XY (horizontal) axes only. The objects height is fixed to the terrain height.

This tool does not need any other palettes. None of the controls in the Tool Options Palette are active. However it will display position data in the Info Palette. If this palette is not visible on the screen then refer to PageLink.PNG Notes: Palettes at the top of this document.



  Top Next Up Next Down Bottom

The Fine Adjustment Tool

S20 FineAdjustmentToolIcon.png Keyboard Shortcut:  D 

The Fine Adjustment Tool is used to make fine adjustments (XYZ axis, rotation, tilt) to objects in the route.

  Top Next Up   Bottom

The Marquee Tool

S20 MarqueeToolIcon.png Keyboard Shortcut:  F 

The Marquee Tool is used to select areas of the route.


  Top Next Up    

Trainz Wiki

TrainzWiki.png

More Tutorials and Guides to Using Trainz

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

Retrieved from "https://online.ts2009.com/mediaWiki/index.php?title=How_to_Use_S20_Tools&oldid=35249"
Personal tools