Getting started
Importing
Design process
3D Configurator
Variables & Expressions (Beta)
Scene and project settings
Sharing, exporting, embedding
Other
Figma Plugin - Vectary 3D Studio Lite
Model API
type ProjectInfo {
projectName: string;
modelId: string;
modelIdBase62: string;
publishedId: string;
workspaceId: string;
};
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",
}
{custom_event_name}Custom events need to be setup directly in studio.
return string | number | boolean | void
configurator_state_changereturn [ConfigurationState](<https://magnificent-emoji-b41.notion.site/Type-Definitions-8c684e7dd18d4f1a9af963d113169fd5>)[]
type ConfigurationState = VariantSwitcherData | MaterialSwitcherData;
type VariantSwitcherData {
variant: string;
active_object: string;
};
type MaterialSwitcherData {
object: string;
active_material: string;
};
type Vector3 = {
x: number;
y: number;
z: number;
};
type Euler = Vector3 & {
order?: string // default: 'XYZ'
};
type Ray = {
start: Vector3;
direction: Vector3;
};
type RayObjectHit = {
id: string;
name: string;
position: Vector3;
normal: Vector3;
uv: Vector3;
};