Options
All
  • Public
  • Public/Protected
  • All
Menu

@thi.ng/geom-io-obj

geom-io-obj

npm versionnpm downloads Twitter Follow

This project is part of the @thi.ng/umbrella monorepo.

About

Wavefront OBJ parser (& exporter soon).

Features

  • Geometry split into declared objects & groups by default (can be disabled)
  • Full support for n-gon faces, polylines
  • Optional n-gon face tessellation into triangles
  • Support for relative (negative) vertex references
  • Optional vertex, normal & UV transforms (e.g. convert Y-up / Z-up, flip UVs)
  • Skip parsing/processing of UVs and/or normals
  • Per group mtllib and usemtl references
  • Per group smooth flags
  • Optionally retained comments (e.g. for additional metadata parsing)
  • Fast (~100 verts, normals & faces per millisecond, MBP2015, Node 13.10)

Planned features

  • OBJ export
  • MTL parser

Status

ALPHA - bleeding edge / work-in-progress

Installation

yarn add @thi.ng/geom-io-obj
// ES module
<script type="module" src="https://unpkg.com/@thi.ng/geom-io-obj?module" crossorigin></script>

// UMD
<script src="https://unpkg.com/@thi.ng/geom-io-obj/lib/index.umd.js" crossorigin></script>

Package sizes (gzipped, pre-treeshake): ESM: 1.02 KB / CJS: 1.07 KB / UMD: 1.18 KB

Dependencies

API

Generated API docs

TODO

See api.ts for details about resulting data structure. Also see tests for more.

import { parseObj } from "@thi.ng/geom-io-obj";

const src = `
# test cube

v 1.0000 1.0000 1.0000
v 1.0000 1.0000 0.0000
v 1.0000 0.0000 0.0000
v 1.0000 0.0000 1.0000
v 0.0000 1.0000 0.0000
v 0.0000 1.0000 1.0000
v 0.0000 0.0000 1.0000
v 0.0000 0.0000 0.0000

# quad faces
f 4 3 2 1
f 8 7 6 5
f 6 1 2 5
f 8 3 4 7
f 7 4 1 6
f 3 8 5 2
`;

// parse with defaults
const model = parseObj(src);

console.log(model.vertices);
// [
//   [ 1, 1, 1 ],
//   [ 1, 1, 0 ],
//   [ 1, 0, 0 ],
//   [ 1, 0, 1 ],
//   [ 0, 1, 0 ],
//   [ 0, 1, 1 ],
//   [ 0, 0, 1 ],
//   [ 0, 0, 0 ]
// ]

// vertex indices now zero-based (instead of 1-based in OBJ)
console.log(model.objects[0].groups[0].faces);
// [
//   { v: [ 3, 2, 1, 0 ] },
//   { v: [ 7, 6, 5, 4 ] },
//   { v: [ 5, 0, 1, 4 ] },
//   { v: [ 7, 2, 3, 6 ] },
//   { v: [ 6, 3, 0, 5 ] },
//   { v: [ 2, 7, 4, 1 ] }
// ]

Benchmarks

Benchmark uses a quad-mesh model with 143,423 vertices, same number of normals and 142,802 quad faces (filesize 43.7MB).

benchmarking: parse
        warmup... 7299.40ms (5 runs)
        executing...
        total: 13795.25ms, runs: 10
        mean: 1379.52ms, median: 1379.91ms, range: [1356.43..1431.49]
        q1: 1362.21ms, q3: 1415.23ms
        sd: 1.77%

benchmarking: parse w/ tessellation
        warmup... 7752.45ms (5 runs)
        executing...
        total: 15170.43ms, runs: 10
        mean: 1517.04ms, median: 1540.89ms, range: [1425.28..1616.09]
        q1: 1487.29ms, q3: 1551.26ms
        sd: 3.35%

Authors

Karsten Schmidt

License

© 2016 - 2020 Karsten Schmidt // Apache Software License 2.0

Generated using TypeDoc