tabakrolletjie/lights.py

   1 """ May it be a light for you in dark places, when all other lights go out.
   2 """
   3
   4 import math
   5
   6 import pymunk
   7 import pymunk.pygame_util
   8 import pygame.display
   9 import pygame.draw
  10 import pygame.locals as pgl
  11 import pygame.rect
  12 import pygame.transform
  13
  14 from .constants import (
  15     LIGHT_CATEGORY, FITTINGS_CATEGORY, OBSTACLE_CATEGORY, TURNIP_CATEGORY,
  16     COLOURS)
  17 from .rays import RayPolyManager
  18 from .utils import DetailedTimer
  19 from .loader import loader
  20 from .transforms import ColourWedges
  21
  22 LIGHT_FILTER = pymunk.ShapeFilter(
  23     mask=pymunk.ShapeFilter.ALL_MASKS ^ (
  24         LIGHT_CATEGORY | FITTINGS_CATEGORY),
  25     categories=LIGHT_CATEGORY)
  26
  27 FITTINGS_FILTER = pymunk.ShapeFilter(
  28     mask=pymunk.ShapeFilter.ALL_MASKS ^ (
  29         LIGHT_CATEGORY | FITTINGS_CATEGORY),
  30     categories=FITTINGS_CATEGORY)
  31
  32 # Just match lights, nothing else
  33 LIT_BY_FILTER = pymunk.ShapeFilter(mask=LIGHT_CATEGORY)
  34 SPACE_FOR_LIGHT_FILTER = pymunk.ShapeFilter(
  35     mask=FITTINGS_CATEGORY | OBSTACLE_CATEGORY | TURNIP_CATEGORY)
  36
  37
  38 def check_space_for_light(space, pos, max_distance):
  39     point_info = space.point_query_nearest(
  40         pos, max_distance, SPACE_FOR_LIGHT_FILTER)
  41     if point_info is not None:
  42         return True
  43     return False
  44
  45
  46 class LightManager(object):
  47     """ Manages a set of lights. """
  48
  49     def __init__(self, space, gamestate):
  50         self._space = space
  51         self._battery_dead = False
  52         self._lights = [
  53             BaseLight.load(cfg) for cfg in gamestate.station["lights"]]
  54         for light in self._lights:
  55             light.add(self._space)
  56
  57     def add_light(self, cfg):
  58         light = BaseLight.load(cfg)
  59         self._lights.append(light)
  60         light.add(self._space)
  61
  62     def remove_light(self, light):
  63         self._lights.remove(light)
  64         light.remove(self._space)
  65
  66     def battery_dead(self):
  67         self._battery_dead = True
  68         for light in self._lights:
  69             light.off()
  70
  71     def serialize_lights(self):
  72         result = []
  73         for light in self._lights:
  74             result.append(light.serialize())
  75         return result
  76
  77     def toggle_nearest(self, *args, **kw):
  78         if self._battery_dead:
  79             return
  80         light = self.nearest(*args, **kw)
  81         if light:
  82             light.toggle()
  83
  84     def nearest(self, pos, surfpos=False, max_distance=1.0):
  85         if surfpos:
  86             surface = pygame.display.get_surface()
  87             pos = pymunk.pygame_util.from_pygame(pos, surface)
  88         point_info = self._space.point_query_nearest(
  89             pos, max_distance, pymunk.ShapeFilter(mask=FITTINGS_CATEGORY))
  90         if point_info is not None:
  91             return point_info.shape.body.light
  92         return None
  93
  94     def lit_by(self, pos, surfpos=False, max_distance=0.0):
  95         if surfpos:
  96             surface = pygame.display.get_surface()
  97             pos = pymunk.pygame_util.from_pygame(pos, surface)
  98         point_info_list = self._space.point_query(
  99             pos, max_distance, LIT_BY_FILTER)
 100         lights = [p.shape.body.light for p in point_info_list]
 101         return [
 102             light for light in lights
 103             if light.on and light.ray_manager.reaches(pos)
 104         ]
 105
 106     def light_query(self, shape):
 107         """Query the lights by shape"""
 108         old_filter = shape.filter
 109         # We need to restrict matches to only the lights
 110         shape.filter = LIT_BY_FILTER
 111         shape_info_list = self._space.shape_query(shape)
 112         shape.filter = old_filter
 113         lights = [p.shape.body.light for p in shape_info_list]
 114         return [
 115             light for light in lights
 116             if light.on and light.ray_manager.reaches(shape.body.position)
 117         ]
 118
 119     def total_power_usage(self):
 120         return sum(light.power_usage() for light in self._lights)
 121
 122     def render_light(self, surface):
 123         for light in self._lights:
 124             light.render_light(surface)
 125
 126     def render_fittings(self, surface):
 127         for light in self._lights:
 128             light.render_fitting(surface)
 129
 130     def tick(self):
 131         for light in self._lights:
 132             light.tick()
 133
 134
 135 def light_fitting_by_type(light_type):
 136     """ Render a light fitting image for a light type. """
 137     return BaseLight.find_cls(light_type).FITTING_IMG
 138
 139
 140 def seed_cost(light_config, num_colours):
 141     """Calculate a seed cost for a light from its configuration. """
 142     cls = BaseLight.find_cls(light_config["type"])
 143     return cls.BASE_COST + int(cls.find_cost(light_config) / 10) + num_colours
 144
 145 def light_info(light_config):
 146     """Generate info about a light to go in the tooltip. """
 147     cls = BaseLight.find_cls(light_config["type"])
 148     return cls.get_info(light_config)
 149
 150
 151 class BaseLight(object):
 152     """ Common light functionality. """
 153
 154     # defaults
 155     RAY_MANAGER = RayPolyManager
 156     FITTING_IMG = None
 157     FITTING_RADIUS = 24.0
 158     BASE_COST = 0
 159
 160     # cached surfaces
 161     _surface_cache = {}
 162
 163     def __init__(
 164             self, colours, position, intensity=1.0, radius_limits=None,
 165             direction=None, spread=None, on=True, start_colour=None,
 166             bounding_radius=None):
 167         self.colour_cycle = colours
 168         self.colour_pos = 0
 169         self.colour = colours[0]
 170         if start_colour and start_colour in colours:
 171             self.colour_pos = colours.index(start_colour)
 172             self.colour = start_colour
 173         self.on = on
 174         if not on:
 175             self.colour_pos = -1
 176         self.intensity = intensity
 177         self.body = pymunk.Body(0, 0, pymunk.body.Body.STATIC)
 178         self.body.light = self
 179         self.ray_manager = self.RAY_MANAGER(
 180             self.body, position, ray_filter=LIGHT_FILTER,
 181             radius_limits=radius_limits, direction=direction, spread=spread,
 182             bounding_radius=bounding_radius)
 183         self.fitting = pymunk.Circle(
 184             self.body, self.FITTING_RADIUS, self.ray_manager.position)
 185         self.fitting.filter = FITTINGS_FILTER
 186         self._fitting_image = None
 187         self._colour_mult_image = None
 188
 189     def serialize(self):
 190         result = self.ray_manager.serialize()
 191         result.update({
 192             "type": self.__class__.__name__.lower(),
 193             "colours": self.colour_cycle,
 194             "position": self.position,
 195             "intensity": self.intensity,
 196             "on": self.on,
 197             "start_colour": self.colour,
 198         })
 199         return result
 200
 201     @property
 202     def position(self):
 203         return self.ray_manager.position
 204
 205     @classmethod
 206     def load(cls, config):
 207         kw = config.copy()
 208         light_type = kw.pop("type")
 209         light_class = cls.find_cls(light_type)
 210         return light_class(**kw)
 211
 212     @classmethod
 213     def find_cls(cls, light_type):
 214         [light_class] = [
 215             c for c in cls.__subclasses__()
 216             if c.__name__.lower() == light_type]
 217         return light_class
 218
 219     @classmethod
 220     def find_cost(cls, config):
 221         cost = 5 * config["intensity"]
 222         return cost
 223
 224     @classmethod
 225     def get_info(cls, config):
 226         return ["intensity: %g" % config["intensity"]]
 227
 228     def add(self, space):
 229         if self.body.space is not None:
 230             space.remove(self.body, *self.body.shapes)
 231         space.add(self.body, self.fitting)
 232         self.ray_manager.set_space(space)
 233         self.ray_manager.update_shapes()
 234
 235     def remove(self, space):
 236         if self.body.space is not None:
 237             space.remove(self.body, *self.body.shapes)
 238
 239     def _cached_surface(self, name, surface):
 240         surf = self._surface_cache.get(name)
 241         if surf is None:
 242             surf = self._surface_cache[name] = pygame.surface.Surface(
 243                 surface.get_size(), pgl.SWSURFACE
 244             ).convert_alpha()
 245         return surf
 246
 247     def light_colour(self):
 248         light_colour = COLOURS[self.colour]
 249         intensity = int(255 * self.intensity)
 250         return light_colour + (intensity,)
 251
 252     def render_light(self, surface):
 253         if not self.on:
 254             return
 255
 256         dt = DetailedTimer("render_light")
 257         dt.start()
 258
 259         max_radius = self.ray_manager.max_radius
 260         min_radius = self.ray_manager.min_radius
 261         dest_rect = self.ray_manager.pygame_rect(surface)
 262
 263         white, black = (255, 255, 255, 255), (0, 0, 0, 0)
 264         light_colour = self.light_colour()
 265
 266         radius_mask = self._cached_surface('radius_mask', surface)
 267         radius_mask.set_clip(dest_rect)
 268         ray_mask = self._cached_surface('ray_mask', surface)
 269         ray_mask.set_clip(dest_rect)
 270
 271         ray_mask.fill(black)
 272         for pygame_poly in self.ray_manager.pygame_polys(surface):
 273             pygame.draw.polygon(ray_mask, white, pygame_poly, 0)
 274             pygame.draw.polygon(ray_mask, white, pygame_poly, 1)
 275         dt.lap("ray mask rendered")
 276
 277         radius_mask.fill(black)
 278         centre = self.ray_manager.pygame_position(surface)
 279         pygame.draw.circle(
 280             radius_mask, light_colour, centre, int(max_radius), 0)
 281         pygame.draw.circle(
 282             radius_mask, black, centre, int(min_radius), 0)
 283         dt.lap("radius mask rendered")
 284
 285         ray_mask.blit(radius_mask, dest_rect, dest_rect, pgl.BLEND_RGBA_MULT)
 286         dt.lap("blitted radius mask to ray mask")
 287
 288         surface.blit(ray_mask, dest_rect, dest_rect)
 289         dt.lap("blitted surface")
 290         dt.end()
 291
 292     def fitting_image(self):
 293         if self._fitting_image is None:
 294             self._fitting_image = loader.load_image(
 295                 "48", self.FITTING_IMG,
 296                 transform=ColourWedges(colours=self.colour_cycle))
 297         return self._fitting_image
 298
 299     def invalidate_fitting_image(self):
 300         self._fitting_image = None
 301
 302     def render_fitting(self, surface):
 303         rx, ry = self.ray_manager.pygame_position(surface)
 304         surface.blit(self.fitting_image(), (rx - self.FITTING_RADIUS, ry - self.FITTING_RADIUS), None, 0)
 305
 306     def power_usage(self):
 307         if not self.on:
 308             return 0.0
 309         area = math.pi * (self.ray_manager.max_radius ** 2)  # radius
 310         area = area * (self.ray_manager.spread / (2 * math.pi))  # spread
 311         return 5 * area * self.intensity / 6400  # 80x80 unit area
 312
 313     def base_damage(self):
 314         return 10 * self.intensity
 315
 316     def off(self):
 317         self.on = False
 318         self.colour_pos = -1
 319
 320     def toggle(self):
 321         self.colour_pos += 1
 322         if self.colour_pos >= len(self.colour_cycle):
 323             self.colour = self.colour_cycle[0]
 324             self.colour_pos = -1
 325             self.on = False
 326         else:
 327             self.colour = self.colour_cycle[self.colour_pos]
 328             self.on = True
 329
 330     def tick(self):
 331         pass
 332
 333
 334 class Lamp(BaseLight):
 335
 336     FITTING_IMG = "lamp.png"
 337     BASE_COST = 1
 338
 339
 340 class PulsatingLamp(BaseLight):
 341
 342     FITTING_IMG = "pulsatinglamp.png"
 343     DEFAULT_PULSE_RANGE = (20, 100)
 344     DEFAULT_PULSE_VELOCITY = 2
 345     DEFAULT_INTENSITY_RANGE = (0.0, 0.9)
 346     DEFAULT_INTENSITY_VELOCITY = 0.1
 347     BASE_COST = 3
 348
 349     def __init__(self, **kw):
 350         self.pulse_range = kw.pop("pulse_range", self.DEFAULT_PULSE_RANGE)
 351         self.pulse_velocity = kw.pop(
 352             "pulse_velocity", self.DEFAULT_PULSE_VELOCITY)
 353         self.intensity_range = kw.pop(
 354             "intensity_range", self.DEFAULT_INTENSITY_RANGE)
 355         self.intensity_velocity = kw.pop(
 356             "intensity_velocity", self.DEFAULT_INTENSITY_VELOCITY)
 357         super(PulsatingLamp, self).__init__(
 358             bounding_radius=self.pulse_range[1], **kw)
 359
 360     def serialize(self):
 361         result = super(PulsatingLamp, self).serialize()
 362         result["pulse_velocity"] = self.pulse_velocity
 363         result["intensity_range"] = self.intensity_range
 364         result["intensity_velocity"] = self.intensity_velocity
 365         return result
 366
 367     def _update_range(self, value, velocity, value_range):
 368         value += velocity
 369         if value < value_range[0]:
 370             value = value_range[0]
 371             velocity = -velocity
 372         elif value > value_range[1]:
 373             value = value_range[1]
 374             velocity = -velocity
 375         return value, velocity
 376
 377     def tick(self):
 378         self.ray_manager.max_radius, self.pulse_velocity = self._update_range(
 379             self.ray_manager.max_radius, self.pulse_velocity, self.pulse_range)
 380         self.intensity, self.intensity_velocity = self._update_range(
 381             self.intensity, self.intensity_velocity, self.intensity_range)
 382
 383     @classmethod
 384     def find_cost(cls, config):
 385         cost = super(PulsatingLamp, cls).find_cost(config)
 386         cost += config.get("pulse_velocity", cls.DEFAULT_PULSE_VELOCITY)
 387         pr = config.get("pulse_range", cls.DEFAULT_PULSE_RANGE)
 388         cost += (pr[1] - pr[0]) / 10
 389         cost += 5 * config.get("intensity_velocity", cls.DEFAULT_INTENSITY_VELOCITY)
 390         ir = config.get("intensity_range", cls.DEFAULT_INTENSITY_RANGE)
 391         cost += 5 * (ir[1] - ir[0])
 392         return cost
 393
 394     @classmethod
 395     def get_info(cls, config):
 396         pr = config.get("pulse_range", cls.DEFAULT_PULSE_RANGE)
 397         pv = config.get("pulse_velocity", cls.DEFAULT_PULSE_VELOCITY)
 398         ir = config.get("intensity_range", cls.DEFAULT_INTENSITY_RANGE)
 399         iv = config.get("intensity_velocity", cls.DEFAULT_INTENSITY_VELOCITY)
 400         return [
 401             "intensity: %g - %g, velocity %g" % (ir[0], ir[1], iv),
 402             "pulse: %d - %d, velocity %g" % (pr[0], pr[1], pv),
 403         ]
 404
 405
 406 class SpotLight(BaseLight):
 407
 408     FITTING_IMG = "spotlight.png"
 409     BASE_COST = 5
 410
 411     def __init__(self, **kw):
 412         self.angular_velocity = kw.pop("angular_velocity", None)
 413         super(SpotLight, self).__init__(**kw)
 414
 415     def serialize(self):
 416         result = super(SpotLight, self).serialize()
 417         result["angular_velocity"] = self.angular_velocity
 418         return result
 419
 420     def fitting_image(self):
 421         fitting_image = super(SpotLight, self).fitting_image()
 422         rot_fitting_image = pygame.transform.rotozoom(
 423             fitting_image, self.ray_manager.direction - 90, 1)
 424
 425         rot_rect = fitting_image.get_rect().copy()
 426         rot_rect.center = rot_fitting_image.get_rect().center
 427         rot_fitting_image = rot_fitting_image.subsurface(rot_rect).copy()
 428
 429         return rot_fitting_image
 430
 431     def tick(self):
 432         if self.angular_velocity:
 433             self.ray_manager.direction -= self.angular_velocity
 434             self.ray_manager.update_shapes()
 435
 436     @classmethod
 437     def find_cost(cls, config):
 438         cost = super(SpotLight, cls).find_cost(config)
 439         cost += config.get("angular_velocity", 0)
 440         cost += config["spread"] / 10
 441         rl = config["radius_limits"]
 442         cost += (rl[1] - rl[0]) / 10
 443         return cost
 444
 445     @classmethod
 446     def get_info(cls, config):
 447         info = super(SpotLight, cls).get_info(config)
 448         rl = config["radius_limits"]
 449         info.extend([
 450             "spread: %d" % config["spread"],
 451             "length: %d" % (rl[1] - rl[0]),
 452             "angular velocity: %g" % config.get("angular_velocity", 0),
 453         ])
 454         return info