Heightmap

The Heightmap is one of the four asset types that can be used in a Foxel project. Heightmaps are pixel-based. Each pixel can store a color index, a material index and the pixel's height. Heightmaps can be loaded into Voxel Scenes via VoxelHeightmapReference nodes which convert the 2D pixel data into 3D voxel data.

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
size	2i	(1, 1)	🟩🟥	The surface size in pixels
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 Heightmap use FxFile.Create with FileType 115.

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

TIP

The size of new Heightmaps is (1, 1). To resize the open Heightmap use FxFile.Set2i with the property size. For example, to resize to (100, 100) use FxFile.Set2i(115, "size" 100, 100);

Files

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

Supported Nodes

PixelLayer, PixelHeightmapReference, Group2D