Cocos2d-x  v3.17
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups Pages
Lens3D Class Reference

Lens3D action. More...

Inherits Grid3DAction.

Public Member Functions

float getLensEffect () const
 Get the value of lens effect. More...
 
local getLensEffect ()
 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 Vec2getPosition () 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 Lens3Dclone () const override
 Returns a clone of action. More...
 
var clone ()
 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 GridBasegetGrid () override
 Get the pointer of GridBase. More...
 
var getGrid ()
 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...
 
Rect getGridRect () const
 Get the effect grid rect. More...
 
var getGridRect ()
 Get the effect grid rect. More...
 
local getGridRect ()
 Get the effect grid rect. More...
 
- Public Member Functions inherited from GridAction
virtual GridActionreverse () const override
 Returns a new action that performs the exact reverse of the action. More...
 
local reverse ()
 Returns a new action that performs the exact reverse of the 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 ()
 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 amplitude rate, extension in GridAction. More...
 
float getAmplitudeRate ()
 Gets the amplitude rate, extension in GridAction. More...
 
var getAmplitudeRate ()
 Gets the amplitude rate, extension in GridAction. More...
 
local getAmplitudeRate ()
 Gets the amplitude rate, extension in GridAction. More...
 
virtual bool isDone () const override
 Return true if the action has finished. More...
 
var 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...
 
local setDuration ( local duration)
 Set duration in seconds of the action. More...
 
- Public Member Functions inherited from Action
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
 Return certain target. More...
 
var getTarget ()
 Return certain target. More...
 
local getTarget ()
 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...
 
NodegetOriginalTarget () 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...
 
local setOriginalTarget ( local 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...
 
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...
 
unsigned int getFlags () const
 Returns a flag field that is used to group the actions easily. More...
 
var getFlags ()
 Returns a flag field that is used to group the actions easily. More...
 
local getFlags ()
 Returns a flag field that is used to group the actions easily. More...
 
void setFlags (unsigned int flags)
 Changes the flag field that is used to group the actions easily. More...
 
- Public Member Functions inherited from Ref
void retain ()
 Retains the ownership. More...
 
void release ()
 Releases the ownership immediately. More...
 
local 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 ()
 Destructor. More...
 
- Public Member Functions inherited from Clonable
Refcopy () const
 Returns a copy of the Ref. More...
 

Static Public Member Functions

static Lens3Dcreate (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...
 

Protected Member Functions

bool initWithDuration (float duration, const Size &gridSize, const Vec2 &position, float radius)
 Initializes the action with center position, radius, grid size and duration. More...
 
var initWithDuration ( var duration, var gridSize, var position, var radius)
 Initializes the action with center position, radius, grid size and duration. More...
 
local initWithDuration ( local duration, local gridSize, local position, local radius)
 Initializes the action with center position, radius, grid size and duration. More...
 
- Protected Member Functions inherited from GridAction
bool initWithDuration (float duration, const Size &gridSize)
 Initializes the action with size and duration. More...
 
var initWithDuration ( var duration, var gridSize)
 Initializes the action with size and duration. More...
 
local initWithDuration ( local duration, local gridSize)
 Initializes the action with size and duration. More...
 
- Protected Member Functions inherited from ActionInterval
bool initWithDuration (float d)
 initializes the action
 
var initWithDuration ( var d)
 initializes the action
 
local initWithDuration ( local d)
 initializes the action
 

Additional Inherited Members

- Public Attributes inherited from Ref
unsigned int _ID
 object id, ScriptSupport need public _ID
 
local _ID
 object id, ScriptSupport need public _ID
 
int _luaID
 Lua reference id.
 
local _luaID
 Lua reference id.
 
void * _scriptObject
 scriptObject, support for swift
 
local _scriptObject
 scriptObject, support for swift
 
bool _rooted
 When true, it means that the object was already rooted.
 
local _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. 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...
 

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

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
durationSpecify the duration of the Lens3D action. It's a value in seconds.
gridSizeSpecify the size of the grid.
positionSpecify the center position of the lens.
radiusSpecify the radius of the lens.
Returns
If the creation success, 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
durationSpecify the duration of the Lens3D action. It's a value in seconds.
gridSizeSpecify the size of the grid.
positionSpecify the center position of the lens.
radiusSpecify the radius of the lens.
Returns
If the creation success, 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
durationSpecify the duration of the Lens3D action. It's a value in seconds.
gridSizeSpecify the size of the grid.
positionSpecify the center position of the lens.
radiusSpecify the radius of the lens.
Returns
If the creation success, 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.
void setLensEffect ( float  lensEffect)
inline

Set the value of lens effect.

Parameters
lensEffectThe value of lens effect will be set.
var setLensEffect ( var  lensEffect)
inline

Set the value of lens effect.

Parameters
lensEffectThe value of lens effect will be set.
local setLensEffect ( local  lensEffect)
inline

Set the value of lens effect.

Parameters
lensEffectThe value of lens effect will be set.
void setConcave ( bool  concave)
inline

Set whether lens is concave.

Parameters
concaveWhether lens is concave.
var setConcave ( var  concave)
inline

Set whether lens is concave.

Parameters
concaveWhether lens is concave.
local setConcave ( local  concave)
inline

Set whether lens is concave.

Parameters
concaveWhether lens is concave.
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 setPosition ( const Vec2 position)

Set the center position of lens effect.

Parameters
positionThe center position will be set.
var setPosition ( var  position)

Set the center position of lens effect.

Parameters
positionThe center position will be set.
local setPosition ( local  position)

Set the center position of lens effect.

Parameters
positionThe center position will be set.
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.

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
timeA 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
timeA 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
timeA value between 0 and 1.

Reimplemented from Action.

bool initWithDuration ( float  duration,
const Size &  gridSize,
const Vec2 position,
float  radius 
)
protected

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

Parameters
durationSpecify the duration of the Lens3D action. It's a value in seconds.
gridSizeSpecify the size of the grid.
positionSpecify the center position of the lens effect.
radiusSpecify the radius of the lens effect.
Returns
If the initialization success, return true; otherwise, return false.
var initWithDuration ( var  duration,
var  gridSize,
var  position,
var  radius 
)
protected

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

Parameters
durationSpecify the duration of the Lens3D action. It's a value in seconds.
gridSizeSpecify the size of the grid.
positionSpecify the center position of the lens effect.
radiusSpecify the radius of the lens effect.
Returns
If the initialization success, return true; otherwise, return false.
local initWithDuration ( local  duration,
local  gridSize,
local  position,
local  radius 
)
protected

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

Parameters
durationSpecify the duration of the Lens3D action. It's a value in seconds.
gridSizeSpecify the size of the grid.
positionSpecify the center position of the lens effect.
radiusSpecify the radius of the lens effect.
Returns
If the initialization success, return true; otherwise, return false.

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