Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up

MaterialX / glTF Interoperability Tools

License

NotificationsYou must be signed in to change notification settings

kwokcb/materialxgltf

Repository files navigation

Contents

Introduction

This package supports the bi-directional translation between MaterialX materials and glTF materials. The minimum version of MaterialX required is 1.38.9 and the target glTF version is 2.0.1. The current package is synced with MaterialX release 1.39.

See thehome page for this project.

Below is an example of converting the "Sci Fi Helmet" asset (found in theglTF Sample Model repository) to MaterialX and previewing.

SciFiLeHelmet

The functionality found here is equivalent to the C++ module available inthis repository. Note that additional documentation can be found on that site.

Installation

The minimum version of Python is assumed to be 3.9 and has been tested up to 3.11.

The package hosted onPyPi can be installed usingpip:

pip install materialxgltf

or thesource repository can be cloned and the package built from the command line:

py -m build

This will build a distribution folder calleddist which contains a zip file which can be installed using:

pip --install<name of zip>

Requirements

Requires the installation of the following packages:

  • materialx version 1.39 or higher: For MaterialX support.
  • pygltflib : For conversion fromglTF toglb including packaging dependent geometry and image resources.

Documentation

Command Line Utilities

The package provides basic command line utilities for converting between glTF and MaterialX. These can be found by running the module:

python -m materialxgltf -h

which will result in the following output:

Usage: python -m materialxgltf<command> [options] wherecommand is mtlx2gltf or gltf2mtlx

Querying for help for each command will provide more detailed information:

glTF to MaterialX Conversion

python -m materialxgltf gltf2mtlx -h
usage: gltf2mtlx.py [-h] [--mtlxFileName MTLXFILENAME] [--createAssignments CREATEASSIGNMENTS] [--addAllInputs ADDALLINPUTS] gltfFileNameUtility to convert a glTF file to MaterialX filepositional arguments:  gltfFileName          Path containing glTF file to convert.options:  -h, --help            show thishelp message andexit  --mtlxFileName MTLXFILENAME                        Name of MaterialX output file. If not specified the glTF name with"_tomtlx.mtlx" suffix will be used  --createAssignments CREATEASSIGNMENTS                        Create material assignments. Default is True  --addAllInputs ADDALLINPUTS                        Add all definition inputs to MaterialX shader nodes. Default is False

MaterialX to glTF Conversion

python -m materialxgltf mtlx2gltf -h
usage: mtlx2gltf.py [-h] [--gltfFileName GLTFFILENAME] [--gltfGeomFileName GLTFGEOMFILENAME] [--primsPerMaterial PRIMSPERMATERIAL] [--packageBinary PACKAGEBINARY] [--translateShaders TRANSLATESHADERS] [--bakeTextures BAKETEXTURES][--bakeResolution BAKERESOLUTION] [--writeDefaultInputs WRITEDEFAULTINPUTS] mtlxFileNameUtility to convert a MaterialX file to a glTF filepositional arguments:  mtlxFileName          Path containing MaterialX file to convert.options:  -h, --help            show thishelp message andexit  --gltfFileName GLTFFILENAME                        Name of MaterialX output file. If not specified the glTF name with"_tomtlx.mtlx" suffix will be used  --gltfGeomFileName GLTFGEOMFILENAME                        Name of MaterialX output file. If not specified the glTF name with"_tomtlx.mtlx" suffix will be used  --primsPerMaterial PRIMSPERMATERIAL                        Create a new primitive per material and assign the material. Default is False  --packageBinary PACKAGEBINARY                        Create a biary packaged GLB file. Default is False  --translateShaders TRANSLATESHADERS                        Translate shaders to glTF. Default is False  --bakeTextures BAKETEXTURES                        Bake pattern graphs as textures. Default is False  --bakeResolution BAKERESOLUTION                        Bake image resolution. Default is 256  --writeDefaultInputs WRITEDEFAULTINPUTS                        Write default inputs on shader nodes. Default is False

For more detailed information about the workflow this package supports, please refer to thisdocumentation.

For API usage, refer tothis documentation.

Usage

<script type="module" src="https://unpkg.com/@google/model-viewer/dist/model-viewer.js"></script>

The following shows is a set of progressive examples to convert from a glTF file to MaterialX and then to a new glTF file for "shader ball" preview ofextracted materials.

Note that the sample data is included as part of the package for convenience.

The sample input file is the "BoomBox with Axes" file from the glTFhttps://github.com/KhronosGroup/glTF-Sample-Assets/tree/main/Models/sitory foundhere.

This is converted from glTF to a MaterialX document which can be previewed / modified using an integration which supports MaterialX. Here the file is loaded into the a graph editor

Graph Editor Snapshot

The converted materials are then used to create a new glTF file using sample "shaderball" data with each material found assigned to different instances of the "shaderball"

VSCode Snapshot

Interactive Example

AJupyter notebook which performs the same steps is availablehere.

This or any other notebook can be used if the user wishes to test the package in an interactive environment.

Import the package

importmaterialxgltf.coreascore

Check Available Sample Data

importpkg_resourcesdirectory_name="data"files=pkg_resources.resource_listdir('materialxgltf',directory_name)forfileinfiles:print('Data file: ',file)

Convert from glTF to MaterialX

importpkg_resourcesimportMaterialXasmxgltfFileName=pkg_resources.resource_filename('materialxgltf','data/BoomBoxWithAxes.gltf')print(gltfFileName)# Instantiate a the reader class. Read in sample  glTF file# and output a MaterialX documentgltf2MtlxReader=core.GLTF2MtlxReader()doc=gltf2MtlxReader.convert(gltfFileName)ifnotdoc:print('Existing due to error')else:status,err=doc.validate()ifnotstatus:print('Generated MaterialX document has validation errors: ',err)else:print('Generated MaterialX document is valid')# Write the document to a stringprint('Resulting MaterialX document:\n')result=core.Util.writeMaterialXDocString(doc)print(result)

Using glTF to MaterialX Options

# Set option to write material assignmentsoptions=core.GLTF2MtlxOptions()options['createAssignments']=Truegltf2MtlxReader.setOptions(options)doc=gltf2MtlxReader.convert(gltfFileName)ifnotdoc:print('Existing due to error')else:status,err=doc.validate()ifnotstatus:print('Generated MaterialX document has validation errors: ',err)else:print('Generated MaterialX document is valid')# Write the document to a stringprint('Resulting MaterialX document:\n')result=core.Util.writeMaterialXDocString(doc)print(result)

Conversion from MaterialX to glTF

materialXFileName=pkg_resources.resource_filename('materialxgltf','data/BoomBoxWithAxes.mtlx')print('> Load MaterialX document: %s'%materialXFileName)mtlx2glTFWriter=core.MTLX2GLTFWriter()doc,libFiles=core.Util.createMaterialXDoc()mx.readFromXmlFile(doc,materialXFileName,mx.FileSearchPath())options=core.MTLX2GLTFOptions()options['debugOutput']=Truemtlx2glTFWriter.setOptions(options)gltfString=mtlx2glTFWriter.convert(doc)iflen(gltfString)>0:print('> Resulting glTF:\n')print(gltfString)else:print('> Failed to convert MaterialX document to glTF')

Embedding Geometry

gltfGeometryFile=pkg_resources.resource_filename('materialxgltf','data/shaderBall.gltf')print('> Load glTF geometry file: %s'%gltfGeometryFile)options=core.MTLX2GLTFOptions()options['geometryFile']=gltfGeometryFileoptions['primsPerMaterial']=Falsemtlx2glTFWriter.setOptions(options)gltfString=mtlx2glTFWriter.convert(doc)iflen(gltfString)>0:print('> Resulting glTF:\n')print(gltfString)else:print('> Failed to convert MaterialX document to glTF')

Creating Primitives Per Material

gltfGeometryFile=pkg_resources.resource_filename('materialxgltf','data/shaderBall.gltf')print('> Load glTF geometry file: %s'%gltfGeometryFile)options=core.MTLX2GLTFOptions()options['geometryFile']=gltfGeometryFileoptions['primsPerMaterial']=Truemtlx2glTFWriter.setOptions(options)gltfString=mtlx2glTFWriter.convert(doc)iflen(gltfString)>0:print('> Resulting glTF:\n')print(gltfString)else:print('> Failed to convert MaterialX document to glTF')

Packaging A Binary File

gltfFileName=pkg_resources.resource_filename('materialxgltf','data/BoomBoxWithAxes_primMaterials.gltf')print('> Load glTF geometry file: %s'%gltfGeometryFile)binaryFileName=str()binaryFileName=gltfFileName .replace('.gltf','.glb')print('Packaging GLB...')try:saved,images,buffers=mtlx2glTFWriter.packageGLTF(gltfFileName ,binaryFileName)print('Save GLB file:'+binaryFileName+'. Status:'+str(saved))forimageinimages:print('- Embedded image: %s'%image)forbufferinbuffers:print('  - Embedded buffer: %s'%buffer)print('Packaging GLB...Done')exceptExceptionaserr:print('Failed to package GLB file: %s'%err)

Translate Shader and Bake Textures

All materials are assumed to use glTF PBR surface shaders.Conversion to this shading model can be performed via MaterialXutilities, which includes texture baking.

Please refer to thesample Jupyter notebook for an example of shadertranslation and baking using some convenience functions included with the package.Note that they do not need to be used as the core MaterialX distribution providesaccess to the APIs used in this package.

Build

There are a number of build scripts in theutiltities folder provided for convenienceif users wish to build the repository locally.

Authors

[8]ページ先頭
©2009-2025 Movatter.jp