Loading [MathJax]/jax/input/TeX/config.js

⚠️ This documentation corresponds to the latest development branch of axmol. It might diverge from the official releases.

 
Axmol Engine 2.4.0-ce063c5
All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Modules Pages
Loading...
Searching...
No Matches
GridAction Class Reference

Base class for Grid actions. More...

#include <ActionGrid.h>

Inherits ActionInterval.

Inherited by Grid3DAction, and TiledGrid3DAction.

Public Member Functions

virtual GridBasegetGrid ()
 Get the pointer of GridBase.
 
bool initWithDuration (float duration, const Vec2 &gridSize)
 Initializes the action with size and duration.
 
- Public Member Functions inherited from ActionInterval
float getElapsed ()
 How many seconds had elapsed since the actions started to run.
 
void setAmplitudeRate (float amp)
 Sets the amplitude rate, extension in GridAction.
 
float getAmplitudeRate ()
 Gets the amplitude rate, extension in GridAction.
 
virtual void step (float dt) override
 
bool initWithDuration (float d)
 initializes the action
 

Detailed Description

Base class for Grid actions.

Grid actions are the actions take effect on GridBase.

Member Function Documentation

◆ getGrid()

virtual GridBase * getGrid ( )
virtual

Get the pointer of GridBase.

Returns
The pointer of GridBase.

Reimplemented in Grid3DAction, PageTurn3D, and TiledGrid3DAction.

◆ initWithDuration()

bool initWithDuration ( float duration,
const Vec2 & gridSize )

Initializes the action with size and duration.

Parameters
durationThe duration of the GridAction. It's a value in seconds.
gridSizeThe size of the GridAction should be.
Returns
Return true when the initialization success, otherwise return false.

The documentation for this class was generated from the following file: