Viewer: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
 
(47 intermediate revisions by 2 users not shown)
Line 1: Line 1:
The main user interface allows end users to interact with the [[3D Visualization]], from the perspective of a [[stakeholder]]. It is rendered on top of the 3D Visualization and displays panels to inspect the [[Current]] and [[Planned]] situation of a [[project]]. It also contains panels that allow [[stakeholder]]s to plan [[action]]s that will change the [[Planned situation]].  
The '''Viewer''' is the main interface that allows users to interact with the project [[session]] and [[3D Visualization]] from the perspective of a [[stakeholder]]. It is rendered on top of the [[3D Visualization]] and displays panels to inspect the [[Current Situation]] and [[Future Design]]ed state of a [[project]]. It also contains panels that allow [[stakeholder]]s to plan [[action]]s that will change the [[Planned situation]].  


To change the current situation of a project, users will have to user the [[Editor]]. The editor panels are added around the main interface, as shown in the image below.  
To change the current situation of a project, users will have to user the [[Editor]]. The editor panels are added around the viewer interface, as shown in the image below.  
<gallery mode=nolines>
<gallery mode=nolines heights=300px widths=400px>
File:Q1-2016-End_User_Interface-b.jpg|User Interface
File:Q1-2016-End_User_Interface-b.jpg|[[Viewer ]]interface
File:Q1-2016-EditorPanel.jpg|Editor Interface
File:Q1-2016-EditorPanel.jpg|[[Editor ]]interface
</gallery>
</gallery>


==Main interface elements==
==Main interface elements==
[[File:Q1-2016-End_User_Interface-b.jpg|thumb|400px|right|The main interface, showing the [[Top bar]] (top), [[Action menu panel]] (left) and the [[navigation panel]] (right).]]
The Main Interface consists of the following main elements:
The Main Interface consists of the following main elements:
* [[#Top bar|Top bar]]: Top part of the screen; Displays [[Indicators]] and buttons to switch between the [[Current]] and [[Planned situation]].
* [[Top bar]]: Top part of the screen; Displays [[Indicators]] and buttons to switch between the [[Current situation|Current]] and [[Planned situation]].
* [[Actions panel]]: Left part of the screen; Displays the [[Action Menu]]s containing the [[Action]]s available to the selected [[Stakeholder]].
* [[Action menu panel]]: Left part of the screen; Displays the [[Action Menu]]s containing the [[Action]]s available to the selected [[Stakeholder]].
* [[Navigation panel]]: Right part of the screen; Displays multiple things:
* [[Navigation panel]]: Right part of the screen; Displays multiple things:
** a search bar for [[address]]es and [[building]]s  
** a search bar for [[address]]es and [[building]]s  
** the selected [[Camera]] and it's controls;
** the selected [[Camera]] and it's controls;
** a transparency view option,
** a transparency view option,
** the [[Measurement Tool]] button;
** the [[Measuring tool]] button;
** the available [[overlay]]s (sometimes grouped together);
** the available [[overlay]]s (sometimes grouped together);
** the [[Action log]];
** the [[Log panel]];
* [[Legend panel]]: Bottom part of the screen; Displays a legend of the selected [[Overlay]] or for [[Drawing]].
* [[Legend panel]]: Bottom part of the screen; Displays a legend of the selected [[Overlay]] or for [[Drawing]].
These elements can in open and show other panels in the User Interface.
These elements can open and show other panels in the interface.
[[File:Q1-2016-End_User_Interface-b.jpg|thumb|400px|left|The main interface, showing the [[Top bar]], [[actions panel]] and the [[navigation panel]].]]
<br clear=all>
 
==Top bar==
{{Image with gallery|filename=Interface_game_topbar_small.jpg|size=400px|filedescription=The top bar, which provides information on the stakeholders and indicators.|float=right|gallery=<gallery mode="nolines">
File:Interface_game_top_bar_-_indicator_hover_panel.jpg|Hover over an indicator
</gallery>}}
 
The top bar is the large element at the top of the [[User Interface]]. Displayed, in order from left to right, are the [[Domain#Logo|Domain logo]], the [[stakeholders|stakeholder]] name, the time, the display mode, and the [[indicators]]. When the Domain logo is pressed, the credits of the project are displayed. The logo will also start flashing red when the computer has trouble maintaining a connection with the {{software}} server. The stakeholder name indicates which role the user has selected, and thus which party they represent during the session. They can click the name of the stakeholder to view descriptions of other stakeholders. The time indicates how long the simulation has been running so far. The display mode allows you to switch between seeing the project in the 3D Visualization as it currently is and, for planning based projects, how it was at the start of the session.
 
The right section of the top bar is entirely filled with indicators. Each indicator shows the current amount of progress made on that indicator towards the target set for it. By hovering over the indicators, you can see the full name of the indicator and the current score on the indicator.
 
{{Editor steps|preamble=|form=:*|title=Interacting with the Top Bar
|Set the "Display" to "Original" to see the state of the project in the [[3D Visualization]] at the beginning of the [[session]].
|Set the "Display" to "Planned" to see the current state of the project in the [[3D Visualization]].
|Click on an indicator to open the [[indicator panel]].
}}
 
==Action menu==
{{Image with gallery|filename=Interface_game_category_panel_small.jpg|size=400px|filedescription=The action menu, which contains a stakeholder's actions.|float=right|gallery=<gallery mode="nolines">
File:Interface_game_category_panel_-_action_panel.jpg|The action panel
File:Interface_game_category_panel_-_top_bar_effects_.jpg|Effects in the top bar
</gallery>}}
 
The action menu is the list of icons on the left hand side of the screen. This menu contains [[actions]] available to a stakeholder. Clicking one of the icons, opens the action panel. In the action panel you can select a specific action.
 
===Action panel===
The action panel is the most important element to make changes to the [[project]] using the [[3D Visualization]]. It's a versatile panel, since this panel can be used to create new buildings, demolish existing buildings, open panels to transfer money among others. Two main differences occur: Actions and Measures.
 
====Actions====
When taking an [[action]], you need to draw a selection in the [[3D Visualization]], to define the area where the action should be applied. Drawing is done by clicking somewhere in the 3D Visualization, moving the cursor and clicking again to adjust the selection shape. If it's an action with configurable settings (such as the amount of floors for a building), an element will be provided to allow you to select a proper value.{{:Drawing validity}}
 
====Measures====
When using a [[measure]], you will simple be able to "apply" or "cancel" the action. A [[Measure]] is a predefined plan, implemented by the designer/ editor of the project.
 
====Special Options====
A few special options exist. Financial actions, such as "Finance View", open their own panels to provide information or continue interaction.
 
{{Editor steps|preamble=|form=:*|title=Interacting with the action menu and action panel|Click on an icon to open the action panel.|Select the action you wish to take in the action panel.|If required, set the amount of floors using the slider in the action panel.|If required, draw a selection in the 3D Visualization.|Confirm the action by pressing the appropriate button on the action panel.}}
 
==Navigation panel==
===Address search===
Located at the top of the navigation panel is the address search bar. This search bar can be used to quickly navigate to a precise address in the [[project area]]. Once one of the provided results is selected, the [[Camera]] will fly to the location of the [[address]].
 
{{Editor steps|preamble=|form=:*|title=Using the Address search bar|Click the address search bar|Type in an address|Autocomplete will try to complete the address|Press the enter key to confirm}}
==Legend==
[[File:Interface_game_legend.jpg|250px|right|The legend. It appears to provide information when using certain overlays, and indicates why selections are invalid when drawing.]]
When drawing in the 3D Visualization, or when inspecting an overlay, a legend will be displayed at the bottom of the screen. The legend serves as a reference for which colors correspond to what information. For example, when viewing the [[Ownership (Overlay)|ownership overlay]], the legend will display which stakeholder is displayed with which color. When viewing the [[Livability (Overlay)|livability overlay]], it provides a reminder of which colors indicate the most and least desirable values.<br clear=all>
 
==Additional interface elements==
Besides the main interface elements described above, there are also a number of additional elements in the interface. These will appear and disappear depending on your interaction with the project.
 
===Popups===
: ''Main article: [[popups]].
Popups are an important part of the interface, which are not immediately visible to the user. Instead, they appear whenever an action is taken, and input is required from the user concerning that action. This includes actions which the user takes themselves, but popups more often appear when other stakeholders take actions which the user in question must respond to. They also appear in the minimap in the form of exclamation marks.
 
{{:popups}}
 
===Indicator panel===
[[File:Interface_game_indicator_panel.jpg|250px|right|The indicator panel. the left side displays the name, importance, and description of the indicator, as well as the targets and the progress on the indicator. The right side displays the progress on this indicator over time.]]
When you click on an indicator in the top bar, the indicator panel is opened. This panel displays information about the indicator you have selected. On the left side, at the top of the panel, is the name of the indicator, followed by its importance. A description of the indicator follows, to provide the user with information on what the indicator means, why it is important to the stakeholder and how to increase its score.
 
Under the "Explanation" heading, an overview displays the current score of the indicator, the target of the indicator, and the amount of progress which still needs to be made to score 100% on the indicator. The exact layout of this information differs per indicator.
 
On the right side of the panel, two graphs are visible. The top graph displays the total score on the indicator over time. The bottom graph displays the sub scores for the indicator over time. For example, in the case of the parking indicator, the bottom graph shows the amount of parking spaces per zone.<br clear=all>
 
===Budget panel===
[[File:Interface_game_budget_panel.jpg|250px|right|The budget panel. It displays the incomes and expenses for your budget.]]
The budget panel can be accessed in two ways. You can open the indicator panel for your budget, and then press the button "To budget". Alternatively, when a finances category is available in the category panel, one of the available actions may be "Finance view". By selecting "Finance view, the budget panel is opened.
 
The budget panel displays an overview of your expenses and incomes. The left side of the panel displays the list of expenses. The expenses are collected in categories, which can be expanded by clicking the arrow next to a category. This displays all expenses within that category. At the bottom, in red, the total expenses are displayed. The right side of the panel displays the incomes in a similar fashion. Sources of income are categorized together, and can be expanded where desired to see what sources of income exist in a particular category. At the bottom, in green, the total amount of income is displayed.
 
At the bottom of the panel, the net balance is displayed. This is the amount of money the stakeholder has at that moment. The net balance is calculated by taking the total income and subtracting the total expenses from this value.
<br clear=all>
 
===Hover panel===
[[File:Interface_game_hover_panel.jpg|250px|right|The hover panel. when clicking any location in the [[project area]] in the 3D Visualizaition, it appears to provide information about the area indicated.]]
When you click the cursor still over any part of the project area, the hover panel will appear. The hover panel will display information about the area your cursor is pointing at, based on which overlay is currently active. By default, it display information about the:
* [[terrain|type of terrain]];
* [[buildings]]
* address;
* owner;
* and data source.
<br clear=all>
 
===Cinematic panel===
[[File:Interface_game_cinematic_panel.jpg|250px|right|The cinematic panel. The cinematic panel is displayed during [[cinematic]]s.]] Whenever text is displayed during a [[Cinematic|cinematic]], it appears in the cinematic panel. While the cinematic panel is visible, the [[Camera#Cinematic|cinematic camera]] is paused. When you have read the text in the cinematic panel, you can click "continue" to close the cinematic panel and continue the cinematic.<br clear=all>
 
===Escape menu===
[[File:Interface_game_escape.jpg|250px|right|The cinematic panel. The cinematic panel is displayed during [[cinematic]]s.]]
The escape menu is opened by pressing the "Esc" key on your keyboard. The escape menu allows you to access the settings screen by pressing "Settings", and to display the credits by pressing "Credits". In [[single user]] and [[multi user]] sessions, you are also able to exit the session from this menu, by pressing "Exit". In single user sessions, you are also able to save the session state by pressing "Save".<br clear=all>
 
===Settings screen===
<!--: ''Main article: [[graphics settings]].''-->
[[File:Interface_game_settings.jpg|250px|right|The settings screen. The settings screen allows you to adjust the graphics.]]
The settings screen allows you to adjust the graphical settings of the {{software}}. By raising the values, you increase the graphical quality of the virtual environment. By lowering the values, you lower the stress on your hardware and thus increase performance. The settings panel offers four default settings: "Low", "Medium", "High" and "Full". Each of these options set the graphics to predefined values. By selecting "Advanced", you are also able to finely adjust which graphical settings to increase and decrease.
 
You can also adjust the volume by using the "Volume" slider.<br clear=all>


{{article end
{{article end
|seealso=
|seealso=
*[[Editor]]
*[[Editor]]
*[[Interface]]
*[[3D Visualization]]
*[[Camera]]
*[[List of Keyboard Shortcuts]]
}}
}}
{{viewer nav}}
[[Category:Interface]]
[[Category:Interface]]

Latest revision as of 06:47, 5 October 2023

The Viewer is the main interface that allows users to interact with the project session and 3D Visualization from the perspective of a stakeholder. It is rendered on top of the 3D Visualization and displays panels to inspect the Current Situation and Future Designed state of a project. It also contains panels that allow stakeholders to plan actions that will change the Planned situation.

To change the current situation of a project, users will have to user the Editor. The editor panels are added around the viewer interface, as shown in the image below.

Main interface elements

The main interface, showing the Top bar (top), Action menu panel (left) and the navigation panel (right).

The Main Interface consists of the following main elements:

These elements can open and show other panels in the interface.