Client Event

From Tygron Support wiki
(Redirected from Client Events)
Jump to navigation Jump to search

Client events are not communicated to the server and and are usually a graphical effect for the stakeholder who triggered the event. Examples of this include the flashing of an action menu or an indicator to draw the user's attention, or the visualization of a weather effect, such as a rain storm.

How do Client Events relate to the Tygron Platform

Client Events can be used on multiple locations in the Tygron Platform; as part of a measure, as part of a larger event bundle in the action menu, or during a cinematic sequence. Client Events do not communicate with the server, but trigger a reaction locally on the user's system.

See also: Measures, Actions & Cinematics

Different Client Event types

Below is a list describing the available Client Event Types:

ACTIVATE_WEATHER Activate the selected weather type on the client system
ACTIVATE_VIDEO Activate video on the client system with selected video loaded
BLINK_INDICATOR Make the selected indicator icon on the client system blink, to attract the user's attention
BLINK_OVERLAY Make the selected overlay icon on the client system blink, to attract the user's attention
BLINK_CATEGORY Make the selected action menu category icon on the client system blink, to attract the user's attention
BLINK_STOP_ALL Cancel all the blinking of icons
CHANGE_ZONE_PERMIT Change the zoning permit for the selected zone ID
FEEDBACK_PANEL_SHOW_TEXT Display the entered text on a small panel on the bottom of the main project view
FEEDBACK_PANEL_HIDE_TEXT Remove the feedback panel from the main project view
FORCE_ACTIVATE_VIDEO Force a selected video to play on the client system
GOTO_START_LOCATION Sets the user's view point to a predefined starting position
MESSAGE_ANSWERED Sends a standard reply to a message, based on the selected Answer ID
MESSAGE_MOTIVATION_ANSWER Sends a reply to a message, with a predefined motivation text added
SELECT_HOTSPOT Activate the selected popup panel
SET_VISUALIZATION_SPEED Adjust the visualization speed of environmental animations (e.g., movement of clouds) with a factor larger than 0
SHOW_BROWSER_MAP Open a new window containing the ArcGIS map of the project area
SHOW_OVERLAY Activate the selected overlay
SHOW_PANEL Activate the selected panel
STOP_WEATHER Halt any previously activated weather

Adding Client Events to a project

As mentioned above, events can be added to a project element on multiple occasions and locations. Please refer to the main articles relating to these elements for more information about the specific steps to take.

In general, adding Events to an element in the Tygron Platform happens on the right panel, after selecting the element (ex. measures, levels, etc) to have an event added to on the left panel first. Select on the right panel bottom the 'Add Event' button; a default blank event named NO_DEF is created in the list above the buttons. Selecting an Event on the list and using the 'Remove Event' button deletes the event from the list.

Selecting an event on the right panel also opens up the bottom panel where the actual event type can be selected. This selection can then be confirmed on the bottom panel by using the 'Commit' button. The 'Cancel' button clears the selection on the bottom panel.

How to add events to a project element:
  1. Select Project Element to have events added to
  2. Select the Event option on the left panel
  3. Select 'Add event' on the bottom of the right panel
  4. Select the newly added event on the right panel
  5. Select the desired server event from the bottom panel
  6. Confirm the selection with the 'Commit' button (or use the 'Cancel' button to clear the selection
Event bundle bottom panel with 'Commit' and 'Cancel' buttons

Changing the properties of a Client Event in a project

The properties of events can be edited on the bottom panel (see image above). On this panel a linked ID of a measure or cinematic can be linked to an event for instance. Any changed made need to be confirmed first with the 'Commit' button, or cancelled with the 'Cancel' button.