PointSequence.h

/*
 * Gamedev Framework (gf)
 * Copyright (C) 2016-2021 Julien Bernard
 *
 * This software is provided 'as-is', without any express or implied
 * warranty.  In no event will the authors be held liable for any damages
 * arising from the use of this software.
 *
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 *
 * 1. The origin of this software must not be misrepresented; you must not
 *    claim that you wrote the original software. If you use this software
 *    in a product, an acknowledgment in the product documentation would be
 *    appreciated but is not required.
 * 2. Altered source versions must be plainly marked as such, and must not be
 *    misrepresented as being the original software.
 * 3. This notice may not be removed or altered from any source distribution.
 */
#ifndef GF_POINT_SEQUENCE_H
#define GF_POINT_SEQUENCE_H

#include <vector>

#include "CoreApi.h"
#include "Math.h"
#include "Matrix.h"
#include "SerializationFwd.h"
#include "Span.h"
#include "Vector.h"

namespace gf {
#ifndef DOXYGEN_SHOULD_SKIP_THIS
inline namespace v1 {
#endif

  class GF_CORE_API PointSequence {
  public:
    PointSequence() = default;

    PointSequence(Span<const Vector2f> points);

    template<typename Iterator>
    PointSequence(Iterator first, Iterator last)
    : m_points(first, last)
    {
    }

    bool isEmpty() const {
      return m_points.empty();
    }

    void addPoint(Vector2f point) {
      m_points.push_back(point);
    }

    std::size_t getPointCount() const {
      return m_points.size();
    }

    Vector2f getPoint(std::size_t index) const;

    Vector2f getCenter() const;

    const Vector2f *begin() const {
      return m_points.data();
    }

    Vector2f *begin() {
      return m_points.data();
    }

    const Vector2f *end() const {
      return m_points.data() + m_points.size();
    }

    Vector2f *end() {
      return m_points.data() + m_points.size();
    }

    Vector2f getFirstPoint() const {
      return m_points.front();
    }

    Vector2f getLastPoint() const {
      return m_points.back();
    }

    void applyTransform(const Matrix3f& mat);

    void simplify(float distance = Epsilon);

  protected:
    std::vector<Vector2f>& getRawPoints() {
      return m_points;
    }

    const std::vector<Vector2f>& getRawPoints() const {
      return m_points;
    }

  private:
    std::vector<Vector2f> m_points;
  };

  GF_CORE_API Serializer& operator|(Serializer& ar, const PointSequence& sequence);

  GF_CORE_API Deserializer& operator|(Deserializer& ar, PointSequence& sequence);

#ifndef DOXYGEN_SHOULD_SKIP_THIS
}
#endif
}

#endif // GF_POINT_SEQUENCE_H