PyWavefront 0.3.1

Python/pyglet library for importing Wavefront .obj files

[](https://circleci.com/gh/greenmoss/PyWavefront)

PyWavefront
===========

PyWavefront reads Wavefront 3D object files (`something.obj` and `something.mtl`)
and generates interleaved vertex data for each material ready for rendering.
Python 2.7.x or 3.6+ is supported. A simple (optional) visualization module is also
provided for rendering the object(s). The interleaved data can also be used by
more modern renderers thought VBOs or VAOs.

Currently the most commonly used features in [the defined specification](https://en.wikipedia.org/wiki/Wavefront_.obj_file) has
been implemented. Positions, texture coordinates, normals, vertex color and material parsing.
We currently don't support parameter space vertices, line elements or smoothing groups.
Create an issue or pull request on github if needed features are missing.

The package is on pypi or can be cloned on [github](https://github.com/greenmoss/PyWavefront).

```
pip install PyWavefront
```

## Usage

Basic example loading and obj file:

```python
import pywavefront
scene = pywavefront.Wavefront('something.obj')
```

A more complex example

* `strict` will raise an exception if unsupported features are found in the obj or mtl file. Default `True`.
* `encoding` of the obj and mtl file(s). Default `utf-8`.
* `parse` decides if parsing should start immediately. Default 'False'.

```python
import pywavefront
scene = pywavefront.Wavefront('something.obj', strict=True, encoding="iso-8859-1", parse=False)
scene.parse() # Explicit call to parse() needed when parse=False

# All vertex data if merged
for name, material in data.materials.items():
# Contains the vertex format (string) such as "T2F_N3F_V3F"
# T2F, C3F, N3F and V3F may appear in this string
material.vertex_format
# Contains the vertex list of floats in the format described above
material.vertices
# Material properties
material.diffuse
material.ambient
material.texture
# ..
```

## Visualization

[Pyglet](http://www.pyglet.org/) is required to use the visualization module.
```
pip install pyglet
```

Example:

```python
import pywavefront
from pywavefront import visualization

[create a window and set up your OpenGl context]
obj = pywavefront.Wavefront('something.obj')

[inside your drawing loop]
visualization.draw(obj)
```

### Example Scripts

The `example` directory contains some basic examples using the `visualization` module

* `pyglet_demo.py` : Simple textured globe
* `pyglet_demo2.py` : Higher resolution textured globe
* `pyglet_demo_boxes.py` : Boxes demonstrating supported vertex formats

### Generating a Wavefront file with Blender

The following presumes you are using [Blender](http://www.blender.org/) to generate your mesh:

* Using Blender, create a mesh with a UV-mapped texture. The UV-mapping is important! If it is working properly, you will see the texture applied within Blender's 3d view.
* Export the mesh from Blender using the Wavefront format, including normals.
* Reference your `*.obj` file as in the pywavefront example above.

## Tests

All tests can be found in the `test` directory. To run the tests:

* Install nose: `pip install nose`
* Change to the top-level directory, e.g. `PyWavefront`, the directory that contains this `README` file.
* Run `nosetests`

## Community

Slack: [channel](https://pywavefront.slack.com/). [Email the admins](mailto:[e-mail]?subject=Please%20send%20me%20an%20invitation%20to%20the%20PyWavefront%20Slack%20channel&body=Thanks!)
to request an invitation. Ensure you leave the subject line intact!

## Contributors

* Daniel Coelho
* dav92lee
* Einar Forselv
* Jerek Shoemaker
* Kurt Yoder
* Marxlp
* Patrik Huber
* Sérgio Agostinho
* Zohar Jackson

License
-------

PyWavefront is BSD-licensed; see file `LICENSE`.