# coding: utf-8
# /*##########################################################################
#
# Copyright (c) 2017 European Synchrotron Radiation Facility
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
#
# ###########################################################################*/
"""This module provides regular mesh item class.
"""
from __future__ import absolute_import
__authors__ = ["T. Vincent"]
__license__ = "MIT"
__date__ = "15/11/2017"
import numpy
from ..scene import primitives
from .core import DataItem3D, ItemChangedType
[docs]class Mesh(DataItem3D):
"""Description of mesh.
:param parent: The View widget this item belongs to.
"""
def __init__(self, parent=None):
DataItem3D.__init__(self, parent=parent)
self._mesh = None
[docs] def setData(self,
position,
color,
normal=None,
mode='triangles',
copy=True):
"""Set mesh geometry data.
Supported drawing modes are:
- For points: 'points'
- For lines: 'lines', 'line_strip', 'loop'
- For triangles: 'triangles', 'triangle_strip', 'fan'
:param numpy.ndarray position:
Position (x, y, z) of each vertex as a (N, 3) array
:param numpy.ndarray color: Colors for each point or a single color
:param numpy.ndarray normal: Normals for each point or None (default)
:param str mode: The drawing mode.
:param bool copy: True (default) to copy the data,
False to use as is (do not modify!).
"""
self._getScenePrimitive().children = [] # Remove any previous mesh
if position is None or len(position) == 0:
self._mesh = 0
else:
self._mesh = primitives.Mesh3D(
position, color, normal, mode=mode, copy=copy)
self._getScenePrimitive().children.append(self._mesh)
self.sigItemChanged.emit(ItemChangedType.DATA)
[docs] def getData(self, copy=True):
"""Get the mesh geometry.
:param bool copy:
True (default) to get a copy,
False to get internal representation (do not modify!).
:return: The positions, colors, normals and mode
:rtype: tuple of numpy.ndarray
"""
return (self.getPositionData(copy=copy),
self.getColorData(copy=copy),
self.getNormalData(copy=copy),
self.getDrawMode())
[docs] def getPositionData(self, copy=True):
"""Get the mesh vertex positions.
:param bool copy:
True (default) to get a copy,
False to get internal representation (do not modify!).
:return: The (x, y, z) positions as a (N, 3) array
:rtype: numpy.ndarray
"""
if self._mesh is None:
return numpy.empty((0, 3), dtype=numpy.float32)
else:
return self._mesh.getAttribute('position', copy=copy)
[docs] def getColorData(self, copy=True):
"""Get the mesh vertex colors.
:param bool copy:
True (default) to get a copy,
False to get internal representation (do not modify!).
:return: The RGBA colors as a (N, 4) array or a single color
:rtype: numpy.ndarray
"""
if self._mesh is None:
return numpy.empty((0, 4), dtype=numpy.float32)
else:
return self._mesh.getAttribute('color', copy=copy)
[docs] def getNormalData(self, copy=True):
"""Get the mesh vertex normals.
:param bool copy:
True (default) to get a copy,
False to get internal representation (do not modify!).
:return: The normals as a (N, 3) array, a single normal or None
:rtype: numpy.ndarray or None
"""
if self._mesh is None:
return None
else:
return self._mesh.getAttribute('normal', copy=copy)
[docs] def getDrawMode(self):
"""Get mesh rendering mode.
:return: The drawing mode of this primitive
:rtype: str
"""
return self._mesh.drawMode
