threejs-vox-loader
Version:
Improved three.js loader for MagicaVoxel .vox files
268 lines (222 loc) • 8.97 kB
JavaScript
import { unpack, unpackString } from 'byte-data';
import { Color, SRGBColorSpace } from 'three';
import ModelObject from './ModelObject';
const INT_32 = { bits: 32, be: false, signed: true, fp: false };
//https://paulbourke.net/dataformats/vox/
//https://github.com/ephtracy/voxel-model/blob/master/MagicaVoxel-file-format-vox.txt
//https://github.com/ephtracy/voxel-model/blob/master/MagicaVoxel-file-format-vox-extension.txt
const DEFAULT_PALETTE = [
0x00000000, 0xffffffff, 0xffccffff, 0xff99ffff, 0xff66ffff, 0xff33ffff, 0xff00ffff, 0xffffccff,
0xffccccff, 0xff99ccff, 0xff66ccff, 0xff33ccff, 0xff00ccff, 0xffff99ff, 0xffcc99ff, 0xff9999ff,
0xff6699ff, 0xff3399ff, 0xff0099ff, 0xffff66ff, 0xffcc66ff, 0xff9966ff, 0xff6666ff, 0xff3366ff,
0xff0066ff, 0xffff33ff, 0xffcc33ff, 0xff9933ff, 0xff6633ff, 0xff3333ff, 0xff0033ff, 0xffff00ff,
0xffcc00ff, 0xff9900ff, 0xff6600ff, 0xff3300ff, 0xff0000ff, 0xffffffcc, 0xffccffcc, 0xff99ffcc,
0xff66ffcc, 0xff33ffcc, 0xff00ffcc, 0xffffcccc, 0xffcccccc, 0xff99cccc, 0xff66cccc, 0xff33cccc,
0xff00cccc, 0xffff99cc, 0xffcc99cc, 0xff9999cc, 0xff6699cc, 0xff3399cc, 0xff0099cc, 0xffff66cc,
0xffcc66cc, 0xff9966cc, 0xff6666cc, 0xff3366cc, 0xff0066cc, 0xffff33cc, 0xffcc33cc, 0xff9933cc,
0xff6633cc, 0xff3333cc, 0xff0033cc, 0xffff00cc, 0xffcc00cc, 0xff9900cc, 0xff6600cc, 0xff3300cc,
0xff0000cc, 0xffffff99, 0xffccff99, 0xff99ff99, 0xff66ff99, 0xff33ff99, 0xff00ff99, 0xffffcc99,
0xffcccc99, 0xff99cc99, 0xff66cc99, 0xff33cc99, 0xff00cc99, 0xffff9999, 0xffcc9999, 0xff999999,
0xff669999, 0xff339999, 0xff009999, 0xffff6699, 0xffcc6699, 0xff996699, 0xff666699, 0xff336699,
0xff006699, 0xffff3399, 0xffcc3399, 0xff993399, 0xff663399, 0xff333399, 0xff003399, 0xffff0099,
0xffcc0099, 0xff990099, 0xff660099, 0xff330099, 0xff000099, 0xffffff66, 0xffccff66, 0xff99ff66,
0xff66ff66, 0xff33ff66, 0xff00ff66, 0xffffcc66, 0xffcccc66, 0xff99cc66, 0xff66cc66, 0xff33cc66,
0xff00cc66, 0xffff9966, 0xffcc9966, 0xff999966, 0xff669966, 0xff339966, 0xff009966, 0xffff6666,
0xffcc6666, 0xff996666, 0xff666666, 0xff336666, 0xff006666, 0xffff3366, 0xffcc3366, 0xff993366,
0xff663366, 0xff333366, 0xff003366, 0xffff0066, 0xffcc0066, 0xff990066, 0xff660066, 0xff330066,
0xff000066, 0xffffff33, 0xffccff33, 0xff99ff33, 0xff66ff33, 0xff33ff33, 0xff00ff33, 0xffffcc33,
0xffcccc33, 0xff99cc33, 0xff66cc33, 0xff33cc33, 0xff00cc33, 0xffff9933, 0xffcc9933, 0xff999933,
0xff669933, 0xff339933, 0xff009933, 0xffff6633, 0xffcc6633, 0xff996633, 0xff666633, 0xff336633,
0xff006633, 0xffff3333, 0xffcc3333, 0xff993333, 0xff663333, 0xff333333, 0xff003333, 0xffff0033,
0xffcc0033, 0xff990033, 0xff660033, 0xff330033, 0xff000033, 0xffffff00, 0xffccff00, 0xff99ff00,
0xff66ff00, 0xff33ff00, 0xff00ff00, 0xffffcc00, 0xffcccc00, 0xff99cc00, 0xff66cc00, 0xff33cc00,
0xff00cc00, 0xffff9900, 0xffcc9900, 0xff999900, 0xff669900, 0xff339900, 0xff009900, 0xffff6600,
0xffcc6600, 0xff996600, 0xff666600, 0xff336600, 0xff006600, 0xffff3300, 0xffcc3300, 0xff993300,
0xff663300, 0xff333300, 0xff003300, 0xffff0000, 0xffcc0000, 0xff990000, 0xff660000, 0xff330000,
0xff0000ee, 0xff0000dd, 0xff0000bb, 0xff0000aa, 0xff000088, 0xff000077, 0xff000055, 0xff000044,
0xff000022, 0xff000011, 0xff00ee00, 0xff00dd00, 0xff00bb00, 0xff00aa00, 0xff008800, 0xff007700,
0xff005500, 0xff004400, 0xff002200, 0xff001100, 0xffee0000, 0xffdd0000, 0xffbb0000, 0xffaa0000,
0xff880000, 0xff770000, 0xff550000, 0xff440000, 0xff220000, 0xff110000, 0xffeeeeee, 0xffdddddd,
0xffbbbbbb, 0xffaaaaaa, 0xff888888, 0xff777777, 0xff555555, 0xff444444, 0xff222222, 0xff111111
];
export default class VOXFile {
constructor(data) {
this.buffer = data;
this.head = 0;
this.materials = new Map();
this.objects = [];
this.currentObject = null;
this.nodes = {};
}
readChar() {
let str = '';
str = unpackString(this.buffer, this.head, this.head + 4);
this.head += 4;
return str;
}
readInt32() {
let value = unpack(this.buffer, INT_32, this.head);
this.head += 4;
return value;
}
readByte() {
let value = this.buffer[this.head];
this.head++;
return value;
}
readString() {
let size = this.readInt32();
let str = '';
str = unpackString(this.buffer, this.head, this.head + size);
this.head += size;
return str;
}
readDict() {
let dict = {};
let numPairs = this.readInt32();
for (let i = 0; i < numPairs; i++) {
let key = this.readString();
let value = this.readString();
dict[key] = value;
}
return dict;
}
readNextChunk() {
let chunk_id = this.readChar();
let chunk_bytes = this.readInt32();
this.readInt32(); //child_chunk_bytes
let current_head = this.head;
let reader = this["read" + chunk_id];
if (typeof reader === "function") {
reader.apply(this)
} else {
//we ignore main data
this.head += chunk_bytes;
}
if (this.head !== current_head + chunk_bytes) throw new Error("Expected to read " + chunk_bytes + " bytes, read " + (this.head - current_head));
}
readPACK() {
this.pack = {
numModels: this.readInt32()
}
}
readSIZE() {
let size = {
x: this.readInt32(),
y: this.readInt32(),
z: this.readInt32()
};
this.currentObject = new ModelObject(size);
this.objects.push(this.currentObject)
}
readXYZI() {
let numVoxels = this.readInt32();
const obj = this.currentObject;
const offset_y = obj.size.x;
const offset_z = obj.size.x * obj.size.y;
obj.voxels = new Array(obj.size.x * obj.size.y * obj.size.z);
obj.voxels.fill(null);
for (let i = 0; i < numVoxels; i++) {
let x = this.readByte();
let y = this.readByte();
let z = this.readByte();
const index = x + (y * offset_y) + (z * offset_z);
obj.voxels[index] = this.readByte();
}
}
readRGBA() {
this.palette = [];
for (let i = 0; i < 256; i++) {
this.palette.push({
r: this.readByte(),
g: this.readByte(),
b: this.readByte(),
a: this.readByte(),
})
}
}
readDefaultPalette() {
this.palette = DEFAULT_PALETTE.map(c => {
return {
a: c >> 0 & 0xff,
r: c >> 8 & 0xff,
g: c >> 16 & 0xff,
b: c >> 24 & 0xff,
};
})
}
readMATL() {
let material_id = this.readInt32();
this.materials.set(material_id, {
id: material_id,
...this.readDict()
});
}
readnTRN() {
let node_id = this.readInt32();
let attrs = this.readDict();
let child_node_id = this.readInt32();
this.readInt32(); //reserved_id
let layer_id = this.readInt32();
let frame_count = this.readInt32();
let frames = [];
for (let i = 0; i < frame_count; i++) {
frames.push(this.readDict());
}
this.nodes[node_id] = {
id: node_id,
type: "T",
attrs,
child_node_ids: [child_node_id],
layer_id,
frames
};
}
readnGRP() {
let node_id = this.readInt32();
let attrs = this.readDict();
let child_node_count = this.readInt32();
let child_node_ids = [];
for (let i = 0; i < child_node_count; i++) {
child_node_ids.push(this.readInt32());
}
this.nodes[node_id] = {
id: node_id,
type: "G",
attrs,
child_node_ids
};
}
readnSHP() {
let node_id = this.readInt32();
let attrs = this.readDict();
let model_count = this.readInt32();
let models = [];
for (let i = 0; i < model_count; i++) {
let model_id = this.readInt32();
models.push({
id: model_id,
...this.readDict()
});
}
this.nodes[node_id] = {
id: node_id,
type: "S",
attrs,
models
};
}
// ===
getColor(colorIndex) {
return this.palette[colorIndex - 1];
}
getThreeColor(colorIndex) {
let color = this.getColor(colorIndex);
const _color = new Color();
_color.setRGB(color.r / 255, color.g / 255, color.b / 255, SRGBColorSpace);
return _color;
}
getMaterial(colorIndex) {
return this.materials.get(colorIndex);
}
}