cocos2d-x  3.3rc0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
PageTurn3D Class Reference

This action simulates a page turn from the bottom right hand corner of the screen. More...

#include <CCActionPageTurn3D.h>

Inheritance diagram for PageTurn3D:
Grid3DAction GridAction ActionInterval FiniteTimeAction Action Ref Clonable

Public Member Functions

virtual GridBasegetGrid ()
 returns the grid More...
 
local getGrid ()
 returns the grid More...
 
virtual PageTurn3Dclone () const override
 returns a clone of action More...
 
local clone ()
 returns a clone of action More...
 
virtual void update (float time) override
 called once per frame. More...
 
local update ( local time)
 called once per frame. More...
 
- Public Member Functions inherited from Grid3DAction
Vec3 getVertex (const Vec2 &position) const
 returns the vertex than belongs to certain position in the grid More...
 
Vec3 vertex (const Vec2 &position)
Vec3 getOriginalVertex (const Vec2 &position) const
 returns the non-transformed vertex than belongs to certain position in the grid More...
 
Vec3 originalVertex (const Vec2 &position)
void setVertex (const Vec2 &position, const Vec3 &vertex)
 sets a new vertex to a certain position of the grid More...
 
- Public Member Functions inherited from GridAction
virtual GridActionreverse () const override
 returns a new action that performs the exactly the reverse action More...
 
virtual void startWithTarget (Node *target) override
 called before the action start. It will also set the target. More...
 
local startWithTarget ( local target)
 called before the action start. It will also set the target. More...
 
- Public Member Functions inherited from ActionInterval
float getElapsed (void)
 how many seconds had elapsed since the actions started to run. More...
 
var getElapsed ()
 how many seconds had elapsed since the actions started to run. More...
 
local getElapsed ()
 how many seconds had elapsed since the actions started to run. More...
 
void setAmplitudeRate (float amp)
local setAmplitudeRate ( local amp)
float getAmplitudeRate (void)
local getAmplitudeRate ()
virtual bool isDone (void) const override
 return true if the action has finished More...
 
var isDone ()
 return true if the action has finished More...
 
local isDone ()
 return true if the action has finished More...
 
virtual void step (float dt) override
 called every frame with it's delta time. DON'T override unless you know what you are doing. More...
 
local step ( local dt)
 called every frame with it's delta time. DON'T override unless you know what you are doing. More...
 
- Public Member Functions inherited from FiniteTimeAction
float getDuration () const
 get duration in seconds of the action More...
 
var getDuration ()
 get duration in seconds of the action More...
 
local getDuration ()
 get duration in seconds of the action More...
 
void setDuration (float duration)
 set duration in seconds of the action More...
 
var setDuration ( var duration)
 set duration in seconds of the action More...
 
local setDuration ( local duration)
 set duration in seconds of the action More...
 
- Public Member Functions inherited from Action
virtual std::string description () const
virtual void stop ()
 called after the action has finished. More...
 
var stop ()
 called after the action has finished. More...
 
local stop ()
 called after the action has finished. More...
 
NodegetTarget () const
var getTarget ()
local getTarget ()
void setTarget (Node *target)
 The action will modify the target properties. More...
 
var setTarget ( var target)
 The action will modify the target properties. More...
 
local setTarget ( local target)
 The action will modify the target properties. More...
 
NodegetOriginalTarget () const
var getOriginalTarget ()
local getOriginalTarget ()
void setOriginalTarget (Node *originalTarget)
 Set the original target, since target can be nil. More...
 
var setOriginalTarget ( var originalTarget)
 Set the original target, since target can be nil. More...
 
local setOriginalTarget ( local originalTarget)
 Set the original target, since target can be nil. More...
 
int getTag () const
var getTag ()
local getTag ()
void setTag (int tag)
var setTag ( var tag)
local setTag ( local tag)
virtual ~Action ()
var ~Action ()
local ~Action ()
- Public Member Functions inherited from Ref
void retain ()
 Retains the ownership. More...
 
void release ()
 Releases the ownership immediately. More...
 
Refautorelease ()
 Releases the ownership sometime soon automatically. More...
 
unsigned int getReferenceCount () const
 Returns the Ref's current reference count. More...
 
local getReferenceCount ()
 Returns the Ref's current reference count. More...
 
virtual ~Ref ()
- Public Member Functions inherited from Clonable
virtual ~Clonable ()
Refcopy () const
 returns a copy of the Ref. More...
 
var copy ()
 returns a copy of the Ref. More...
 
local copy ()
 returns a copy of the Ref. More...
 

Static Public Member Functions

static PageTurn3Dcreate (float duration, const Size &gridSize)
 create the action More...
 
var create ( var duration, var gridSize)
 create the action More...
 
local create ( local duration, local gridSize)
 create the action More...
 

Additional Inherited Members

- Public Attributes inherited from GridAction
CC_CONSTRUCTOR_ACCESS __pad0__: GridAction() {} virtual ~GridAction() {} bool initWithDuration(float duration
var __pad0__: GridAction() {} virtual ~GridAction() {} bool initWithDuration(float duration
local __pad0__: GridAction() {} virtual ~GridAction() {} bool initWithDuration(float duration
CC_CONSTRUCTOR_ACCESS const SizegridSize
var gridSize
local gridSize
- Public Attributes inherited from ActionInterval
CC_CONSTRUCTOR_ACCESS __pad0__: bool initWithDuration(float d)
local __pad0__: bool initWithDuration(float d)
- Public Attributes inherited from FiniteTimeAction
CC_CONSTRUCTOR_ACCESS __pad0__: FiniteTimeAction() : _duration(0) {} virtual ~FiniteTimeAction(){}protected: float _duration
var __pad0__: FiniteTimeAction() : _duration(0) {} virtual ~FiniteTimeAction(){}protected: float _duration
local __pad0__: FiniteTimeAction() : _duration(0) {} virtual ~FiniteTimeAction(){}protected: float _duration
- Public Attributes inherited from Action
CC_CONSTRUCTOR_ACCESS __pad0__: Action()
- Static Public Attributes inherited from Action
static const int INVALID_TAG = -1
 Default tag used for all the actions. More...
 
var INVALID_TAG = -1
 Default tag used for all the actions. More...
 
local INVALID_TAG = -1
 Default tag used for all the actions. More...
 
- Protected Member Functions inherited from GridAction
void cacheTargetAsGridNode ()
var cacheTargetAsGridNode ()
local cacheTargetAsGridNode ()
- Protected Member Functions inherited from Ref
 Ref ()
 Constructor. More...
 
 Ref ()
 Constructor. More...
 
- Protected Attributes inherited from GridAction
Size _gridSize
var _gridSize
local _gridSize
NodeGrid_gridNodeTarget
var _gridNodeTarget
local _gridNodeTarget
- Protected Attributes inherited from ActionInterval
float _elapsed
var _elapsed
local _elapsed
bool _firstTick
var _firstTick
local _firstTick
- Protected Attributes inherited from Action
Node_originalTarget
Node_target
 The "target". More...
 
int _tag
 The action tag. More...
 
- Protected Attributes inherited from Ref
unsigned int _referenceCount
 count of references More...
 
local _referenceCount
 count of references More...
 

Detailed Description

This action simulates a page turn from the bottom right hand corner of the screen.

It's not much use by itself but is used by the PageTurnTransition.

Based on an original paper by L Hong et al. http://www.parc.com/publication/1638/turning-pages-of-3d-electronic-books.html

Since
v0.8.2

Member Function Documentation

virtual PageTurn3D* clone ( ) const
overridevirtual

returns a clone of action

Reimplemented from Grid3DAction.

var clone ( )
overridevirtual

returns a clone of action

Reimplemented from Grid3DAction.

local clone ( )
overridevirtual

returns a clone of action

Reimplemented from Grid3DAction.

static PageTurn3D* create ( float  duration,
const Size gridSize 
)
static

create the action

var create ( var  duration,
var  gridSize 
)
static

create the action

local create ( local  duration,
local  gridSize 
)
static

create the action

virtual GridBase* getGrid ( )
virtual

returns the grid

Reimplemented from Grid3DAction.

var getGrid ( )
virtual

returns the grid

Reimplemented from Grid3DAction.

local getGrid ( )
virtual

returns the grid

Reimplemented from Grid3DAction.

virtual void update ( float  time)
overridevirtual

called once per frame.

time a value between 0 and 1

For example:

  • 0 means that the action just started
  • 0.5 means that the action is in the middle
  • 1 means that the action is over

Reimplemented from Action.

var update ( var  time)
overridevirtual

called once per frame.

time a value between 0 and 1

For example:

  • 0 means that the action just started
  • 0.5 means that the action is in the middle
  • 1 means that the action is over

Reimplemented from Action.

local update ( local  time)
overridevirtual

called once per frame.

time a value between 0 and 1

For example:

  • 0 means that the action just started
  • 0.5 means that the action is in the middle
  • 1 means that the action is over

Reimplemented from Action.


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