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 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413
|
"""This module contains several flavors of constraint classes. Each has a
method `Constraint.solve_for(name)` and a method `Constraint.mark_dirty(v)`.
These methods are used by the constraint solver (`solver.Solver`) to set the
variables.
Variables should be of type `solver.Variable`.
See classes' documentation below for constraints description and for
examples of their usage.
EqualsConstraint
Make 'a' and 'b' equal.
LessThanConstraint
Ensure one variable stays smaller than another.
CenterConstraint
Ensures a Variable is kept between two other variables.
BalanceConstraint
Keeps three variables in line, maintaining a specific ratio.
LineConstraint
Solves the equation where a line is connected to a line or side at
a specific point.
New constraint class should derive from Constraint class abstract
class and implement `Constraint.solve_for(Variable)` method to update
a variable with appropriate value.
"""
from __future__ import annotations
import logging
import math
from gaphas.position import Position
from gaphas.solver import BaseConstraint, Constraint
log = logging.getLogger(__name__)
def constraint(
*,
horizontal: tuple[Position, Position] | None = None,
vertical: tuple[Position, Position] | None = None,
left_of: tuple[Position, Position] | None = None,
above: tuple[Position, Position] | None = None,
line: tuple[Position, tuple[Position, Position]] | None = None,
delta: float = 0.0,
align: float | None = None,
) -> Constraint:
"""Utility (factory) method to create item's internal constraint between
two positions or between a position and a line.
Position is a tuple of coordinates, i.e. ``(2, 4)``.
Line is a tuple of positions, i.e. ``((2, 3), (4, 2))``.
This method shall not be used to create constraints between
two different items.
Created constraint is returned.
:Parameters:
horizontal=(p1, p2)
Keep positions ``p1`` and ``p2`` aligned horizontally.
vertical=(p1, p2)
Keep positions ``p1`` and ``p2`` aligned vertically.
left_of=(p1, p2)
Keep position ``p1`` on the left side of position ``p2``.
above=(p1, p2)
Keep position ``p1`` above position ``p2``.
line=(p, l)
Keep position ``p`` on line ``l``.
"""
cc: Constraint | None
if horizontal:
p1, p2 = horizontal
cc = EqualsConstraint(p1[1], p2[1], delta)
elif vertical:
p1, p2 = vertical
cc = EqualsConstraint(p1[0], p2[0], delta)
elif left_of:
p1, p2 = left_of
cc = LessThanConstraint(p1[0], p2[0], delta)
elif above:
p1, p2 = above
cc = LessThanConstraint(p1[1], p2[1], delta)
elif line:
pos, line_l = line
if align is None:
cc = LineConstraint(line=line_l, point=pos)
else:
cc = LineAlignConstraint(line=line_l, point=pos, align=align, delta=delta)
else:
raise ValueError("Constraint incorrectly specified")
return cc
# is simple abs(x - y) > EPSILON enough for canvas needs?
EPSILON = 1e-6
def _update(variable, value):
if abs(variable.value - value) > EPSILON:
variable.value = value
class EqualsConstraint(BaseConstraint):
"""Constraint, which ensures that two arguments ``a`` and ``b`` are equal:
a + delta = b
for example
>>> from gaphas.solver import Variable
>>> a, b = Variable(1.0), Variable(2.0)
>>> eq = EqualsConstraint(a, b)
>>> eq.solve_for(a)
>>> a
Variable(2, 20)
>>> a.value = 10.8
>>> eq.solve_for(b)
>>> b
Variable(10.8, 20)
"""
def __init__(self, a=None, b=None, delta=0.0):
super().__init__(a, b, delta)
self.a = a
self.b = b
self.delta = delta
def solve_for(self, var):
assert var in (self.a, self.b, self.delta)
_update(
*(
(var is self.a)
and (self.a, self.b.value - self.delta)
or (var is self.b)
and (self.b, self.a.value + self.delta)
or (self.delta, self.b.value - self.a.value)
)
)
class CenterConstraint(BaseConstraint):
"""Simple Constraint, takes three arguments: 'a', 'b' and center. When
solved, the constraint ensures 'center' is located in the middle of 'a' and
'b'.
>>> from gaphas.solver import Variable
>>> a, b, center = Variable(1.0), Variable(3.0), Variable()
>>> eq = CenterConstraint(a, b, center)
>>> eq.solve_for(a)
>>> a
Variable(1, 20)
>>> center
Variable(2, 20)
>>> a.value = 10
>>> eq.solve_for(b)
>>> b
Variable(3, 20)
>>> center
Variable(6.5, 20)
"""
def __init__(self, a=None, b=None, center=None):
super().__init__(a, b, center)
self.a = a
self.b = b
self.center = center
def solve_for(self, var):
assert var in (self.a, self.b, self.center)
v = (self.a.value + self.b.value) / 2.0
_update(self.center, v)
class LessThanConstraint(BaseConstraint):
"""Ensure ``smaller`` is less than ``bigger``. The variable that is passed
as to-be-solved is left alone (cause it is the variable that has not been
moved lately). Instead the other variable is solved.
>>> from gaphas.solver import Variable
>>> a, b = Variable(3.0), Variable(2.0)
>>> lt = LessThanConstraint(smaller=a, bigger=b)
>>> lt.solve_for(a)
>>> a, b
(Variable(3, 20), Variable(3, 20))
>>> b.value = 0.8
>>> lt.solve_for(b)
>>> a, b
(Variable(0.8, 20), Variable(0.8, 20))
Also minimal delta between two values can be set
>>> a, b = Variable(10.0), Variable(8.0)
>>> lt = LessThanConstraint(smaller=a, bigger=b, delta=5)
>>> lt.solve_for(a)
>>> a, b
(Variable(10, 20), Variable(15, 20))
"""
def __init__(self, smaller=None, bigger=None, delta=0.0):
super().__init__(smaller, bigger, delta)
self.smaller = smaller
self.bigger = bigger
self.delta = delta
def solve_for(self, var):
if self.smaller.value > self.bigger.value - self.delta:
if var is self.smaller:
self.bigger.value = self.smaller.value + self.delta
elif var is self.bigger:
self.smaller.value = self.bigger.value - self.delta
elif var is self.delta:
self.delta.value = self.bigger.value - self.smaller.value
class BalanceConstraint(BaseConstraint):
"""Ensure that a variable ``v`` is between values specified by ``band`` and
in distance proportional from ``band[0]``.
Consider
>>> from gaphas.solver import Variable, WEAK
>>> a, b, c = Variable(2.0), Variable(3.0), Variable(2.3, WEAK)
>>> bc = BalanceConstraint(band=(a,b), v=c)
>>> c.value = 2.4
>>> c
Variable(2.4, 10)
>>> bc.solve_for(c)
>>> a, b, c
(Variable(2, 20), Variable(3, 20), Variable(2.3, 10))
Band does not have to be ``band[0] < band[1]``
>>> a, b, c = Variable(3.0), Variable(2.0), Variable(2.45, WEAK)
>>> bc = BalanceConstraint(band=(a,b), v=c)
>>> c.value = 2.50
>>> c
Variable(2.5, 10)
>>> bc.solve_for(c)
>>> a, b, c
(Variable(3, 20), Variable(2, 20), Variable(2.45, 10))
"""
def __init__(self, band=None, v=None, balance=None):
super().__init__(band[0], band[1], v)
self.band = band
self.balance = balance
self.v = v
if self.balance is None:
self.update_balance()
def update_balance(self):
b1, b2 = self.band
w = b2 - b1
self.balance = (self.v - b1) / w if w != 0 else 0
def solve_for(self, var):
b1, b2 = self.band
w = b2.value - b1.value
value = b1.value + w * self.balance
_update(var, value)
class LineConstraint(BaseConstraint):
"""Ensure a point is kept on a line.
Attributes:
- _line: line defined by tuple ((x1, y1), (x2, y2))
- _point: point defined by tuple (x, y)
"""
def __init__(self, line, point):
super().__init__(
line[0][0], line[0][1], line[1][0], line[1][1], point[0], point[1]
)
self._line = line
self._point = point
self.update_ratio()
def update_ratio(self):
"""
>>> from gaphas.solver import Variable
>>> line = (Variable(0), Variable(0)), (Variable(30), Variable(20))
>>> point = (Variable(15), Variable(4))
>>> lc = LineConstraint(line=line, point=point)
>>> lc.update_ratio()
>>> lc.ratio_x, lc.ratio_y
(0.5, 0.2)
>>> line[1][0].value = 40
>>> line[1][1].value = 30
>>> lc.solve_for(point[0])
>>> lc.ratio_x, lc.ratio_y
(0.5, 0.2)
>>> point
(Variable(20, 20), Variable(6, 20))
"""
sx, sy = self._line[0]
ex, ey = self._line[1]
px, py = self._point
try:
self.ratio = float(px.value - sx.value) / float(ex.value - sx.value)
except ZeroDivisionError:
try:
self.ratio = float(py.value - sy.value) / float(ey.value - sy.value)
except ZeroDivisionError:
self.ratio = 0.0
def solve_for(self, var=None):
self._solve()
def _solve(self):
"""Solve the equation for the connected_handle.
>>> from gaphas.solver import Variable
>>> line = (Variable(0), Variable(0)), (Variable(30), Variable(20))
>>> point = (Variable(15), Variable(4))
>>> lc = LineConstraint(line=line, point=point)
>>> lc.update_ratio()
>>> lc.solve_for(point[0])
>>> point
(Variable(15, 20), Variable(4, 20))
>>> line[1][0].value = 40
>>> line[1][1].value = 30
>>> lc.solve_for(point[0])
>>> point
(Variable(20, 20), Variable(6, 20))
"""
sx, sy = self._line[0]
ex, ey = self._line[1]
px, py = self._point
x = sx.value + (ex.value - sx.value) * self.ratio
y = sy.value + (ey.value - sy.value) * self.ratio
_update(px, x)
_update(py, y)
class PositionConstraint(BaseConstraint):
"""Ensure that point is always in origin position.
Attributes:
- _origin: origin position
- _point: point to be in origin position
"""
def __init__(self, origin, point):
super().__init__(origin[0], origin[1], point[0], point[1])
self._origin = origin
self._point = point
def solve_for(self, var=None):
"""Ensure that point's coordinates are the same as coordinates of the
origin position."""
x, y = self._origin[0].value, self._origin[1].value
_update(self._point[0], x)
_update(self._point[1], y)
class LineAlignConstraint(BaseConstraint):
"""Ensure a point is kept on a line in position specified by align and
padding information.
Align is specified as a number between 0 and 1, for example
0
keep point at one end of the line
1
keep point at other end of the line
0.5
keep point in the middle of the line
Align can be adjusted with `delta` parameter, which specifies the padding of
the point.
:Attributes:
_line
Line defined by tuple ((x1, y1), (x2, y2)).
_point
Point defined by tuple (x, y).
_align
Align of point.
_delta
Padding of the align.
"""
def __init__(self, line, point, align=0.5, delta=0.0):
super().__init__(
line[0][0], line[0][1], line[1][0], line[1][1], point[0], point[1]
)
self._line = line
self._point = point
self._align = align
self._delta = delta
def solve_for(self, var=None):
sx, sy = self._line[0]
ex, ey = self._line[1]
px, py = self._point
a = math.atan2(ey.value - sy.value, ex.value - sx.value)
x = sx.value + (ex.value - sx.value) * self._align + self._delta * math.cos(a)
y = sy.value + (ey.value - sy.value) * self._align + self._delta * math.sin(a)
_update(px, x)
_update(py, y)
|