Ribbon: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 111: Line 111:
*[[Template]]
*[[Template]]
*[[Debug Info]]
*[[Debug Info]]
===Tabs and buttons===
[[File:Editor_ribbon_bar_middle.jpg|850px|thumb|left|The ribbon header, with active "Indicators" tab, the ribbon bar with the active "Indicators" Button and several other (inactive) buttons]]<br clear=all>
The ribbon header consists of a number of tabs, which provide access to buttons required to edit your project. The visible buttons are context-sensitive, they depend on the active tab in the ribbon header. The different tabs including buttons will be described below.
==Ribbon bar==
[[File:Editor_ribbon_bar.jpg|850px|The ribbon bar]]
The ribbon bar provides access to the main properties adjustable in the {{software}}. The ribbon bar has 3 main functionalities. Starting and stopping the test run, currently active buttons (based on the active tab) and accessing and switching playable stakeholders available in the current project.
===Test run===
: ''Main article: [[Test_Run|Test run]].
[[File:Editor_ribbon_bar_testrun_active.jpg|thumb|left|test run Active]] A test run is a convenient way of quickly testing the current state of your project.
<br clear=all>
===Active buttons===
[[File:Editor_ribbon_header_stakeholders.jpg|850px|thumb|left|]]<br clear=all>
Contains the options related to stakeholders: [[stakeholders]], [[actions]], [[measures]] and [[messages]].
The ribbon bar displays available buttons. Active buttons are indicated by a blue background color. When active, the button provides access to the properties in the left panel. Selecting a different tab in the ribbon header makes different buttons available.
===Ribbon bar dropdown menu===
[[File:Editor_ribbon_bar_dropdown.jpg|150px|thumb|left|The ribbon bar dropdown menu]]
A dropdown menu can be presented when hovering buttons on the ribbon bar. The dropdown menu can be used as a shortcut to access the left panel, to add items to your project, or can redirect users to the documentation section.
<br clear=all>
===Playable stakeholders, switching stakeholders, collaborate===
[[File:Editor_ribbon_bar_right_stakeholders.jpg|850px|thumb|left|The ribbon bar with all playable Stakeholders, the currently selected Stakeholder: "Gemeente" (Municipality), and another occupied stakeholder "Company".]]<br clear=all>
On the far right hand side, the ribbon bar displays all playable stakeholders for the current project. The currently active stakeholder is displayed with a blue background. An occupied  stakeholder (selected by another user) is indicated with a gray background. Available stakeholders are displayed with a white background. This stakeholder becomes available for selection again when a user switches to a different stakeholder, or logs out of the {{software}}.
The stakeholder buttons enable users to switch between stakeholders by selecting the corresponding button. You can only switch to a stakeholder that is not yet selected by another user.
The stakeholder buttons are always visible, independently of the tab currently selected in the ribbon header.
===Switching stakeholders===
Switching a stakeholder is done by pressing an available stakeholder button (displayed with a white background). Keep in mind that, when switching a stakeholder you will also switch the indicators, budget and actions among others. You will make an identity switch!
{{Editor steps|title=switch to an available stakeholder|Hover over an available stakeholder in the ribbon bar.|Select the hovered stakeholder.}}
====Invite a friend====
Users can also invite others to collaboratively make use of the editor. An invitation can be made by hovering over a stakeholder button and selecting "invite a friend".
{{Editor steps|title=invite others to collaboratively make use of the editor.|Hover over an available stakeholder in the ribbon bar, the invite dropdown menu appears|Select "Invite a friend" (below the switch stakeholder text)|The invitation panel will appear| Select a registered person from your organisation or invite someone without an account via email}}
<gallery mode="nolines">
File:Editor_ribbon_bar_invite.jpg|1. Hover over an available stakeholder in the ribbon bar, a dropdown appears
File:Editor_ribbon_bar_invite.jpg|2. Select "Invite a friend"
File:Editor_ribbon_bar_invite_popup.jpg|3. The invitation panel will appear
</gallery>
==Ribbon tab overview ==
This section shows a full overview of available tabs and buttons when using the ribbon bar.
===File===
: ''Main article: [[File Menu|File menu]].
[[File:Editor_file_ribbon_header.jpg|left|File Pane]]
Selecting the "File" Tab from the ribbon header opens the [[File Menu]].<br clear=all>
===Stakeholders===
[[File:Editor_ribbon_header_stakeholders.jpg|850px|thumb|left|]]<br clear=all>
Contains the options related to stakeholders: [[stakeholders]], [[actions]], [[measures]] and [[messages]].
===Indicators===
[[File:Editor_ribbon_header_indicators.jpg|850px|thumb|left|]]<br clear=all>
Contains the options related to: [[indicators]], the properties of [[functions]], and their [[functions#Changing effects on custom indicators|effects on custom indicators]]. The option [[recalculate indicators]] can also be found here.
===Geo Data===
[[File:Editor_ribbon_header_3dworld.jpg|850px|thumb|left|]]<br clear=all>
Contains all the options with a spatial aspect, and thus must exist or be drawn in the 3D world: [[constructions]] [[terrain|land]], [[neighborhoods]], [[zoning]], [[plots]], [[areas]], and[[overlays]].
===Animations===
[[File:Editor_ribbon_header_animations.jpg|850px|thumb|left|]]<br clear=all>
Contains all the options with a moving aspect: [[Cinematic|cinematics]], [[Special Effects|special effects]], [[Units|units]], [[Weather|weather]], [[Environment|environment]].
===Storyline===
[[File:Editor_ribbon_header_storyline.jpg|850px|thumb|left|]]<br clear=all>
Contains the options with a storyline related aspect: [[Levels]], [[Timeline]], [[Intro Texts]] and [[Interface]]
===Tools===
[[File:Editor_ribbon_header_tools.jpg|850px|thumb|left|]]<br clear=all>
Contains the options with a tool related aspect: [[Event Bundles]], [[Screenshot]], [[Video recording|Video]], [[Free cam|Free Cam]], [[Query Tool]] and the [[Api Overview]]
===Help===
[[File:Editor_ribbon_header_help.jpg|850px|thumb|left|]]<br clear=all>
Contains the following help options: [[Team Chat Box]], [[Community]], [[Contact Support]]

Revision as of 12:04, 1 May 2019

Template:Learned

How does the ribbon relate to the Tygron Platform

The ribbon is located in the top part of the editor. It is a tabbed header, which provides access to tools grouped by categories. Those categories are in organized in tabs. This makes tools accessible in a logical way.

The 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.


Ribbon overview

Editor ribbon.jpg


The ribbon at the top consists of 2 parts, the ribbon header and the ribbon bar.

The ribbon header provides access to the File Menu and five other tabs:

Clicking on one of these five tabs reveals a menu on the ribbon bar corresponding to the selected tab.

The tab that is currently active is colored, while the non-active tabs are grey.

Ribbon bar dropdown menu

The ribbon bar dropdown menu

A dropdown menu can be presented when hovering buttons on the ribbon bar. The dropdown menu can be used as a shortcut to access the left panel, to add items to your project, or can redirect users to the documentation section.

Calculation Panel

The Calculation panel helps you to manage the calculation time of your project. The Calculation Panel can be found by hovering with your mouse over the 'A' circle-arrow button. Recalculate panel.JPG

Ribbon tab overview

This section shows a full overview of available tabs and buttons when using the ribbon.

File

Main article: File menu.
File Pane

Selecting the "File" Tab from the ribbon header opens the File Menu.

Current Situation

Main article: Current Situation.
Editor ribbon header currentsituation.jpg


Contains the options related to the Current Situation:

Future Design

Main article: Future Design.
Editor ribbon header futuredesign.jpg


Contains the options related to the Future Design:

Multi Stakeholder

Main article: Multi Stakeholder.
Editor ribbon header multistakeholder.jpg


Contains the options related to the Multi Stakeholder:

Tools

Main article: Tools.
Editor ribbon header tools.jpg


Contains the options with a tool related aspect:

Community

Main article: Community.
Editor ribbon header community.jpg


Contains the options with a community related aspect: