''' Contains the Zone object '''
[docs]class Zone(object):
'''
Correlates with beginning and end of Frames to add functionality.
:param begin: The beginning of the Zone in pixels.
:type begin: int
:param end: The end of the Zone in pixels.
:type end: int
:param zone_type: The type of the Zone for Rules. 'generic' by default.
:type zone_type: str
'''
zone_id = 0
def __init__(self, begin, end, zone_type='generic'):
Zone.zone_id += 1
self.zone_id = Zone.zone_id
self.begin = begin
self.end = end
self.zone_type = zone_type
def __str__(self):
return "Zone #" + str(self.zone_id).ljust(2) + " - Range: [" + str(self.begin) + "," + str(self.end) + "] - Type: " + str(self.zone_type)
[docs] def check(self, pos):
'''
Returns True if the given position is in the zone.
:param pos: The position in pixels.
:type pos: int
:rtype: bool
'''
return self.begin <= pos <= self.end