annotate gamelib/cursor.py @ 302:6d93e04036c9

CursorSprite: Default pointer-position to the centre of the cursor
author Stefano Rivera <stefano@rivera.za.net>
date Sat, 28 Aug 2010 01:32:54 +0200
parents fbfd8e748ac0
children 3476e8f3b100
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
66
05346a412b55 A sprite cursor attempt
Stefano Rivera <stefano@rivera.za.net>
parents:
diff changeset
1 # cursor.py
05346a412b55 A sprite cursor attempt
Stefano Rivera <stefano@rivera.za.net>
parents:
diff changeset
2 # Copyright Boomslang team, 2010 (see COPYING File)
05346a412b55 A sprite cursor attempt
Stefano Rivera <stefano@rivera.za.net>
parents:
diff changeset
3 # Sprite Cursor
05346a412b55 A sprite cursor attempt
Stefano Rivera <stefano@rivera.za.net>
parents:
diff changeset
4
135
b43599b7f8a2 Cursor highlights
Stefano Rivera <stefano@rivera.za.net>
parents: 129
diff changeset
5 from albow.resource import get_image
70
213e47dea4d0 Funkier cursor handling
Neil Muller <neil@dip.sun.ac.za>
parents: 66
diff changeset
6 from albow.widget import Widget
66
05346a412b55 A sprite cursor attempt
Stefano Rivera <stefano@rivera.za.net>
parents:
diff changeset
7 from pygame.sprite import Sprite, RenderUpdates
135
b43599b7f8a2 Cursor highlights
Stefano Rivera <stefano@rivera.za.net>
parents: 129
diff changeset
8 import pygame
b43599b7f8a2 Cursor highlights
Stefano Rivera <stefano@rivera.za.net>
parents: 129
diff changeset
9 import pygame.color
70
213e47dea4d0 Funkier cursor handling
Neil Muller <neil@dip.sun.ac.za>
parents: 66
diff changeset
10 import pygame.cursors
213e47dea4d0 Funkier cursor handling
Neil Muller <neil@dip.sun.ac.za>
parents: 66
diff changeset
11 import pygame.mouse
213e47dea4d0 Funkier cursor handling
Neil Muller <neil@dip.sun.ac.za>
parents: 66
diff changeset
12
66
05346a412b55 A sprite cursor attempt
Stefano Rivera <stefano@rivera.za.net>
parents:
diff changeset
13 class CursorSprite(Sprite):
05346a412b55 A sprite cursor attempt
Stefano Rivera <stefano@rivera.za.net>
parents:
diff changeset
14 "A Sprite that follows the Cursor"
05346a412b55 A sprite cursor attempt
Stefano Rivera <stefano@rivera.za.net>
parents:
diff changeset
15
302
6d93e04036c9 CursorSprite: Default pointer-position to the centre of the cursor
Stefano Rivera <stefano@rivera.za.net>
parents: 187
diff changeset
16 def __init__(self, filename, x=None, y=None):
66
05346a412b55 A sprite cursor attempt
Stefano Rivera <stefano@rivera.za.net>
parents:
diff changeset
17 Sprite.__init__(self)
135
b43599b7f8a2 Cursor highlights
Stefano Rivera <stefano@rivera.za.net>
parents: 129
diff changeset
18 self.filename = filename
129
4223d66d88b4 Cursor change when you select a Tool
Stefano Rivera <stefano@rivera.za.net>
parents: 124
diff changeset
19 self.pointer_x = x
4223d66d88b4 Cursor change when you select a Tool
Stefano Rivera <stefano@rivera.za.net>
parents: 124
diff changeset
20 self.pointer_y = y
172
3b5cfb3f794e Ensure cursor loaded when calling set_highlight
Stefano Rivera <stefano@rivera.za.net>
parents: 171
diff changeset
21 self.highlighted = False
66
05346a412b55 A sprite cursor attempt
Stefano Rivera <stefano@rivera.za.net>
parents:
diff changeset
22
135
b43599b7f8a2 Cursor highlights
Stefano Rivera <stefano@rivera.za.net>
parents: 129
diff changeset
23 def load(self):
b43599b7f8a2 Cursor highlights
Stefano Rivera <stefano@rivera.za.net>
parents: 129
diff changeset
24 if not hasattr(self, 'plain_image'):
b43599b7f8a2 Cursor highlights
Stefano Rivera <stefano@rivera.za.net>
parents: 129
diff changeset
25 self.plain_image = get_image('items', self.filename)
b43599b7f8a2 Cursor highlights
Stefano Rivera <stefano@rivera.za.net>
parents: 129
diff changeset
26 self.image = self.plain_image
b43599b7f8a2 Cursor highlights
Stefano Rivera <stefano@rivera.za.net>
parents: 129
diff changeset
27 self.rect = self.image.get_rect()
302
6d93e04036c9 CursorSprite: Default pointer-position to the centre of the cursor
Stefano Rivera <stefano@rivera.za.net>
parents: 187
diff changeset
28
6d93e04036c9 CursorSprite: Default pointer-position to the centre of the cursor
Stefano Rivera <stefano@rivera.za.net>
parents: 187
diff changeset
29 if self.pointer_x is None:
6d93e04036c9 CursorSprite: Default pointer-position to the centre of the cursor
Stefano Rivera <stefano@rivera.za.net>
parents: 187
diff changeset
30 self.pointer_x = self.rect.size[0] // 2
6d93e04036c9 CursorSprite: Default pointer-position to the centre of the cursor
Stefano Rivera <stefano@rivera.za.net>
parents: 187
diff changeset
31 if self.pointer_y is None:
6d93e04036c9 CursorSprite: Default pointer-position to the centre of the cursor
Stefano Rivera <stefano@rivera.za.net>
parents: 187
diff changeset
32 self.pointer_y = self.rect.size[1] // 2
6d93e04036c9 CursorSprite: Default pointer-position to the centre of the cursor
Stefano Rivera <stefano@rivera.za.net>
parents: 187
diff changeset
33
135
b43599b7f8a2 Cursor highlights
Stefano Rivera <stefano@rivera.za.net>
parents: 129
diff changeset
34 self.highlight = pygame.Surface(self.rect.size)
b43599b7f8a2 Cursor highlights
Stefano Rivera <stefano@rivera.za.net>
parents: 129
diff changeset
35 color = pygame.color.Color(255, 100, 100, 0)
b43599b7f8a2 Cursor highlights
Stefano Rivera <stefano@rivera.za.net>
parents: 129
diff changeset
36 self.highlight.fill(color)
b43599b7f8a2 Cursor highlights
Stefano Rivera <stefano@rivera.za.net>
parents: 129
diff changeset
37
66
05346a412b55 A sprite cursor attempt
Stefano Rivera <stefano@rivera.za.net>
parents:
diff changeset
38 def update(self):
135
b43599b7f8a2 Cursor highlights
Stefano Rivera <stefano@rivera.za.net>
parents: 129
diff changeset
39 pos = pygame.mouse.get_pos()
129
4223d66d88b4 Cursor change when you select a Tool
Stefano Rivera <stefano@rivera.za.net>
parents: 124
diff changeset
40 self.rect.left = pos[0] - self.pointer_x
4223d66d88b4 Cursor change when you select a Tool
Stefano Rivera <stefano@rivera.za.net>
parents: 124
diff changeset
41 self.rect.top = pos[1] - self.pointer_y
66
05346a412b55 A sprite cursor attempt
Stefano Rivera <stefano@rivera.za.net>
parents:
diff changeset
42
135
b43599b7f8a2 Cursor highlights
Stefano Rivera <stefano@rivera.za.net>
parents: 129
diff changeset
43 def set_highlight(self, enable):
139
a5972444ad1e Improve cursor state handling, disable highlights on modal dialogs
Stefano Rivera <stefano@rivera.za.net>
parents: 135
diff changeset
44 if enable != self.highlighted:
172
3b5cfb3f794e Ensure cursor loaded when calling set_highlight
Stefano Rivera <stefano@rivera.za.net>
parents: 171
diff changeset
45 self.load()
139
a5972444ad1e Improve cursor state handling, disable highlights on modal dialogs
Stefano Rivera <stefano@rivera.za.net>
parents: 135
diff changeset
46 self.highlighted = enable
a5972444ad1e Improve cursor state handling, disable highlights on modal dialogs
Stefano Rivera <stefano@rivera.za.net>
parents: 135
diff changeset
47 self.image = self.plain_image.copy()
a5972444ad1e Improve cursor state handling, disable highlights on modal dialogs
Stefano Rivera <stefano@rivera.za.net>
parents: 135
diff changeset
48 if enable:
a5972444ad1e Improve cursor state handling, disable highlights on modal dialogs
Stefano Rivera <stefano@rivera.za.net>
parents: 135
diff changeset
49 self.image.blit(self.highlight, self.highlight.get_rect(),
a5972444ad1e Improve cursor state handling, disable highlights on modal dialogs
Stefano Rivera <stefano@rivera.za.net>
parents: 135
diff changeset
50 None, pygame.BLEND_MULT)
135
b43599b7f8a2 Cursor highlights
Stefano Rivera <stefano@rivera.za.net>
parents: 129
diff changeset
51
b43599b7f8a2 Cursor highlights
Stefano Rivera <stefano@rivera.za.net>
parents: 129
diff changeset
52
b43599b7f8a2 Cursor highlights
Stefano Rivera <stefano@rivera.za.net>
parents: 129
diff changeset
53 HAND = CursorSprite('hand.png', 12, 0)
b43599b7f8a2 Cursor highlights
Stefano Rivera <stefano@rivera.za.net>
parents: 129
diff changeset
54
124
97322b78d1c1 Minor style cleanups
Neil Muller <neil@dip.sun.ac.za>
parents: 115
diff changeset
55
70
213e47dea4d0 Funkier cursor handling
Neil Muller <neil@dip.sun.ac.za>
parents: 66
diff changeset
56 class CursorWidget(Widget):
213e47dea4d0 Funkier cursor handling
Neil Muller <neil@dip.sun.ac.za>
parents: 66
diff changeset
57 """Mix-in widget to ensure that mouse_move is propogated to parents"""
213e47dea4d0 Funkier cursor handling
Neil Muller <neil@dip.sun.ac.za>
parents: 66
diff changeset
58
129
4223d66d88b4 Cursor change when you select a Tool
Stefano Rivera <stefano@rivera.za.net>
parents: 124
diff changeset
59 cursor = HAND
4223d66d88b4 Cursor change when you select a Tool
Stefano Rivera <stefano@rivera.za.net>
parents: 124
diff changeset
60
187
fbfd8e748ac0 Remove screen reference from State.
Jeremy Thurgood <firxen@gmail.com>
parents: 172
diff changeset
61 def __init__(self, screen, *args, **kwargs):
84
c76f2fad2af5 Draw CursorWidget on top of StateWidget
Stefano Rivera <stefano@rivera.za.net>
parents: 70
diff changeset
62 Widget.__init__(self, *args, **kwargs)
c76f2fad2af5 Draw CursorWidget on top of StateWidget
Stefano Rivera <stefano@rivera.za.net>
parents: 70
diff changeset
63 self._cursor_group = RenderUpdates()
129
4223d66d88b4 Cursor change when you select a Tool
Stefano Rivera <stefano@rivera.za.net>
parents: 124
diff changeset
64 self._loaded_cursor = None
187
fbfd8e748ac0 Remove screen reference from State.
Jeremy Thurgood <firxen@gmail.com>
parents: 172
diff changeset
65 self.screen = screen
66
05346a412b55 A sprite cursor attempt
Stefano Rivera <stefano@rivera.za.net>
parents:
diff changeset
66
139
a5972444ad1e Improve cursor state handling, disable highlights on modal dialogs
Stefano Rivera <stefano@rivera.za.net>
parents: 135
diff changeset
67 def enter_screen(self):
a5972444ad1e Improve cursor state handling, disable highlights on modal dialogs
Stefano Rivera <stefano@rivera.za.net>
parents: 135
diff changeset
68 pygame.mouse.set_visible(0)
a5972444ad1e Improve cursor state handling, disable highlights on modal dialogs
Stefano Rivera <stefano@rivera.za.net>
parents: 135
diff changeset
69
a5972444ad1e Improve cursor state handling, disable highlights on modal dialogs
Stefano Rivera <stefano@rivera.za.net>
parents: 135
diff changeset
70 def leave_screen(self):
a5972444ad1e Improve cursor state handling, disable highlights on modal dialogs
Stefano Rivera <stefano@rivera.za.net>
parents: 135
diff changeset
71 pygame.mouse.set_visible(1)
a5972444ad1e Improve cursor state handling, disable highlights on modal dialogs
Stefano Rivera <stefano@rivera.za.net>
parents: 135
diff changeset
72
114
13d8cb1d5962 Better cursor handling using draw_all() and mouse_delta().
Jeremy Thurgood <firxen@gmail.com>
parents: 108
diff changeset
73 def draw_all(self, _surface):
13d8cb1d5962 Better cursor handling using draw_all() and mouse_delta().
Jeremy Thurgood <firxen@gmail.com>
parents: 108
diff changeset
74 Widget.draw_all(self, _surface)
187
fbfd8e748ac0 Remove screen reference from State.
Jeremy Thurgood <firxen@gmail.com>
parents: 172
diff changeset
75 item = self.screen.state.tool
fbfd8e748ac0 Remove screen reference from State.
Jeremy Thurgood <firxen@gmail.com>
parents: 172
diff changeset
76 if item is None:
fbfd8e748ac0 Remove screen reference from State.
Jeremy Thurgood <firxen@gmail.com>
parents: 172
diff changeset
77 self.set_cursor(HAND)
fbfd8e748ac0 Remove screen reference from State.
Jeremy Thurgood <firxen@gmail.com>
parents: 172
diff changeset
78 else:
fbfd8e748ac0 Remove screen reference from State.
Jeremy Thurgood <firxen@gmail.com>
parents: 172
diff changeset
79 self.set_cursor(item.CURSOR)
106
da547e148532 Some (slightly) better cursor handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 84
diff changeset
80 surface = self.get_root().surface
129
4223d66d88b4 Cursor change when you select a Tool
Stefano Rivera <stefano@rivera.za.net>
parents: 124
diff changeset
81 if self.cursor != self._loaded_cursor:
135
b43599b7f8a2 Cursor highlights
Stefano Rivera <stefano@rivera.za.net>
parents: 129
diff changeset
82 self._loaded_cursor = self.cursor
129
4223d66d88b4 Cursor change when you select a Tool
Stefano Rivera <stefano@rivera.za.net>
parents: 124
diff changeset
83 if self.cursor is None:
115
5e704ee7b84b Remove "in-widget" check and always draw cursor.
Jeremy Thurgood <firxen@gmail.com>
parents: 114
diff changeset
84 pygame.mouse.set_visible(1)
5e704ee7b84b Remove "in-widget" check and always draw cursor.
Jeremy Thurgood <firxen@gmail.com>
parents: 114
diff changeset
85 self._cursor_group.empty()
5e704ee7b84b Remove "in-widget" check and always draw cursor.
Jeremy Thurgood <firxen@gmail.com>
parents: 114
diff changeset
86 else:
5e704ee7b84b Remove "in-widget" check and always draw cursor.
Jeremy Thurgood <firxen@gmail.com>
parents: 114
diff changeset
87 pygame.mouse.set_visible(0)
135
b43599b7f8a2 Cursor highlights
Stefano Rivera <stefano@rivera.za.net>
parents: 129
diff changeset
88 self.cursor.load()
115
5e704ee7b84b Remove "in-widget" check and always draw cursor.
Jeremy Thurgood <firxen@gmail.com>
parents: 114
diff changeset
89 self._cursor_group.empty()
135
b43599b7f8a2 Cursor highlights
Stefano Rivera <stefano@rivera.za.net>
parents: 129
diff changeset
90 self._cursor_group.add(self.cursor)
129
4223d66d88b4 Cursor change when you select a Tool
Stefano Rivera <stefano@rivera.za.net>
parents: 124
diff changeset
91 if self.cursor is not None:
115
5e704ee7b84b Remove "in-widget" check and always draw cursor.
Jeremy Thurgood <firxen@gmail.com>
parents: 114
diff changeset
92 self._cursor_group.update()
5e704ee7b84b Remove "in-widget" check and always draw cursor.
Jeremy Thurgood <firxen@gmail.com>
parents: 114
diff changeset
93 self._cursor_group.draw(surface)
66
05346a412b55 A sprite cursor attempt
Stefano Rivera <stefano@rivera.za.net>
parents:
diff changeset
94
114
13d8cb1d5962 Better cursor handling using draw_all() and mouse_delta().
Jeremy Thurgood <firxen@gmail.com>
parents: 108
diff changeset
95 def mouse_delta(self, event):
66
05346a412b55 A sprite cursor attempt
Stefano Rivera <stefano@rivera.za.net>
parents:
diff changeset
96 self.invalidate()
70
213e47dea4d0 Funkier cursor handling
Neil Muller <neil@dip.sun.ac.za>
parents: 66
diff changeset
97
129
4223d66d88b4 Cursor change when you select a Tool
Stefano Rivera <stefano@rivera.za.net>
parents: 124
diff changeset
98 def set_cursor(self, cursor):
4223d66d88b4 Cursor change when you select a Tool
Stefano Rivera <stefano@rivera.za.net>
parents: 124
diff changeset
99 CursorWidget.cursor = cursor
135
b43599b7f8a2 Cursor highlights
Stefano Rivera <stefano@rivera.za.net>
parents: 129
diff changeset
100
b43599b7f8a2 Cursor highlights
Stefano Rivera <stefano@rivera.za.net>
parents: 129
diff changeset
101 def cursor_highlight(self, enable):
b43599b7f8a2 Cursor highlights
Stefano Rivera <stefano@rivera.za.net>
parents: 129
diff changeset
102 self.cursor.set_highlight(enable)