Skip to content

References โ€‹

Reference objects use data from other assets.

Foxel provides two reference categories:

  • Voxel References
  • Pixel References

A voxel object can be either a Voxel Layer or a Voxel Reference. A pixel object can be either a Pixel Layer or a Pixel Reference. Use the broader terms only when a concept applies to both.

Voxel References โ€‹

Voxel References load data from other assets and display the result as voxel data inside a Voxel Scene.

Depending on the reference type, the source data may be scanned, converted, or voxelized before it is displayed.

Voxel References can also be transformed at the grid level, for example by rotating, flipping, or cropping the generated voxel data.

Scene Reference โ€‹

A Scene Reference loads voxel data from another Voxel Scene.

The voxel data is generated by scanning a region of the source scene and merging the voxel result into a single grid.

Properties โ€‹

Voxel SceneThe source Voxel Scene.
Scan BoxDefines which Scan Box is used for scanning the source scene.

A Scene Reference can use either the asset's Default Scan Box or a custom Scan Box.

Movie Reference โ€‹

A Movie Reference loads voxel data from a Voxel Movie.

It displays the voxel data of a selected frame.

Properties โ€‹

Voxel MovieThe source Voxel Movie.
FrameDefines which frame is displayed.

Heightmap Reference โ€‹

A Heightmap Reference converts a Heightmap into voxel data.

Properties โ€‹

HeightmapThe source Heightmap.
Height OffsetAdds an offset to the generated height values.
Height ScaleMultiplies the generated height values.

Mesh Reference โ€‹

A Mesh Reference voxelizes mesh data from a Mesh Asset.

Properties โ€‹

Mesh AssetThe source Mesh Asset.
Scan BoxDefines which Scan Box is used for voxelization.

Shared Voxel Reference Properties โ€‹

All Voxel Reference types share the following properties:

CropEnables cropping of the generated voxel grid.
Crop Box PositionDefines the position of the crop box inside the voxel grid.
Crop Box SizeDefines the size of the crop box. Voxel data outside this region is excluded.

Pixel References โ€‹

Pixel References load data from other assets and display the result as pixel data inside a Heightmap.

At the moment, Pixel References can reference Heightmaps only.

The loaded pixel grid can be flipped, rotated, and scaled.

Pixel Reference Properties โ€‹

HeightmapThe source Heightmap.
Grid Flip XFlips the pixel grid horizontally.
Grid Flip YFlips the pixel grid vertically.
Grid RotateRotates the pixel grid.
Grid Scale XScales the pixel grid along the X axis.
Grid Scale YScales the pixel grid along the Y axis.

TIP

For more information about updating, converting, and breaking references, see Referencing Assets.