Voxel Movie

The Voxel Movie is one of the four asset types that can be used in a Foxel project. The main purpose of voxel movies is to provide an alternative way of displaying voxel animations to the standard keyframe-based method. Voxel movies contain voxel frames, which are displayed one at a time for a specified duration. In other words, voxel movies are essentially 3D GIF animations.

The node tree of a voxel movie is flat and does not support parenting.

A voxel movies can be assigned to a VoxelMovieReference node, which loads and displays the voxel movie's voxel data at a specified frame.

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
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 movie use FxFile.Create with FileType 113.

assetID = FxFile.Create(113);
assetID = FxFile.Rename(113, assetID, "MyAsset"); -- rename new asset
FxFile.Open(113, 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

VoxelFrame