Mercurial > boomslang

annotate pyntnclick/cursor.py @ 603:3ce19d33b51f pyntnclick

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Rename state to game to not cause confusion with the other state
author Neil Muller <neil@dip.sun.ac.za>
date Sat, 11 Feb 2012 20:09:47 +0200
parents 1b1ab71535bd
children 2748d3afcae5
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
401
92029c76b687 Different toolbar colour and remove highlighted cursor outside scene widget.
Jeremy Thurgood <firxen@gmail.com>
parents: 324
diff changeset
8 from pygame.rect import Rect
135
b43599b7f8a2 Cursor highlights
Stefano Rivera <stefano@rivera.za.net>
parents: 129
diff changeset
9 import pygame
b43599b7f8a2 Cursor highlights
Stefano Rivera <stefano@rivera.za.net>
parents: 129
diff changeset
10 import pygame.color
70
213e47dea4d0 Funkier cursor handling
Neil Muller <neil@dip.sun.ac.za>
parents: 66
diff changeset
11 import pygame.cursors
213e47dea4d0 Funkier cursor handling
Neil Muller <neil@dip.sun.ac.za>
parents: 66
diff changeset
12 import pygame.mouse
213e47dea4d0 Funkier cursor handling
Neil Muller <neil@dip.sun.ac.za>
parents: 66
diff changeset
13
576
1b1ab71535bd Classify constants, which involves a whole bunch of XXX comments
Stefano Rivera <stefano@rivera.za.net>
parents: 551
diff changeset
14 # XXX: Need a way to get at the constants
1b1ab71535bd Classify constants, which involves a whole bunch of XXX comments
Stefano Rivera <stefano@rivera.za.net>
parents: 551
diff changeset
15 from pyntnclick.constants import GameConstants
1b1ab71535bd Classify constants, which involves a whole bunch of XXX comments
Stefano Rivera <stefano@rivera.za.net>
parents: 551
diff changeset
16 SCENE_SIZE = GameConstants().scene_size
401
92029c76b687 Different toolbar colour and remove highlighted cursor outside scene widget.
Jeremy Thurgood <firxen@gmail.com>
parents: 324
diff changeset
17
92029c76b687 Different toolbar colour and remove highlighted cursor outside scene widget.
Jeremy Thurgood <firxen@gmail.com>
parents: 324
diff changeset
18
66
05346a412b55 A sprite cursor attempt
Stefano Rivera <stefano@rivera.za.net>
parents:
diff changeset
19 class CursorSprite(Sprite):
05346a412b55 A sprite cursor attempt
Stefano Rivera <stefano@rivera.za.net>
parents:
diff changeset
20 "A Sprite that follows the Cursor"
05346a412b55 A sprite cursor attempt
Stefano Rivera <stefano@rivera.za.net>
parents:
diff changeset
21
302
6d93e04036c9 CursorSprite: Default pointer-position to the centre of the cursor
Stefano Rivera <stefano@rivera.za.net>
parents: 187
diff changeset
22 def __init__(self, filename, x=None, y=None):
66
05346a412b55 A sprite cursor attempt
Stefano Rivera <stefano@rivera.za.net>
parents:
diff changeset
23 Sprite.__init__(self)
135
b43599b7f8a2 Cursor highlights
Stefano Rivera <stefano@rivera.za.net>
parents: 129
diff changeset
24 self.filename = filename
129
4223d66d88b4 Cursor change when you select a Tool
Stefano Rivera <stefano@rivera.za.net>
parents: 124
diff changeset
25 self.pointer_x = x
4223d66d88b4 Cursor change when you select a Tool
Stefano Rivera <stefano@rivera.za.net>
parents: 124
diff changeset
26 self.pointer_y = y
172
3b5cfb3f794e Ensure cursor loaded when calling set_highlight
Stefano Rivera <stefano@rivera.za.net>
parents: 171
diff changeset
27 self.highlighted = False
66
05346a412b55 A sprite cursor attempt
Stefano Rivera <stefano@rivera.za.net>
parents:
diff changeset
28
135
b43599b7f8a2 Cursor highlights
Stefano Rivera <stefano@rivera.za.net>
parents: 129
diff changeset
29 def load(self):
b43599b7f8a2 Cursor highlights
Stefano Rivera <stefano@rivera.za.net>
parents: 129
diff changeset
30 if not hasattr(self, 'plain_image'):
b43599b7f8a2 Cursor highlights
Stefano Rivera <stefano@rivera.za.net>
parents: 129
diff changeset
31 self.plain_image = get_image('items', self.filename)
b43599b7f8a2 Cursor highlights
Stefano Rivera <stefano@rivera.za.net>
parents: 129
diff changeset
32 self.image = self.plain_image
b43599b7f8a2 Cursor highlights
Stefano Rivera <stefano@rivera.za.net>
parents: 129
diff changeset
33 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
34
6d93e04036c9 CursorSprite: Default pointer-position to the centre of the cursor
Stefano Rivera <stefano@rivera.za.net>
parents: 187
diff changeset
35 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
36 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
37 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
38 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
39
135
b43599b7f8a2 Cursor highlights
Stefano Rivera <stefano@rivera.za.net>
parents: 129
diff changeset
40 self.highlight = pygame.Surface(self.rect.size)
b43599b7f8a2 Cursor highlights
Stefano Rivera <stefano@rivera.za.net>
parents: 129
diff changeset
41 color = pygame.color.Color(255, 100, 100, 0)
b43599b7f8a2 Cursor highlights
Stefano Rivera <stefano@rivera.za.net>
parents: 129
diff changeset
42 self.highlight.fill(color)
b43599b7f8a2 Cursor highlights
Stefano Rivera <stefano@rivera.za.net>
parents: 129
diff changeset
43
66
05346a412b55 A sprite cursor attempt
Stefano Rivera <stefano@rivera.za.net>
parents:
diff changeset
44 def update(self):
135
b43599b7f8a2 Cursor highlights
Stefano Rivera <stefano@rivera.za.net>
parents: 129
diff changeset
45 pos = pygame.mouse.get_pos()
129
4223d66d88b4 Cursor change when you select a Tool
Stefano Rivera <stefano@rivera.za.net>
parents: 124
diff changeset
46 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
47 self.rect.top = pos[1] - self.pointer_y
66
05346a412b55 A sprite cursor attempt
Stefano Rivera <stefano@rivera.za.net>
parents:
diff changeset
48
135
b43599b7f8a2 Cursor highlights
Stefano Rivera <stefano@rivera.za.net>
parents: 129
diff changeset
49 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
50 if enable != self.highlighted:
172
3b5cfb3f794e Ensure cursor loaded when calling set_highlight
Stefano Rivera <stefano@rivera.za.net>
parents: 171
diff changeset
51 self.load()
139
a5972444ad1e Improve cursor state handling, disable highlights on modal dialogs
Stefano Rivera <stefano@rivera.za.net>
parents: 135
diff changeset
52 self.highlighted = enable
a5972444ad1e Improve cursor state handling, disable highlights on modal dialogs
Stefano Rivera <stefano@rivera.za.net>
parents: 135
diff changeset
53 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
54 if enable:
a5972444ad1e Improve cursor state handling, disable highlights on modal dialogs
Stefano Rivera <stefano@rivera.za.net>
parents: 135
diff changeset
55 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
56 None, pygame.BLEND_MULT)
135
b43599b7f8a2 Cursor highlights
Stefano Rivera <stefano@rivera.za.net>
parents: 129
diff changeset
57
b43599b7f8a2 Cursor highlights
Stefano Rivera <stefano@rivera.za.net>
parents: 129
diff changeset
58
b43599b7f8a2 Cursor highlights
Stefano Rivera <stefano@rivera.za.net>
parents: 129
diff changeset
59 HAND = CursorSprite('hand.png', 12, 0)
b43599b7f8a2 Cursor highlights
Stefano Rivera <stefano@rivera.za.net>
parents: 129
diff changeset
60
124
97322b78d1c1 Minor style cleanups
Neil Muller <neil@dip.sun.ac.za>
parents: 115
diff changeset
61
70
213e47dea4d0 Funkier cursor handling
Neil Muller <neil@dip.sun.ac.za>
parents: 66
diff changeset
62 class CursorWidget(Widget):
213e47dea4d0 Funkier cursor handling
Neil Muller <neil@dip.sun.ac.za>
parents: 66
diff changeset
63 """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
64
129
4223d66d88b4 Cursor change when you select a Tool
Stefano Rivera <stefano@rivera.za.net>
parents: 124
diff changeset
65 cursor = HAND
324
3476e8f3b100 Fixed mouse and cursor handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 302
diff changeset
66 _cursor_group = RenderUpdates()
3476e8f3b100 Fixed mouse and cursor handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 302
diff changeset
67 _loaded_cursor = None
129
4223d66d88b4 Cursor change when you select a Tool
Stefano Rivera <stefano@rivera.za.net>
parents: 124
diff changeset
68
187
fbfd8e748ac0 Remove screen reference from State.
Jeremy Thurgood <firxen@gmail.com>
parents: 172
diff changeset
69 def __init__(self, screen, *args, **kwargs):
84
c76f2fad2af5 Draw CursorWidget on top of StateWidget
Stefano Rivera <stefano@rivera.za.net>
parents: 70
diff changeset
70 Widget.__init__(self, *args, **kwargs)
187
fbfd8e748ac0 Remove screen reference from State.
Jeremy Thurgood <firxen@gmail.com>
parents: 172
diff changeset
71 self.screen = screen
66
05346a412b55 A sprite cursor attempt
Stefano Rivera <stefano@rivera.za.net>
parents:
diff changeset
72
139
a5972444ad1e Improve cursor state handling, disable highlights on modal dialogs
Stefano Rivera <stefano@rivera.za.net>
parents: 135
diff changeset
73 def enter_screen(self):
a5972444ad1e Improve cursor state handling, disable highlights on modal dialogs
Stefano Rivera <stefano@rivera.za.net>
parents: 135
diff changeset
74 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
75
a5972444ad1e Improve cursor state handling, disable highlights on modal dialogs
Stefano Rivera <stefano@rivera.za.net>
parents: 135
diff changeset
76 def leave_screen(self):
a5972444ad1e Improve cursor state handling, disable highlights on modal dialogs
Stefano Rivera <stefano@rivera.za.net>
parents: 135
diff changeset
77 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
78
324
3476e8f3b100 Fixed mouse and cursor handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 302
diff changeset
79 def draw_all(self, surface):
3476e8f3b100 Fixed mouse and cursor handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 302
diff changeset
80 Widget.draw_all(self, surface)
3476e8f3b100 Fixed mouse and cursor handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 302
diff changeset
81 self.draw_cursor(self.get_root().surface)
3476e8f3b100 Fixed mouse and cursor handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 302
diff changeset
82
3476e8f3b100 Fixed mouse and cursor handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 302
diff changeset
83 def draw_cursor(self, surface):
603
3ce19d33b51f Rename state to game to not cause confusion with the other state
Neil Muller <neil@dip.sun.ac.za>
parents: 576
diff changeset
84 self.set_cursor(self.screen.game.tool)
324
3476e8f3b100 Fixed mouse and cursor handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 302
diff changeset
85 self.cursor.set_highlight(self.cursor_highlight())
129
4223d66d88b4 Cursor change when you select a Tool
Stefano Rivera <stefano@rivera.za.net>
parents: 124
diff changeset
86 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
87 self._cursor_group.update()
5e704ee7b84b Remove "in-widget" check and always draw cursor.
Jeremy Thurgood <firxen@gmail.com>
parents: 114
diff changeset
88 self._cursor_group.draw(surface)
66
05346a412b55 A sprite cursor attempt
Stefano Rivera <stefano@rivera.za.net>
parents:
diff changeset
89
114
13d8cb1d5962 Better cursor handling using draw_all() and mouse_delta().
Jeremy Thurgood <firxen@gmail.com>
parents: 108
diff changeset
90 def mouse_delta(self, event):
66
05346a412b55 A sprite cursor attempt
Stefano Rivera <stefano@rivera.za.net>
parents:
diff changeset
91 self.invalidate()
70
213e47dea4d0 Funkier cursor handling
Neil Muller <neil@dip.sun.ac.za>
parents: 66
diff changeset
92
324
3476e8f3b100 Fixed mouse and cursor handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 302
diff changeset
93 @classmethod
3476e8f3b100 Fixed mouse and cursor handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 302
diff changeset
94 def set_cursor(cls, item):
513
0e8487038834 fixed crash caused by the manual item's special snowflakeness
Adrianna Pińska <adrianna.pinska@gmail.com>
parents: 401
diff changeset
95 if item is None or item.CURSOR is None:
324
3476e8f3b100 Fixed mouse and cursor handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 302
diff changeset
96 cls.cursor = HAND
3476e8f3b100 Fixed mouse and cursor handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 302
diff changeset
97 else:
3476e8f3b100 Fixed mouse and cursor handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 302
diff changeset
98 cls.cursor = item.CURSOR
3476e8f3b100 Fixed mouse and cursor handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 302
diff changeset
99 if cls.cursor != cls._loaded_cursor:
3476e8f3b100 Fixed mouse and cursor handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 302
diff changeset
100 cls._loaded_cursor = cls.cursor
3476e8f3b100 Fixed mouse and cursor handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 302
diff changeset
101 if cls.cursor is None:
3476e8f3b100 Fixed mouse and cursor handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 302
diff changeset
102 pygame.mouse.set_visible(1)
3476e8f3b100 Fixed mouse and cursor handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 302
diff changeset
103 cls._cursor_group.empty()
3476e8f3b100 Fixed mouse and cursor handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 302
diff changeset
104 else:
3476e8f3b100 Fixed mouse and cursor handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 302
diff changeset
105 pygame.mouse.set_visible(0)
3476e8f3b100 Fixed mouse and cursor handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 302
diff changeset
106 cls.cursor.load()
3476e8f3b100 Fixed mouse and cursor handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 302
diff changeset
107 cls._cursor_group.empty()
3476e8f3b100 Fixed mouse and cursor handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 302
diff changeset
108 cls._cursor_group.add(cls.cursor)
135
b43599b7f8a2 Cursor highlights
Stefano Rivera <stefano@rivera.za.net>
parents: 129
diff changeset
109
324
3476e8f3b100 Fixed mouse and cursor handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 302
diff changeset
110 def cursor_highlight(self):
401
92029c76b687 Different toolbar colour and remove highlighted cursor outside scene widget.
Jeremy Thurgood <firxen@gmail.com>
parents: 324
diff changeset
111 if not Rect((0, 0), SCENE_SIZE).collidepoint(pygame.mouse.get_pos()):
92029c76b687 Different toolbar colour and remove highlighted cursor outside scene widget.
Jeremy Thurgood <firxen@gmail.com>
parents: 324
diff changeset
112 return False
603
3ce19d33b51f Rename state to game to not cause confusion with the other state
Neil Muller <neil@dip.sun.ac.za>
parents: 576
diff changeset
113 if self.screen.game.highlight_override:
324
3476e8f3b100 Fixed mouse and cursor handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 302
diff changeset
114 return True
603
3ce19d33b51f Rename state to game to not cause confusion with the other state
Neil Muller <neil@dip.sun.ac.za>
parents: 576
diff changeset
115 current_thing = self.screen.game.current_thing
324
3476e8f3b100 Fixed mouse and cursor handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 302
diff changeset
116 if current_thing:
3476e8f3b100 Fixed mouse and cursor handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 302
diff changeset
117 return current_thing.is_interactive()
3476e8f3b100 Fixed mouse and cursor handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 302
diff changeset
118 return False