nomlib
Loading...
Searching...
No Matches
CallbackAction.hpp
1/******************************************************************************
2
3 nomlib - C++11 cross-platform game engine
4
5Copyright (c) 2013, 2014 Jeffrey Carpenter <i8degrees@gmail.com>
6All rights reserved.
7
8Redistribution and use in source and binary forms, with or without
9modification, are permitted provided that the following conditions are met:
10
111. Redistributions of source code must retain the above copyright notice, this
12 list of conditions and the following disclaimer.
132. Redistributions in binary form must reproduce the above copyright notice,
14 this list of conditions and the following disclaimer in the documentation
15 and/or other materials provided with the distribution.
16
17THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
18ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
21ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
26SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27
28******************************************************************************/
29#ifndef NOMLIB_ACTIONS_CALLBACK_ACTION_HPP
30#define NOMLIB_ACTIONS_CALLBACK_ACTION_HPP
31
32#include <memory>
33
34#include "nomlib/config.hpp"
35#include "nomlib/actions/IActionObject.hpp"
36
37namespace nom {
38
40class CallbackAction: public virtual IActionObject
41{
42 public:
44 friend class ActionTest;
45
46 typedef CallbackAction self_type;
47 typedef IActionObject derived_type;
48
49 typedef std::function<void()> callback_func;
50
54 CallbackAction(const callback_func& action);
55
60 CallbackAction(real32 seconds, const callback_func& action);
61
62 virtual ~CallbackAction();
63
64 virtual std::unique_ptr<IActionObject> clone() const override;
65
66 virtual IActionObject::FrameState next_frame(real32 delta_time) override;
67
68 virtual IActionObject::FrameState prev_frame(real32 delta_time) override;
69
71 virtual void pause(real32 delta_time) override;
72
74 virtual void resume(real32 delta_time) override;
75
77 virtual void rewind(real32 delta_time) override;
78
79 virtual void release() override;
80
81 private:
82 static const char* DEBUG_CLASS_NAME;
83
85 callback_func action_;
86};
87
88} // namespace nom
89
90#endif // include guard defined
91
CallbackAction(real32 seconds, const callback_func &action)
Execute a function over a time period.
virtual IActionObject::FrameState next_frame(real32 delta_time) override
Play the action forward in time by one time step.
virtual void release() override
Free externally referenced resources held by the action.
CallbackAction(const callback_func &action)
Execute a function instantaneously.
virtual IActionObject::FrameState prev_frame(real32 delta_time) override
Play the action backwards in time by one time step.
friend class ActionTest
Allow access into our private parts for unit testing.
callback_func action_
The stored function pointer.
virtual void resume(real32 delta_time) override
This action does not support being resumed.
virtual std::unique_ptr< IActionObject > clone() const override
Create a deep copy instance of the action.
virtual void pause(real32 delta_time) override
This action does not support being paused.
virtual void rewind(real32 delta_time) override
This action does not support being reset.
FrameState
The update status of the action.