Getting started

System Requirements

Rendering

Vectary Dashboard

Account Settings

Roles

User Interface

Scene Orientation

Units

How To Get Help

Importing

Import formats

Figma frames import

CAD files

Processor

Design process

Design mode

Materials and Textures

Animated Materials

Decals

UV mapping

Camera

Lighting and Environment

Effects

Background

Ground plane

Control Bar

Libraries

Edit mode

3D Configurator

Variants

Interactions

Animations

Floating UI

Hotspots

Variables & Expressions (Beta)

Scene and project settings

Version History

Augmented Reality (WebAR)

WebXR (beta)

Loading screen

Mouse controls

Interaction prompt

Menu - Settings

Sharing, exporting, embedding

Sharing

Performance analyzer

Optimizing a shared project

Project cloning

Embedding to other software

Export options

Other

Figma Plugin - Vectary 3D Studio Lite

2D to 3D

Adding comments

Object Editing

Left bar

Shortcuts

Model API

Introduction

Quick Start

Events & Listeners

Floating UI Configurators

Ecommerce

API - Floating UI

What is a Floating UI Configurator?

Vectary configurators can be enhanced with a Floating UI (FUI for short), with the ability to customize different parts displayed (text, images, links, etc)

A configurator is, at a base level, just a model that contains any number of Variants and/or Materials.

<aside> 💡 You can learn more about configurators here:

3D configurator maker

</aside>

Example

Here’s an example which loads a configurator and uses the API to:

https://codesandbox.io/s/get-setconfigurationstate-kl0psw?autoresize=1&expanddevtools=1&fontsize=14&hidenavigation=1&theme=dark&codemirror=1

getConfigurationState

Returns an array with the current ConfigurationState of all Variants and Materials .

getConfigurationState(): Promise<ConfigurationState[]>

Usage:

await modelApi.getConfigurationState();

Return value:

[
    [
        {
            "variant": "Object Switcher",
            "active_object": "NUNO Stand"
        },
        {
            "object": "Adjustable Headband",
            "active_material": "White"
        }
    ]
]