Class cocos.actions.grid3d_actions.Waves

             object --+                
                      |                
    base_actions.Action --+            
                          |            
base_actions.IntervalAction --+        
                              |        
basegrid_actions.GridBaseAction --+    
                                  |    
      basegrid_actions.Grid3DAction --+
                                      |
                                     Waves

Simulates waves using the math.sin() function both in the vertical and horizontal axis. The z coordinate is not modified.

Example:

scene.do( Waves( waves=4, amplitude=20, hsin=False, vsin=True, grid=(16,16), duration=10) )

Methods

	init(self, waves=4, amplitude=20, hsin=True, vsin=True, args, *kw) Initializes the Waves actions
	update(self, t) Gets called on every frame.
Inherited from `basegrid_actions.Grid3DAction`: `get_grid`, `get_original_vertex`, `get_vertex`, `set_vertex` Inherited from `basegrid_actions.GridBaseAction`: `__reversed__`, `start` Inherited from `base_actions.IntervalAction`: `done` Inherited from `base_actions.Action`: `__add__`, `__init__`, `__mul__`, `__or__`, `step`, `stop` Inherited from `object`: `__delattr__`, `__getattribute__`, `__hash__`, `__new__`, `__reduce__`, `__reduce_ex__`, `__repr__`, `__setattr__`, `__str__`

Properties

Inherited from object: __class__

Instance Variables

	hsin whether or not it will do horizontal waves
	vsin whether or not it will do vertical waves
	waves total number of wave
	amplitude amplitude of the waves
	amplitude_rate amplitude rate.
Inherited from `base_actions.Action`: `target`

Method Details

init

init(self, waves=4, amplitude=20, hsin=True, vsin=True, *args, **kw)

Initializes the Waves actions

Parameters:

waves : int: Number of waves (2 * pi) that the action will perform. Default is 4
amplitude : int: Wave amplitude (height). Default is 20
hsin : bool: whether or not in will perform horizontal waves. Default is True
vsin : bool: whether or not in will perform vertical waves. Default is True

Overrides:

basegrid_actions.GridBaseAction.init

update

update(self, t)

Gets called on every frame. t is in [0,1] If this action takes 5 seconds to execute, t will be equal to 0 at 0 seconds. t will be 0.5 at 2.5 seconds and t will be 1 at 5sec.

Overrides:: base_actions.IntervalAction.update

Instance Variable Details

amplitude_rate

amplitude rate. Default: 1.0 This value is modified by other actions like AccelAmplitude.