~facundo/enjuewemela/trunk

« back to all changes in this revision

Viewing changes to cocos/actions/basegrid_actions.py

  • Committer: facundo at com
  • Date: 2010-11-20 01:41:24 UTC
  • mto: This revision was merged to the branch mainline in revision 63.
  • Revision ID: facundo@taniquetil.com.ar-20101120014124-zjyxkchmvili5m2u
Project reorder!

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# ----------------------------------------------------------------------------
 
2
# cocos2d
 
3
# Copyright (c) 2008 Daniel Moisset, Ricardo Quesada, Rayentray Tappa, Lucio Torre
 
4
# All rights reserved.
 
5
#
 
6
# Redistribution and use in source and binary forms, with or without
 
7
# modification, are permitted provided that the following conditions are met:
 
8
#
 
9
#   * Redistributions of source code must retain the above copyright
 
10
#     notice, this list of conditions and the following disclaimer.
 
11
#   * Redistributions in binary form must reproduce the above copyright 
 
12
#     notice, this list of conditions and the following disclaimer in
 
13
#     the documentation and/or other materials provided with the
 
14
#     distribution.
 
15
#   * Neither the name of cocos2d nor the names of its
 
16
#     contributors may be used to endorse or promote products
 
17
#     derived from this software without specific prior written
 
18
#     permission.
 
19
#
 
20
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 
21
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 
22
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 
23
# FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 
24
# COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 
25
# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 
26
# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 
27
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 
28
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 
29
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 
30
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 
31
# POSSIBILITY OF SUCH DAMAGE.
 
32
# ----------------------------------------------------------------------------
 
33
'''Grid Actions
 
34
 
 
35
Grid Actions
 
36
============
 
37
 
 
38
There are 2 kinds of grids:
 
39
 
 
40
  - `Grid3D` : A 3D grid with x,y and z coordinates
 
41
  - `TiledGrid3D` : A 3D grid with x,y and z coordinates, composed
 
42
     with independent tiles
 
43
 
 
44
 
 
45
Hence, there are 2 kinds of grid actions:
 
46
 
 
47
  - `Grid3DAction`
 
48
  - `TiledGrid3DAction`
 
49
 
 
50
The `Grid3DAction` can modify any of vertex of the grid in any direction (x,y or z).
 
51
The `TiledGrid3DAction` can modify any tile of the grid without modifying the adjacent tiles.
 
52
 
 
53
To understand visually the difference between these 2 kinds of grids, try these examples:
 
54
 
 
55
  - run ``test/test_shakytiles3d.py`` to see a `TiledGrid3DAction` example 
 
56
  - run ``test/test_shaky3d.py`` to see the `Grid3DAction` counterpart
 
57
'''
 
58
 
 
59
__docformat__ = 'restructuredtext'
 
60
 
 
61
from pyglet.gl import *
 
62
 
 
63
from cocos.grid import Grid3D, TiledGrid3D
 
64
from cocos.director import director
 
65
from cocos.euclid import *
 
66
from base_actions import *
 
67
 
 
68
__all__ = [ 'GridException',            # Grid Exceptions
 
69
            'GridBaseAction',               # Base classes
 
70
            'Grid3DAction',
 
71
            'TiledGrid3DAction',
 
72
            
 
73
            'AccelAmplitude',           # Amplitude modifiers
 
74
            'DeccelAmplitude',
 
75
            'AccelDeccelAmplitude',
 
76
            
 
77
            'StopGrid',
 
78
            'ReuseGrid',
 
79
            ]
 
80
 
 
81
class GridException( Exception ):
 
82
    pass
 
83
    
 
84
class GridBaseAction( IntervalAction ):
 
85
    '''GridBaseAction is the base class of all Grid Actions.'''
 
86
    def init( self, grid=(4,4), duration=5):
 
87
        """Initialize the Grid Action
 
88
 
 
89
        :Parameters:
 
90
            `grid` : (int,int)
 
91
                Number of horizontal and vertical quads in the grid
 
92
            `duration` : int 
 
93
                Number of seconds that the action will last
 
94
        """
 
95
        self.duration = duration
 
96
        if not isinstance(grid,Point2):
 
97
            grid = Point2( *grid)
 
98
        self.grid = grid
 
99
 
 
100
    def start( self ):        
 
101
        new_grid = self.get_grid()
 
102
 
 
103
        if self.target.grid and self.target.grid.reuse_grid > 0:                
 
104
            # Reusing the grid 
 
105
            if self.target.grid.active \
 
106
                    and self.grid == self.target.grid.grid \
 
107
                    and type(new_grid) == type(self.target.grid):
 
108
                # since we are reusing the grid,
 
109
                # we must "cheat" the action that the original vertex coords are
 
110
                # the ones that were inhereted.
 
111
                self.target.grid.vertex_points = self.target.grid.vertex_list.vertices[:]
 
112
                self.target.grid.reuse_grid -= 1
 
113
                self.target.grid.reuse_grid = max(0, self.target.grid.reuse_grid)
 
114
            else:
 
115
                # condition are not met
 
116
                raise GridException("Cannot reuse grid. class grid or grid size did not match: %s vs %s and %s vs %s"
 
117
                                    % ( str(self.grid), str(self.target.grid.grid), type(new_grid), type(self.target.grid) ) )
 
118
        else:
 
119
            # Not reusing the grid
 
120
            if self.target.grid and self.target.grid.active:
 
121
                self.target.grid.active = False
 
122
            self.target.grid = new_grid
 
123
            self.target.grid.init( self.grid )
 
124
            self.target.grid.active = True
 
125
 
 
126
        x,y = director.get_window_size()
 
127
        self.size_x = x // self.grid.x
 
128
        self.size_y = y // self.grid.y
 
129
      
 
130
    def __reversed__(self):
 
131
        return _ReverseTime(self)
 
132
 
 
133
 
 
134
class Grid3DAction( GridBaseAction ):
 
135
    '''Action that does transformations
 
136
    to a 3D grid ( `Grid3D` )'''
 
137
 
 
138
    def get_grid(self):
 
139
        return Grid3D()
 
140
    
 
141
    def get_vertex( self, x, y):
 
142
        '''Get the current vertex coordinate
 
143
 
 
144
        :Parameters:
 
145
            `x` : int 
 
146
               x-vertex
 
147
            `y` : int
 
148
               y-vertex
 
149
 
 
150
        :rtype: (float, float, float)
 
151
        '''
 
152
        return self.target.grid.get_vertex(x,y)
 
153
 
 
154
    def get_original_vertex( self, x, y):
 
155
        '''Get the original vertex coordinate.
 
156
        The original vertices are the ones weren't modified by the current action.
 
157
 
 
158
        :Parameters:
 
159
            `x` : int 
 
160
               x-vertex
 
161
            `y` : int
 
162
               y-vertex
 
163
 
 
164
        :rtype: (float, float, float)
 
165
        '''
 
166
        return self.target.grid.get_original_vertex(x,y)
 
167
 
 
168
 
 
169
    def set_vertex( self, x, y, v):
 
170
        '''Set a vertex point is a certain value
 
171
 
 
172
        :Parameters:
 
173
            `x` : int 
 
174
               x-vertex
 
175
            `y` : int
 
176
               y-vertex
 
177
            `v` : (float, float, float)
 
178
                tuple value for the vertex
 
179
        '''
 
180
        return self.target.grid.set_vertex(x,y,v)
 
181
 
 
182
 
 
183
class TiledGrid3DAction( GridBaseAction ):
 
184
    '''Action that does transformations
 
185
    to a grid composed of tiles ( `TiledGrid3D` ).
 
186
    You can transform each tile individually'''
 
187
 
 
188
    def get_grid(self):
 
189
        return TiledGrid3D()
 
190
    
 
191
    def set_tile(self, x, y, coords):
 
192
        '''Set the 4 tile coordinates
 
193
 
 
194
        Coordinates positions::
 
195
 
 
196
            3 <-- 2
 
197
                  ^
 
198
                  |
 
199
            0 --> 1
 
200
 
 
201
        :Parameters:
 
202
            `x` : int 
 
203
                x coodinate of the tile
 
204
            `y` : int 
 
205
                y coordinate of the tile
 
206
            `coords` : [ float, float, float, float, float, float, float, float, float, float, float, float ]
 
207
                The 4 coordinates in the format (x0, y0, z0, x1, y1, z1,..., x3, y3, z3)
 
208
        '''
 
209
        return self.target.grid.set_tile(x,y,coords)
 
210
    
 
211
    def get_original_tile(self, x, y):
 
212
        '''Get the 4-original tile coordinates.
 
213
 
 
214
        Coordinates positions::
 
215
 
 
216
            3 <-- 2
 
217
                  ^
 
218
                  |
 
219
            0 --> 1
 
220
 
 
221
        :Parameters:
 
222
            `x` : int
 
223
                x coordinate of the tile
 
224
            `y` : int
 
225
                y coordinate of the tile
 
226
 
 
227
        :rtype: [ float, float, float, float, float, float, float, float, float, float, float, float ]
 
228
        :returns: The 4 coordinates with the following order: x0, y0, z0, x1, y1, z1,...,x3, y3, z3
 
229
        '''
 
230
        return self.target.grid.get_original_tile(x,y)
 
231
 
 
232
    def get_tile(self, x, y):
 
233
        '''Get the current tile coordinates.
 
234
 
 
235
        Coordinates positions::
 
236
 
 
237
            3 <-- 2
 
238
                  ^
 
239
                  |
 
240
            0 --> 1
 
241
 
 
242
        :Parameters:
 
243
            `x` : int
 
244
                x coordinate of the tile
 
245
            `y` : int
 
246
                y coordinate of the tile
 
247
 
 
248
        :rtype: [ float, float, float, float, float, float, float, float, float, float, float, float ]
 
249
        :returns: The 4 coordinates with the following order: x0, y0, z0, x1, y1, z1,...,x3, y3, z3
 
250
        '''
 
251
        return self.target.grid.get_tile(x,y)
 
252
        
 
253
 
 
254
class AccelDeccelAmplitude( IntervalAction ):
 
255
    """
 
256
    Increases and Decreases the amplitude of Wave
 
257
    
 
258
    Example::
 
259
 
 
260
        # when t=0 and t=1 the amplitude will be 0
 
261
        # when t=0.5 (half time), the amplitude will be 40
 
262
        action = AccellDeccelAmplitude( Wave3D( waves=4, amplitude=40, duration=6) )
 
263
        scene.do( action )
 
264
    """
 
265
    def init(self, other, rate=1.0 ):
 
266
        """Init method.
 
267
 
 
268
        :Parameters:
 
269
            `other` : `IntervalAction`
 
270
                The action that will be affected
 
271
            `rate` : float
 
272
                The acceleration rate. 1 is linear (default value)
 
273
        """
 
274
        if not hasattr(other,'amplitude'):
 
275
            raise GridAction("Invalid Composition: IncAmplitude needs an action with amplitude")
 
276
 
 
277
        self.other = other
 
278
        self.rate = rate
 
279
        self.duration = other.duration
 
280
 
 
281
    def start(self):
 
282
        self.other.target = self.target
 
283
        self.other.start()
 
284
 
 
285
    def update(self, t):
 
286
        f = t*2
 
287
        if f > 1:
 
288
            f -= 1
 
289
            f = 1 -f  
 
290
 
 
291
        self.other.amplitude_rate = f**self.rate
 
292
        self.other.update( t )
 
293
 
 
294
    def __reversed__(self):
 
295
        return AccelDeccelAmplitude( Reverse(self.other) )
 
296
 
 
297
class AccelAmplitude( IntervalAction ):
 
298
    """
 
299
    Increases the waves amplitude from 0 to self.amplitude
 
300
    
 
301
    Example::
 
302
 
 
303
        # when t=0 the amplitude will be 0
 
304
        # when t=1 the amplitude will be 40
 
305
        action = AccelAmplitude( Wave3D( waves=4, amplitude=40, duration=6), rate=1.0 )
 
306
        scene.do( action )
 
307
    """
 
308
    def init(self, other, rate=1 ):
 
309
        """Init method.
 
310
 
 
311
        :Parameters:
 
312
            `other` : `IntervalAction`
 
313
                The action that will be affected
 
314
            `rate` : float
 
315
                The acceleration rate. 1 is linear (default value)
 
316
        """
 
317
        if not hasattr(other,'amplitude'):
 
318
            raise GridAction("Invalid Composition: IncAmplitude needs an action with amplitude")
 
319
        
 
320
        self.other = other
 
321
        self.duration = other.duration
 
322
        self.rate = rate
 
323
 
 
324
    def start(self):
 
325
        self.other.target = self.target
 
326
        self.other.start()
 
327
 
 
328
    def update(self, t):
 
329
        self.other.amplitude_rate = (t ** self.rate)
 
330
        self.other.update( t )
 
331
 
 
332
    def __reversed__(self):
 
333
        return DeccelAmplitude( Reverse(self.other), rate=self.rate )
 
334
 
 
335
 
 
336
class DeccelAmplitude( AccelAmplitude ):
 
337
    """
 
338
    Decreases the waves amplitude from self.amplitude to 0
 
339
    
 
340
    Example::
 
341
 
 
342
        # when t=1 the amplitude will be 0
 
343
        # when t=0 the amplitude will be 40
 
344
        action = DeccelAmplitude( Wave3D( waves=4, amplitude=40, duration=6), rate=1.0 )
 
345
        scene.do( action )
 
346
    """
 
347
 
 
348
    def update(self, t):
 
349
        self.other.amplitude_rate = ((1-t) ** self.rate)
 
350
        self.other.update( t )
 
351
 
 
352
    def __reversed__(self):
 
353
        return AccelAmplitude( Reverse(self.other), rate=self.rate )
 
354
 
 
355
 
 
356
class StopGrid( InstantAction ):
 
357
    """StopGrid disables the current grid.
 
358
    Every grid action, after finishing, leaves the screen with a certain grid figure.
 
359
    This figure will be displayed until StopGrid or another Grid action is executed.
 
360
    
 
361
    Example::
 
362
    
 
363
        scene.do( Waves3D( duration=2) + StopGrid() )
 
364
    """
 
365
    def update(self, t):
 
366
        if self.target.grid and self.target.grid.active:
 
367
            self.target.grid.active = False
 
368
 
 
369
class ReuseGrid( InstantAction ):
 
370
    """Will reuse the current grid for the next grid action.
 
371
    The next grid action must have these properties:
 
372
    
 
373
        - Be of the same class as the current one ( `Grid3D` or `TiledGrid3D` )
 
374
        - Have the same size
 
375
    
 
376
    If these condition are met, then the next grid action will receive as the ``original vertex``
 
377
    or ``original tiles`` the current ones.
 
378
    
 
379
    Example::
 
380
    
 
381
        scene.do( Waves3D( duration=2) + ReuseGrid() + Lens3D(duration=2) )
 
382
    """
 
383
    def init(self, reuse_times=1):
 
384
        '''
 
385
        :Parameters:
 
386
            `reuse_times` : int
 
387
                Number of times that the current grid will be reused by Grid actions. Default: 1
 
388
        '''
 
389
        self.reuse_times = reuse_times
 
390
    def start(self):
 
391
        if self.target.grid and self.target.grid.active:
 
392
            self.target.grid.reuse_grid += self.reuse_times
 
393
        else:
 
394
            raise GridException("ReuseGrid must be used when a grid is still active")