text_array_object.hpp

//  SuperTux
//  Copyright (C) 2018 Nir <goproducti@gmail.com>
//
//  This program is free software: you can redistribute it and/or modify
//  it under the terms of the GNU General Public License as published by
//  the Free Software Foundation, either version 3 of the License, or
//  (at your option) any later version.
//
//  This program is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.
//
//  You should have received a copy of the GNU General Public License
//  along with this program.  If not, see <http://www.gnu.org/licenses/>.

#ifndef HEADER_SUPERTUX_OBJECT_TEXT_ARRAY_OBJECT_HPP
#define HEADER_SUPERTUX_OBJECT_TEXT_ARRAY_OBJECT_HPP

#include <memory>

#include "squirrel/exposed_object.hpp"
#include "scripting/text_array.hpp"

#include "supertux/game_object.hpp"
#include "supertux/timer.hpp"

#include "object/text_object.hpp"
#include "object/text_array_item.hpp"

typedef size_t ta_index;

class TextArrayObject final : public GameObject,
                              public ExposedObject<TextArrayObject, scripting::TextArray>
{
public:
  TextArrayObject(const std::string& name = std::string());
  TextArrayObject(const ReaderMapping& reader);

  ~TextArrayObject() = default;

  virtual void draw(DrawingContext& context) override;
  virtual void update(float dt_sec) override;

  virtual bool is_singleton() const override { return true; }
  virtual bool is_saveable() const override { return false; }

  virtual std::string get_class() const override { return "text-array"; }
  virtual std::string get_display_name() const override { return _("Text array"); }

  virtual const std::string get_icon_path() const override {
    return "images/engine/editor/textarray.png";
  }


  void clear();

  void add_text(const std::string& text, float duration = 3.0f);

  void set_text_index(ta_index index);

  void set_keep_visible(bool keep_visible);

  void set_fade_transition(bool fade_transition);

  void set_fade_time(float fadetime);

  void set_done(bool done);

  void set_auto(bool is_auto);

  void next_text();

  void prev_text();


  TextArrayItem* get_text_item(ta_index index);

  TextArrayItem* get_current_text_item();

  TextArrayItem* get_last_text_item();

private:
  void override_properties();

  void reset_automation();

  void handle_input_requests();

  bool should_fade();

private:
  bool m_isDone;
  bool m_isAuto;
  bool m_keepVisible;
  bool m_fadeTransition;

  float m_fadetime;

  std::vector<std::unique_ptr<TextArrayItem> > m_texts;
  ta_index m_curTextIndex;
  ta_index m_lastTextIndex;

  Timer m_waiting;

private:
  TextArrayObject(const TextArrayObject&) = delete;
  TextArrayObject& operator=(const TextArrayObject&) = delete;
};

#endif

/* EOF */