vispy 0.15.0__cp312-cp312-macosx_10_13_x86_64.whl

vispy/visuals/mesh.py

@@ -0,0 +1,373 @@
+# -*- coding: utf-8 -*-
+# -----------------------------------------------------------------------------
+# Copyright (c) Vispy Development Team. All Rights Reserved.
+# Distributed under the (new) BSD License. See LICENSE.txt for more info.
+# -----------------------------------------------------------------------------
+
+"""A MeshVisual Visual that uses the new shader Function."""
+
+from __future__ import division
+from functools import lru_cache
+
+import numpy as np
+
+from .visual import Visual
+from .shaders import Function, FunctionChain
+from ..gloo import VertexBuffer
+from ..geometry import MeshData
+from ..color import Color, get_colormap
+from ..color.colormap import CubeHelixColormap
+from ..util.event import Event
+
+
+_VERTEX_SHADER = """
+varying vec4 v_base_color;
+
+void main() {
+    v_base_color = $color_transform($base_color);
+    gl_Position = $transform($to_vec4($position));
+}
+"""
+
+_FRAGMENT_SHADER = """
+varying vec4 v_base_color;
+void main() {
+    gl_FragColor = v_base_color;
+}
+"""
+
+
+class MeshVisual(Visual):
+    """Mesh visual
+
+    Parameters
+    ----------
+    vertices : array-like | None
+        The vertices.
+    faces : array-like | None
+        The faces.
+    vertex_colors : array-like | None
+        Colors to use for each vertex.
+    face_colors : array-like | None
+        Colors to use for each face.
+    color : instance of Color
+        The color to use.
+    vertex_values : array-like | None
+        The values to use for each vertex (for colormapping).
+    meshdata : instance of MeshData | None
+        The meshdata.
+    shading : str | None
+        Shading to use. This uses the
+        :class:`~vispy.visuals.filters.mesh.ShadingFilter`
+        filter introduced in VisPy 0.7. This class provides additional
+        features that are available when the filter is attached manually.
+        See 'examples/basics/scene/mesh_shading.py' for an example.
+    mode : str
+        The drawing mode.
+    **kwargs : dict
+        Keyword arguments to pass to `Visual`.
+
+    Notes
+    -----
+    Additional functionality is available through filters. Mesh-specific
+    filters can be found in the :mod:`vispy.visuals.filters.mesh` module.
+
+    This class emits a `data_updated` event when the mesh data is updated. This
+    is used for example by filters for synchronization.
+
+    Examples
+    --------
+    Create a primitive shape from a helper function:
+
+    >>> from vispy.geometry import create_sphere
+    >>> meshdata = create_sphere()
+    >>> mesh = MeshVisual(meshdata=meshdata)
+
+    Create a custom shape:
+
+    >>> # A rectangle made out of two triangles.
+    >>> vertices = [(0, 0, 0), (1, 0, 1), (1, 1, 1), (0, 1, 0)]
+    >>> faces = [(0, 1, 2), (0, 2, 3)]
+    >>> mesh = MeshVisual(vertices=vertices, faces=faces)
+    """
+
+    _shaders = {
+        'vertex': _VERTEX_SHADER,
+        'fragment': _FRAGMENT_SHADER,
+    }
+
+    def __init__(self, vertices=None, faces=None, vertex_colors=None,
+                 face_colors=None, color=(0.5, 0.5, 1, 1), vertex_values=None,
+                 meshdata=None, shading=None, mode='triangles', **kwargs):
+        Visual.__init__(self, vcode=self._shaders['vertex'], fcode=self._shaders['fragment'],
+                        **kwargs)
+        self.set_gl_state('translucent', depth_test=True, cull_face=False)
+
+        self.events.add(data_updated=Event)
+
+        self._meshdata = None
+
+        # Define buffers
+        self._vertices = VertexBuffer(np.zeros((0, 3), dtype=np.float32))
+        self._cmap = CubeHelixColormap()
+        self._clim = 'auto'
+
+        # Uniform color
+        self._color = Color(color)
+
+        # add filters for various modifiers
+        self.shading_filter = None
+        self.shading = shading
+
+        # Init
+        self._bounds = None
+        # Note we do not call subclass set_data -- often the signatures
+        # do no match.
+        MeshVisual.set_data(
+            self, vertices=vertices, faces=faces, vertex_colors=vertex_colors,
+            face_colors=face_colors, vertex_values=vertex_values,
+            meshdata=meshdata, color=color)
+
+        # primitive mode
+        self._draw_mode = mode
+
+        self.freeze()
+
+    @property
+    def shading(self):
+        """The shading method."""
+        return self._shading
+
+    @shading.setter
+    def shading(self, shading):
+        assert shading in (None, 'flat', 'smooth')
+        self._shading = shading
+        if shading is None and self.shading_filter is None:
+            # Delay creation of filter until necessary.
+            return
+        if self.shading_filter is None:
+            from vispy.visuals.filters import ShadingFilter
+            self.shading_filter = ShadingFilter(shading=shading)
+            self.attach(self.shading_filter)
+        else:
+            self.shading_filter.shading = shading
+
+    def set_data(self, vertices=None, faces=None, vertex_colors=None,
+                 face_colors=None, color=None, vertex_values=None,
+                 meshdata=None):
+        """Set the mesh data
+
+        Parameters
+        ----------
+        vertices : array-like | None
+            The vertices.
+        faces : array-like | None
+            The faces.
+        vertex_colors : array-like | None
+            Colors to use for each vertex.
+        face_colors : array-like | None
+            Colors to use for each face.
+        color : instance of Color
+            The color to use.
+        vertex_values : array-like | None
+            Values for each vertex.
+        meshdata : instance of MeshData | None
+            The meshdata.
+        """
+        if meshdata is not None:
+            self._meshdata = meshdata
+        else:
+            self._meshdata = MeshData(vertices=vertices, faces=faces,
+                                      vertex_colors=vertex_colors,
+                                      face_colors=face_colors,
+                                      vertex_values=vertex_values)
+        self._bounds = self._meshdata.get_bounds()
+        if color is not None:
+            self._color = Color(color)
+        self.mesh_data_changed()
+
+    @property
+    def clim(self):
+        return (self._clim if isinstance(self._clim, str) else
+                tuple(self._clim))
+
+    @clim.setter
+    def clim(self, clim):
+        if isinstance(clim, str):
+            if clim != 'auto':
+                raise ValueError('clim must be "auto" if a string')
+        else:
+            clim = np.array(clim, float)
+            if clim.shape != (2,):
+                raise ValueError('clim must have two elements')
+        self._clim = clim
+        self.mesh_data_changed()
+
+    @property
+    def _clim_values(self):
+        if isinstance(self._clim, str):  # == 'auto'
+            if self._meshdata.has_vertex_value():
+                clim = self._meshdata.get_vertex_values()
+                clim = (np.min(clim), np.max(clim))
+            else:
+                clim = (0, 1)
+        else:
+            clim = self._clim
+        return clim
+
+    @property
+    def cmap(self):
+        return self._cmap
+
+    @cmap.setter
+    def cmap(self, cmap):
+        self._cmap = get_colormap(cmap)
+        self.mesh_data_changed()
+
+    @property
+    def mode(self):
+        """The triangle mode used to draw this mesh.
+
+        Options are:
+
+            * 'triangles': Draw one triangle for every three vertices
+              (eg, [1,2,3], [4,5,6], [7,8,9)
+            * 'triangle_strip': Draw one strip for every vertex excluding the
+              first two (eg, [1,2,3], [2,3,4], [3,4,5])
+            * 'triangle_fan': Draw each triangle from the first vertex and the
+              last two vertices (eg, [1,2,3], [1,3,4], [1,4,5])
+        """
+        return self._draw_mode
+
+    @mode.setter
+    def mode(self, m):
+        modes = ['triangles', 'triangle_strip', 'triangle_fan']
+        if m not in modes:
+            raise ValueError("Mesh mode must be one of %s" % ', '.join(modes))
+        self._draw_mode = m
+
+    @property
+    def mesh_data(self):
+        """The mesh data"""
+        return self._meshdata
+
+    @property
+    def color(self):
+        """The uniform color for this mesh"""
+        return self._color
+
+    @color.setter
+    def color(self, c):
+        """Set the uniform color of the mesh
+
+        This value is only used if per-vertex or per-face colors are not
+        specified.
+
+        Parameters
+        ----------
+        c : instance of Color
+            The color to use.
+        """
+        if c is not None:
+            self._color = Color(c)
+        self.mesh_data_changed()
+
+    def mesh_data_changed(self):
+        self._data_changed = True
+        self.update()
+
+    def _build_color_transform(self, colors):
+        # Eventually this could be de-duplicated with visuals/image.py, which does
+        # something similar (but takes a ``color`` instead of ``float``)
+        null_color_transform = 'vec4 pass(vec4 color) { return color; }'
+        clim_func = 'float cmap(float val) { return (val - $cmin) / ($cmax - $cmin); }'
+        if colors.ndim == 2 and colors.shape[1] == 1:
+            fun = Function(clim_func)
+            fun['cmin'] = self._clim_values[0]
+            fun['cmax'] = self._clim_values[1]
+            fun = FunctionChain(None, [fun, Function(self.cmap.glsl_map)])
+        else:
+            fun = Function(null_color_transform)
+        return fun
+
+    @staticmethod
+    @lru_cache(maxsize=2)
+    def _ensure_vec4_func(dims):
+        if dims == 2:
+            func = Function("""
+                vec4 vec2to4(vec2 xyz) {
+                    return vec4(xyz, 0.0, 1.0);
+                }
+            """)
+        elif dims == 3:
+            func = Function("""
+                vec4 vec3to4(vec3 xyz) {
+                    return vec4(xyz, 1.0);
+                }
+            """)
+        else:
+            raise TypeError("Vertex data must have shape (...,2) or (...,3).")
+        return func
+
+    def _update_data(self):
+        md = self.mesh_data
+
+        v = md.get_vertices(indexed='faces')
+        if v is None:
+            return False
+        if v.shape[-1] == 2:
+            v = np.concatenate((v, np.zeros((v.shape[:-1] + (1,)))), -1)
+        self._vertices.set_data(v, convert=True)
+        if md.has_vertex_color():
+            colors = md.get_vertex_colors(indexed='faces')
+            colors = colors.astype(np.float32)
+        elif md.has_face_color():
+            colors = md.get_face_colors(indexed='faces')
+            colors = colors.astype(np.float32)
+        elif md.has_vertex_value():
+            colors = md.get_vertex_values(indexed='faces')
+            colors = colors.ravel()[:, np.newaxis]
+            colors = colors.astype(np.float32)
+        else:
+            colors = self._color.rgba
+
+        self.shared_program.vert['position'] = self._vertices
+
+        self.shared_program['texture2D_LUT'] = self._cmap.texture_lut()
+
+        # Position input handling
+        ensure_vec4 = self._ensure_vec4_func(v.shape[-1])
+        self.shared_program.vert['to_vec4'] = ensure_vec4
+
+        # Set the base color.
+        #
+        # The base color is mixed further by the material filters for texture
+        # or shading effects.
+        self.shared_program.vert['color_transform'] = self._build_color_transform(colors)
+        if colors.ndim == 1:
+            self.shared_program.vert['base_color'] = colors
+        else:
+            self.shared_program.vert['base_color'] = VertexBuffer(colors)
+
+        self._data_changed = False
+
+        self.events.data_updated()
+
+    def _prepare_draw(self, view):
+        if self._data_changed:
+            if self._update_data() is False:
+                return False
+            self._data_changed = False
+
+    @staticmethod
+    def _prepare_transforms(view):
+        tr = view.transforms.get_transform()
+        view.view_program.vert['transform'] = tr
+
+    def _compute_bounds(self, axis, view):
+        if self._bounds is None:
+            return None
+        if axis >= len(self._bounds):
+            return (0, 0)
+        else:
+            return self._bounds[axis]

vispy/visuals/mesh_normals.py

@@ -0,0 +1,159 @@
+# -*- coding: utf-8 -*-
+# -----------------------------------------------------------------------------
+# Copyright (c) Vispy Development Team. All Rights Reserved.
+# Distributed under the (new) BSD License. See LICENSE.txt for more info.
+# -----------------------------------------------------------------------------
+"""A visual for displaying mesh normals as lines."""
+
+import numpy as np
+
+from . import LineVisual
+
+
+class MeshNormalsVisual(LineVisual):
+    """Display mesh normals as lines.
+
+    Parameters
+    ----------
+    meshdata : instance of :class:`~vispy.geometry.meshdata.MeshData`
+        The mesh data.
+    primitive : {'face', 'vertex'}
+        The primitive type on which to compute and display the normals.
+    length : None or float or array-like, optional
+        The length(s) of the normals. If None, the length is computed with
+        `length_method`.
+    length_method : {'median_edge', 'max_extent'}, default='median_edge'
+        The method to compute the length of the normals (when `length=None`).
+        Methods: 'median_edge', the median edge length; 'max_extent', the
+        maximum side length of the bounding box of the mesh.
+    length_scale : float, default=1.0
+        A scale factor applied to the length computed with `length_method`.
+    **kwargs : dict, optional
+        Extra arguments to define the appearance of lines. Refer to
+        :class:`~vispy.visuals.line.line.LineVisual`.
+
+    Examples
+    --------
+    Create a :class:`~vispy.visuals.mesh.MeshVisual` on which to display
+    the normals and get the :class:`~vispy.geometry.meshdata.MeshData`:
+
+    >>> mesh = MeshVisual(vertices=vertices, faces=faces, ...)
+    >>> meshdata = mesh.mesh_data
+
+    Create a visual for the mesh normals:
+
+    >>> normals = MeshNormalsVisual(meshdata)
+
+    Display the face normals:
+
+    >>> MeshNormalsVisual(..., primitive='face')
+    >>> MeshNormalsVisual(...)  # equivalent (default values)
+
+    Display the vertex normals:
+
+    >>> MeshNormalsVisual(..., primitive='vertex')
+
+    Fixed length for all normals:
+
+    >>> MeshNormalsVisual(..., length=0.25)
+
+    Individual length per normal:
+
+    >>> lengths = np.array([0.5, 0.2, 0.7, ..., 0.7], dtype=float)
+    >>> MeshNormalsVisual(..., length=lengths)
+    >>> assert len(lengths) == len(faces)  # for face normals
+    >>> assert len(lengths) == len(vertices)  # for vertex normals
+
+    Normals at about the length of a triangle:
+
+    >>> MeshNormalsVisual(..., length_method='median_edge', length_scale=1.0)
+    >>> MeshNormalsVisual(...)  # equivalent (default values)
+
+    Normals at about 10% the size of the mesh:
+
+    >>> MeshNormalsVisual(..., length_method='max_extent', length_scale=0.1)
+    """
+
+    def __init__(self, meshdata=None, primitive='face', length=None,
+                 length_method='median_edge', length_scale=1.0, **kwargs):
+        self._previous_meshdata = None
+        super().__init__(connect='segments')
+        self.set_data(meshdata, primitive, length, length_method, length_scale, **kwargs)
+
+    def set_data(self, meshdata=None, primitive='face', length=None,
+                 length_method='median_edge', length_scale=1.0, **kwargs):
+        """Set the data used to draw this visual
+
+        Parameters
+        ----------
+        meshdata : instance of :class:`~vispy.geometry.meshdata.MeshData`
+            The mesh data.
+        primitive : {'face', 'vertex'}
+            The primitive type on which to compute and display the normals.
+        length : None or float or array-like, optional
+            The length(s) of the normals. If None, the length is computed with
+            `length_method`.
+        length_method : {'median_edge', 'max_extent'}, default='median_edge'
+            The method to compute the length of the normals (when `length=None`).
+            Methods: 'median_edge', the median edge length; 'max_extent', the
+            maximum side length of the bounding box of the mesh.
+        length_scale : float, default=1.0
+            A scale factor applied to the length computed with `length_method`.
+        **kwargs : dict, optional
+            Extra arguments to define the appearance of lines. Refer to
+            :class:`~vispy.visuals.line.line.LineVisual`.
+        """
+        if meshdata is None:
+            meshdata = self._previous_meshdata
+
+        if meshdata is None or meshdata.is_empty():
+            normals = None
+        elif primitive == 'face':
+            normals = meshdata.get_face_normals()
+        elif primitive == 'vertex':
+            normals = meshdata.get_vertex_normals()
+        else:
+            raise ValueError('primitive must be "face" or "vertex", got %s'
+                             % primitive)
+
+        # remove connect from kwargs to make sure we don't change it
+        kwargs.pop('connect', None)
+
+        if normals is None:
+            super().set_data(pos=np.empty((0, 3), dtype=np.float32), connect='segments', **kwargs)
+            return
+
+        self._previous_meshdata = meshdata
+
+        norms = np.sqrt((normals ** 2).sum(axis=-1, keepdims=True))
+        unit_normals = normals / norms
+
+        if length is None and length_method == 'median_edge':
+            face_corners = meshdata.get_vertices(indexed='faces')
+            edges = np.stack((
+                face_corners[:, 1, :] - face_corners[:, 0, :],
+                face_corners[:, 2, :] - face_corners[:, 1, :],
+                face_corners[:, 0, :] - face_corners[:, 2, :],
+            ))
+            edge_lengths = np.sqrt((edges ** 2).sum(axis=-1))
+            length = np.median(edge_lengths)
+        elif length is None and length_method == 'max_extent':
+            vertices = meshdata.get_vertices()
+            max_extent = np.max(vertices.max(axis=0) - vertices.min(axis=0))
+            length = max_extent
+        length *= length_scale
+
+        if primitive == 'face':
+            origins = meshdata.get_vertices(indexed='faces')
+            origins = origins.mean(axis=1)
+        elif primitive == 'vertex':
+            origins = meshdata.get_vertices()
+
+        # Ensure the broadcasting if the input is an `(n,)` array.
+        length = np.atleast_1d(length)
+        length = length[:, None]
+
+        ends = origins + length * unit_normals
+        segments = np.hstack((origins, ends)).reshape(-1, 3)
+
+        super().set_data(pos=segments, connect='segments', **kwargs)

vispy/visuals/plane.py

@@ -0,0 +1,54 @@
+# -*- coding: utf-8 -*-
+# -----------------------------------------------------------------------------
+# Copyright (c) Vispy Development Team. All Rights Reserved.
+# Distributed under the (new) BSD License. See LICENSE.txt for more info.
+# -----------------------------------------------------------------------------
+
+from ..geometry import create_plane
+from .visual import CompoundVisual
+from .mesh import MeshVisual
+
+
+class PlaneVisual(CompoundVisual):
+    """Visual that displays a plane.
+
+    Parameters
+    ----------
+    width : float
+        Plane width.
+    height : float
+        Plane height.
+    width_segments : int
+        Plane segments count along the width.
+    height_segments : float
+        Plane segments count along the height.
+    direction: unicode
+        ``{'-x', '+x', '-y', '+y', '-z', '+z'}``
+        Direction the plane will be facing.
+    vertex_colors : ndarray
+        Same as for `MeshVisual` class. See `create_plane` for vertex ordering.
+    face_colors : ndarray
+        Same as for `MeshVisual` class. See `create_plane` for vertex ordering.
+    color : Color
+        The `Color` to use when drawing the cube faces.
+    edge_color : tuple or Color
+        The `Color` to use when drawing the cube edges. If `None`, then no
+        cube edges are drawn.
+    """
+
+    def __init__(self, width=1, height=1, width_segments=1, height_segments=1,
+                 direction='+z', vertex_colors=None, face_colors=None,
+                 color=(0.5, 0.5, 1, 1), edge_color=None):
+        vertices, filled_indices, outline_indices = create_plane(
+            width, height, width_segments, height_segments, direction)
+
+        self._mesh = MeshVisual(vertices['position'], filled_indices,
+                                vertex_colors, face_colors, color)
+        self._mesh.update_gl_state(polygon_offset=(1, 1),
+                                   polygon_offset_fill=True)
+        self._outline = None
+        CompoundVisual.__init__(self, [self._mesh])
+        if edge_color:
+            self._outline = MeshVisual(vertices['position'], outline_indices,
+                                       color=edge_color, mode='lines')
+            self.add_subvisual(self._outline)