Metadata

Models can contain metadata.

Add metadata to CAD / 3D files

The pre-requisit to use metadata is a zipped file. Direct CAD / 3D file uploads cannot contain metadata.

A meta.json file contained in a zipped CAD / 3D file can contain properties which are read by Vuframe® Studio and Aura™ when the file is processed.

meta.json Properties

Property	Description	Example
name	will be used in Vuframe® Studio instead of the actual filename	"sofa-scene"
asset	identifies the main CAD / 3D file contained in the archive	"sofa-scene"
guid	a GUID which uniquely identifies the contained model	"294a34db-44b2-4fb3-b95b-2c67e3ea631c"
version	a integer value, starting at 1 which uniquely identifies the file version	1
timestamp	a timestamp which represents the creation/last modification date of the file. Format: "yyyy-MM-dd HH:mm:ss zzz"	"2019-12-31 19:01:01 -06:00"
api_version	if the model is interactive (exported from Unity 3D or Unreal Engine) this specifies the framework version used to create the model file	3215 or 3300, etc.
meta_format	integer that defines which structure the json file is using	2
format	string which specifies the contained format	"vf3d", "aura"
format_version	string which specifies the contained format version	"1.0.0", "2.0.0"
resolution	string which specifies the contained resolution; comma separated list	"raw", "high", "low", "legacy"
editor	string which specifies the editor that was used to create this file	"unity"
editor_version	string which specifies the version of the editor used to create this file	"2017.4.40f1"
editor_variant	string which specifies the runtime/encoding environment in the editor used to create the file, e.g. "Standalone" or "iOS" in Unity 3D	"standalone", "ios"
exporter	string identifying the authoring environment	"sdk", "ndk"
exporter_version	integer or string which specifies the version of the plugin used to create this file	88, "0.8.8"
plugin_version	❌ deprecated, use exporter_version instead	88, "0.8.8"
published_at	❌ deprecated, use timestamp instead, should include timezone	-
cms_file_type	❌ deprecated (string)	"cms/ panic3d_scene_item_version"
type	❌ deprecated (string)	"cloud_scene"
augmented_middleware	❌ deprecated (string)	"wikitude", "vuforia"
main_ar_pattern	❌ deprecated (string)	-
ar_patterns	❌ deprecated (array of strings)	-
features	❌ deprecated (array of strings)	-

Examples

Example (July 2020)

{
	// global properties
	"name": "sofa-scene",
	"guid": "294a34db-44b2-4fb3-b95b-2c67e3ea631c",
	"version": 48,
	"published_at": "8/6/2020 12:11:44 PM", // deprecated
	"timestamp": "8/6/2020 12:11:44 PM", // use this instead of published_at
	"api_version": 3300,
	"editor": "unity",
	"editor_version": "2017.4.40f1",
	"editor_variant": "ios",
	"plugin_version": 88
}

Legacy Example

{
	// global properties
	"name": "sofa-scene",
	"guid": "294a34db-44b2-4fb3-b95b-2c67e3ea631c",
	"version": 48,
	"published_at": "8/6/2020 12:11:44 PM", // deprecated
	"timestamp": "8/6/2020 12:11:44 PM", // use this instead of published_at
	"api_version": 3300,
	"editor": "unity",
	"editor_version": "2017.4.40f1",
	"editor_variant": "ios",
	"plugin_version": 88, // deprecated
	
	// content properties
	"asset": "sofa-scene",
	"cms_file_type": "cms/panic3d_scene_item_version", // deprecated
	"type": "cloud_scene", // deprecated
	
	// background & lighting - DEPRECATED, moved to scene.json
	"lighting_color": "0,0,0",
	"lighting_type": "dynamic",
	"lighting_direction": "(0.0,0.0,0.0)",
	"lighting_intensity": "0",
	"background_color": "rgba(1.000, 1.000, 1.000, 1.000)",
	
	// content elements - DEPRECATED here, moved to scene.json
	"layouts": 
		[
			"root"
		],
	"materials": 
		[
			"floor 1",
			"cloth_1",
			"base_material"
		],
	"objects": 
		[
			"/sofa-scene",
			"/Plane",
			"/sofa_4",
			"/sofa_4/back",
			"/sofa_4/back 1",
			"/sofa_4/back 2",
			"/sofa_4/base",
			"/sofa_4/left",
			"/sofa_4/legs",
			"/sofa_4/right",
			"/sofa_4/seat",
			"/sofa_4/seat 1",
			"/sofa_4/seat 2"
		],
	"triggers": 
		[],
	"tours": 
		[],
	"external_materials": 
		[],
	"surfaces": 
		[],
	"external_textures": 
		[],
	"variations": 
		[],
	"external_objects": 
		[],
		
	// runtime compatibility - DEPRECATED
	"features": 
		[
			"touch",
			"ontable"
		],
		
	// augmented reality middleware – DEPRECATED
	"augmented_middleware": "wikitude"
	"main_ar_pattern": "",
	"ar_patterns": 
		[],
}