diff --git a/docs/core/examples/guides/assets/event-edge.png b/docs/core/examples/guides/assets/event-edge.png index 3a0f85c7..dd43e322 100644 Binary files a/docs/core/examples/guides/assets/event-edge.png and b/docs/core/examples/guides/assets/event-edge.png differ diff --git a/docs/core/examples/guides/assets/timer-settings.png b/docs/core/examples/guides/assets/timer-settings.png index 428ecfdc..ee8d4451 100644 Binary files a/docs/core/examples/guides/assets/timer-settings.png and b/docs/core/examples/guides/assets/timer-settings.png differ diff --git a/docs/core/examples/guides/assets/trigger-buttons.gif b/docs/core/examples/guides/assets/trigger-buttons.gif deleted file mode 100644 index cb21431b..00000000 Binary files a/docs/core/examples/guides/assets/trigger-buttons.gif and /dev/null differ diff --git a/docs/core/examples/guides/assets/trigger-buttons.webm b/docs/core/examples/guides/assets/trigger-buttons.webm new file mode 100644 index 00000000..a646431f Binary files /dev/null and b/docs/core/examples/guides/assets/trigger-buttons.webm differ diff --git a/docs/core/examples/guides/editor-example.md b/docs/core/examples/guides/editor-example.md index 72f3cd31..0cb3f0db 100644 --- a/docs/core/examples/guides/editor-example.md +++ b/docs/core/examples/guides/editor-example.md @@ -8,7 +8,7 @@ import eventSourceHandle from './assets/event-source-handle.png' import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; import timerSettings from './assets/timer-settings.png' -import triggerButtons from './assets/trigger-buttons.gif' +import triggerButtons from './assets/trigger-buttons.webm' # The application graph editor @@ -17,16 +17,24 @@ and any changes will automatically be written back to the YAML representation. ## Using the application graph editor -Drag the background to pan the graph view and scroll to zoom in or out. Click the arrow icons on the central divider -on the page to expand either the code editor or graph view to full screen. +By default, both left and right panels are maximized when an application is created or opened. Minimize the left one, +that contains application controls, to provide more space for the main view. The ratio between main view and right panel +can be adjusted by dragging its border. Drag the background to pan the graph view and scroll to zoom in or out. -You can also use the graph control buttons on the bottom left to zoom and fit the view. The mini-map on the bottom right -can also be used to navigate around the graph. +The mini-view switcher on the bottom left can also be used to switch to the 3D scene representation on the main view. In +this case, the graph is still available in the **Graph view** tab of the right panel. However, users are not allowed to +make modifications there, only trigger buttons and check the state. + +:::note + +The mini-view switcher can also be minimized to provide more space. + +::: ## Editing component settings -Component parameters and settings can be edited directly from the graph view. Click on the gear icon of the first Timer -component to open its settings panel. The settings panel can be closed with the X or by clicking anywhere in the graph. +Component parameters and settings can be edited directly from the graph view. Click on the component block to open its +settings in the **Scene** tab of the right panel.
Timer settings @@ -36,10 +44,10 @@ component to open its settings panel. The settings panel can be closed with the Because the timer components are lifecycle components, they only count down the time when they are active. By default, the "Load" or "Transition" events start the lifecycle component in an unconfigured state. The "auto-configure" and -"auto-activate" toggle switches can be used to enable or disable +"auto-activate" toggle buttons on the component block can be used to enable or disable [auto-lifecycle events](/docs/concepts/building-blocks/components#auto-lifecycle-events). -When both toggle switches are enabled, the YAML code will show the corresponding events for the components: +When both toggle buttons are enabled, the YAML code will show the corresponding events for the components: ```yaml events: @@ -54,50 +62,54 @@ When both toggle switches are enabled, the YAML code will show the corresponding transition: activate ``` -Disabling one or both auto-lifecycle event switches will also remove the corresponding events from the YAML, while +Disabling one or both auto-lifecycle event buttons will also remove the corresponding events from the YAML, while enabling the switch will regenerate the event in the YAML. ## Setting component parameters -Component parameters can be edited directly in the settings panel. Change the value of the Timeout parameter and look -for the corresponding change in the code editor. Then press play on the application and observe that the timer now has a -different duration before triggering the "Is timed out" predicate. +Component parameters can be edited directly in the **Settings** tab. Change the value of the Timeout parameter and look +for the corresponding change in the code editor. Then press **Start** on the application and observe that the timer now +has a different duration before triggering the "Is timed out" predicate. ## Adding and deleting elements -Elements can be added to the graph using the sidebar menu; press the (+) button in the top right corner of the graph to -open the sidebar and see a list of available application elements. At the top of the list are the "Hardware Interface", -"Trigger Events Button", "Sequence" and "Condition" nodes. These are followed by a list of all available components from -AICA Core and any additionally installed packages, grouped by package. Clicking on any element in the sidebar will -automatically add it to the graph. +Elements can be added to the graph using the right panel; switch to the **Add component** section of the Scene tab +to see a list of available application elements. At the top of the list are the "Hardware Interface", "Trigger Events +Button", "Sequence" and "Condition" nodes. These are followed by a list of all available components from AICA Core and +any additionally installed packages, grouped by package. Clicking on any element in the sidebar will automatically add +it to the graph. + +Graphs with multiple instances of several elements can get quite extensive. The **Scene List** section provides an +overview of the added components. Clicking on an item in the list centers the view on the respective component in the +graph, and opens its settings. -To delete an element from the graph, press the small menu icon in its top right corner, then click Remove. Elements can -also be deleted by selecting them with a click and pressing the Backspace key on your keyboard. +To delete an element from the graph, select it with a click and then click Remove in the available options that appear +above it. Elements can also be deleted by selecting them and pressing the Backspace key on your keyboard. -To delete an element from the graph, press the small menu icon in its top right corner, then click Remove. Elements can -also be deleted by selecting them with a click and pressing the Delete key on your keyboard. +To delete an element from the graph, select it with a click and then click Remove in the available options that appear +above it. Elements can also be deleted by selecting them and pressing the Delete key on your keyboard. -For this example, let's add a "Trigger Events Button" to the timer application by clicking on it in the sidebar. A new -button should appear on the graph and in the code. This is an interactive elements that can be used to trigger events +For this example, let's add a "Trigger Events Button" to the timer application by clicking on it in the right panel. A +new button should appear on the graph and in the code. This is an interactive element that can be used to trigger events through mouse clicks and interact with the flow of the application. -The sidebar menu can be closed with the X icon or by clicking anywhere in the graph. +The right panel can be minimized with the icon on its top left. Drag the button to change its position in the graph. This will also update the corresponding Trigger Events Button -position in the YAML code editor. +position in the **Code** tab. ## Creating and deleting event edges @@ -135,28 +147,31 @@ For this example, choose the Deactivate event in order to pause the timer on cli
Clicking on an edge also selects it, which is indicated by the increased line thickness. Clicking away from the edge -will deselect it. While the edge is selected, press the Delete key to delete the edge. This will also remove the -event from the YAML representation. +will deselect it. While the edge is selected, press the Backspace (Delete for macOS) key to delete the edge. This will +also remove the event from the YAML representation. Now add a second trigger button, create a new event edge to Timer 2 and choose the Activate event type. -
- Trigger buttons example +
+
## Renaming elements in the graph Both buttons now still have the default "Trigger Events Button" name, which may become confusing in larger applications. -To rename an element in the graph, click on the small menu icon in its top right corner, then click Rename. Give the two -buttons a new name: "Pause Timer" for the button with the Deactivate event, and "Play Timer" for the button with the -Activate event. +To rename an element in the graph, select it with a click and then click Rename in the available options that appear +above it. Give the two buttons a new name: "Pause Timer" for the button with the Deactivate event, and "Play Timer" for +the button with the Activate event. Now, try to run the application again and use the Pause Timer and Play Timer trigger buttons to deactivate and activate Timer 2 while it is active. Verify that once deactivated, the elapsed time does not count towards the component timing out and it only times out once it has been in the active state for a total of 4 seconds. That is, deactivating the component will freeze the timer until reactivation. -Now that we learned to add buttons and create event edges, try to do the same for components. As an exercise, delete -all elements from the graph and try to recreate this example from scratch using only the graph editor. Search for and -add the timer components from the sidebar, set the auto-lifecycle events, and connect the transition edges. Remember to -set a timeout value in the component parameters. +Now that we learned to add buttons and create event edges, try to do the same for components. As an exercise, delete all +elements from the graph and try to recreate this example from scratch using only the graph editor. Search for and add +the timer components from the sidebar, set the auto-lifecycle events, and connect the transition edges. Remember to set +a timeout value in the component parameters. diff --git a/docs/core_versioned_docs/version-v4/examples/guides/editor-example.md b/docs/core_versioned_docs/version-v4/examples/guides/editor-example.md index 72f3cd31..c6b33717 100644 --- a/docs/core_versioned_docs/version-v4/examples/guides/editor-example.md +++ b/docs/core_versioned_docs/version-v4/examples/guides/editor-example.md @@ -91,7 +91,7 @@ also be deleted by selecting them with a click and pressing the Delete key on yo For this example, let's add a "Trigger Events Button" to the timer application by clicking on it in the sidebar. A new -button should appear on the graph and in the code. This is an interactive elements that can be used to trigger events +button should appear on the graph and in the code. This is an interactive element that can be used to trigger events through mouse clicks and interact with the flow of the application. The sidebar menu can be closed with the X icon or by clicking anywhere in the graph.