PageTurn3D Class Reference

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

Inherits Grid3DAction.

Public Member Functions
virtual GridBase *	getGrid () override
	NA
virtual PageTurn3D *	clone () const override
	Returns a clone of action.
virtual void	update (float time) override
	Called once per frame.
Public Member Functions inherited from Grid3DAction
Vec3	getVertex (const Vec2 &position) const
	Get the vertex that belongs to certain position in the grid.
Vec3	getOriginalVertex (const Vec2 &position) const
	Get the non-transformed vertex that belongs to certain position in the grid.
void	setVertex (const Vec2 &position, const Vec3 &vertex)
	Set a new vertex to a certain position of the grid.
Rect	getGridRect () const
	Get the effect grid rect.
Public Member Functions inherited from GridAction
virtual GridAction *	reverse () const override
	Returns a new action that performs the exact reverse of the action.
virtual void	startWithTarget (Node *target) override
	Called before the action start.
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 bool	isDone () const override
	Return true if the action has finished.
virtual void	step (float dt) override
Public Member Functions inherited from FiniteTimeAction
float	getDuration () const
	Get duration in seconds of the action.
void	setDuration (float duration)
	Set duration in seconds of the action.
Public Member Functions inherited from Action
virtual std::string	description () const
	NA NA
virtual void	stop ()
	Called after the action has finished.
Node *	getTarget () const
	Return certain target.
void	setTarget (Node *target)
	The action will modify the target properties.
Node *	getOriginalTarget () const
	Return a original Target.
void	setOriginalTarget (Node *originalTarget)
	Set the original target, since target can be nil.
int	getTag () const
	Returns a tag that is used to identify the action easily.
void	setTag (int tag)
	Changes the tag that is used to identify the action easily.
unsigned int	getFlags () const
	Returns a flag field that is used to group the actions easily.
void	setFlags (unsigned int flags)
	Changes the flag field that is used to group the actions easily.
Public Member Functions inherited from Ref
void	retain ()
	Retains the ownership.
void	release ()
	Releases the ownership immediately.
Ref *	autorelease ()
	Releases the ownership sometime soon automatically.
unsigned int	getReferenceCount () const
	Returns the Ref's current reference count.
virtual	~Ref ()
	Destructor.
Public Member Functions inherited from Clonable
virtual	~Clonable ()
	NA NA

Static Public Member Functions
static PageTurn3D *	create (float duration, const Size &gridSize)
	Create an action with duration, grid size.

Additional Inherited Members
Public Attributes inherited from Ref
unsigned int	_ID
	object id, ScriptSupport need public _ID
int	_luaID
	Lua reference id.
void *	_scriptObject
	scriptObject, support for swift
bool	_rooted
	When true, it means that the object was already rooted.
Static Public Attributes inherited from Action
static const int	INVALID_TAG = -1
	Default tag used for all the actions.
Protected Member Functions inherited from GridAction
bool	initWithDuration (float duration, const Size &gridSize)
	Initializes the action with size and duration.

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

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

static

Create an action with duration, grid size.

Parameters

duration	Specify the duration of the PageTurn3D action. It's a value in seconds.
gridSize	Specify the size of the grid.

Returns

If the creation success, return a pointer of PageTurn3D action; otherwise, return nil.

virtual PageTurn3D* clone ( ) const

overridevirtual

Returns a clone of action.

Returns

A clone action.

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.

Parameters

time	A value between 0 and 1.

Reimplemented from Action.

---

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

• CCActionPageTurn3D.h