Merge pull request #1116 from severin-lemaignan/master

[pyassimp] Add missing library + updated doc
pull/1123/head
Kim Kulling 2016-12-20 17:55:20 +01:00 committed by GitHub
commit c81eb3fe23
3 changed files with 1737 additions and 11 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 50 KiB

View File

@ -11,14 +11,32 @@ Note that pyassimp is not complete. Many ASSIMP features are missing.
USAGE USAGE
----- -----
To get started with pyAssimp, examine the `sample.py` script in `scripts/`, ### Complete example: 3D viewer
which illustrates the basic usage. All Assimp data structures are wrapped using
ctypes. All the data+length fields in Assimp's data structures (such as
`aiMesh::mNumVertices`, `aiMesh::mVertices`) are replaced by simple python
lists, so you can call len() on them to get their respective size and access
members using [].
For example, to load a file named 'hello.3ds' and print the first `pyassimp` comes with a simple 3D viewer that shows how to load and display a 3D
model using a shader-based OpenGL pipeline.
![Screenshot](3d_viewer_screenshot.png)
To use it, from within `/port/PyAssimp`:
```
$ cd scripts
$ python ./3D-viewer <path to your model>
```
You can use this code as starting point in your applications.
### Writing your own code
To get started with `pyassimp`, examine the simpler `sample.py` script in `scripts/`,
which illustrates the basic usage. All Assimp data structures are wrapped using
`ctypes`. All the data+length fields in Assimp's data structures (such as
`aiMesh::mNumVertices`, `aiMesh::mVertices`) are replaced by simple python
lists, so you can call `len()` on them to get their respective size and access
members using `[]`.
For example, to load a file named `hello.3ds` and print the first
vertex of the first mesh, you would do (proper error handling vertex of the first mesh, you would do (proper error handling
substituted by assertions ...): substituted by assertions ...):
@ -58,16 +76,19 @@ INSTALL
Install `pyassimp` by running: Install `pyassimp` by running:
> python setup.py install ```
$ python setup.py install
```
PyAssimp requires a assimp dynamic library (`DLL` on windows, PyAssimp requires a assimp dynamic library (`DLL` on windows,
`.so` on linux :-) in order to work. The default search directories `.so` on linux, `.dynlib` on macOS) in order to work. The default search directories
are: are:
- the current directory - the current directory
- on linux additionally: `/usr/lib` and `/usr/local/lib` - on linux additionally: `/usr/lib`, `/usr/local/lib`,
`/usr/lib/x86_64-linux-gnu`
To build that library, refer to the Assimp master INSTALL To build that library, refer to the Assimp master `INSTALL`
instructions. To look in more places, edit `./pyassimp/helper.py`. instructions. To look in more places, edit `./pyassimp/helper.py`.
There's an `additional_dirs` list waiting for your entries. There's an `additional_dirs` list waiting for your entries.

File diff suppressed because it is too large Load Diff