Polyline.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_POLYLINE_H
#define GF_POLYLINE_H

#include <vector>

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

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

  class GF_CORE_API Polyline : public PointSequence {
  public:
    enum Type {
      Chain,  
      Loop,   
    };

    Polyline(Type type = Chain)
    : m_type(type)
    {
    }

    Polyline(Span<const Vector2f> points, Type type = Chain)
    : PointSequence(points)
    , m_type(type)
    {
    }

    template<typename Iterator>
    Polyline(Iterator first, Iterator last, Type type = Chain)
    : PointSequence(first, last)
    , m_type(type)
    {

    }

    bool hasPrevPoint(std::size_t i) const;

    Vector2f getPrevPoint(std::size_t i) const;

    Vector2f getPrevExtensionPoint() const;

    bool hasNextPoint(std::size_t i) const;

    Vector2f getNextPoint(std::size_t i) const;

    Vector2f getNextExtensionPoint() const;

    Winding getWinding() const;

    bool contains(Vector2f point) const;

    void setType(Type type) {
      m_type = type;
    }

    Type getType() const {
      return m_type;
    }

    bool isLoop() const {
      return m_type == Loop;
    }

    bool isChain() const {
      return m_type == Chain;
    }

  private:
    Type m_type;
  };

  GF_CORE_API Serializer& operator|(Serializer& ar, const Polyline& polyline);

  GF_CORE_API Deserializer& operator|(Deserializer& ar, Polyline& polyline);

#ifndef DOXYGEN_SHOULD_SKIP_THIS
}
#endif
}

#endif // GF_POLYLINE_H