> For the complete documentation index, see [llms.txt](https://help.mimeeq.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.mimeeq.com/configurator/rules/actions.md).

# Actions Overview

A reference for all actions available in the Mimeeq configurator — camera, scene, mesh, materials, options, UI, and dimension controls.

Actions are operations that run when a rule's trigger fires. Each action performs a specific task — modifying the 3D view, showing or hiding meshes, changing materials, opening groups, or controlling UI elements. Actions can be combined on a single rule to create complex behaviours.

{% hint style="info" %}
New to rules? Read [Rules Overview](/configurator/rules/overview.md) first to understand how triggers and actions work together.
{% endhint %}

## Action conditions and execution settings

Each action can be customised with conditions that control when and how it runs.

### Device scope

| Scope            | Description                        |
| ---------------- | ---------------------------------- |
| **All devices**  | Runs on all device types (default) |
| **Desktop only** | Runs only when viewed on desktop   |
| **Mobile only**  | Runs only when viewed on mobile    |
| **AR only**      | Runs only when viewed in AR mode   |

### Execution timing

| Timing         | Description                                        |
| -------------- | -------------------------------------------------- |
| **Always**     | Runs whenever trigger conditions are met (default) |
| **On load**    | Runs once when the configurator first loads        |
| **After load** | Runs after the initial loading process completes   |

**Example use cases:**

* **On load** — set an initial camera angle, open a specific group, or start auto-rotation
* **After load** — run secondary actions after initial load actions to prevent conflicts
* **Always** — apply actions continuously whenever trigger conditions are met

### Execution delay

The **Delay time (ms)** setting introduces a delay in milliseconds before an action runs.

* Start an animation 500ms after a configuration change
* Create a sequence of actions by setting different delays on each
* Allow the scene to stabilise before applying further changes

### Execution count

The **Run number of times** setting controls how many times an action can execute.

* Show an introductory animation or message only once
* Limit how many times a particular effect occurs
* Create a finite sequence of automated actions

{% hint style="success" %}
**Best practices**

* Use device scope to tailor the experience per platform.
* Use timing controls to create smooth, sequenced interactions.
* Test your configurator on all target devices after setting conditions.
  {% endhint %}

## Available actions

### Camera and view

| Action                    | Description                                    | Option change | Event |
| ------------------------- | ---------------------------------------------- | ------------- | ----- |
| **Apply camera zoom all** | Zooms the camera to fit the product into view  | ✅             | ✅     |
| **Apply custom zoom**     | Applies a custom camera zoom level             | ✅             | ✅     |
| **Select view**           | Switches to a specific 2D view (for 2D layers) | ✅             | ✅     |
| **Set canvas ratio**      | Applies a fixed aspect ratio to the canvas     | ✅             | ❌     |
| **Start auto-rotation**   | Starts automatic camera rotation               | ✅             | ✅     |
| **Stop auto-rotation**    | Stops automatic camera rotation                | ✅             | ✅     |

### Scene management

| Action             | Description                                                                     | Option change | Event |
| ------------------ | ------------------------------------------------------------------------------- | ------------- | ----- |
| **Change scene**   | Switches to a different 3D scene                                                | ✅             | ❌     |
| **Clear scene**    | Restarts the canvas — used with advanced animation logic such as morph targets  | ✅             | ❌     |
| **Show 2D layers** | Shows 2D image layers within the 3D canvas for Fusion View                      | ✅             | ❌     |
| **Play animation** | Plays an animation with controls for speed, frames, direction, and repeat count | ✅             | ✅     |

### Mesh and material control

| Action                           | Description                                                                                                                         | Option change | Event |
| -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ------------- | ----- |
| **Hide meshes**                  | Hides one or more meshes                                                                                                            | ✅             | ❌     |
| **Hide meshes dynamically**      | Hides meshes based on naming conventions — useful when there are hundreds of meshes                                                 | ✅             | ❌     |
| **Show meshes**                  | Shows a mesh that is hidden by default                                                                                              | ✅             | ❌     |
| **Show meshes dynamically**      | Shows meshes based on naming conventions                                                                                            | ✅             | ❌     |
| **Invert meshes**                | Changes a mesh's rotation or inversion                                                                                              | ✅             | ❌     |
| **Snap meshes**                  | Snaps meshes to a defined position                                                                                                  | ✅             | ❌     |
| **Override materials**           | Overrides the material assigned to one or more meshes                                                                               | ✅             | ❌     |
| **Override material parameters** | Overrides material parameters such as albedo colour, glossiness, or bump texture — see article                                      | ✅             | ❌     |
| **Sync option sets**             | Keeps two option sets in sync bidirectionally — for example, matching a backrest and seat material while allowing different colours | ✅             | ❌     |
| **Billboard mode for meshes**    | Makes meshes always face the camera — useful for signage and key visual elements — see article                                      | ✅             | ❌     |

### Option and parameter management

| Action                          | Description                                                                   | Option change | Event |
| ------------------------------- | ----------------------------------------------------------------------------- | ------------- | ----- |
| **Sync options**                | Syncs options that share the same option set or code across different widgets | ✅             | ❌     |
| **Change block name**           | Renames an option block                                                       | ✅             | ❌     |
| **Change blocks group name**    | Renames a group                                                               | ✅             | ❌     |
| **Disable option blocks**       | Greys out an option block without hiding it                                   | ✅             | ❌     |
| **Disable option sets**         | Greys out a specific option set without hiding it                             | ✅             | ❌     |
| **Disable options**             | Greys out specific options without hiding them                                | ✅             | ❌     |
| **Disable options by filter**   | Greys out options based on the option set filter                              | ✅             | ❌     |
| **Hide option blocks**          | Hides an entire option block                                                  | ✅             | ❌     |
| **Hide option sets**            | Hides a specific option set or sets                                           | ✅             | ❌     |
| **Hide options**                | Hides specific options from an option set                                     | ✅             | ❌     |
| **Hide options by filter**      | Hides options based on a filter attribute                                     | ✅             | ❌     |
| **Select options**              | Selects a specific option set value                                           | ✅             | ✅     |
| **Show components dynamically** | Shows components dynamically                                                  | ✅             | ❌     |
| **Unselect options**            | Deselects a specific option set value — see article                           | ✅             | ✅     |

### UI and information display

| Action                       | Description                                                                                     | Option change | Event |
| ---------------------------- | ----------------------------------------------------------------------------------------------- | ------------- | ----- |
| **Show hotspot**             | Shows a hotspot containing content such as videos, images, or text                              | ✅             | ❌     |
| **Hide hotspot**             | Hides a hotspot                                                                                 | ✅             | ❌     |
| **Hide UI elements**         | Hides specific UI elements                                                                      | ✅             | ❌     |
| **Open group**               | Opens a group in the side panel                                                                 | ❌             | ✅     |
| **Rename tooltip**           | Renames the tooltip assigned to a hotspot                                                       | ✅             | ❌     |
| **Scroll to option**         | Scrolls to a specific option in the panel                                                       | ❌             | ✅     |
| **Override widget settings** | Dynamically changes widget properties — for Engrave/Emboss, Message, and Upload Texture widgets | ✅             | ❌     |

### Dimension control

| Action                            | Description                                                                                           | Option change | Event |
| --------------------------------- | ----------------------------------------------------------------------------------------------------- | ------------- | ----- |
| **Show custom dimensions**        | Displays custom point-to-point measurements on a standard product — see article                       | ✅             | ❌     |
| **Override dimensions**           | Overrides the displayed value for Width, Height, Depth, or a custom dimension — see article           | ✅             | ❌     |
| **Round dimensions**              | Rounds dimension values to the nearest step size for modular products — see article                   | ✅             | ❌     |
| **Add standard dimension labels** | Adds a custom text label to standard dimension lines; the pill displays as Label: Value — see article | ✅             | ❌     |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://help.mimeeq.com/configurator/rules/actions.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
