API Reference

A detailed reference of available methods is provided in this section. The API is continuously evolving -new methods and features will be added over time. For specific use cases or requests, contact a Vectary customer success manager.

#	Name	Documented in	Snippet / Sandbox
1	init	Quick Start	Init
2	isReady	Quick Start	Init
3	projectInfo	Quick Start	Init
4	dispatchEvent	Events & Listeners	dispatchEvent dispatchEvent
5	addEventListener	Events & Listeners	add-removeEventListener
6	removeEventListener	Events & Listeners	add-removeEventListener
7	setConfigurationState	Floating UI	get-setConfigurationState
8	getConfigurationState	Floating UI	get-setConfigurationState
9	getObjects		getObjects
10	getHoveredObjects		Transformations
11	duplicateObjects		duplicateObjects
12	moveObjects		moveObjects
13	getPosition		Transformations
14	setPosition		Transformations
15	getRotation		Transformations
16	setRotation		Transformations
17	getScale		Transformations
18	setScale		Transformations
19	getPrimitives		get-setPrimitives
20	setPrimitives		get-setPrimitives
21	getText3d		get-setText3d
22	setText3d		get-setText3d
23	getAllMaterials		getAllMaterials
24	getMaterials		getMaterials
25	getActiveMaterial		get-setActiveMaterial
26	setActiveMaterial		get-setActiveMaterial
27	addOrEditMaterial		addOrEditMaterial
28	removeMaterial		removeMaterial
29	getTextureData		get-setTextureData
30	setTextureData		get-setTextureData
31	addTexture		add-mapTextures
32	mapTextures		add-mapTextures
33	raycastAll		get-setTextureData
34	raycastObject		getRayFromCoordinate
35	getRayFromCoordinate		getRayFromCoordinate
36	getAnimations		Animation Player
37	playAnimation		Animation Player
38	stopAnimation		Animation Player
39	setAnimationPlayhead		Animation Player
40	rotateEnvironmentMap		rotateEnvironmentMap
41	getViewState		get-setViewState
42	setViewState		get-setViewState
43	fitToView		fitToView
44	takeScreenshot		takeScreenshot
45	importFiles		importFiles
46	importProject		importProject
47	exportFile		exportFile