pygltflib
Python library for reading, writing and handling GLTF files. Python3.6+
Requirements
- Python 3.6+
- dataclasses
- dataclasses-json
- pytest (optional)
It requires python 3.6 and above because it uses dataclasses and all attributes are type hinted.
About
This is an unofficial library that tracks the official file format for GLTF2.
The library was initially built to load and save simple meshes but support for the entire spec, including materials and animations is pretty good. Supports both json (.gltf) and binary (.glb) file formats, although .glb support is missing some features at the moment.
Check the table below for an idea of which sample models validate.
Questions? Contributions? Bug reports? Open an issue on the gitlab page for the project.
We are very interested in hearing your use cases for pygltflib to help drive the roadmap.
Roadmap:
- Add helper functions for creating meshes
- Full support for binary GLTF (.glb) files
- Reject file overwrites unless overwrite flag set
- Give options on storing binary buffers (embedded vs external)
Contributors:
- Luke Miller
- Sebastian Höffner
- Arthur van Hoff
Changelog:
- 1.5
- align embedded data correctly
- add
def glb2gltfanddef gltf2glbutil functions topygltflib.utilsfor easy file conversion
- 1.4
- basic support for saving to binary GLTF (.glb) files
- moved undocumented non-core methods to
pygltfib.utils
- 1.3
- basic support for reading binary GLTF (.glb) files
- 1.2
- better json support
- remove numpy requirement
- suppress infer warning
- basic default methods
- 1.0
- initial release
Install
PIP
Method 1
pip install pygltflib
Method 2
python -m pip install pygltflib
Method 3
py -3 -m pip install pygltflib
Source
git clone https://gitlab.com/dodgyville/pygltflib
Usage
Note: These examples use the official sample models provided by Khronos at:
https://github.com/KhronosGroup/glTF-Sample-Models
Creating
>>> from pygltflib import GLTF2, Scene
>>> gltf = GLTF2()
>>> gltf.scene # no scene set by default
>>> len(gltf.scenes)
0
>>> scene = Scene()
>>> gltf.scenes.append(scene)
>>> len(gltf.scenes)
1
Loading and saving
pygltflib can load json-based .GLTF files and binary .GLB files, based on the file extension.
GLTF files
>>> from pygltflib import GLTF2
>>> filename = "glTF-Sample-Models/2.0/AnimatedCube/glTF/AnimatedCube.gltf"
>>> gltf = GLTF2().load(filename)
>>> gltf.scene
0
>>> gltf.scenes
[Scene(name='', nodes=[0])]
>>> gltf.nodes[0]
Node(mesh=0, skin=None, rotation=[0.0, -1.0, 0.0, 0.0], translation=[], scale=[], children=[], matrix=[], camera=None, name='AnimatedCube')
>>> gltf.nodes[0].name
'AnimatedCube'
>>> gltf.meshes[0].primitives[0].attributes
Attributes(NORMAL=4, POSITION=None, TANGENT=5, TEXCOORD_0=6)
>>> filename2 = "test.gltf"
>>> gltf.save(filename2)
GLB files
>>> from pygltflib import GLTF2
>>> glb_filename = "glTF-Sample-Models/2.0/Box/glTF-Binary/Box.glb"
>>> glb = GLTF2().load(glb_filename)
>>> glb.scene
0
>>> glb.scenes
[Scene(name='', nodes=[0])]
>>> glb.nodes[0]
Node(mesh=None, skin=None, rotation=[], translation=[], scale=[], children=[1], matrix=[1.0, 0.0, 0.0, 0.0, 0.0, 0.0, -1.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 0.0, 0.0, 1.0], camera=None, name=None)
>>> glb.meshes[0].primitives[0].attributes
Attributes(POSITION=2, NORMAL=1, TANGENT=None, TEXCOORD_0=None, TEXCOORD_1=None, COLOR_0=None, JOINTS_0=None, WEIGHTS_0=None)
>>> glb.save("test.glb")
Converting files
First method
>>> from pygltflib import GLTF2
>>> # convert glb to gltf
>>> glb = GLTF2().load("glTF-Sample-Models/2.0/Box/glTF-Binary/Box.glb")
>>> glb.save("test.gltf")
>>> # convert gltf to glb
>>> gltf = GLTF2().load("glTF-Sample-Models/2.0/Box/glTF/Box.gltf")
>>> gltf.save("test.glb")
Second method using utils
>>> from pygltflib.utils import glb2gltf, gltf2glb
>>> # convert glb to gltf
>>> glb2gltf("glTF-Sample-Models/2.0/Box/glTF-Binary/Box.glb")
>>> # convert gltf to glb
>>> gltf2glb("glTF-Sample-Models/2.0/Box/glTF/Box.gltf", "test.glb", override=True)
Running the tests
Status of gltf-validator
Using sample models loaded and then saved using this library, here are validator reports (blank is untested).
Validator Status
| Model | gltf2gltf Validator |
|---|---|
| 2CylinderEngine | passes |
| AlphaBlendModeTest | passes |
| AnimatedCube | passes |
| AnimatedMorphCube | passes |
| AnimatedMorphSphere | passes |
| AnimatedTriangle | passes |
| Avocado | passes |
| BarramundiFish | passes |
| BoomBox | passes |
| BoomBoxWithAxes | passes |
| Box | passes |
| BoxAnimated | passes |
| BoxInterleaved | passes |
| BoxTextured | passes |
| BoxTexturedNonPowerOfTwo | passes |
| BoxVertexColors | passes |
| BrainStem | passes |
| Buggy | passes |
| Cameras | passes |
| CesiumMan | passes |
| CesiumMilkTruck | passes |
| Corset | passes |
| Cube | passes |
| DamagedHelmet | passes |
| Duck | passes |
| FlightHelmet | passes |
| GearboxAssy | passes |
| Lantern | passes |
| MetalRoughSpheres | passes |
| Monster | passes |
| MultiUVTest | passes |
| NormalTangentMirrorTest | passes |
| NormalTangentTest | passes |
| OrientationTest | passes |
| ReciprocatingSaw | passes |
| RiggedFigure | passes |
| RiggedSimple | passes |
| SciFiHelmet | passes |
| SimpleMeshes | passes |
| SimpleMorph | passes |
| SimpleSparseAccessor | passes |
| SpecGlossVsMetalRough | passes |
| Sponza | passes |
| Suzanne | passes |
| TextureCoordinateTest | passes |
| TextureSettingsTest | passes |
| TextureTransformTest | passes |
| Triangle | passes |
| TriangleWithoutIndices | passes |
| TwoSidedPlane | passes |
| VC | passes |
| VertexColorTest | passes |
| WaterBottle | passes |
unittests
pytest tests.py
1 maintainer
Release files for pygltflib 1.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| pygltflib-1.5.tar.gz | 10.3 kB | Details |
Release files / pygltflib-1.5.tar.gz
| Download URL | pygltflib-1.5.tar.gz |
|---|---|
| Size | 10.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8fd3327eac2f1e2d958b3bad1eb07025083120fd90e5fde60ebec70aa498535c
|
|
BLAKE2b-256 checksum How to use checksums |
957f6d2e8e857e53512283ff0f7dfaa4c3c5e0d9b25b32bafdc0ccf10f7110f7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.7
|
