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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
|
# 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 markers item of the :class:`Plot`.
"""
__authors__ = ["T. Vincent"]
__license__ = "MIT"
__date__ = "06/03/2017"
import logging
from ....utils.proxy import docstring
from .core import (Item, DraggableMixIn, ColorMixIn, LineMixIn, SymbolMixIn,
ItemChangedType)
_logger = logging.getLogger(__name__)
class MarkerBase(Item, DraggableMixIn, ColorMixIn):
"""Base class for markers"""
_DEFAULT_COLOR = (0., 0., 0., 1.)
"""Default color of the markers"""
def __init__(self):
Item.__init__(self)
DraggableMixIn.__init__(self)
ColorMixIn.__init__(self)
self._text = ''
self._x = None
self._y = None
self._constraint = self._defaultConstraint
def _addRendererCall(self, backend,
symbol=None, linestyle='-', linewidth=1):
"""Perform the update of the backend renderer"""
return backend.addMarker(
x=self.getXPosition(),
y=self.getYPosition(),
legend=self.getLegend(),
text=self.getText(),
color=self.getColor(),
selectable=self.isSelectable(),
draggable=self.isDraggable(),
symbol=symbol,
linestyle=linestyle,
linewidth=linewidth,
constraint=self.getConstraint())
def _addBackendRenderer(self, backend):
"""Update backend renderer"""
raise NotImplementedError()
@docstring(DraggableMixIn)
def drag(self, from_, to):
self.setPosition(to[0], to[1])
def isOverlay(self):
"""Return true if marker is drawn as an overlay.
A marker is an overlay if it is draggable.
:rtype: bool
"""
return self.isDraggable()
def getText(self):
"""Returns marker text.
:rtype: str
"""
return self._text
def setText(self, text):
"""Set the text of the marker.
:param str text: The text to use
"""
text = str(text)
if text != self._text:
self._text = text
self._updated(ItemChangedType.TEXT)
def getXPosition(self):
"""Returns the X position of the marker line in data coordinates
:rtype: float or None
"""
return self._x
def getYPosition(self):
"""Returns the Y position of the marker line in data coordinates
:rtype: float or None
"""
return self._y
def getPosition(self):
"""Returns the (x, y) position of the marker in data coordinates
:rtype: 2-tuple of float or None
"""
return self._x, self._y
def setPosition(self, x, y):
"""Set marker position in data coordinates
Constraint are applied if any.
:param float x: X coordinates in data frame
:param float y: Y coordinates in data frame
"""
x, y = self.getConstraint()(x, y)
x, y = float(x), float(y)
if x != self._x or y != self._y:
self._x, self._y = x, y
self._updated(ItemChangedType.POSITION)
def getConstraint(self):
"""Returns the dragging constraint of this item"""
return self._constraint
def _setConstraint(self, constraint): # TODO support update
"""Set the constraint.
This is private for now as update is not handled.
:param callable constraint:
:param constraint: A function filtering item displacement by
dragging operations or None for no filter.
This function is called each time the item is
moved.
This is only used if isDraggable returns True.
:type constraint: None or a callable that takes the coordinates of
the current cursor position in the plot as input
and that returns the filtered coordinates.
"""
if constraint is None:
constraint = self._defaultConstraint
assert callable(constraint)
self._constraint = constraint
@staticmethod
def _defaultConstraint(*args):
"""Default constraint not doing anything"""
return args
class Marker(MarkerBase, SymbolMixIn):
"""Description of a marker"""
_DEFAULT_SYMBOL = '+'
"""Default symbol of the marker"""
def __init__(self):
MarkerBase.__init__(self)
SymbolMixIn.__init__(self)
self._x = 0.
self._y = 0.
def _addBackendRenderer(self, backend):
return self._addRendererCall(backend, symbol=self.getSymbol())
def _setConstraint(self, constraint):
"""Set the constraint function of the marker drag.
It also supports 'horizontal' and 'vertical' str as constraint.
:param constraint: The constraint of the dragging of this marker
:type: constraint: callable or str
"""
if constraint == 'horizontal':
constraint = self._horizontalConstraint
elif constraint == 'vertical':
constraint = self._verticalConstraint
super(Marker, self)._setConstraint(constraint)
def _horizontalConstraint(self, _, y):
return self.getXPosition(), y
def _verticalConstraint(self, x, _):
return x, self.getYPosition()
class _LineMarker(MarkerBase, LineMixIn):
"""Base class for line markers"""
def __init__(self):
MarkerBase.__init__(self)
LineMixIn.__init__(self)
def _addBackendRenderer(self, backend):
return self._addRendererCall(backend,
linestyle=self.getLineStyle(),
linewidth=self.getLineWidth())
class XMarker(_LineMarker):
"""Description of a marker"""
def __init__(self):
_LineMarker.__init__(self)
self._x = 0.
def setPosition(self, x, y):
"""Set marker line position in data coordinates
Constraint are applied if any.
:param float x: X coordinates in data frame
:param float y: Y coordinates in data frame
"""
x, _ = self.getConstraint()(x, y)
x = float(x)
if x != self._x:
self._x = x
self._updated(ItemChangedType.POSITION)
class YMarker(_LineMarker):
"""Description of a marker"""
def __init__(self):
_LineMarker.__init__(self)
self._y = 0.
def setPosition(self, x, y):
"""Set marker line position in data coordinates
Constraint are applied if any.
:param float x: X coordinates in data frame
:param float y: Y coordinates in data frame
"""
_, y = self.getConstraint()(x, y)
y = float(y)
if y != self._y:
self._y = y
self._updated(ItemChangedType.POSITION)
|
