Triangle Mesh IO
Supports .obj object wavefront, .off object file format, and .stl stereo litographie (both binary and ascii). This pyhton package serializes meshes of triangles from a python dict into a string (dumps()) or deserializes meshes of triangles from a string (loads()) into a pyhton-dict.
Installation
pip install triangle_mesh_io
Functions
For each file-format, triangle_mesh_io provides five basic functions:
m = loads(s) Loads the meshes/triangles from a string into a python dict.
s = dumps(m) Dumps the meshes/triangles from a python dict into a string.
l = diff(m1, m2) Lists differences l between two meshes m1, and m2.
m = init() Initializes an empty python dict to hold the meshes/triangles.
m = minimal() Initializes a cube (1,1,1) as a minimal example of a populated dict.
Example
import triangle_mesh_io as tmi
m = tmi.obj.minimal()
print(m)
{'v': [[1.0, 0.0, 0.0],
[1.0, 1.0, 0.0],
[0.0, 1.0, 0.0],
[0.0, 0.0, 0.0],
[1.0, 0.0, 1.0],
[1.0, 1.0, 1.0],
[0.0, 1.0, 1.0],
[0.0, 0.0, 1.0]],
'vn': [[1.0, 0.0, 0.0],
[0.0, 1.0, 0.0],
[0.0, 0.0, 1.0],
[-1.0, 0.0, 0.0],
[0.0, -1.0, 0.0],
[0.0, 0.0, -1.0]],
'mtl': {'pos-x': [{'v': [0, 1, 5], 'vn': [0, 0, 0]},
{'v': [5, 4, 0], 'vn': [0, 0, 0]}],
'pos-y': [{'v': [1, 2, 5], 'vn': [1, 1, 1]},
{'v': [5, 2, 6], 'vn': [1, 1, 1]}],
'pos-z': [{'v': [4, 5, 6], 'vn': [2, 2, 2]},
{'v': [6, 7, 4], 'vn': [2, 2, 2]}],
'neg-x': [{'v': [2, 6, 3], 'vn': [3, 3, 3]},
{'v': [6, 7, 3], 'vn': [3, 3, 3]}],
'neg-y': [{'v': [0, 3, 7], 'vn': [4, 4, 4]},
{'v': [7, 4, 0], 'vn': [4, 4, 4]}],
'neg-z': [{'v': [0, 1, 2], 'vn': [5, 5, 5]},
{'v': [2, 3, 0], 'vn': [5, 5, 5]}]}}
s = tmi.obj.dumps(m)
print(s)
# vertices
v 1.000000 0.000000 0.000000
v 1.000000 1.000000 0.000000
v 0.000000 1.000000 0.000000
v 0.000000 0.000000 0.000000
v 1.000000 0.000000 1.000000
v 1.000000 1.000000 1.000000
v 0.000000 1.000000 1.000000
v 0.000000 0.000000 1.000000
# vertex-normals
vn 1.000000 0.000000 0.000000
vn 0.000000 1.000000 0.000000
vn 0.000000 0.000000 1.000000
vn -1.000000 0.000000 0.000000
vn 0.000000 -1.000000 0.000000
vn 0.000000 0.000000 -1.000000
# faces
usemtl pos-x
f 1//1 2//1 6//1
f 6//1 5//1 1//1
usemtl pos-y
f 2//2 3//2 6//2
f 6//2 3//2 7//2
usemtl pos-z
f 5//3 6//3 7//3
f 7//3 8//3 5//3
usemtl neg-x
f 3//4 7//4 4//4
f 7//4 8//4 4//4
usemtl neg-y
f 1//5 4//5 8//5
f 8//5 5//5 1//5
usemtl neg-z
f 1//6 2//6 3//6
f 3//6 4//6 1//6
m_back = tmi.obj.loads(s)
assert len(tmi.obj.diff(m, m_back)) == 0
Formats
triangle_mesh_io has only limited features to convert between mesh formats. The formats are very different and the amount of information is roughly: obj >> off >> stl. Thus the python dicts for the individual formats are not the same. Each dict-format follows its corresponding file format.
.obj |
.off |
.stl |
|
|---|---|---|---|
can subdivide a mesh |
Yes (usemtl) |
No |
No |
can have surface-normals |
Yes (vn) |
No |
Depends |
can define a mesh |
Yes |
Yes |
No |
Defining a mesh is about defining relations between triangles (a.k.a. faces). Unfortunately stl is just a list of coordinates of triangles. Thus in stl, possible neighboring-relations between triangles must be discoverd in an additional search based on the triangles positions.
While stl has a surface-normal in its format, it is unfortunately effectively only ever used as a kind of checksum for the triangle which it is related to. Most programs will not accept surface-normals which differ from the computed normal of the corresponding triangel.
In general: When surface-normals are important to you, because you e.g. simulate optical surfaces such as lenses: Use obj. When you want to define meshes of triangles which can reference more than one surface (which can subdivide a mesh): Use obj. In all other cases you can already reduce down to off and stick to off as long as you are forced to reduce further down to stl in a final export of your work-flow.
Metadata
Release files for triangle-mesh-io 0.1.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| triangle_mesh_io-0.1.3.tar.gz | 550.3 kB | Without provenance | Details for triangle_mesh_io-0.1.3.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| triangle_mesh_io-0.1.3-py3-none-any.whl | Python 3 | none | any | Details for triangle_mesh_io-0.1.3-py3-none-any.whl |
Total release size: 1.1 MB
Release files / triangle_mesh_io-0.1.3.tar.gz
| Download URL | triangle_mesh_io-0.1.3.tar.gz |
|---|---|
| Size | 550.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4e0e89d8626641ec71a7d814e85ab7cd49082e93176bc57b09febebba6cd724d
|
|
BLAKE2b-256 checksum How to use checksums |
505b450f4b01414311952be4a83cc658552593be9021b0475b3fe76ceaf1ddea
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.5
|
Release files / triangle_mesh_io-0.1.3-py3-none-any.whl
| Download URL | triangle_mesh_io-0.1.3-py3-none-any.whl |
|---|---|
| Size | 556.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
875c237d725efb327ccc9f45da2f0ab1b7a6e48fb974b420357f2d2ebb1deed2
|
|
BLAKE2b-256 checksum How to use checksums |
5f3f418c3f917830b55fd77f36a3b6422e02db11acf23813f2e23200ec9018ee
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.5
|
Security for triangle-mesh-io 0.1.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.