Ribbon

From Tygron Support wiki
Jump to navigation Jump to search

Template:Learned

How does the Ribbon relate to the Tygron Engine

The ribbon is the generic header of the Tygron 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.

Ribbon Overview

Editor ribbon.jpg


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

Ribbon header

The Ribbon header provides access to the File Menu. Additionally it provides access to the tabs Stakeholders, Indicators, 3D World, Animations, Storyline, Tools and Help. Activating one of the tabs reveals available sub-items. The Ribbon header also provides access to the Team Chat Box, the ability to Sign in with ArcGIS Online and provides access to your project details.

Ribbon bar

The Ribbon bar provides access to the main properties adjustable in the Tygron Engine. The ribbon bar is divided in 3 parts. The left part for starting and stopping the test run, the middle part for currently active buttons (based on the active tab) and the right part for accessing and switching playable stakeholders available in the current project.

Ribbon bar dropdown menu

The Ribbon bar dropdown menu

A dropdown menu can be presented when hovering some 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 to be redirected to the documentation section.

Left: Test Run

Main article: Test Run.
Test Run Active


A test run is a convenient way of quickly testing the current state of your project.

Middle: Ribbon tabs and buttons

File:Editor ribbon bar middle.jpg
The Ribbon Header, with active "Indicators" tab, the ribbon bar with the active "Indicators" Button and several other (inactive) buttons


The Ribbon 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. Currently the "Indicators" tab is active on the ribbon header, providing access to Indicators, Function Values, Function Assets and Function Scores on the ribbon bar. The "Indicators" button on the ribbon bar is currently selected (indicated by the blue background color), providing access to the indicator properties in the left panel. Selecting a different tab in the ribbon header makes other buttons available. The different tabs including tools will be described below.

File

File Pane

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

Stakeholders


Contains the options related to stakeholders: stakeholders, actions, Measures and Messages.

Indicators


Contains the options related to: indicators, the properties of functions, and their effects on custom indicators. The option recalculate indicators can also be found here.

3D World


Contains all the options with a spatial aspect, and thus must exist or be drawn in the 3D world: constructions, land, zoning, terrains, overlays, dike types and upgrade type.

Animations


Contains all the options with a moving aspect: Cinematics, Special Effects, Units, Weather, Environment.

Storyline


Contains the options with a storyline related aspect: Levels, Timeline, Intro Texts and Interface

Tools

Editor ribbon header tools.jpg


Contains the options with a tool related aspect: Event Bundles, Screenshot, Video, Free Cam, Query Tool and the API Overview

Help


Contains the following help options: Team Chat Box, Community, Contact Support

Right: Playable stakeholders, Switching stakeholders, Invite

The ribbon bar with all playable Stakeholders, the currently selected Stakeholder: "Gemeente" (Municipality), and another occupied stakeholder "Company".


On the far right hand side, the ribbon bar displays all playable stakeholders for the current project. These stakeholder buttons enable users to switch between stakeholders by pressing the corresponding button. The currently active stakeholder is displayed with a blue background. You can only switch to a stakeholder that is not yet selected by another user. A stakeholder selected by another user is indicated with a gray background. When a user switches from stakeholder, or logs out of the Tygron Engine makes this stakeholder available for selection again.

The stakeholder buttons are always visible, independently of the tab currently selected in the Ribbon header.

Switching a stakeholder is done by pressing a different stakeholder button. 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!

Right: Inviting someone to join


Users can also "invite a friend" to collaboratively make use of the editor. An invitation can be made by hovering over a stakeholder button and selecting "invite a friend".


The invitation panel will appear, providing access to invite registered people from your organisation or inviting someone who doesn't have an account.