pyemblite 0.2.9

Python wrapper for Embree-3.

Python wrapper for Embree-3 and Embree-4. Source code adapted from pyembree Embree-2 wrapper.

Quick Start

Example:

import numpy as np
import trimesh
from trimesh.primitives import Sphere
from pyemblite.mesh_construction import TriangleMesh
from pyemblite.rtcore_scene import EmbreeScene

# Create Embree scene which holds meshes.
scene = EmbreeScene()

# Create a mesh using trimesh (https://github.com/mikedh/trimesh).
tmesh = Sphere(radius=5.0, subdivisions=1)

# Create Embree triangle mesh geometry
emesh = TriangleMesh(scene, tmesh.vertices, tmesh.faces)

# Commit the scene (builds spatial acceleration structures).
scene.commit()

# Generate ray origins and ray directions
ray_orgs = (
    np.zeros((tmesh.vertices.shape[0], 3), dtype=np.float32)
    +
    tmesh.centroid
).astype(np.float32)
ray_dirs = (tmesh.vertices - tmesh.centroid).astype(np.float32)
ray_dirs /= np.linalg.norm(ray_dirs, axis=1)[np.newaxis, 1]

# Query the index of the first face which gets hit by ray
# (index of -1 indicates ray did not hit a face)
primID = scene.run(ray_orgs, ray_dirs, query='INTERSECT')

# Query the distance from the ray origin where face which gets hit by ray
# Intersection points are ray_orgs + tfar * ray_dirs
tfar = scene.run(ray_orgs, ray_dirs, query='DISTANCE')
print(tfar)

# Query all info, intersect_info is a dict with keys:
# ['u', 'v', 'Ng', 'tfar', 'primID', 'geomID']
intersect_info = scene.run(ray_orgs, ray_dirs, output=True)

Runtime Selection of Embree-3 or Embree-4

Use the PYEMBLITE_EMBREE_MAJOR_VERSION environment variable to control the runtime version Embree API (when both versions are available):

$ PYEMBLITE_EMBREE_MAJOR_VERSION=3 python -c 'from pyemblite import rtcore as rtc; print(rtc.EmbreeDevice())'
$ PYEMBLITE_EMBREE_MAJOR_VERSION=4 python -c 'from pyemblite import rtcore as rtc; print(rtc.EmbreeDevice())'

Installation

Install from pypi:

$ python -m pip install pyemblite

Install from latest github source:

$ python -m pip install --user setuptools cython wheel numpy 'versioneer[toml]'
$ python -m pip install --no-deps --no-build-isolation --user git+https://github.com/AppliedMathematicsANU/pyemblite.git#egg=pyemblite

or from source directory:

$ python -m pip install --user setuptools cython wheel numpy 'versioneer[toml]'
$ git clone [e-mail]:AppliedMathematicsANU/pyemblite.git
$ cd pyemblite
$ python -m pip install --no-deps --no-build-isolation --user .

If you’re on windows, you can use vcpkg to manage non-python dependencies (can also be used on Linux and MacOS):

PS > git clone https://github.com/microsoft/vcpkg
PS > .\vcpkg\bootstrap-vcpkg.bat
PS > $Env:VCPKG_ROOT=$(Resolve-Path ./vcpkg)
PS > git clone [e-mail]/AppliedMathematicsANU/pyemblite.git
PS > cd pyemblite
PS > python -m pip install --prefix=\path\to\install\root .

You also still need to have build tools installed (some kind of C/C++ compiler). One way to achieve this is to install Visual Studio Build tools. Visual studio build tools likely require the installation of visual studio community edition first. This link should (hopefully) get you started:

https://visualstudio.microsoft.com/downloads/

Requirements

Requires:

• python-3 version >= 3.4,

• numpy version >= 1.7,

• embree >= 3.0 < 5.0 (Latest release)

Testing

Run tests (unit-tests and doctest module docstring tests) using:

$ python -m pyemblite.test

or with fail-fast and verbosity:

$ python -m pyemblite.test -fv

Latest source code

Source at github:

https://github.com/AppliedMathematicsANU/pyemblite

License information

See the file LICENSE.txt for terms & conditions, for usage and a DISCLAIMER OF ALL WARRANTIES.