geom-export-obj

geom-export-obj

Convert one (or more) simplicial complex geometry (positions/cells/normals/uvs/vertexColors) into an OBJ string (optionally optimized with number precision to reduce its size).

Installation

npm install geom-export-obj

Usage

import geomExportObj from "geom-export-obj";
import { cube } from "primitive-geometry";
console.log(geomExportObj(cube()).output);

API

Modules

geomExportObj

Typedefs

SimplicialComplex : object

Geometry definition. All optional.

GeomExportObjOffsets : object

Offsets to for cells. Useful if appending to another obj string. Used internally.

GeomExportObjOptions : object

Options for exporter.

GeomExportObjReturnValue : object

geomExportObj

• geomExportObj
  • geomExportObj(geometries, [options]) ⇒ GeomExportObjReturnValue ⏏
    • .parse(geometry, [offsets], [defaultName], [precision]) ⇒ string

geomExportObj(geometries, [options]) ⇒ GeomExportObjReturnValue ⏏

Parse one or more simplicial complex geometry and return an obj string and vertices offsets.

Kind: Exported function

Param	Type	Default
geometries	SimplicialComplex | Array.<SimplicialComplex>
[options]	GeomExportObjOptions	{}

geomExportObj.parse(geometry, [offsets], [defaultName], [precision]) ⇒ string

Parse a simplicial complex and return an obj string

Kind: static method of geomExportObj See

• http://paulbourke.net/dataformats/obj/
• https://paulbourke.net/dataformats/obj/colour.html

Param	Type	Default	Description
geometry	SimplicialComplex
[offsets]	GeomExportObjOffsets	{ positions: 0, normals: 0, uvs: 0 }}
[defaultName]	string		A name for the object if geometry.name is not specified.
[precision]	number		Decimal digit precision for positions/normals/uvs/vertexColors.

SimplicialComplex : object

Geometry definition. All optional.

Kind: global typedef Properties

Name	Type	Description
positions	Array.<number>
normals	Array.<number>
uvs	Array.<number>
cells	Array.<number>
name	string	The object name.
[materialName]	string	The object material name.

GeomExportObjOffsets : object

Offsets to for cells. Useful if appending to another obj string. Used internally.

Kind: global typedef Properties

Name	Type
positions	number
normals	number
uvs	number

GeomExportObjOptions : object

Options for exporter.

Kind: global typedef Properties

Name	Type	Default	Description
[header]	string	"# geom-export-obj\n"	Header to be prepended to the file.
[prefix]	string	"Mesh_"	Prefix for object names.
[offsets]	GeomExportObjOffsets	{ positions: 0, normals: 0, uvs: 0 }	The initial offsets for cells.
[precision]	number		Decimal digit precision for positions/normals/uvs/vertexColors.

GeomExportObjReturnValue : object

Kind: global typedef Properties

Name	Type	Description
output	string	The obj as a string.
offsets	GeomExportObjOffsets

License

MIT. See license file.

Changelog

2.1.0 (2025-03-13)

Features

• add support for precision (7b3e426)