diff --git a/port/PyAssimp/README b/port/PyAssimp/README deleted file mode 100644 index 1d4a71487..000000000 --- a/port/PyAssimp/README +++ /dev/null @@ -1,66 +0,0 @@ - PyAssimp Readme - --------------- - - --- a simple Python wrapper for Assimp using ctypes to access -the library. Tested for Python 2.6. Known not to work with -Python 2.4. - - -Note that pyassimp is by no means considered mature. It works, -but it is far away from wrapping Assimp perfectly. - - -USAGE -===== - -To get started with pyAssimp, examine the sample.py script, 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 -substituted by assertions ...): - -> from pyassimp import pyassimp, errors -> -> try: -> scene = pyassimp.load('hello.3ds') -> except AssimpError, msg: -> print(msg) -> return - -> assert len(scene.meshes) -> mesh = scene.meshes[0] - -> assert len(mesh.vertices) -> print(mesh.vertices[0]) - -> # don't forget this one, or you will leak! -> pyassimp.release(scene) - - -INSTALL -======= - -PyAssimp requires a assimp dynamic library (DLL on windows, -so on linux :-) in order to work. The default search directories -are: - -- the current directory -- on linux additionally: /usr/local/lib - -To build that library, refer to the Assimp master INSTALL -instructions. To look in more places, edit ./pyassimp/helper.py. -There's an 'additional_dirs' list waiting for your entries. - - - - - - - diff --git a/port/PyAssimp/README.md b/port/PyAssimp/README.md new file mode 100644 index 000000000..84893c881 --- /dev/null +++ b/port/PyAssimp/README.md @@ -0,0 +1,74 @@ +PyAssimp Readme +=============== + +-- a simple Python wrapper for Assimp using ctypes to access +the library. Tested for Python 2.6. Known not to work with +Python 2.4. + + +Note that pyassimp is not complete. Many ASSIMP features are missing. In +particular, only loading of models is currently supported (no export). + +USAGE +----- + +To get started with pyAssimp, examine the 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 +substituted by assertions ...): + +```python + +import pyassimp +scene = pyassimp.load('hello.3ds') + +assert len(scene.meshes) +mesh = scene.meshes[0] + +assert len(mesh.vertices) +print(mesh.vertices[0]) + +# don't forget this one, or you will leak! +pyassimp.release(scene) + +``` + +Another example to list the 'top nodes' in a +scene: + +```python + +import pyassimp +scene = pyassimp.load('hello.3ds') + +for c in scene.rootnode.children: + print(str(c)) + +pyassimp.release(scene) + +``` + +INSTALL +------- + +Install pyassimp by running: + +> python setup.py install + +PyAssimp requires a assimp dynamic library (DLL on windows, +so on linux :-) in order to work. The default search directories +are: + +- the current directory +- on linux additionally: /usr/lib and /usr/local/lib + +To build that library, refer to the Assimp master INSTALL +instructions. To look in more places, edit ./pyassimp/helper.py. +There's an 'additional_dirs' list waiting for your entries. +