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

Events & Listeners

You can send data to the model, and also listen to events dispatched from the model.

Api Events

enum ApiEvents 
	INTERACTION_CUSTOM_EVENT = "{custom_event_name}",
	MOUSE_MOVE = "mouse_move",
	MOUSE_DRAG = 'mouse_drag',
	MOUSE_DOWN = "mouse_down",
	MOUSE_UP = 'mouse_up',
	MOUSE_CLICK = "mouse_click",
	MOUSE_WHEEL = 'mouse_wheel',
	KEY_DOWN = 'key_down',
	HOVERED_OBJECT = 'hovered_object',
	CONFIGURATOR_STATE_CHANGE = "configurator_state_change",
	SELECTION_STATE_CHANGE = "configurator_state_change",
}

Event Responses

{custom_event_name}

Custom events need to be setup directly in studio.

return string | number | boolean | void

configurator_state_change

return [ConfigurationState](<https://magnificent-emoji-b41.notion.site/Type-Definitions-8c684e7dd18d4f1a9af963d113169fd5>)[]

Adding/Removing Event Listeners

Example

https://codesandbox.io/s/add-removeeventlistener-ebeq4d?autoresize=1&expanddevtools=1&fontsize=14&hidenavigation=1&theme=dark&codemirror=1

Dispatching Custom Events

Example

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