VoxFileParser / Model¶

A Model holds the voxel data for one grid inside a MagicaVoxel scene: its dimensions and a palette index for every filled cell. A model has no position in the world, an Instance is what places it. The most common thing you will do with a model is turn it into a renderable triangle mesh with generateTriangleMesh.

namespace GL\Geometry\VoxFileParser
{
    class Model {}
}

Usage¶

Generating a mesh¶

use GL\Buffer\FloatBuffer;
use GL\Buffer\UIntBuffer;

$vertices = new FloatBuffer();
$indices  = new UIntBuffer();

$model->generateTriangleMesh($vertices, $indices, null, 'greedy');

By default every vertex is 9 floats: position (3), normal (3), and an RGB color (3) baked from the palette. See the MagicaVoxel Files guide for the full list of $options that reshape this layout.

Reading a single voxel¶

$paletteIndex = $model->getVoxel(4, 0, 2); // int, or null when empty

Constants¶

The meshing modes are also available as integer constants. You may pass them through the mode key of the $options array. The positional $mode argument of generateTriangleMesh expects the equivalent string ('simple', 'greedy', 'polygon').

public const MODE_SIMPLE = 0;   // 'simple'  - one quad per exposed voxel face
public const MODE_GREEDY = 1;   // 'greedy'  - merge coplanar same-color faces
public const MODE_POLYGON = 2;  // 'polygon' - compact polygonal surfaces

Properties¶

$index¶

The sequential index of this model inside the scene.

/*
 * @var int
 */
public readonly int $index;

$sizeX, $sizeY, $sizeZ¶

The dimensions of the voxel grid.

public readonly int $sizeX;
public readonly int $sizeY;
public readonly int $sizeZ;

$voxelCount¶

The number of filled voxels in the grid.

/*
 * @var int
 */
public readonly int $voxelCount;

$voxelHash¶

A hash identifying the voxel contents, useful for spotting models that share identical geometry.

/*
 * @var int
 */
public readonly int $voxelHash;

$voxelData¶

The raw palette indices for the grid, exposed as a byte buffer.

/*
 * @var \GL\Buffer\UByteBuffer|null
 */
public readonly ?\GL\Buffer\UByteBuffer $voxelData;

Methods¶

`generateTriangleMesh`¶

Generate a triangle mesh for this voxel grid.

function generateTriangleMesh(\GL\Buffer\FloatBuffer $vertices, \GL\Buffer\UIntBuffer $indices, ?\GL\Geometry\VoxFileParser\Palette $palette = null, string $mode = 'simple', ?array $options = null) : bool

arguments

\GL\Buffer\FloatBuffer $vertices Destination buffer for vertex attributes (position, normal, colors).
\GL\Buffer\UIntBuffer $indices Destination buffer for triangle indices.
\GL\Geometry\VoxFileParser\Palette|null $palette Optional palette override or editor instance.
string $mode Mesh generation mode name (simple, greedy, polygon).
array{colors?: "rgb"|"rgba"|"none", includePaletteIndex?: bool, origin?: "corner"|"center", originOffset?: array<int,float>, stats?: array{vertexCount: int, indexCount: int}|null}|null $options Additional mesh generation controls. When provided, this array receives a stats entry on success.

returns

bool True on success, false otherwise.

`getVoxel`¶

Retrieve the palette index stored at the given voxel coordinate.

function getVoxel(int $x, int $y, int $z) : ?int