tweeny.h

/*
This file is part of the Tweeny library.
 
Copyright (c) 2016-2026 Leonardo Guilherme Lucena de Freitas
Copyright (c) 2016 Guilherme R. Costa
 
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/

 
#ifndef TWEENY_TWEENY_H
#define TWEENY_TWEENY_H
 
#include "tween.h"
#include <tuple>
#include <type_traits>
 
#include "detail/tuple-utilities.h"
#include "event.h"
#include "easing.h"

namespace tweeny {
  template <bool WasToCalled, typename FirstValue, typename... RemainingValues>
  class tweeny_builder;
 
  template <typename FirstValue, typename... RemainingValues>
  class tweeny_builder<false, FirstValue, RemainingValues...> {
    typedef std::vector<detail::key_frame<FirstValue, RemainingValues...>> key_frames_t;
    typedef tween<FirstValue, RemainingValues...> tween_t;
    static size_t constexpr value_count = 1 + sizeof...(RemainingValues);
 
    public:
      explicit tweeny_builder(FirstValue firstComponent, RemainingValues... remainingComponents) {
        key_frames.emplace_back(firstComponent, remainingComponents...);
      }
 
      explicit tweeny_builder(key_frames_t && frames) : key_frames(std::move(frames)) {}
      explicit tweeny_builder(const key_frames_t & frames) : key_frames(frames) {}

      tweeny_builder<true, FirstValue, RemainingValues...> to(const FirstValue & firstComponent, const RemainingValues &... remainingComponents) & {
        key_frames.emplace_back(firstComponent, remainingComponents...);
        return tweeny_builder<true, FirstValue, RemainingValues...>(key_frames);
      }

      tweeny_builder<true, FirstValue, RemainingValues...> to(const FirstValue & firstComponent, const RemainingValues &... remainingComponents) && {
        key_frames.emplace_back(firstComponent, remainingComponents...);
        return tweeny_builder<true, FirstValue, RemainingValues...>(std::move(key_frames));
      }
 
    private:
      key_frames_t key_frames;
  };

  template <typename FirstValue, typename... RemainingValues>
  class tweeny_builder<true, FirstValue, RemainingValues...> {
    typedef std::vector<detail::key_frame<FirstValue, RemainingValues...>> key_frames_t;
    typedef tween<FirstValue, RemainingValues...> tween_t;
    static size_t constexpr value_count = 1 + sizeof...(RemainingValues);
 
    public:
      explicit tweeny_builder(FirstValue firstComponent, RemainingValues... remainingComponents) {
        key_frames.emplace_back(firstComponent, remainingComponents...);
      }
 
      explicit tweeny_builder(key_frames_t && frames) : key_frames(std::move(frames)) {}
      explicit tweeny_builder(const key_frames_t & frames) : key_frames(frames) {}

      tweeny_builder to(const FirstValue & firstComponent, const RemainingValues &... remainingComponents) & {
        key_frames.emplace_back(firstComponent, remainingComponents...);
        return tweeny_builder(key_frames);
      }

      tweeny_builder to(const FirstValue & firstComponent, const RemainingValues &... remainingComponents) && {
        key_frames.emplace_back(firstComponent, remainingComponents...);
        return tweeny_builder(std::move(key_frames));
      }

      template<typename... EasingFunctionTypes>
      tweeny_builder & via(EasingFunctionTypes... easing_functions) {
        static_assert(sizeof...(EasingFunctionTypes) == value_count,
                      "via() must have one easing function per tween component");
        auto & key_frame = key_frames.at(key_frames.size() - 2);
        key_frame.easing_functions = std::make_tuple(easing_functions...);
        return *this;
      }

      template<typename EasingFunctionType>
      tweeny_builder & via(EasingFunctionType easing_function) {
        auto & key_frame = key_frames.at(key_frames.size() - 2);
        key_frame.easing_functions = detail::make_repeated_tuple<EasingFunctionType, value_count>(easing_function);
        return *this;
      }

      template<typename... FrameCountsType>
      tweeny_builder & during(FrameCountsType... frame_counts) {
        static_assert(sizeof...(FrameCountsType) == value_count,
                     "during() must have one frame count per tween component");
        static_assert((std::is_same_v<std::decay_t<FrameCountsType>, uint32_t> && ...),
                      "during() parameters must be of type uint32_t");
        auto & key_frame = key_frames.at(key_frames.size() - 2);
        std::array<uint32_t, sizeof...(FrameCountsType)> frame_counts_array = { frame_counts... };
        std::copy(
          std::begin(frame_counts_array),
          std::end(frame_counts_array),
          std::begin(key_frame.tween_frame_counts));
        fix_frame_positions();
        return *this;
      }

      tweeny_builder & during(uint32_t frame_count) {
        auto & key_frame = key_frames.at(key_frames.size() - 2);
        std::fill(
          std::begin(key_frame.tween_frame_counts),
          std::end(key_frame.tween_frame_counts),
          frame_count
        );
        fix_frame_positions();
        return *this;
      }

      tween_t build() const & { return tween(key_frames); }

      tween_t build() && { return tween(std::move(key_frames)); }
 
    private:
      key_frames_t key_frames;
      void fix_frame_positions() {
        uint32_t key_frame_position = 0;
        for (auto & key_frame : key_frames) {
          key_frame.position = key_frame_position;
          key_frame_position += key_frame.highest_frame_count();
        }
      }
  };

  template <typename FirstValue, typename... RemainingValues>
  tweeny_builder<false, FirstValue, RemainingValues...> from(FirstValue firstComponent, RemainingValues... remainingComponents) {
    return tweeny_builder<false, FirstValue, RemainingValues...>(firstComponent, remainingComponents...);
  }
}
 
#endif //TWEENY_TWEENY_H