util/minorview/point.py

   1 # Copyright (c) 2013 ARM Limited
   2 # All rights reserved
   3 #
   4 # The license below extends only to copyright in the software and shall
   5 # not be construed as granting a license to any other intellectual
   6 # property including but not limited to intellectual property relating
   7 # to a hardware implementation of the functionality of the software
   8 # licensed hereunder.  You may use the software subject to the license
   9 # terms below provided that you ensure that this notice is replicated
  10 # unmodified and in its entirety in all distributions of the software,
  11 # modified or unmodified, in source code or in binary form.
  12 #
  13 # Redistribution and use in source and binary forms, with or without
  14 # modification, are permitted provided that the following conditions are
  15 # met: redistributions of source code must retain the above copyright
  16 # notice, this list of conditions and the following disclaimer;
  17 # redistributions in binary form must reproduce the above copyright
  18 # notice, this list of conditions and the following disclaimer in the
  19 # documentation and/or other materials provided with the distribution;
  20 # neither the name of the copyright holders nor the names of its
  21 # contributors may be used to endorse or promote products derived from
  22 # this software without specific prior written permission.
  23 #
  24 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  25 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  26 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  27 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  28 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  29 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  30 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  31 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  32 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  33 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  34 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  35 #
  36 # Authors: Andrew Bardsley
  37
  38 class Point(object):
  39     """2D point coordinates/size type"""
  40     def __init__(self, x, y):
  41         self.x = x
  42         self.y = y
  43
  44     def __add__(self, rhs):
  45         return Point(self.x + rhs.x, self.y + rhs.y)
  46
  47     def __sub__(self, rhs):
  48         return Point(self.x - rhs.x, self.y - rhs.y)
  49
  50     def __mul__(self, rhs):
  51         return Point(self.x * rhs.x, self.y * rhs.y)
  52
  53     def __div__(self, rhs):
  54         return Point(float(self.x) / rhs.x, float(self.y) / rhs.y)
  55
  56     def scale(self, factor):
  57         return Point(self.x * factor, self.y * factor)
  58
  59     def to_pair(self):
  60         return (self.x, self.y)
  61
  62     def __str__(self):
  63         return "Point(%f,%f)" % (self.x, self.y)
  64
  65     def __repr__(self):
  66         return "Point(%f,%f)" % (self.x, self.y)
  67
  68     def is_within_box(self, box):
  69         """Is this point inside the (centre, size) box box"""
  70         centre, size = box
  71         half_size = size.scale(0.5)
  72         top_left = centre - half_size
  73         bottom_right = centre + half_size
  74         return (top_left.x < self.x and
  75             top_left.y < self.y and
  76             bottom_right.x > self.x and
  77             bottom_right.y > self.y)
  78