nomlib
Loading...
Searching...
No Matches
SequenceAction.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_SEQUENCE_ACTION_HPP
30#define NOMLIB_ACTIONS_SEQUENCE_ACTION_HPP
31
32#include <memory>
33#include <vector>
34
35#include "nomlib/config.hpp"
36#include "nomlib/actions/IActionObject.hpp"
37
38namespace nom {
39
41class SequenceAction: public virtual IActionObject
42{
43 public:
45 friend class ActionTest;
46
47 typedef SequenceAction self_type;
48 typedef IActionObject derived_type;
49
54 SequenceAction(const action_list& actions);
55
56 virtual ~SequenceAction();
57
58 virtual std::unique_ptr<IActionObject> clone() const override;
59
60 virtual IActionObject::FrameState next_frame(real32 delta_time) override;
61
62 virtual IActionObject::FrameState prev_frame(real32 delta_time) override;
63
64 virtual void pause(real32 delta_time) override;
65
66 virtual void resume(real32 delta_time) override;
67
68 virtual void rewind(real32 delta_time) override;
69
70 virtual void release() override;
71
75 virtual void set_speed(real32 speed) override;
76
82 virtual void
84
85 private:
86 static const char* DEBUG_CLASS_NAME;
87
89 update(real32 delta_time, uint32 direction);
90
91 typedef std::vector<std::shared_ptr<IActionObject>> container_type;
92 typedef container_type::iterator container_iterator;
93
94 const container_type& actions() const;
95
97 container_type actions_;
98 container_iterator actions_iterator_;
99
101 nom::size_type num_completed_;
102
104 nom::size_type num_actions_;
105};
106
107} // namespace nom
108
109#endif // include guard defined
110
FrameState
The update status of the action.
std::function< real32(real32, real32, real32, real32)> timing_curve_func
A function pointer to a timing mode.
real32 speed() const
Get the speed modifier of the action.
std::vector< std::shared_ptr< IActionObject > > action_list
A collection of actions.
virtual void release() override
Free externally referenced resources held by the action.
nom::size_type num_completed_
The total number of completed actions.
virtual std::unique_ptr< IActionObject > clone() const override
Create a deep copy instance of the action.
SequenceAction(const action_list &actions)
Run a collection of actions sequentially.
virtual void set_timing_curve(const IActionObject::timing_curve_func &mode) override
Set the timing mode of the child actions.
virtual void set_speed(real32 speed) override
Set the speed factor of the child actions.
virtual void rewind(real32 delta_time) override
Reset the internal state of the action back to its initial starting values.
friend class ActionTest
Allow access into our private parts for unit testing.
virtual void pause(real32 delta_time) override
Freeze the action's internal state.
virtual IActionObject::FrameState next_frame(real32 delta_time) override
Play the action forward in time by one time step.
container_type actions_
The child actions.
virtual IActionObject::FrameState prev_frame(real32 delta_time) override
Play the action backwards in time by one time step.
nom::size_type num_actions_
The total number of actions at the time of construction.
virtual void resume(real32 delta_time) override
Resume the internal state of the action.