Tygron Client: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
Tag: Manual revert
 
(38 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{learned|what the interface is|how the {{software}} interface is implemented|how to use the interface in various parts of the {{software}}}}
The [[{{software|client}}]] is an application that allows users to log in and interact with the {{software}}. It can be used to:
* [[New Project Wizard|Create new projects]];
* [[editor|Edit existing projects]];
* Explore [[scenario]]s using [[session|test-run sessions]];
* Host [[session|single and multi-stakeholder sessions]];
* [[Account management|Manage your {{software}} account]].


==Interface==
The [[{{software|client}}]] provides distinct user interfaces for these various actions:
An interface is an intermediary by which two systems, such as a human and a machine, communicate. An interface serves as a means to retrieve and provide information in a way the other system is capable of providing or understanding.
; Login screens
: ''The login screen and various validation screens. These are shown before you have logged in and shortly after to check if the user can connect with the {{software}} and properly run the {{software|client}}.''
; [[Administration]]:
: ''To manage your [[project]]s and [[Account Management|account]] and optionally [[domain]], you can use the administration interface.''
; [[Viewer]]
: ''The interface relevant to [[Stakeholder]]s in a the project [[session]]. This interface is rendered on top of the [[3D Visualization]], and provides a user with all the options and information relevant to their role as stakeholder. This is the most complex interface.''
;[[Editor]]
: ''The interface used to [[editor|edit]] a [[project]]. It is structured around the [[Viewer]] and also rendered on top of the [[3D Visualization]].''


==How interfaces are implemented in the {{software}}==
===Viewer===
Each part of the {{software}} which can be accessed, can be accessed by using a graphical user interface. This means that options are provided by listing them in the form of texts or icons, and you can select these options using your cursor. Because the {{software}} encompasses several different functions, the {{software}} also uses different interfaces to allow you to interact with it.
[[File:Interface_game_general.jpg|thumb|800px|center|The [[Viewer ]]interface.]]<br clear=both>
The [[Viewer]] is the interface relevant to [[Stakeholder]] during a session. It is rendered on top of the [[3D Visualization]]. Near the edges of the screen you can find the most prominent parts of the interface; the [[Top bar]], the [[Action menu panel]], the [[Navigation panel]]. These are available to provide information to the user, provide means to the user to gather more information, and to interact with the [[Session|project session]].
Other panels, such as [[Popup panel|popup]], [[Indicator panel|indicator]] and [[budget panel]]s are accessible through these panels or by interacting with objects, such as [[popup]]s, in the [[3D Visualization]].


==Types of interface==
{{viewer nav}}
There are 5 different types of interface which may be available as you use the {{software}}.
; Main menu
: ''The login screen and initial menu. In the main menu, you can select which functionality of the {{software}} you wish to use.''
; Management
: ''The management screens. To manage your projects and accounts, you can use the management screens. In these screens, you will be able to use simple lists and buttons to indicate what you wish to do.''
; Project Session
: ''The interface during the project session. This interface is projected over the [[3D World]], and provides a user with all the options and information relevant to their role as stakeholder. This is the most complex interface.''
;Editor
: ''The interface used to [[editor|edit]] a project. Part of the interface includes a panel with a view of the 3D World with the user interface. The editor interface is structured around the 3D World panel.''
 
==How to use the interfaces==
 
Although each interface follows standard practices for software interfaces, it can sometimes be a bit daunting when an interface changes. Each interface behaves differently from the other interfaces.
 
===Initial Screens===
The initial screens of the {{software}} are all screens which appear before the main menu appears. It includes the End User License Agreement, the [[hardware test]] and the login screen.
 
===Main menu===
The main menu is the first visible interface from where you can navigate freely. When you have logged in successfully, the main menu will appear on the left of the screen. Each option has a clickable icon, and is located in a descriptive section with a title at the top. When an icon is clicked, you progress further into the menu. When your options have clearly indicated what you wish to do, you will proceed into a different part of the editor. For example, you can follow the steps below to start the editor, and enter a different part of the {{software}} with a different interface:
 
{{editor steps|title=start the editor to create a new project|Start the online {{software}} ({{url|protocol=true}})|When presented with a log in screen, enter a valid username and password, and log in.|Under the heading "Editor", select "Start Editor".|Select "New Project".}}
 
===Options===
: ''Main article: [[Options interface]].''
The options interface is used for the screens where you are able to manage your projects and accounts. They can be found under the option "Options" in the main menu. They are screens comprised of lists of that which you wish to manage, and several input fields for their properties. By using the buttons and input fields, you can change the properties of users and projects.
 
===User Interface===
: ''Main article: [[User Interface]].''
[[File:Interface_game_general.jpg|300px|right|The user interface.]]
The user interface is the most complex interface in the {{software}}. During a session, the 3D World is largest visible element on the screen. Near the edges of the screen you can find the most prominent parts of the interface. These are available to provide information to the user, provide means to the user to gather more information, and to interact with the 3D world.
 
The user interface consists of main interface elements and additional panels. The main interface elements include the 3D World, the Top Bar, the Category panel, the Minimap, and all popups that appear during a project. These elements are either always present, or play a key role in interacting with the project. The additional panels are contextually available, and include (among others) the legend, the hover panel, and the indicator panels.<br clear=all>
 
===Multiplayer===
: ''Main article: [[Multiplayer interface]].''


===Editor===
===Editor===
: ''Main article: [[Editor]].''
[[File:Q1-2016-EditorPanel.jpg|thumb|850px|center|The Tygron Editor. The Ribbon at the top of the screen, the Left Panel on the left side of the screen, the User Main Interface in the center of the screen, the Right Panel on the right side of the screen, and the Bottom Panel at the bottom of the screen.]]<br clear=both>
 
The [[Editor|Editor interface]] is synonymous with the editor. It is the interface which allows you to change projects as desired. The editor interface consists of the Editor Menu bar, the Editing area and the [[3D Visualization]], which is itself the user interface. The editor allows access to editor panels which allow various components of a project to be added, changed, and removed, such as [[stakeholders]], [[indicators]] and [[building]]s.  
The editor interface is synonymous with the editor. It is the interface which allows you to change projects as desired. The editor interface consists of the Editor Menu bar, the Editing area and the Virtual 3D World, which is itself the user interface. The editor allows access to editor panels which allow various components of a project to be added, changed, and removed, such as [[stakeholders]], [[indicators]] and constructions. It also allows for changing data related to the project, such as its [[names|name]], [[Introduction Text|description]], and [[contributors]].
{{Template:Editor ui nav}}


{{Template:Editor multi stakeholder nav}}
{{article end
|seealso=
}}
[[Category:Interface]]

Latest revision as of 09:08, 21 February 2023

The Tygron Client is an application that allows users to log in and interact with the Tygron Platform. It can be used to:

The Tygron Client provides distinct user interfaces for these various actions:

Login screens
The login screen and various validation screens. These are shown before you have logged in and shortly after to check if the user can connect with the Tygron Platform and properly run the Tygron Client.
Administration
To manage your projects and account and optionally domain, you can use the administration interface.
Viewer
The interface relevant to Stakeholders in a the project session. This interface is rendered on top of the 3D Visualization, and provides a user with all the options and information relevant to their role as stakeholder. This is the most complex interface.
Editor
The interface used to edit a project. It is structured around the Viewer and also rendered on top of the 3D Visualization.

Viewer


The Viewer is the interface relevant to Stakeholder during a session. It is rendered on top of the 3D Visualization. Near the edges of the screen you can find the most prominent parts of the interface; the Top bar, the Action menu panel, the Navigation panel. These are available to provide information to the user, provide means to the user to gather more information, and to interact with the project session. Other panels, such as popup, indicator and budget panels are accessible through these panels or by interacting with objects, such as popups, in the 3D Visualization.



Editor

The Tygron Editor. The Ribbon at the top of the screen, the Left Panel on the left side of the screen, the User Main Interface in the center of the screen, the Right Panel on the right side of the screen, and the Bottom Panel at the bottom of the screen.


The Editor interface is synonymous with the editor. It is the interface which allows you to change projects as desired. The editor interface consists of the Editor Menu bar, the Editing area and the 3D Visualization, which is itself the user interface. The editor allows access to editor panels which allow various components of a project to be added, changed, and removed, such as stakeholders, indicators and buildings.