Metadata-Version: 1.1
Name: trimesh
Version: 2.5.10
Summary: Import, export, process, analyze and view triangular meshes.
Home-page: http://github.com/mikedh/trimesh
Author: Mike Dawson-Haggerty
Author-email: mik3dh@gmail.com
License: MIT
Description: trimesh
        =======
        
        |Build Status| |Build status|
        
        Python (2.7-3\*) library for loading and using triangular meshes. The
        goal of the library is to provide a fully featured Trimesh object which
        allows for easy manipulation and analysis, in the style of the excellent
        Polygon object in the `Shapely
        library <http://toblerity.org/shapely/manual.html>`__.
        
        The API is mostly stable, but this should not be relied on and is not
        guaranteed; install a specific version if you plan on deploying
        something using trimesh as a backend.
        
        Installation
        ------------
        
        Once you have a python distribution and the system packages from the
        pre-install, the **recommended** way to install with most functionality
        is:
        
        .. code:: bash
        
            pip install trimesh[all]
        
        Or, for only **minimal dependencies** (no ray queries, boolean
        operations, vector path handling, mesh creation, viewer, etc):
        
        .. code:: bash
        
            pip install trimesh
        
        The minimum set of packages required to import ``trimesh`` are
        `numpy <http://www.numpy.org/>`__, `scipy <http://www.scipy.org/>`__ and
        `networkx <https://networkx.github.io/>`__.
        
        Ubuntu Pre-install
        ''''''''''''''''''
        
        Blender and openSCAD are backends used for boolean operations,
        libspatialindex and libgeos are the libraries used by RTree and Shapely
        respectivly, and cmake is included to build assimp if you want the
        latest version.
        
        .. code:: bash
        
            sudo apt-get install cmake openscad blender libspatialindex-dev libgeos-dev
        
        Windows Pre-Install:
        ''''''''''''''''''''
        
        The easiest way to get going on Windows is to install the `Anaconda
        Python distribution <https://www.continuum.io/downloads>`__, followed by
        ``shapely``, ``rtree``, and ``meshpy`` from the `Unofficial Windows
        Binaries from Christoph
        Gohlke <http://www.lfd.uci.edu/~gohlke/pythonlibs/>`__
        
        Optional Dependencies
        '''''''''''''''''''''
        
        To install the latest assimp for `additional import
        formats <http://www.assimp.org/main_features_formats.html>`__
        (python-pyassimp in Ubuntu 14.04 is very old):
        
        .. code:: bash
        
            sudo pip install git+https://github.com/robotics/assimp_latest.git
        
        If you are using a lot of graph operations (specifically mesh.split)
        trimesh will automatically use
        `graph-tool <https://graph-tool.skewed.de/download>`__ if it is
        installed, for a roughly 10x speedup over networkx on certain
        operations.
        
        Features
        --------
        
        -  Import binary/ASCII STL, Wavefront OBJ, ASCII OFF, and binary PLY
        -  Import additional mesh formats using assimp (if pyassimp installed)
        -  Import STEP files as meshes (if STEPtools Inc. Author Tools
           installed)
        -  Import and export 2D or 3D vector paths from/to DXF or SVG files
        -  Export meshes as binary STL, binary PLY, ASCII OFF, COLLADA,
           dictionaries, JSON- serializable dictionaries (base64 encoded
           arrays), MSGPACK- serializable dictionaries (binary string arrays)
        -  Preview meshes (requires pyglet)
        -  Internal caching of computed values which are cleared when vertices
           or faces are changed (validated with a zlib.adler32 CRC)
        -  Fast loading of binary files through importers written by defining
           custom numpy dtypes (on a 234,230 face mesh, 24.5x faster than
           assimp)
        -  Calculate face adjacencies quickly (for the same 234,230 face mesh
           .248 s)
        -  Calculate cross sections (.146 s)
        -  Split mesh based on face connectivity using networkx (4.96 s) or
           graph-tool (.584 s)
        -  Calculate mass properties, including volume, center of mass, and
           moment of inertia (.246 s)
        -  Find planar facets, or coplanar groups of faces (.454 s)
        -  Fix triangle winding to be consistent
        -  Fix normals to be oriented 'outwards' using ray tests
        -  Find convex hulls of meshes
        -  Compute a rotation/translation/tessellation invariant identifier for
           meshes (from an FFT of the radius distribution)
        -  Merge duplicate meshes from identifier
        -  Determine if a mesh is watertight
        -  Repair single triangle and single quad holes
        -  Uniformly sample the surface of a mesh
        -  Ray-mesh queries
        -  Boolean operations on meshes (intersection, union, difference) using
           OpenSCAD or Blender as backend
        -  Voxelize watertight meshes
        -  Unit conversions
        -  Subdivide faces of a mesh
        -  Rapid computation of minimum volume oriented bounding box for a mesh
        -  Minimum volume bounding sphere / n-spheres
        -  Symbolic integration of function(x,y,z) over a triangle
        -  Very quick (sympy-numpy lambda) evaluation of symbolic integral
           result over a mesh
        -  Calculate nearest point on mesh surface and signed distance
        -  Determine if a point lies inside or outside of a mesh using signed
           distance
        -  Create meshes with primitive objects (Extrude, Box, Sphere) which are
           subclasses of Trimesh
        -  Simple scene graph and transform tree which can be rendered (pyglet)
           or exported.
        -  Numerous utility functions, such as transforming points, unitizing
           vectors, tracking arrays for changes, grouping rows, etc.
        
        Quick Start
        -----------
        
        Here is an example of loading a mesh from file and colorizing its faces.
        Here is a nicely formatted `ipython notebook
        version <http://github.com/mikedh/trimesh/blob/master/examples/quick_start.ipynb>`__
        of this example. Also check out the `cross section
        example <https://github.com/mikedh/trimesh/blob/master/examples/section.ipynb>`__
        or possibly the `integration of a function over a mesh
        example <https://github.com/mikedh/trimesh/blob/master/examples/integrate.ipynb>`__.
        
        .. code:: python
        
            import numpy as np
            import trimesh
        
            # load a file by name or from a buffer
            mesh = trimesh.load_mesh('../models/featuretype.STL')
        
            # is the current mesh watertight?
            mesh.is_watertight
        
            # what's the euler number for the mesh?
            mesh.euler_number
        
            # the convex hull is another Trimesh object that is available as a property
            # lets compare the volume of our mesh with the volume of its convex hull
            np.divide(mesh.volume, mesh.convex_hull.volume)
        
            # since the mesh is watertight, it means there is a
            # volumetric center of mass which we can set as the origin for our mesh
            mesh.vertices -= mesh.center_mass
        
            # what's the moment of inertia for the mesh?
            mesh.moment_inertia
        
            # if there are multiple bodies in the mesh we can split the mesh by
            # connected components of face adjacency
            # since this example mesh is a single watertight body we get a list of one mesh
            mesh.split()
        
            # find groups of coplanar adjacent faces
            facets, facets_area = mesh.facets(return_area=True)
        
            # set each facet to a random color
            # colors are 8 bit RGBA by default (n,4) np.uint8
            for facet in facets:
                mesh.visual.face_colors[facet] = trimesh.visual.random_color()
        
            # preview mesh in an opengl window if you installed pyglet with pip
            mesh.show()
        
            # transform method can be passed a (4,4) matrix and will cleanly apply the transform
            mesh.apply_transform(trimesh.transformations.random_rotation_matrix())
        
            # axis aligned bounding box is available
            mesh.bounding_box.extents
        
            # a minimum volume oriented bounding box also available
            # primitives are subclasses of Trimesh objects which automatically generate
            # faces and vertices from data stored in the 'primitive' attribute
            mesh.bounding_box_oriented.primitive.extents
            mesh.bounding_box_oriented.primitive.transform
        
            # show the mesh appended with its oriented bounding box
            # the bounding box is a trimesh.primitives.Box object, which subclasses
            # Trimesh and lazily evaluates to fill in vertices and faces when requested
            # (press w in viewer to see triangles)
            (mesh + mesh.bounding_box_oriented).show()
        
            # bounding spheres and bounding cylinders of meshes are also
            # available, and will be the minimum volume version of each
            # except in certain degenerate cases, where they will be no worse
            # than a least squares fit version of the primitive.
            print(mesh.bounding_box_oriented.volume, 
                  mesh.bounding_cylinder.volume,
                  mesh.bounding_sphere.volume)
        
        Optional Viewer
        ---------------
        
        Trimesh includes an optional pyglet- based viewer for
        debugging/inspecting. In the mesh view window:
        
        -  dragging rotates the view
        -  ctl + drag pans
        -  mouse wheel zooms
        -  'z' returns to the base view
        -  'w' toggles wireframe mode
        -  'c' toggles backface culling
        
        Containers
        ----------
        
        If you want to deploy something in a container that uses trimesh,
        automated builds containing trimesh and its dependancies are available
        on docker hub. For an Ubuntu 16.04 based image:
        
        ``docker pull mikedh/trimesh``
        
        Or, for a smaller Debian Jessie based image with no boolean operations
        and slightly slower graph operations (as graph-tool requires X as of
        this writing):
        
        ``docker pull mikedh/trimesh_minimal``
        
        .. |Build Status| image:: https://travis-ci.org/mikedh/trimesh.svg?branch=master
           :target: https://travis-ci.org/mikedh/trimesh
        .. |Build status| image:: https://ci.appveyor.com/api/projects/status/j8h3luwvst1tkghl?svg=true
           :target: https://ci.appveyor.com/project/mikedh/trimesh
        
Keywords: graphics mesh geometry
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX :: Linux
Classifier: Topic :: Scientific/Engineering
