WMS:Graphical User Interface: Difference between revisions

From XMS Wiki
Jump to navigationJump to search
 
(31 intermediate revisions by 2 users not shown)
Line 1: Line 1:
One of the problems with learning any new software interface is the need to understand both what the program can do (functionality) as well as how the program works (GUI controls). It is a chicken and egg kind of problem because things like display/contour options, panning, zooming, saving files, etc. are meaningless without a purpose or reason, and yet it is hard to also learn how WMS does hydrology without knowing some of the basic GUI operations. Past experience tells us that "sneaking" in some of these operational ideas with the functionality of the tutorials can be confusing and so we have developed this section in order to provide some basic helps on some of the common questions that come up about display options, contour options, manipulating the display, and file management.
[[File:WMS Layout.png|thumb|right|600 px|Example of the WMS layout]]
The '''WMS Graphical User Interface''', or '''GUI''', allows the user to easily manage any project within the [[WMS:WMS|Watershed Modeling System]]. It is divided into a number of sections, listed clockwise starting from the top left (see the image, right):
*Menus
*Macros
*Model Selection
*Modules
*Get Data
*Units
*Properties Winow
*Selection Info
*Cursor Coordinates
*Help Strip
*Drawing Tools
*Project Explorer
*Static and Dynamic Tools
*Graphics Window


==Interface Layout==
Many of these can be separated from the main panel as floating windows, or re-docked in other locations using the double line "handle" at the left or top of the toolbar or panel.
The [WMS:Quick_Tour_-_Getting_Started|Quick Tour]] provides a good overview of the interface layout, as well as other things. If you haven't gone through this tour you should do so now. Specifically you can view the different parts of the [[WMS:Quick Tour - Layout|WMS GUI]], learn about the [[WMS:Quick Tour - Modules|modules]], [[WMS:Quick Tour - Tools|tools]], and [[WMS:Quick Tour - Macros|macro]] palettes, and understand what the [[WMS:Quick Tour - Properties Window|Edit]] and [[WMS:Quick Tour - Help Strip|Help]] strips are.


==Using the Project Explorer==
==Menu Bar==
The Project Explorer has become an important part of the WMS interface. It is used to create new data objects (i.e. coverages, TINs, etc.), to control the visibility of data objects, change the coordinate system, delete, and more. Learning how to interact with the [[WMS:Overview|Project Explorer]] is an important part of understanding WMS.
{{main|WMS:Menu Bar}}
The Menu Bar collects various drop-down menus. Additional menus become available depending on which module or model are selected. For more details on these and other menus, see [[WMS:Menu Bar]].


==Pan, Zoom, and Rotate==
==Macros Toolbar==
Most graphical user environments have the ability to zoom in/out on data, pan, and rotate. Learn more about how these tools work in WMS in the [[WMS:Static Tool Palette|Static Tool Palette]] article.
{{main|WMS:Macros}}
[[File:WMS Macros toolbar.png|thumb|right|Macros toolbar]]
The Macros toolbar collects a number of standard Windows macros as well as several commonly-used commands within WMS.  
{{-}}
==Model Selection==
{{main|WMS:Model Selection}}
[[File:WMSmodelSelector.png|thumb|right|Model selection drop-down]]
The Model Selection drop-down is (by default) located to the right of the Macros toolbar. It allows selection of models supported within the currently-selected module. Selecting a model causes its associated menu(s) to appear in the Menu Bar.  


==Display Options==
The following models, depending on the module selected, are available (listed alphabetically): [[WMS:CE-QUAL-W2|CE-QUAL-W2]], [[WMS:GSSHA|GSSHA]], [[WMS:HEC-1|HEC-1]], [[WMS:HEC-HMS|HEC-HMS]], [[WMS:HEC-RAS|HEC-RAS]], [[WMS:HSPF|HSPF]], [[WMS:MODRAT|MODRAT]], [[WMS:NSS|NSS]], [[WMS:Orange County Unit Hydrograph|OC Hydrograph]], [[WMS:Orange County Rational Method|OC Rational]], [[WMS:Rational Method|Rational]], [[WMS:River Tools|River Tools]], [[WMS:SMPDBK|SMPDBK]], [[WMS:Storm Drain|Storm Drain]], [[WMS:Storm Drain|Storm Drain-FHWA]], [[WMS:SWMM|SWMM]], [[WMS:TR-20|TR-20]], [[WMS:TR-55|TR-55]].
The following display options can be set and controlled from the [[WMS:Display Options|Display Options]] dialog:


:* [[WMS:Display Options#Changing Color|Symbol, line, and text color]]
See [[WMS:Model Selection]] for specifics on the menu options for each module.
:* [[WMS:Display Options#Changing Symbols|Symbol style and size]]
{{-}}
:* [[WMS:Display Options#Changing Line Styles|Line style and thickness]]
==Modules Toolbar==
:* [[WMS:Display Options#Changing Polygon Colors|Polygon color]]
{{main|WMS:Modules}}
:* [[WMS:Display Options#Changing Text Fonts and Styles|Text font and style]]
[[File:Module toolbar in WMS.png|thumb|right|Module toolbar]]
The interface for WMS is divided into eight modules. A module is provided for each of the basic data types or modeling environments supported by WMS.


Check boxes are used to determine whether or not individual entities (points, triangles, contours, etc.) are to be displayed. The check box next to a data object in the [[WMS:Overview|Project Explorer]] window sets the visibility of all entities for that object, regardless of the individual settings in the [[WMS:Display Options|Display Options]] dialog.
The following modules are supported in WMS:
*[[File:WMS TerrainIcon.svg|16 px]] [[WMS:Terrain Data Module|Terrain Data Module]]
*[[File:Drainage Module Icon.svg|16 px]] [[WMS:Drainage Module|Drainage Module]]
*[[File:Map Module Icon.svg|14 px]] [[WMS:Map Module|Map Module]]
*[[File:Hydrologic Module Icon.svg|15 px]] [[WMS:Hydrologic Modeling Module|Hydrologic Modeling Module]]
*[[File:Hydraulic Module Icon.svg|13 px]] [[WMS:Hydraulic Modeling|Hydraulic Modeling Introduction]]
*[[File:GIS Module Icon.svg|16 px]] [[WMS:GIS Module|GIS Module]]
*[[File:2D Grid Icon.svg|16 px]] [[WMS:2D Grid Module|2D Grid Module]]
*[[File:2D Scatter Icon.svg|16 px]] [[WMS:2D Scatter Point Module|2D Scatter Point Module]]


A grid displayed for snapping vertices/points when digitizing, or to use as a scale bar can be defined using the [[WMS:Grid Options|Grid Options]] command from the Display menu.
==Get Data Toolbar==
{{main|WMS:Get Data Toolbar}}
The Get Data toolbar allows the user to import data from a variety of online sources, obtain data from within a WMS project, and import previously-downloaded files from the user's computer.


==Contour Options==
The tools include:
Visualization of contours is an important part of any program that utilizes digital terrain data. The following links provide key information and examples about WMS's contouring capabilities.
*[[Image:Measure Tool.svg|16 px]] [[Measure Tool|'''Measure''']] – Measure the distance and slope along any user defined path if a TIN or DEM is present in the project.
*[[File:WMS AddGISDataIcon.svg|16 px]] '''Add GIS Data''' – Opens an ''Add GIS Data'' dialog allowing opening of GIS files.
*[[File:WMS GetDataFromMapIcon.svg|16 px]] '''Get Data From Map''' – Opens the [[Import from Web|''Virtual Earth Map Locator'' dialog]].
*[[File:Add Online Maps Icon.svg|16 px]] '''Get Online Maps''' – Opens the [[Import from Web|''Virtual Earth Map Locator'' dialog]].
*[[File:WMS GetDataToolIcon.svg|16 px]] '''Get Data''' – Requires existing data in the project and a projection. Drawing a selection box with this tool active opens the [[WMS:Get Data Tool|''Data Service Options'' dialog]].
*[[File:HydrologicModelingWizardIcon.svg|15 px]] '''Hydrologic Modeling Wizard''' – Opens the [[WMS:Hydrologic_Modeling_Wizard|''Hydrologic Modeling Wizard'' dialog]].
*[[File:HY8 ModelingWizardIcon.svg|16 px]] '''HY-8 Modeling Wizard''' – Opens the [[WMS:HY8 Modeling Wizard|''HY-8 Modeling Wizard'' dialog]].
*[[File:HydraulicToolboxIcon.png]] '''Hydraulic Toolbox''' – Launches the [[WMS:Hydraulic Toolbox|Hydraulic Toolbox]].
*[[File:HY8icon.png]] '''HY-8''' – Launches [[HY8:HY-8|HY-8]].
*[[File:MWBM ModelingTool.png]] '''MWBM Modeling Wizard''' – Opens the [[WMS:MWBM Wizard|''MWBM Modeling Wizard'' dialog]].
*[[File:MapFloodIcon.svg|16 px]] '''Map Flood''' – Opens the [[WMS:Map Flood|''Floodplain Mapping Options'' dialog]].


:* [[WMS:Contour Options|Setting contour options]] such as method, legends, and ranges.
==Map Tools Macros Toolbar==
:* [[WMS:Color Ramp|Selecting color schemes]].
[[File:Map Tools Macros toolbar in WMS.png|thumb|right|Map Tools Macros toolbar]]
:* [[WMS:Contour Interval|Choosing the contour interval]].
The Map Tools Macros toolbar contains the following macros:
:* [[WMS:Contour Labels|Placing labels]].
*[[File:WMS Build Polygons macro icon.png]] [[WMS:Feature Objects Menu#Build Polygons|'''Build Polygons''']]
*[[File:WMS Create TIN macro icon.png]] [[WMS:Creating TINs|'''Create TIN''']]
*[[File:WMS Create Grid macro icon.png]] [[WMS:Feature Objects Menu#Create Grid|'''Create Grid''']]


==File Management==
==Units==
WMS incorporates the use of many different files and it can be a bit confusing (especially at first) how all of these files are opened and saved. The following are basic guidelines to file management in WMS with links to more detailed information.
{{main|WMS:Units Toolbar}}
[[File:WMS UnitsBar.png|thumb|right|Units toolbar]]
The Units toolbar displays the ''XY Units'' and ''Z Units'' for the project. The '''Units''' button on the toolbar opens the [[WMS:Edit Menu#Units|''Units'' dialog]].
{{-}}
==Properties Window==
{{main|WMS:Properties Window}}
The Properties window display information about the selected entity in the [[#Main Graphics Window|Main Graphics Window]], as well as allowing some of the attributes of the selected entity to be edited. See [[WMS:Properties Window]] for more details.


:* File types are typically identified by their three letter extension. When [[WMS:Open|opening a file]] the extensions listed relate to the current module. For example if you are in the Map Module then it will look for files with .map, .dxf, .dwg, .tif, etc. since these are the data used primarily in this module. However, any WMS file can be opened from any module, regardless of whether it's extension is currently listed.
==Bottom of the Window==
:* Because WMS manages so many different file types it incorporates a [[WMS:WMS Project Files|project file]] which reads/saves all files and then stores the name and type of file in the project file. It is recommended that you save project files in their own separate directory.
{{anchor|Selection Info|Cursor Coordinates|Help Strip}}
:* The type of file [[WMS:Save As|saved]] is identified by the extension. Unless saving a project file, only the specified file type is saved.
There are three information sections at the bottom of the WMS window.  
:* Sometimes files with formats WMS is capable of reading do not have the same extension as used by WMS. In such cases the file can still be read without changing the extension, however you may have to explicitly define the type of file format it is since WMS will not recognize the extension.
*''Selection Info'' – Displays the name of the current active tool.
:* Some file types are [[WMS:WMS Native Files|native to WMS]] (the format is determined by WMS) and some file types are [[WMS:WMS Non-native Files|non-native]] (defined by some other program, or industry standard).
*''Cursor Coordinates'' – Displays the X, Y, and Z coordinates of the cursor as it moves within the graphics window. If a projection is set, the global coordinates will also display according to the selected projection. See [[WMS:Coordinate Tracking]] for more details.
:* If you [[WMS:Drag and Drop|drag a file]] from Windows Explorer into the main graphics window of WMS it will automatically be opened (as long as the extension matches a WMS supported file type).
*''Help Strip'' – Dsplays context sensitive help messages. See [[WMS:Help Strip]] for more details.
:* WMS will remember recently opened files and display them at the bottom of the File menu for quick access.


==Documentation==
The [[WMS:Drawing Tools|Drawing Tools toolbar]] is located (by default) at the bottom left corner of the WMS window.
This [[WMS:WMS|help file]] comprises the reference information for the WMS interface. Separate [[WMS:Model Documentation|.pdf files for supported models]], along with the [[WMS:WMS Tutorials|tutorials]] for WMS can be found in a directory named "docs" under the main installation directory of WMS. You can open these files with Adobe Acrobat and print if you desire.
 
==Project Explorer==
{{main|WMS:Project Explorer}}
The Project Explorer contains a hierarchical representation of the data associated with a modeling project. It allows the user to manage the data, including creation, visibility, or deletion of data objects. See [[WMS:Project Explorer]] for more details.
 
==Static Tools==
{{main|WMS:Static Tool Palette}}
The Static Tools are commonly-used tools available regardless of which module is active. These include Pan, Zoom, Rotate, View Previous, and View Next. See [[WMS:Static Tool Palette]] for more details.
 
==Dynamic Tool Palettes==
{{main|WMS:Dynamic Tool Palette}}
The dynamic tool palettes contain tools specific to each module, changing depending on which module is active. See [[WMS:Dynamic Tool Palette]] for more details.
 
==Main Graphics Window==
The Main Graphics Window, or simply "Graphics Window", displays the active project, allows the user to use tools and macros to manipulate the contents and change the view and perspective. The [[WMS:Display Options|Display]] and [[WMS:Contour Options|contour options]] can be changed in order to hide or make visible any of the entities within the project, change symbol, arc, point, polygon, and text color, style, and thickness, label entities, and change the colors and transparency of contours used within the project.  


==Related Links==
==Related Links==
* [[WMS:WMS|Getting Started with WMS]]
* [[WMS:WMS|Getting Started with WMS]]
* [[WMS:Menu Bar|Menu Bar]]
* [[WMS:Properties Window|Edit Window]]
* [[WMS:Modules#Module Palette|Module Palette]]
* [[WMS:Toolbars|Tool Palette]]
* [[WMS:Macros|Macros]]
* [[WMS:Help Strip|Help Strip]]
* [[WMS:Project Explorer Overview|Project Explorer]]




{{WMSMain}}
{{WMSMain}}
[[Category:WMS General Information]]

Latest revision as of 21:31, 14 February 2022

Example of the WMS layout

The WMS Graphical User Interface, or GUI, allows the user to easily manage any project within the Watershed Modeling System. It is divided into a number of sections, listed clockwise starting from the top left (see the image, right):

  • Menus
  • Macros
  • Model Selection
  • Modules
  • Get Data
  • Units
  • Properties Winow
  • Selection Info
  • Cursor Coordinates
  • Help Strip
  • Drawing Tools
  • Project Explorer
  • Static and Dynamic Tools
  • Graphics Window

Many of these can be separated from the main panel as floating windows, or re-docked in other locations using the double line "handle" at the left or top of the toolbar or panel.

Menu Bar

The Menu Bar collects various drop-down menus. Additional menus become available depending on which module or model are selected. For more details on these and other menus, see WMS:Menu Bar.

Macros Toolbar

Macros toolbar

The Macros toolbar collects a number of standard Windows macros as well as several commonly-used commands within WMS.

Model Selection

Model selection drop-down

The Model Selection drop-down is (by default) located to the right of the Macros toolbar. It allows selection of models supported within the currently-selected module. Selecting a model causes its associated menu(s) to appear in the Menu Bar.

The following models, depending on the module selected, are available (listed alphabetically): CE-QUAL-W2, GSSHA, HEC-1, HEC-HMS, HEC-RAS, HSPF, MODRAT, NSS, OC Hydrograph, OC Rational, Rational, River Tools, SMPDBK, Storm Drain, Storm Drain-FHWA, SWMM, TR-20, TR-55.

See WMS:Model Selection for specifics on the menu options for each module.

Modules Toolbar

Module toolbar

The interface for WMS is divided into eight modules. A module is provided for each of the basic data types or modeling environments supported by WMS.

The following modules are supported in WMS:

Get Data Toolbar

The Get Data toolbar allows the user to import data from a variety of online sources, obtain data from within a WMS project, and import previously-downloaded files from the user's computer.

The tools include:

Map Tools Macros Toolbar

Map Tools Macros toolbar

The Map Tools Macros toolbar contains the following macros:

Units

Units toolbar

The Units toolbar displays the XY Units and Z Units for the project. The Units button on the toolbar opens the Units dialog.

Properties Window

The Properties window display information about the selected entity in the Main Graphics Window, as well as allowing some of the attributes of the selected entity to be edited. See WMS:Properties Window for more details.

Bottom of the Window

There are three information sections at the bottom of the WMS window.

  • Selection Info – Displays the name of the current active tool.
  • Cursor Coordinates – Displays the X, Y, and Z coordinates of the cursor as it moves within the graphics window. If a projection is set, the global coordinates will also display according to the selected projection. See WMS:Coordinate Tracking for more details.
  • Help Strip – Dsplays context sensitive help messages. See WMS:Help Strip for more details.

The Drawing Tools toolbar is located (by default) at the bottom left corner of the WMS window.

Project Explorer

The Project Explorer contains a hierarchical representation of the data associated with a modeling project. It allows the user to manage the data, including creation, visibility, or deletion of data objects. See WMS:Project Explorer for more details.

Static Tools

The Static Tools are commonly-used tools available regardless of which module is active. These include Pan, Zoom, Rotate, View Previous, and View Next. See WMS:Static Tool Palette for more details.

Dynamic Tool Palettes

The dynamic tool palettes contain tools specific to each module, changing depending on which module is active. See WMS:Dynamic Tool Palette for more details.

Main Graphics Window

The Main Graphics Window, or simply "Graphics Window", displays the active project, allows the user to use tools and macros to manipulate the contents and change the view and perspective. The Display and contour options can be changed in order to hide or make visible any of the entities within the project, change symbol, arc, point, polygon, and text color, style, and thickness, label entities, and change the colors and transparency of contours used within the project.

Related Links