index file template

Actions

With actions, you can add interactions to your projects

Actions can be added to:

  • scenes items
  • scenes model meshes
  • overlays items
  • state engine states
  • modules such as the QR code / barcode readers

XR+ studio actions

  • Change scene
    Switch to another scene.
  • Restart scene timeline
    Restart the current scene timeline
  • Pause scene timeline
    Pause the current scene timeline, also pause all audios & videos
  • Resume scene timeline
    Resume the current scene timeline, also resume playback of audios & videos
  • Change overlay
    Display another scene overlay, or remove the current overlay
  • Play model animation
    Play an animation from a model that contains animations. At the end of the animation playback, you can choose to switch to another state.
  • Pause model animations
    Pause all the animations from the selected model
  • Play basic animation
    Animate a mesh from a model with a simple animation: scale up/down, pulse, rotate clockwise, rotate anticlockwise
  • Stop basic animation
    Stop all basic animation on the selected mesh
  • Play audio
    Play an audio file from the assets library
  • Stop audio(s)
    Stop the playback of an audio file
  • Play video
    Play a video from the composition
  • Pause video(s)
    Pause the selected video from the composition
  • Stop video(s)
    Stop the selected video from the composition
  • Change material
    Apply the selected material on the selected mesh
  • Set material color
    Change the color of the selected material
  • Recenter composition
    Recenter the composition in front of the user, only available when using 3 DOF tracking
  • Reset user position & rotation
    Recenter the composition in front of the user, only available when using 6 DOF tracking
  • JS API action
    Send a message to the XR+ Javascript & CSS API

Only available in the states engine:

  • Timer => switch to a state
    Set an timer alarm, when the alarm is triggered, switch to another state
  • Play basic animation
    Animate a mesh from a model with a simple animation: scale up/down, pulse, rotate clockwise, rotate anticlockwise
  • Stop basic animation
    Stop all basic animation on the selected mesh
  • Show composition items
    Unhide the selected items from the composition
  • Hide composition items
    Hide the selected items from the composition
  • Show model meshes
    Unhide the selected meshes from the composition
  • Hide model meshes
    Hide the selected meshes from the composition

When to use the States engine?

If you need to trigger multiple actions at once like: change scene, then hide an item, then wait 3s, then change overlay… Then use a state from the states engine

States engine

(formerly ‘advanced interactions’ module)

Complex actions sequences can be made with the ‘States engine‘, by switching between states.

A state is made of one or several actions. Use states when you need to trigger multiple actions at once like: change scene, then hide an item, then wait 3s, then change overlay…

When a project switches to a new state, all actions from the new state are applied in a top to bottom order.

There are many different actions, such as:
change scene, change overlay, hide / show an item, play an animation, play a sound effect, change a color.

States actions

See ‘actions’ section for the list of all available XR+ studio actions.

Tip: multiple states can be chained with a timer action, to switch to another state after a fixed amount of time.

Tutorial

You can follow this step by step tutorial to practice using the states interactions module

States engine tutorial