Voxel Scene

The Voxel Scene is the most important of the four asset types that can be used in a Foxel project. Voxel scenes are the files you work with to create voxel-based models and animations that can be rendered to file or exported to third-party applications.

Voxel scenes contain a node tree for easy scene management, and a timeline for keyframe-based animation.

Voxel scenes can load data from other assets by using VoxelReference nodes.

To light your scene use Light nodes and to render everything to file add a custom Camera node.

Properties

Name	Type	Default	Access	Description
category	1i	0	🟩🟥	Category
copyrightInfoUrl	1s		🟩🟥	Metadata, link to copyright info
copyrightNotice	1s		🟩🟥	Metadata, copyright notice
copyrightStatus	1i	0	🟩🟥	Metadata, CopyrightStatus
creator	1s		🟩🟥	Metadata, creator of asset
description	1s		🟩🟥	Metadata, description
fps	1f	24.0	🟩🟥	Animation frames per second
guid	1s		🟩❌	Globally unique identifier
headline	1s		🟩🟥	Metadata, headline
keywords	1s		🟩🟥	Metadata, keyword
scanBoxFrame	1i	1	🟩🟥	Default Scan Box frame
scanBoxOrigin	3i	(0, 0, 0)	🟩🟥	Default Scan Box origin
scanBoxPosition	3i	(-128, -128, -128)	🟩🟥	Default Scan Box position
scanBoxSize	3i	(256, 256, 256)	🟩🟥	Default Scan Box size
title	1s		🟩🟥	Metadata, title
unitScale	1f	1.0	🟩🟥	Unit scale

Details

Type
1b: boolean
1c: color (integer)
1i: integer
1f: float
1s: string
2b: 2-component boolean vector
2i: 2-component integer vector
2f: 2-component float vector
3b: 3-component boolean vector
3i: 3-component integer vector
3f: 3-component float vector

Access
🟩 : Property value can be read with FxFile.Get
🟥 : Property value can be changed with FxFile.Set
❌ : Property value is read-only and can't be changed

Create

To create a new voxel scene use FxFile.Create with FileType 112.

assetID = FxFile.Create(112);
assetID = FxFile.Rename(112, assetID, "MyAsset"); -- rename new asset
FxFile.Open(112, assetID); -- open new asset

Files

All asset files of a project are stored in the project folder Projects\PROJECTNAME\Assets\ with the file extension .fxl.

Supported Nodes

VoxelLayer, VoxelSceneReference, VoxelHeightmapReference, VoxelMovieReference, FirstPersonCamera, OrbitCamera, DirLight, PointLight, SpotLight, Group3D, ScanBox, Locator