obj2gltf/bin/obj2gltf.js

#!/usr/bin/env node
"use strict";
const Cesium = require("cesium");
const fsExtra = require("fs-extra");
const path = require("path");
const yargs = require("yargs");
const obj2gltf = require("../lib/obj2gltf");

const defaultValue = Cesium.defaultValue;
const defined = Cesium.defined;

const defaults = obj2gltf.defaults;

const args = process.argv;

const argv = yargs
  .usage("Usage: node $0 -i inputPath -o outputPath")
  .example("node $0 -i ./specs/data/box/box.obj -o box.gltf")
  .help("h")
  .alias("h", "help")
  .options({
    input: {
      alias: "i",
      describe: "Path to the obj file.",
      type: "string",
      demandOption: true,
      coerce: function (p) {
        if (!defined(p)) {
          return undefined;
        }
        if (p.length === 0) {
          throw new Error("Input path must be a file name");
        }
        return path.resolve(p);
      },
    },
    output: {
      alias: "o",
      describe: "Path of the converted glTF or glb file.",
      type: "string",
      coerce: function (p) {
        if (!defined(p)) {
          return undefined;
        }
        if (p.length === 0) {
          throw new Error("Output path must be a file name");
        }
        return path.resolve(p);
      },
    },
    binary: {
      alias: "b",
      describe: "Save as binary glTF (.glb)",
      type: "boolean",
      default: defaults.binary,
    },
    separate: {
      alias: "s",
      describe:
        "Write separate buffers and textures instead of embedding them in the glTF.",
      type: "boolean",
      default: defaults.separate,
    },
    separateTextures: {
      alias: "t",
      describe: "Write out separate textures only.",
      type: "boolean",
      default: defaults.separateTextures,
    },
    checkTransparency: {
      describe:
        "Do a more exhaustive check for texture transparency by looking at the alpha channel of each pixel. By default textures are considered to be opaque.",
      type: "boolean",
      default: defaults.checkTransparency,
    },
    secure: {
      describe:
        "Prevent the converter from reading textures or mtl files outside of the input obj directory.",
      type: "boolean",
      default: defaults.secure,
    },
    packOcclusion: {
      describe:
        "Pack the occlusion texture in the red channel of metallic-roughness texture.",
      type: "boolean",
      default: defaults.packOcclusion,
    },
    metallicRoughness: {
      describe:
        "The values in the .mtl file are already metallic-roughness PBR values and no conversion step should be applied. Metallic is stored in the Ks and map_Ks slots and roughness is stored in the Ns and map_Ns slots.",
      type: "boolean",
      default: defaults.metallicRoughness,
    },
    specularGlossiness: {
      describe:
        "The values in the .mtl file are already specular-glossiness PBR values and no conversion step should be applied. Specular is stored in the Ks and map_Ks slots and glossiness is stored in the Ns and map_Ns slots. The glTF will be saved with the KHR_materials_pbrSpecularGlossiness extension.",
      type: "boolean",
      default: defaults.specularGlossiness,
    },
    unlit: {
      describe:
        "The glTF will be saved with the KHR_materials_unlit extension.",
      type: "boolean",
      default: defaults.unlit,
    },
    metallicRoughnessOcclusionTexture: {
      describe:
        "Path to the metallic-roughness-occlusion texture that should override textures in the .mtl file, where occlusion is stored in the red channel, roughness is stored in the green channel, and metallic is stored in the blue channel. The model will be saved with a pbrMetallicRoughness material. This is often convenient in workflows where the .mtl does not exist or is not set up to use PBR materials. Intended for models with a single material",
      type: "string",
      normalize: true,
    },
    specularGlossinessTexture: {
      describe:
        "Path to the specular-glossiness texture that should override textures in the .mtl file, where specular color is stored in the red, green, and blue channels and specular glossiness is stored in the alpha channel. The model will be saved with a material using the KHR_materials_pbrSpecularGlossiness extension.",
      type: "string",
      normalize: true,
    },
    occlusionTexture: {
      describe:
        "Path to the occlusion texture that should override textures in the .mtl file.",
      type: "string",
      normalize: true,
    },
    normalTexture: {
      describe:
        "Path to the normal texture that should override textures in the .mtl file.",
      type: "string",
      normalize: true,
    },
    baseColorTexture: {
      describe:
        "Path to the baseColor/diffuse texture that should override textures in the .mtl file.",
      type: "string",
      normalize: true,
    },
    emissiveTexture: {
      describe:
        "Path to the emissive texture that should override textures in the .mtl file.",
      type: "string",
      normalize: true,
    },
    alphaTexture: {
      describe:
        "Path to the alpha texture that should override textures in the .mtl file.",
    },
    inputUpAxis: {
      describe: "Up axis of the obj.",
      choices: ["X", "Y", "Z"],
      type: "string",
      default: "Y",
    },
    outputUpAxis: {
      describe: "Up axis of the converted glTF.",
      choices: ["X", "Y", "Z"],
      type: "string",
      default: "Y",
    },
    triangleWindingOrderSanitization: {
      describe: "Apply triangle winding order sanitization.",
      type: "boolean",
      default: defaults.triangleWindingOrderSanitization,
    },
    doubleSidedMaterial: {
      describe: "Allow the material properties to be double-sided",
      type: "boolean",
      default: defaults.doubleSidedMaterial,
    },
  })
  .parse(args);

if (argv.metallicRoughness + argv.specularGlossiness > 1) {
  console.error(
    "Only one material type may be set from [--metallicRoughness, --specularGlossiness].",
  );
  process.exitCode = 1;
  return;
}

if (
  defined(argv.metallicRoughnessOcclusionTexture) &&
  defined(argv.specularGlossinessTexture)
) {
  console.error(
    "--metallicRoughnessOcclusionTexture and --specularGlossinessTexture cannot both be set.",
  );
  process.exitCode = 1;
  return;
}

const objPath = argv.input;
let gltfPath = argv.output;

const filename = defaultValue(gltfPath, objPath);
const name = path.basename(filename, path.extname(filename));
const outputDirectory = path.dirname(filename);
const binary = argv.binary || path.extname(filename).toLowerCase() === ".glb";
const extension = binary ? ".glb" : ".gltf";

gltfPath = path.join(outputDirectory, name + extension);

const overridingTextures = {
  metallicRoughnessOcclusionTexture: argv.metallicRoughnessOcclusionTexture,
  specularGlossinessTexture: argv.specularGlossinessTexture,
  occlusionTexture: argv.occlusionTexture,
  normalTexture: argv.normalTexture,
  baseColorTexture: argv.baseColorTexture,
  emissiveTexture: argv.emissiveTexture,
  alphaTexture: argv.alphaTexture,
};

const options = {
  binary: binary,
  separate: argv.separate,
  separateTextures: argv.separateTextures,
  checkTransparency: argv.checkTransparency,
  secure: argv.secure,
  packOcclusion: argv.packOcclusion,
  metallicRoughness: argv.metallicRoughness,
  specularGlossiness: argv.specularGlossiness,
  unlit: argv.unlit,
  overridingTextures: overridingTextures,
  outputDirectory: outputDirectory,
  inputUpAxis: argv.inputUpAxis,
  outputUpAxis: argv.outputUpAxis,
  triangleWindingOrderSanitization: argv.triangleWindingOrderSanitization,
  doubleSidedMaterial: argv.doubleSidedMaterial,
};

console.time("Total");

obj2gltf(objPath, options)
  .then(function (gltf) {
    if (binary) {
      // gltf is a glb buffer
      return fsExtra.outputFile(gltfPath, gltf);
    }
    const jsonOptions = {
      spaces: 2,
    };
    return fsExtra.outputJson(gltfPath, gltf, jsonOptions);
  })
  .then(function () {
    console.timeEnd("Total");
  })
  .catch(function (error) {
    console.log(error.message);
    process.exitCode = 1;
  });