nomlib
Loading...
Searching...
No Matches
GroupAction.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_GROUP_ACTION_HPP
30#define NOMLIB_ACTIONS_GROUP_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
40// Forward declarations
41struct group_action;
42
44class GroupAction: public virtual IActionObject
45{
46 public:
48 friend class ActionTest;
49
50 typedef GroupAction self_type;
51 typedef IActionObject derived_type;
52
57 GroupAction(const action_list& actions);
58
59 virtual ~GroupAction();
60
61 virtual std::unique_ptr<IActionObject> clone() const override;
62
63 virtual IActionObject::FrameState next_frame(real32 delta_time) override;
64
65 virtual IActionObject::FrameState prev_frame(real32 delta_time) override;
66
67 virtual void pause(real32 delta_time) override;
68
69 virtual void resume(real32 delta_time) override;
70
71 virtual void rewind(real32 delta_time) override;
72
73 virtual void release() override;
74
78 virtual void set_speed(real32 speed) override;
79
85 virtual void
87
88 private:
89 static const char* DEBUG_CLASS_NAME;
90
94 typedef std::vector<group_action> container_type;
95 typedef container_type::iterator container_iterator;
96
98 update(real32 delta_time, uint32 direction);
99
100 const container_type& actions() const;
101
104
106 nom::size_type num_completed_;
107
109 nom::size_type num_actions_;
110};
111
112} // namespace nom
113
114#endif // include guard defined
115
virtual std::unique_ptr< IActionObject > clone() const override
Create a deep copy instance of the action.
nom::size_type num_completed_
The total number of completed actions.
virtual IActionObject::FrameState prev_frame(real32 delta_time) override
Play the action backwards in time by one time step.
virtual void set_speed(real32 speed) override
Set the speed factor of the child actions.
virtual void set_timing_curve(const IActionObject::timing_curve_func &mode) override
Set the timing mode of the child actions.
virtual void resume(real32 delta_time) override
Resume the internal state of the action.
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.
friend class ActionTest
Allow access into our private parts for unit testing.
std::vector< group_action > container_type
virtual void rewind(real32 delta_time) override
Reset the internal state of the action back to its initial starting values.
GroupAction(const action_list &actions)
Run a collection of actions together (in parallel).
container_type actions_
The child actions.
nom::size_type num_actions_
The total number of actions at the time of construction.
virtual void release() override
Free externally referenced resources held by the action.
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.