#include <CCActionGrid3D.h>

Inheritance diagram for Lens3D:

Public Member Functions
float	getLensEffect () const
	Get the value of lens effect. More...

void	setLensEffect (float lensEffect)
	Set the value of lens effect. More...

var	setLensEffect ( var lensEffect)
	Set the value of lens effect. More...

local	setLensEffect ( local lensEffect)
	Set the value of lens effect. More...

void	setConcave (bool concave)
	Set whether lens is concave. More...

var	setConcave ( var concave)
	Set whether lens is concave. More...

local	setConcave ( local concave)
	Set whether lens is concave. More...

const Vec2 &	getPosition () const
	Get the center position of lens effect. More...

local	getPosition ()
	Get the center position of lens effect. More...

void	setPosition (const Vec2 &position)
	Set the center position of lens effect. More...

var	setPosition ( var position)
	Set the center position of lens effect. More...

local	setPosition ( local position)
	Set the center position of lens effect. More...

virtual Lens3D *	clone () 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
virtual GridBase *	getGrid () override
	Get the pointer of GridBase. More...

local	getGrid ()
	Get the pointer of GridBase. More...

Vec3	getVertex (const Vec2 &position) const
	Get the vertex that belongs to certain position in the grid. More...

var	vertex ( var position)
	Get the vertex that belongs to certain position in the grid. More...

Vec3	vertex (const Vec2 &position)
Vec3	getOriginalVertex (const Vec2 &position) const
	Get the non-transformed vertex that belongs to certain position in the grid. More...

Vec3	originalVertex (const Vec2 &position)
void	setVertex (const Vec2 &position, const Vec3 &vertex)
	Set a new vertex to a certain position of the grid. More...

Public Member Functions inherited from GridAction
virtual GridAction *	reverse () const override
	Returns a new action that performs the exactly the reverse action. More...

var	reverse ()
	Returns a new action that performs the exactly the reverse action. More...

local	reverse ()
	Returns a new action that performs the exactly the reverse action. More...

virtual void	startWithTarget (Node *target) override
	Called before the action start. More...

local	startWithTarget ( local target)
	Called before the action start. 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)
	Sets the ampliture rate, extension in GridAction. More...

local	setAmplitudeRate ( local amp)
	Sets the ampliture rate, extension in GridAction. More...

float	getAmplitudeRate (void)
	Gets the ampliture rate, extension in GridAction. More...

local	getAmplitudeRate ()
	Gets the ampliture rate, extension in GridAction. More...

virtual bool	isDone (void) const override
	Return true if the action has finished. More...

local	isDone ()
	Return true if the action has finished. More...

virtual void	step (float dt) override
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...

Node *	getTarget () const
	Return certain target. More...

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...

Node *	getOriginalTarget () const
	Return a original Target. More...

var	getOriginalTarget ()
	Return a original Target. More...

local	getOriginalTarget ()
	Return a original Target. More...

void	setOriginalTarget (Node *originalTarget)
	Set the original target, since target can be nil. More...

int	getTag () const
	Returns a tag that is used to identify the action easily. More...

var	getTag ()
	Returns a tag that is used to identify the action easily. More...

local	getTag ()
	Returns a tag that is used to identify the action easily. More...

void	setTag (int tag)
	Changes the tag that is used to identify the action easily. More...

var	setTag ( var tag)
	Changes the tag that is used to identify the action easily. More...

local	setTag ( local tag)
	Changes the tag that is used to identify the action easily. More...

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...

Ref *	autorelease ()
	Releases the ownership sometime soon automatically. More...

unsigned int	getReferenceCount () const
	Returns the Ref's current reference count. More...

virtual	~Ref ()
	Destructor. More...

Public Member Functions inherited from Clonable
virtual	~Clonable ()
Ref *	copy () const
	Returns a copy of the Ref. More...

Static Public Member Functions
static Lens3D *	create (float duration, const Size &gridSize, const Vec2 &position, float radius)
	Create the action with center position, radius, a grid size and duration. More...

local	create ( local duration, local gridSize, local position, local radius)
	Create the action with center position, radius, a grid size and duration. More...

Public Attributes
CC_CONSTRUCTOR_ACCESS	__pad0__: Lens3D() {} virtual ~Lens3D() {} bool initWithDuration(float duration
CC_CONSTRUCTOR_ACCESS const Size &	gridSize
var	gridSize
local	gridSize
CC_CONSTRUCTOR_ACCESS const Size const Vec2 &	position
var	position
local	position
CC_CONSTRUCTOR_ACCESS const Size const Vec2 float	radius
Public Attributes inherited from GridAction
CC_CONSTRUCTOR_ACCESS	__pad0__: GridAction() {} virtual ~GridAction() {} bool initWithDuration(float duration
CC_CONSTRUCTOR_ACCESS const Size &	gridSize
var	gridSize
local	gridSize
Public Attributes inherited from ActionInterval
CC_CONSTRUCTOR_ACCESS	__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()

Protected Attributes
Vec2	_position
var	_position
local	_position
float	_radius
var	_radius
local	_radius
float	_lensEffect
	lens effect. More...

var	_lensEffect
	lens effect. More...

local	_lensEffect
	lens effect. More...

bool	_concave
	lens is concave. More...

bool	_dirty
Protected Attributes inherited from GridAction
Size	_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...

Additional Inherited Members
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...

Detailed Description

Lens3D action.

This action is used for take effect on the target node as lens. You can create the action by these parameters: duration, grid size, center position of lens, radius of lens. Also you can change the lens effect value & whether effect is concave by the setter methods.

Member Function Documentation

virtual Lens3D* clone ( ) const

overridevirtual

Returns a clone of action.

Returns: A clone action.

Reimplemented from Grid3DAction.

var clone ( )

overridevirtual

Returns a clone of action.

Returns: A clone action.

Reimplemented from Grid3DAction.

local clone ( )

overridevirtual

Returns a clone of action.

Returns: A clone action.

Reimplemented from Grid3DAction.

static Lens3D* create	(	float	duration,
		const Size &	gridSize,
		const Vec2 &	position,
		float	radius
	)

static

Create the action with center position, radius, a grid size and duration.

Parameters

duration	Specify the duration of the Lens3D action. It's a value in seconds.
gridSize	Specify the size of the grid.
position	Specify the center position of the lens.
radius	Specify the radius of the lens.

Returns: If the creation sucess, return a pointer of Lens3D action; otherwise, return nil.

var create	(	var	duration,
		var	gridSize,
		var	position,
		var	radius
	)

static

Create the action with center position, radius, a grid size and duration.

Parameters

duration	Specify the duration of the Lens3D action. It's a value in seconds.
gridSize	Specify the size of the grid.
position	Specify the center position of the lens.
radius	Specify the radius of the lens.

Returns: If the creation sucess, return a pointer of Lens3D action; otherwise, return nil.

local create	(	local	duration,
		local	gridSize,
		local	position,
		local	radius
	)

static

Create the action with center position, radius, a grid size and duration.

Parameters

duration	Specify the duration of the Lens3D action. It's a value in seconds.
gridSize	Specify the size of the grid.
position	Specify the center position of the lens.
radius	Specify the radius of the lens.

Returns: If the creation sucess, return a pointer of Lens3D action; otherwise, return nil.

float getLensEffect ( ) const

inline

Get the value of lens effect.

Default value is 0.7.

Returns: The value of lens effect.

var getLensEffect ( )

inline

Get the value of lens effect.

Default value is 0.7.

Returns: The value of lens effect.

local getLensEffect ( )

inline

Get the value of lens effect.

Default value is 0.7.

Returns: The value of lens effect.

const Vec2& getPosition ( ) const

inline

Get the center position of lens effect.

Returns: The center position of lens effect.

var getPosition ( )

inline

Get the center position of lens effect.

Returns: The center position of lens effect.

local getPosition ( )

inline

Get the center position of lens effect.

Returns: The center position of lens effect.

void setConcave ( bool concave )

inline

Set whether lens is concave.

Parameters

concave Whether lens is concave.

var setConcave ( var concave )

inline

Set whether lens is concave.

Parameters

concave Whether lens is concave.

local setConcave ( local concave )

inline

Set whether lens is concave.

Parameters

concave Whether lens is concave.

void setLensEffect ( float lensEffect )

inline

Set the value of lens effect.

Parameters

lensEffect The value of lens effect will be set.

var setLensEffect ( var lensEffect )

inline

Set the value of lens effect.

Parameters

lensEffect The value of lens effect will be set.

local setLensEffect ( local lensEffect )

inline

Set the value of lens effect.

Parameters

lensEffect The value of lens effect will be set.

void setPosition ( const Vec2 & position )

Set the center position of lens effect.

Parameters

The	center position will be set.

var setPosition ( var position )

Set the center position of lens effect.

Parameters

The	center position will be set.

local setPosition ( local position )

Set the center position of lens effect.

Parameters

The	center position will be set.

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.

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.

Parameters

time	A value between 0 and 1.

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.

Parameters

time	A value between 0 and 1.

Reimplemented from Action.

Member Data Documentation

CC_CONSTRUCTOR_ACCESS __pad0__

bool _concave

protected

lens is concave.

(true = concave, false = convex) default is convex i.e. false

var _concave

protected

lens is concave.

(true = concave, false = convex) default is convex i.e. false

local _concave

protected

lens is concave.

(true = concave, false = convex) default is convex i.e. false

bool _dirty

protected

var _dirty

protected

local _dirty

protected

float _lensEffect

protected

lens effect.

Defaults to 0.7 - 0 means no effect, 1 is very strong effect

var _lensEffect

protected

lens effect.

Defaults to 0.7 - 0 means no effect, 1 is very strong effect

local _lensEffect

protected

lens effect.

Defaults to 0.7 - 0 means no effect, 1 is very strong effect

Vec2 _position

protected

var _position

protected

local _position

protected

float _radius

protected

var _radius

protected

local _radius

protected

CC_CONSTRUCTOR_ACCESS const
Size& gridSize

var gridSize

local gridSize

CC_CONSTRUCTOR_ACCESS const
Size const Vec2& position

var position

local position

CC_CONSTRUCTOR_ACCESS const
Size const Vec2 float radius

var radius

local radius

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

/Users/minggo/SourceCode/cocos2d-x/cocos/2d/CCActionGrid3D.h

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

Member Data Documentation