cocos2d-x  3.0rc1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Lens3D Class Reference

Lens3D action. More...

#include <CCActionGrid3D.h>

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

Public Member Functions

float getLensEffect () const
 Get lens center position. More...
 
void setLensEffect (float lensEffect)
 Set lens center position. More...
 
void setConcave (bool concave)
 Set whether lens is concave. More...
 
const PointgetPosition () const
void setPosition (const Point &position)
virtual Lens3Dclone () const override
 returns a clone of action More...
 
virtual void update (float time) override
 called once per frame. More...
 
- Public Member Functions inherited from Grid3DAction
virtual GridBasegetGrid ()
 returns the grid More...
 
Vertex3F getVertex (const Point &position) const
 returns the vertex than belongs to certain position in the grid More...
 
CC_DEPRECATED_ATTRIBUTE Vertex3F vertex (const Point &position)
Vertex3F getOriginalVertex (const Point &position) const
 returns the non-transformed vertex than belongs to certain position in the grid More...
 
CC_DEPRECATED_ATTRIBUTE Vertex3F originalVertex (const Point &position)
void setVertex (const Point &position, const Vertex3F &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...
 
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. 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...
 
void setAmplitudeRate (float amp)
float getAmplitudeRate (void)
virtual bool isDone (void) const override
 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...
 
void setDuration (float 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
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
local getOriginalTarget ()
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
void setTag (int tag)
var setTag ( var tag)
local setTag ( local tag)
- Public Member Functions inherited from Ref
void retain ()
 Retains the ownership. More...
 
void release ()
 Release the ownership immediately. More...
 
local release ()
 Release the ownership immediately. More...
 
Refautorelease ()
 Release the ownership sometime soon automatically. More...
 
unsigned int getReferenceCount () const
 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 Lens3Dcreate (float duration, const Size &gridSize, const Point &position, float radius)
 creates the action with center position, radius, a grid size and duration More...
 

Protected Member Functions

 Lens3D ()
virtual ~Lens3D ()
bool initWithDuration (float duration, const Size &gridSize, const Point &position, float radius)
 initializes the action with center position, radius, a grid size and duration More...
 

Protected Attributes

Point _position
float _radius
float _lensEffect
 lens effect. More...
 
bool _concave
 lens is concave. More...
 
bool _dirty

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

Detailed Description

Lens3D action.

Constructor & Destructor Documentation

Lens3D ( )
inlineprotected
virtual ~Lens3D ( )
inlineprotectedvirtual

Member Function Documentation

virtual Lens3D* clone ( ) const
overridevirtual

returns a clone of action

Implements Grid3DAction.

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

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

float getLensEffect ( ) const
inline

Get lens center position.

const Point& getPosition ( ) const
inline
bool initWithDuration ( float  duration,
const Size gridSize,
const Point position,
float  radius 
)
protected

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

void setConcave ( bool  concave)
inline

Set whether lens is concave.

void setLensEffect ( float  lensEffect)
inline

Set lens center position.

void setPosition ( const Point position)
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.

Member Data Documentation

bool _concave
protected

lens is concave.

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

bool _dirty
protected
float _lensEffect
protected

lens effect.

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

Point _position
protected
float _radius
protected

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