ActionPlayer.hpp

/******************************************************************************
 
  nomlib - C++11 cross-platform game engine
 
Copyright (c) 2013, 2014 Jeffrey Carpenter <i8degrees@gmail.com>
All rights reserved.
 
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
 
1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.
 
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
******************************************************************************/
#ifndef NOMLIB_ACTIONS_ACTION_PLAYER_HPP
#define NOMLIB_ACTIONS_ACTION_PLAYER_HPP
 
#include <memory>
#include <functional>
#include <vector>
#include <map>
#include <deque>
 
#include "nomlib/config.hpp"
 
namespace nom {
 
// Forward declarations
class IActionObject;
class DispatchQueue;
 
typedef std::function<void()> action_callback_func;

class ActionPlayer
{
  public:
    typedef ActionPlayer self_type;

    typedef std::vector<const char*> action_names;

    enum State
    {
      RUNNING = 0,
      PAUSED,
      STOPPED,
    };
 
    ActionPlayer();
 
    ~ActionPlayer();

    ActionPlayer(const ActionPlayer& rhs) = delete;

    ActionPlayer& operator =(const ActionPlayer& rhs) = delete;

    bool idle() const;

    nom::size_type num_actions() const;

    ActionPlayer::State player_state() const;

    void pause();

    void resume();

    void stop();

    bool action_running(const std::string& action_id) const;

    bool cancel_action(const std::string& action_id);
 
    void cancel_actions(const action_names& actions);

    void cancel_actions();

    bool run_action(const std::shared_ptr<IActionObject>& action);

    bool run_action(  const std::shared_ptr<IActionObject>& action,
                      const action_callback_func& completion_func );

    bool update(real32 delta_time);
 
  private:
    bool run_action(  const std::shared_ptr<IActionObject>& action,
                      std::unique_ptr<DispatchQueue> dispatch_queue,
                      const action_callback_func& completion_func );
 
    static const char* DEBUG_CLASS_NAME;
 
    typedef
    std::map<std::string, std::unique_ptr<DispatchQueue>> container_type;
 
    typedef container_type::iterator container_iterator;
 
    ActionPlayer::State player_state_;

    container_type actions_;

    std::deque<container_iterator> free_list_;
};
 
} // namespace nom
 
#endif // include guard defined