objtojs

A nodejs module to parses WaveFront Object (.obj) files to javascript or JSON.

This is a fork of chrispalazzolo's objtojs. All it does is skips parsing usemtl and smoothing groups information from the select OBJ file.

It's a lame-ass workaround I have put in place to get around the problems that this library has with parsing this information as I don't need this for my current purposes.

More info on these 2 known issues can be found here:

chrispalazzolo#1 chrispalazzolo#2

Overview

Parse WaveFront Object file (.obj) to a javascript object and/or JSON.

Option to save the parsed data to a JSON file which will also break down the data to segments and save each segment to it's own JSON file.

Installation

npm install objtojs

Dependencies

mtltojs

Usage:

Returns a js object and optional JSON.

var parser = require("objtojs");

// Async call
parser.parse(file, function(err, data){
  // do stuff with data
});

//Synchronous call
var data = parser.parseSync("C:/3d/materials/sample.obj");

Methods

parse - Is an async method which takes in a filepath and optional options object. Returns a js objected of the parsed data. Options to save JSON and log information to a file. For options See below

parse(file[,options], callback)

parseSync - Is a synchronous call which takes the same arguments as the asynchronous parse call..

parseSync(file[,options])

Parameters

These are the parameters for methods...

parse(file, options, callback) and parseSync(file, options)

file - - full path to the .mtl file. options - - flags for events such as logging, saving to JSON files, etc... callback - - callback function only for the async call 'parse'.

Options

Is a js object that contains configurations for logging, saving JSON files, etc...

parseComments - bool (default: false) - flag to retain comments when parsing the file.
verbose - bool (default: false) - flag to write parsing details to the nodejs console.
logging - bool (default: false) - flag to write and save parsing details to a log file.
returnJSON - bool (default: false) - flag to have the a JSON string of the parsed object returned with the js object.
saveJSON - bool (default: false) - flag to save the parsed data as a JSON string to file. parseMTLFile - bool (default: false) - flag to parse material file referenced in the object file.
returnMTLJSON - bool (default: false) - flag to return parsed material file data as JSON. NOTE: This flag is ignored if parseMTLFile is false.
saveMTLJSON - bool (default: false) - flag to save the parsed material file data as JSON. NOTE: This flag is ignored if parseMTLFile is false.

Default Option object if the options parameter is omitted...

options = {
  parseComments: false,
  verbose: false,
  logging: false,
  returnJSON: false,
  saveJSON: false,
  parseMTLFile: false,
  returnMTLJSON: false,
  saveMTLJSON: false
}

License

MIT

Release History

0.1.0 Initial Release

oculushut/objtojs