mirror of https://github.com/axmolengine/axmol.git
451 lines
13 KiB
C++
451 lines
13 KiB
C++
/****************************************************************************
|
|
Copyright (c) 2008-2010 Ricardo Quesada
|
|
Copyright (c) 2010-2012 cocos2d-x.org
|
|
Copyright (c) 2011 Zynga Inc.
|
|
Copyright (c) 2013-2016 Chukong Technologies Inc.
|
|
Copyright (c) 2017-2018 Xiamen Yaji Software Co., Ltd.
|
|
|
|
https://axmolengine.github.io/
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
of this software and associated documentation files (the "Software"), to deal
|
|
in the Software without restriction, including without limitation the rights
|
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
copies of the Software, and to permit persons to whom the Software is
|
|
furnished to do so, subject to the following conditions:
|
|
|
|
The above copyright notice and this permission notice shall be included in
|
|
all copies or substantial portions of the Software.
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
THE SOFTWARE.
|
|
****************************************************************************/
|
|
|
|
#ifndef __ACTIONS_CCACTION_H__
|
|
#define __ACTIONS_CCACTION_H__
|
|
|
|
#include "base/Ref.h"
|
|
#include "math/Math.h"
|
|
#include "base/ScriptSupport.h"
|
|
|
|
NS_AX_BEGIN
|
|
|
|
class Node;
|
|
|
|
enum
|
|
{
|
|
kActionUpdate
|
|
};
|
|
|
|
/**
|
|
* @addtogroup actions
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @brief Base class for Action objects.
|
|
*/
|
|
class AX_DLL Action : public Ref, public Clonable
|
|
{
|
|
public:
|
|
/** Default tag used for all the actions. */
|
|
static const int INVALID_TAG = -1;
|
|
/**
|
|
* @js NA
|
|
* @lua NA
|
|
*/
|
|
virtual std::string description() const;
|
|
|
|
/** Returns a clone of action.
|
|
*
|
|
* @return A clone action.
|
|
*/
|
|
virtual Action* clone() const
|
|
{
|
|
AX_ASSERT(0);
|
|
return nullptr;
|
|
}
|
|
|
|
/** Returns a new action that performs the exact reverse of the action.
|
|
*
|
|
* @return A new action that performs the exact reverse of the action.
|
|
* @js NA
|
|
*/
|
|
virtual Action* reverse() const
|
|
{
|
|
AX_ASSERT(0);
|
|
return nullptr;
|
|
}
|
|
|
|
/** Return true if the action has finished.
|
|
*
|
|
* @return Is true if the action has finished.
|
|
*/
|
|
virtual bool isDone() const;
|
|
|
|
/** Called before the action start. It will also set the target.
|
|
*
|
|
* @param target A certain target.
|
|
*/
|
|
virtual void startWithTarget(Node* target);
|
|
|
|
/**
|
|
* Called after the action has finished. It will set the 'target' to nil.
|
|
* IMPORTANT: You should never call "Action::stop()" manually. Instead, use: "target->stopAction(action);".
|
|
*/
|
|
virtual void stop();
|
|
|
|
/** Called every frame with it's delta time, dt in seconds. DON'T override unless you know what you are doing.
|
|
*
|
|
* @param dt In seconds.
|
|
*/
|
|
virtual void step(float dt);
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* @param time A value between 0 and 1.
|
|
*/
|
|
virtual void update(float time);
|
|
/** Return certain target.
|
|
*
|
|
* @return A certain target.
|
|
*/
|
|
Node* getTarget() const { return _target; }
|
|
/** The action will modify the target properties.
|
|
*
|
|
* @param target A certain target.
|
|
*/
|
|
void setTarget(Node* target) { _target = target; }
|
|
/** Return a original Target.
|
|
*
|
|
* @return A original Target.
|
|
*/
|
|
Node* getOriginalTarget() const { return _originalTarget; }
|
|
/**
|
|
* Set the original target, since target can be nil.
|
|
* Is the target that were used to run the action. Unless you are doing something complex, like ActionManager, you
|
|
* should NOT call this method. The target is 'assigned', it is not 'retained'.
|
|
* @since v0.8.2
|
|
*
|
|
* @param originalTarget Is 'assigned', it is not 'retained'.
|
|
*/
|
|
void setOriginalTarget(Node* originalTarget) { _originalTarget = originalTarget; }
|
|
/** Returns a tag that is used to identify the action easily.
|
|
*
|
|
* @return A tag.
|
|
*/
|
|
int getTag() const { return _tag; }
|
|
/** Changes the tag that is used to identify the action easily.
|
|
*
|
|
* @param tag Used to identify the action easily.
|
|
*/
|
|
void setTag(int tag) { _tag = tag; }
|
|
/** Returns a flag field that is used to group the actions easily.
|
|
*
|
|
* @return A tag.
|
|
*/
|
|
unsigned int getFlags() const { return _flags; }
|
|
/** Changes the flag field that is used to group the actions easily.
|
|
*
|
|
* @param flags Used to group the actions easily.
|
|
*/
|
|
void setFlags(unsigned int flags) { _flags = flags; }
|
|
|
|
Action();
|
|
virtual ~Action();
|
|
|
|
protected:
|
|
Node* _originalTarget;
|
|
/**
|
|
* The "target".
|
|
* The target will be set with the 'startWithTarget' method.
|
|
* When the 'stop' method is called, target will be set to nil.
|
|
* The target is 'assigned', it is not 'retained'.
|
|
*/
|
|
Node* _target;
|
|
/** The action tag. An identifier of the action. */
|
|
int _tag;
|
|
/** The action flag field. To categorize action into certain groups.*/
|
|
unsigned int _flags;
|
|
|
|
private:
|
|
AX_DISALLOW_COPY_AND_ASSIGN(Action);
|
|
};
|
|
|
|
/** @class FiniteTimeAction
|
|
* @brief
|
|
* Base class actions that do have a finite time duration.
|
|
* Possible actions:
|
|
* - An action with a duration of 0 seconds.
|
|
* - An action with a duration of 35.5 seconds.
|
|
* Infinite time actions are valid.
|
|
*/
|
|
class AX_DLL FiniteTimeAction : public Action
|
|
{
|
|
public:
|
|
/** Get duration in seconds of the action.
|
|
*
|
|
* @return The duration in seconds of the action.
|
|
*/
|
|
float getDuration() const { return _duration; }
|
|
/** Set duration in seconds of the action.
|
|
*
|
|
* @param duration In seconds of the action.
|
|
*/
|
|
void setDuration(float duration) { _duration = duration; }
|
|
|
|
//
|
|
// Overrides
|
|
//
|
|
virtual FiniteTimeAction* reverse() const override
|
|
{
|
|
AX_ASSERT(0);
|
|
return nullptr;
|
|
}
|
|
virtual FiniteTimeAction* clone() const override
|
|
{
|
|
AX_ASSERT(0);
|
|
return nullptr;
|
|
}
|
|
|
|
FiniteTimeAction() : _duration(0) {}
|
|
virtual ~FiniteTimeAction() {}
|
|
|
|
protected:
|
|
//! Duration in seconds.
|
|
float _duration;
|
|
|
|
private:
|
|
AX_DISALLOW_COPY_AND_ASSIGN(FiniteTimeAction);
|
|
};
|
|
|
|
class ActionInterval;
|
|
class RepeatForever;
|
|
|
|
/** @class Speed
|
|
* @brief Changes the speed of an action, making it take longer (speed>1)
|
|
* or shorter (speed<1) time.
|
|
* Useful to simulate 'slow motion' or 'fast forward' effect.
|
|
* @warning This action can't be Sequenceable because it is not an IntervalAction.
|
|
*/
|
|
class AX_DLL Speed : public Action
|
|
{
|
|
public:
|
|
/** Create the action and set the speed.
|
|
*
|
|
* @param action An action.
|
|
* @param speed The action speed.
|
|
*/
|
|
static Speed* create(ActionInterval* action, float speed);
|
|
/** Return the speed.
|
|
*
|
|
* @return The action speed.
|
|
*/
|
|
float getSpeed() const { return _speed; }
|
|
/** Alter the speed of the inner function in runtime.
|
|
*
|
|
* @param speed Alter the speed of the inner function in runtime.
|
|
*/
|
|
void setSpeed(float speed) { _speed = speed; }
|
|
|
|
/** Replace the interior action.
|
|
*
|
|
* @param action The new action, it will replace the running action.
|
|
*/
|
|
void setInnerAction(ActionInterval* action);
|
|
/** Return the interior action.
|
|
*
|
|
* @return The interior action.
|
|
*/
|
|
ActionInterval* getInnerAction() const { return _innerAction; }
|
|
|
|
//
|
|
// Override
|
|
//
|
|
virtual Speed* clone() const override;
|
|
virtual Speed* reverse() const override;
|
|
virtual void startWithTarget(Node* target) override;
|
|
virtual void stop() override;
|
|
/**
|
|
* @param dt in seconds.
|
|
*/
|
|
virtual void step(float dt) override;
|
|
/** Return true if the action has finished.
|
|
*
|
|
* @return Is true if the action has finished.
|
|
*/
|
|
virtual bool isDone() const override;
|
|
|
|
Speed();
|
|
virtual ~Speed();
|
|
/** Initializes the action. */
|
|
bool initWithAction(ActionInterval* action, float speed);
|
|
|
|
protected:
|
|
float _speed;
|
|
ActionInterval* _innerAction;
|
|
|
|
private:
|
|
AX_DISALLOW_COPY_AND_ASSIGN(Speed);
|
|
};
|
|
|
|
/** @class Follow
|
|
* @brief Follow is an action that "follows" a node.
|
|
* Eg:
|
|
* @code
|
|
* layer->runAction(Follow::create(hero));
|
|
* @endcode
|
|
* Instead of using Camera as a "follower", use this action instead.
|
|
* @since v0.99.2
|
|
*/
|
|
class AX_DLL Follow : public Action
|
|
{
|
|
public:
|
|
/**
|
|
* Creates the action with a set boundary or with no boundary.
|
|
*
|
|
* @param followedNode The node to be followed.
|
|
* @param rect The boundary. If \p rect is equal to Rect::ZERO, it'll work
|
|
* with no boundary.
|
|
*/
|
|
|
|
static Follow* create(Node* followedNode, const Rect& rect = Rect::ZERO);
|
|
|
|
/**
|
|
* Creates the action with a set boundary or with no boundary with offsets.
|
|
*
|
|
* @param followedNode The node to be followed.
|
|
* @param rect The boundary. If \p rect is equal to Rect::ZERO, it'll work
|
|
* with no boundary.
|
|
* @param xOffset The horizontal offset from the center of the screen from which the
|
|
* node is to be followed.It can be positive,negative or zero.If
|
|
* set to zero the node will be horizontally centered followed.
|
|
* @param yOffset The vertical offset from the center of the screen from which the
|
|
* node is to be followed.It can be positive,negative or zero.
|
|
* If set to zero the node will be vertically centered followed.
|
|
* If both xOffset and yOffset are set to zero,then the node will be horizontally and vertically centered
|
|
* followed.
|
|
*/
|
|
|
|
static Follow* createWithOffset(Node* followedNode, float xOffset, float yOffset, const Rect& rect = Rect::ZERO);
|
|
|
|
/** Return boundarySet.
|
|
*
|
|
* @return Return boundarySet.
|
|
*/
|
|
bool isBoundarySet() const { return _boundarySet; }
|
|
/** Alter behavior - turn on/off boundary.
|
|
*
|
|
* @param value Turn on/off boundary.
|
|
*/
|
|
void setBoundarySet(bool value) { _boundarySet = value; }
|
|
|
|
//
|
|
// Override
|
|
//
|
|
virtual Follow* clone() const override;
|
|
virtual Follow* reverse() const override;
|
|
/**
|
|
* @param dt in seconds.
|
|
* @js NA
|
|
*/
|
|
virtual void step(float dt) override;
|
|
virtual bool isDone() const override;
|
|
virtual void stop() override;
|
|
|
|
/**
|
|
* @js ctor
|
|
*/
|
|
Follow()
|
|
: _followedNode(nullptr)
|
|
, _boundarySet(false)
|
|
, _boundaryFullyCovered(false)
|
|
, _leftBoundary(0.0)
|
|
, _rightBoundary(0.0)
|
|
, _topBoundary(0.0)
|
|
, _bottomBoundary(0.0)
|
|
, _offsetX(0.0)
|
|
, _offsetY(0.0)
|
|
, _worldRect(Rect::ZERO)
|
|
{}
|
|
/**
|
|
* @js NA
|
|
* @lua NA
|
|
*/
|
|
virtual ~Follow();
|
|
|
|
/**
|
|
* Initializes the action with a set boundary or with no boundary.
|
|
*
|
|
* @param followedNode The node to be followed.
|
|
* @param rect The boundary. If \p rect is equal to Rect::ZERO, it'll work
|
|
* with no boundary.
|
|
*/
|
|
bool initWithTarget(Node* followedNode, const Rect& rect = Rect::ZERO);
|
|
|
|
/**
|
|
* Initializes the action with a set boundary or with no boundary with offsets.
|
|
*
|
|
* @param followedNode The node to be followed.
|
|
* @param rect The boundary. If \p rect is equal to Rect::ZERO, it'll work
|
|
* with no boundary.
|
|
* @param xOffset The horizontal offset from the center of the screen from which the
|
|
* node is to be followed.It can be positive,negative or zero.If
|
|
* set to zero the node will be horizontally centered followed.
|
|
* @param yOffset The vertical offset from the center of the screen from which the
|
|
* node is to be followed.It can be positive,negative or zero.
|
|
* If set to zero the node will be vertically centered followed.
|
|
* If both xOffset and yOffset are set to zero,then the node will be horizontally and vertically centered
|
|
followed.
|
|
|
|
*/
|
|
bool initWithTargetAndOffset(Node* followedNode, float xOffset, float yOffset, const Rect& rect = Rect::ZERO);
|
|
|
|
protected:
|
|
/** Node to follow. */
|
|
Node* _followedNode;
|
|
|
|
/** Whether camera should be limited to certain area. */
|
|
bool _boundarySet;
|
|
|
|
/** If screen size is bigger than the boundary - update not needed. */
|
|
bool _boundaryFullyCovered;
|
|
|
|
/** Fast access to the screen dimensions. */
|
|
Vec2 _halfScreenSize;
|
|
Vec2 _fullScreenSize;
|
|
|
|
/** World boundaries. */
|
|
float _leftBoundary;
|
|
float _rightBoundary;
|
|
float _topBoundary;
|
|
float _bottomBoundary;
|
|
|
|
/** Horizontal (x) and vertical (y) offset values. */
|
|
float _offsetX;
|
|
float _offsetY;
|
|
|
|
Rect _worldRect;
|
|
|
|
private:
|
|
AX_DISALLOW_COPY_AND_ASSIGN(Follow);
|
|
};
|
|
|
|
// end of actions group
|
|
/// @}
|
|
|
|
NS_AX_END
|
|
|
|
#endif // __ACTIONS_CCACTION_H__
|