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 "supertux/game_object.hpp"

#include <memory>

#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:
  static void register_class(ssq::VM& vm);

public:
  TextArrayObject(const std::string& name = "");
  ~TextArrayObject() override = default;

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

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

  static std::string class_name() { return "text-array"; }
  virtual std::string get_class_name() const override { return class_name(); }
  virtual std::string get_exposed_class_name() const override { return "TextArrayObject"; }
  static std::string display_name() { return _("Text array"); }
  virtual std::string get_display_name() const override { return display_name(); }
  virtual GameObjectClasses get_class_types() const override { return GameObject::get_class_types().add(typeid(TextArrayObject)); }

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

  void clear();
  void add_text(const std::string& text);
  void add_text_duration(const std::string& text, float duration);
  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();

  /*
   * TextObject API related
   * @see: text_object.hpp
   */
  void set_text(const std::string& text);
  void set_font(const std::string& fontname);
  void fade_in(float fadetime);
  void fade_out(float fadetime);
  void grow_in(float fadetime);
  void grow_out(float fadetime);
  void set_visible(bool visible);
  void set_centered(bool centered);
  void set_pos(float x, float y);
  float get_x() const;
  float get_y() const;
  void set_anchor_point(int anchor);
  int get_anchor_point() const;
  void set_anchor_offset(float x, float y);
  float get_wrap_width() const;
  void set_wrap_width(float width);
  void set_front_fill_color(float red, float green, float blue, float alpha);
  void set_back_fill_color(float red, float green, float blue, float alpha);
  void set_text_color(float red, float green, float blue, float alpha);
  void set_roundness(float roundness);

  TextArrayItem* get_text_item(ta_index index) const;

  TextArrayItem* get_current_text_item() const;

  TextArrayItem* get_last_text_item() const;

private:
  void override_properties();

  void reset_automation();

  void handle_input_requests();

  bool should_fade() const;

private:
  bool m_finished;
  bool m_is_auto;

  bool m_keep_visible;
  bool m_fade_transition;

  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 */