1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
|
# coding: utf-8
# /*##########################################################################
#
# Copyright (c) 2017-2019 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 the :class:`Shape` item of the :class:`Plot`.
"""
__authors__ = ["T. Vincent"]
__license__ = "MIT"
__date__ = "21/12/2018"
import logging
import numpy
import six
from ... import colors
from .core import Item, ColorMixIn, FillMixIn, ItemChangedType, LineMixIn
_logger = logging.getLogger(__name__)
# TODO probably make one class for each kind of shape
# TODO check fill:polygon/polyline + fill = duplicated
class Shape(Item, ColorMixIn, FillMixIn, LineMixIn):
"""Description of a shape item
:param str type_: The type of shape in:
'hline', 'polygon', 'rectangle', 'vline', 'polylines'
"""
def __init__(self, type_):
Item.__init__(self)
ColorMixIn.__init__(self)
FillMixIn.__init__(self)
LineMixIn.__init__(self)
self._overlay = False
assert type_ in ('hline', 'polygon', 'rectangle', 'vline', 'polylines')
self._type = type_
self._points = ()
self._lineBgColor = None
self._handle = None
def _addBackendRenderer(self, backend):
"""Update backend renderer"""
points = self.getPoints(copy=False)
x, y = points.T[0], points.T[1]
return backend.addItem(x,
y,
legend=self.getLegend(),
shape=self.getType(),
color=self.getColor(),
fill=self.isFill(),
overlay=self.isOverlay(),
z=self.getZValue(),
linestyle=self.getLineStyle(),
linewidth=self.getLineWidth(),
linebgcolor=self.getLineBgColor())
def isOverlay(self):
"""Return true if shape is drawn as an overlay
:rtype: bool
"""
return self._overlay
def setOverlay(self, overlay):
"""Set the overlay state of the shape
:param bool overlay: True to make it an overlay
"""
overlay = bool(overlay)
if overlay != self._overlay:
self._overlay = overlay
self._updated(ItemChangedType.OVERLAY)
def getType(self):
"""Returns the type of shape to draw.
One of: 'hline', 'polygon', 'rectangle', 'vline', 'polylines'
:rtype: str
"""
return self._type
def getPoints(self, copy=True):
"""Get the control points of the shape.
:param bool copy: True (Default) to get a copy,
False to use internal representation (do not modify!)
:return: Array of point coordinates
:rtype: numpy.ndarray with 2 dimensions
"""
return numpy.array(self._points, copy=copy)
def setPoints(self, points, copy=True):
"""Set the point coordinates
:param numpy.ndarray points: Array of point coordinates
:param bool copy: True (Default) to get a copy,
False to use internal representation (do not modify!)
:return:
"""
self._points = numpy.array(points, copy=copy)
self._updated(ItemChangedType.DATA)
def getLineBgColor(self):
"""Returns the RGBA color of the item
:rtype: 4-tuple of float in [0, 1] or array of colors
"""
return self._lineBgColor
def setLineBgColor(self, color, copy=True):
"""Set item color
:param color: color(s) to be used
:type color: str ("#RRGGBB") or (npoints, 4) unsigned byte array or
one of the predefined color names defined in colors.py
:param bool copy: True (Default) to get a copy,
False to use internal representation (do not modify!)
"""
if color is not None:
if isinstance(color, six.string_types):
color = colors.rgba(color)
else:
color = numpy.array(color, copy=copy)
# TODO more checks + improve color array support
if color.ndim == 1: # Single RGBA color
color = colors.rgba(color)
else: # Array of colors
assert color.ndim == 2
self._lineBgColor = color
self._updated(ItemChangedType.LINE_BG_COLOR)
|
