API Reference

Complete list of Model API methods organized by category.

New methods and features are added to the API over time. While we aim to keep this reference up to date, some methods may not yet be documented or may lack complete details.

We welcome your questions and feedback. If something is unclear, missing, incorrect, or not working as described, please contact us.

Methods

Initialization

#	Method	Description	Snippet
1	init	Initialize API connection with the embedded model	Init
2	isReady	Check if the API is ready	Init
3	projectInfo	Get project information	Init

---

Events

#	Method	Description	Snippet
4	dispatchEvent	Send event to the scene	dispatchEvent
5	addEventListener	Listen for events from the scene	add-removeEventListener
6	removeEventListener	Remove event listener	add-removeEventListener

---

Configuration

#	Method	Description	Snippet
7	getConfigurationState	Get current variants and materials state	get-setConfigurationState
8	setConfigurationState	Set variants and materials state	get-setConfigurationState

---

Objects

#	Method	Description	Snippet
9	getObjects	Get objects by name or all objects	getObjects
10	removeObjects	Remove objects from the scene	removeObjects
11	getHoveredObjects	Get objects currently under cursor	Transformations
12	duplicateObjects	Duplicate objects	duplicateObjects
13	moveObjects	Move objects in hierarchy	moveObjects
14	toggleVisibility	Show or hide objects	toggleVisibility
15	selectObjects	Select one or more objects by name or ID
16	deselectObjects	Remove objects from selection, or clear entire selection
17	getSelectedObjects	Get currently selected objects

---

Gizmo

#	Method	Description	Snippet
18	configureGizmo	Configure transform gizmo visibility, orientation, and snapping

---

Transformations

#	Method	Description	Snippet
19	getPosition	Get object position	Transformations
20	setPosition	Set object position	Transformations
21	getRotation	Get object rotation	Transformations
22	setRotation	Set object rotation	Transformations
23	getScale	Get object scale	Transformations
24	setScale	Set object scale	Transformations

---

Materials

#	Method	Description	Snippet
25	getAllMaterials	Get all materials in the scene	getAllMaterials
26	getMaterials	Get materials assigned to an object	getMaterials
27	getActiveMaterial	Get active material of an object	get-setActiveMaterial
28	setActiveMaterial	Set active material of an object	get-setActiveMaterial
29	addOrEditMaterial	Add new or edit existing material	addOrEditMaterial
30	removeMaterial	Remove material from an object	removeMaterial

---

Textures

#	Method	Description	Snippet
31	getTextureData	Get texture raw data	get-setTextureData
32	setTextureData	Set texture raw data	get-setTextureData
33	addTexture	Add new texture from file	add-mapTextures
34	mapTextures	Overlay texture with positioning	add-mapTextures

---

Primitives

#	Method	Description	Snippet
35	getPrimitives	Get primitive settings	get-setPrimitives
36	setPrimitives	Set primitive settings	get-setPrimitives
37	createBox	Create a box primitive and add it to the scene
38	createSphere	Create a sphere primitive and add it to the scene
39	createCone	Create a cone primitive and add it to the scene
40	createCylinder	Create a cylinder primitive and add it to the scene
41	createTorus	Create a torus primitive and add it to the scene
42	createTube	Create a tube primitive and add it to the scene
43	createPolyhedron	Create a polyhedron primitive and add it to the scene
44	createPlane	Create a square plane primitive and add it to the scene

---

Boolean Operations

#	Method	Description	Snippet
45	setBooleanEnabled	Enable or disable boolean calculation on a boolean operator
46	getBooleanEnabled	Check if boolean calculation is active
47	setBooleanChildOperation	Set operation type for a child of a boolean operator
48	getBooleanChildOperation	Get operation type for a child of a boolean operator

---

3D Text

#	Method	Description	Snippet
49	getText3d	Get 3D text settings	get-setText3d
50	setText3d	Set 3D text settings	get-setText3d

---

Camera

#	Method	Description	Snippet
51	getViewState	Get camera position and target	get-setViewState
52	setViewState	Set camera position and target	get-setViewState
53	fitToView	Fit object in camera view	fitToView

---

Animations

#	Method	Description	Snippet
54	getAnimations	Get list of animations	Animation Player
55	playAnimation	Play animation	Animation Player
56	stopAnimation	Stop animation	Animation Player
57	setAnimationPlayhead	Set animation progress (0-100)	Animation Player

---

Raycast

#	Method	Description	Snippet
58	raycastAll	Raycast from current mouse position	get-setTextureData
59	raycastObject	Raycast specific object	getRayFromCoordinate
60	getRayFromCoordinate	Get ray from screen coordinates	getRayFromCoordinate

---

Environment

#	Method	Description	Snippet
61	rotateEnvironmentMap	Rotate HDRI environment (degrees)	rotateEnvironmentMap

---

Import / Export

#	Method	Description	Snippet
62	importFiles	Import 3D file into scene	importFiles
63	importProject	Import another Vectary project	importProject
64	exportFile	Export scene to file	exportFile
65	takeScreenshot	Take screenshot of the scene	takeScreenshot

---

Common Types

Types that appear in multiple methods are documented here. Types specific to a single method are described on that method's page.

Vector3

3D coordinates or RGB color values.

type Vector3 = {
  x: number;
  y: number;
  z: number;
};

Euler

Rotation angles in degrees.

type Euler = {
  x: number;
  y: number;
  z: number;
  order?: string; // default: 'XYZ'
};

Object

Scene object returned by getObjects() and similar methods.

type Object = {
  id: string;
  instanceId: string;
  name: string;
  type: SceneObjects;
  position: Vector3;
  rotation: Euler;
  scale: Vector3;
  materials?: Material[];
  primitive?: PrimitiveNodeSettings;
  text3d?: Text3DNodeSettings;
};

CreatePrimitiveOptions

Shared options object accepted by all create* primitive methods

type CreatePrimitiveOptions = {
  name?: string;
  position?: Vector3;
  rotation?: Euler;
  scale?: Vector3;
  primitiveSettings?: Partial<PrimitiveNodeSettings>;
};

ConfigurationState

State of variants and materials, returned by getConfigurationState().

type ConfigurationState = VariantSwitcherData | MaterialSwitcherData;

type VariantSwitcherData = {
  variant: string;
  variant_instanceId: string;
  active_object: string;
  active_object_instanceId: string;
};

type MaterialSwitcherData = {
  object: string;
  object_instanceId: string;
  active_material: string;
  active_material_instanceId: string;
};

CameraViewState

Camera position and orientation, used by getViewState() and setViewState().

type CameraViewState = {
  target: Vector3;
  position: Vector3;
  upVector: Vector3;
};

Material

Material properties for PBR rendering.

type Material = {
	id?: string;
	name: string;

	baseColor?: {
		textureConfig?: TextureConfig;
		color?: Vector3;
	};
	roughness?: {
		textureConfig?: TextureConfig;
		value?: number;
	};
	metalness?: {
		textureConfig?: TextureConfig;
		value?: number;
	};
	emission?: {
		textureConfig?: TextureConfig;
		color?: Vector3;
		value?: number;
	};
	normal?: {
		textureConfig?: TextureConfig;
		value?: number;
	};
	opacity?: {
		textureConfig?: TextureConfig;
		value?: number;
		alphaMode?: AlphaMode;
		alphaCutoff?: number;
	};
	doubleSided?: boolean;
	clearcoat?: {
		amount?: number;
		reflectivity?: number;
		roughness?: number;
	};
	refraction?: {
		amount?: number;
		IOR?: number;
		absorptionDepth?: number;
		absorptionColor?: Vector3;
		thicknessTextureConfig?: TextureConfig;
		thicknessValue?: number;
	};
	subsurface?: {
		amount?: number;
		color?: Vector3;
		radius?: number;
	};
	iridescence?: {
		textureConfig?: TextureConfig;
		value?: number;
	};
	reflectivity?: {
		textureConfig?: TextureConfig;
		value?: number;
	};
	baked?: {
		ambientOcclusion?: {
			textureConfig?: TextureConfig;
			value?: number;
		};
		lightmap: {
			textureConfig?: TextureConfig;
			value?: number;
		};
	};
	globalMapping?: TextureMapSettings;
};

Textures

TextureConfig

type TextureConfig<T> = {
	id?: string;
	name?: string;
	filters?: TextureFilterSettings;
	mapping?: TextureMapSettings;
	wrapping?: WrapMode;
};

TextureFilterSettings

type TextureFilterSettings = {
	brightness: number;
	contrast: number;
	hue: number;
	saturation: number;
	invert: boolean;
};

TextureMapSettings

type TextureMapSettings = {
	offsetY: number;
	offsetX: number;
	repeatX: number;
	repeatY: number;
	rotation: number;
};

WrapMode

enum WrapMode {
    REPEAT = 0,
    MIRRORED_REPEAT = 1,
    CLAMP = 2
}

TextureData

type TextureData = {
	image: ArrayBuffer;
	width: number;
	height: number;
};