UnrealEngineUWP/Engine/Source/Runtime/GeometryCore/Public/Polyline3.h

// Copyright Epic Games, Inc. All Rights Reserved.

#pragma once

#include "VectorTypes.h"
#include "SegmentTypes.h"
#include "LineTypes.h"
#include "BoxTypes.h"

namespace UE
{
namespace Geometry
{

using namespace UE::Math;

/**
 * TPolyline3 represents a 3D polyline stored as a list of Vertices.
 */
template<typename T>
class TPolyline3
{
protected:
	/** The list of vertices of the polyline */
	TArray<TVector<T>> Vertices;

	/** A counter that is incremented every time the polyline vertices are modified */
	UE_DEPRECATED(5.1, "Timestamps for TPolyline3 were not being used and will be removed in the future")
	int Timestamp = 0;

public:

	// Note: We need all 5 of these explicitly defaulted just because of the deprecated Timestamp member
	// Once Timestamp is deleted, we can delete these as well
	PRAGMA_DISABLE_DEPRECATION_WARNINGS
	~TPolyline3() = default;
	TPolyline3(const TPolyline3& Other) = default;
	TPolyline3(TPolyline3&& Other) noexcept = default;
	TPolyline3& operator=(const TPolyline3& Other) = default;
	TPolyline3& operator=(TPolyline3&& Other) noexcept = default;
	PRAGMA_ENABLE_DEPRECATION_WARNINGS


	TPolyline3()
	{
	}

	/**
	 * Construct polyline with given list of vertices
	 */
	TPolyline3(const TArray<TVector<T>>& VertexList) : Vertices(VertexList)
	{
	}

	/**
	 * Construct a single-segment polyline
	 */
	TPolyline3(const TVector<T>& Point0, const TVector<T>& Point1)
	{
		Vertices.Add(Point0);
		Vertices.Add(Point1);
	}

	/** @return the Timestamp for the polyline, which is updated every time the polyline is modified */
	UE_DEPRECATED(5.1, "Timestamps for TPolyline3 were not being used and will be removed in the future")
	int GetTimestamp() const
	{
		PRAGMA_DISABLE_DEPRECATION_WARNINGS
		return Timestamp;
		PRAGMA_ENABLE_DEPRECATION_WARNINGS
	}

	/** Explicitly increment the Timestamp */
	UE_DEPRECATED(5.1, "Timestamps for TPolyline3 were not being used and will be removed in the future")
	void IncrementTimestamp()
	{
		IncrementDeprecatedTimestamp();
	}

	/**
	 * Get the vertex at a given index
	 */
	const TVector<T>& operator[](int Index) const
	{
		return Vertices[Index];
	}

	/**
	 * Get the vertex at a given index
	 * @warning changing the vertex via this operator does not update Timestamp!
	 */
	TVector<T>& operator[](int Index)
	{
		return Vertices[Index];
	}


	/**
	 * @return first vertex of polyline
	 */
	const TVector<T>& Start() const
	{
		return Vertices[0];
	}

	/**
	 * @return last vertex of polyline
	 */
	const TVector<T>& End() const
	{
		return Vertices[Vertices.Num()-1];
	}


	/**
	 * @return list of Vertices of polyline
	 */
	const TArray<TVector<T>>& GetVertices() const
	{
		return Vertices;
	}

	/**
	 * @return number of Vertices in polyline
	 */
	int VertexCount() const
	{
		return Vertices.Num();
	}

	/**
	 * @return number of segments in polyline
	 */
	int SegmentCount() const
	{
		return Vertices.Num()-1;
	}


	/** Discard all vertices of polyline */
	void Clear()
	{
		Vertices.Reset();
		IncrementDeprecatedTimestamp();
	}

	/**
	 * Add a vertex to the polyline
	 */
	void AppendVertex(const TVector<T>& Position)
	{
		Vertices.Add(Position);
		IncrementDeprecatedTimestamp();
	}

	/**
	 * Add a list of Vertices to the polyline
	 */
	void AppendVertices(const TArray<TVector<T>>& NewVertices)
	{
		Vertices.Append(NewVertices);
		IncrementDeprecatedTimestamp();
	}

	/**
	 * Add a list of Vertices to the polyline
	 */
	template<typename VectorType>
	void AppendVertices(const TArray<VectorType>& NewVertices)
	{
		int32 NumV = NewVertices.Num();
		Vertices.Reserve(Vertices.Num() + NumV);
		for (int32 k = 0; k < NumV; ++k)
		{
			Vertices.Append( (TVector<T>)NewVertices[k] );
		}
		IncrementDeprecatedTimestamp();
	}

	/**
	 * Set vertex at given index to a new Position
	 */
	void Set(int VertexIndex, const TVector<T>& Position)
	{
		Vertices[VertexIndex] = Position;
		IncrementDeprecatedTimestamp();
	}

	/**
	 * Remove a vertex of the polyline (existing Vertices are shifted)
	 */
	void RemoveVertex(int VertexIndex)
	{
		Vertices.RemoveAt(VertexIndex);
		IncrementDeprecatedTimestamp();
	}

	/**
	 * Replace the list of Vertices with a new list
	 */
	void SetVertices(const TArray<TVector<T>>& NewVertices)
	{
		int NumVerts = NewVertices.Num();
		Vertices.SetNum(NumVerts, false);
		for (int k = 0; k < NumVerts; ++k)
		{
			Vertices[k] = NewVertices[k];
		}
		IncrementDeprecatedTimestamp();
	}


	/**
	 * Reverse the order of the Vertices in the polyline (ie switch between Clockwise and CounterClockwise)
	 */
	void Reverse()
	{
		int32 j = Vertices.Num() - 1;
		for (int32 VertexIndex = 0; VertexIndex < j; VertexIndex++, j--)
		{
			Swap(Vertices[VertexIndex], Vertices[j]);
		}
		IncrementDeprecatedTimestamp();
	}


	/**
	 * Get the tangent vector at a vertex of the polyline, which is the normalized
	 * vector from the previous vertex to the next vertex
	 */
	TVector<T> GetTangent(int VertexIndex) const
	{
		if (VertexIndex == 0)
		{
			return (Vertices[1] - Vertices[0]).Normalized();
		} 
		int NumVerts = Vertices.Num();
		if (VertexIndex == NumVerts - 1)
		{
			return (Vertices[NumVerts-1] - Vertices[NumVerts-2]).Normalized();
		}
		return (Vertices[VertexIndex+1] - Vertices[VertexIndex-1]).Normalized();
	}



	/**
	 * @return edge of the polyline starting at vertex SegmentIndex
	 */
	TSegment3<T> GetSegment(int SegmentIndex) const
	{
		return TSegment3<T>(Vertices[SegmentIndex], Vertices[SegmentIndex+1]);
	}


	/**
	 * @param SegmentIndex index of first vertex of the edge
	 * @param SegmentParam parameter in range [-Extent,Extent] along segment
	 * @return point on the segment at the given parameter value
	 */
	TVector<T> GetSegmentPoint(int SegmentIndex, T SegmentParam) const
	{
		TSegment3<T> seg(Vertices[SegmentIndex], Vertices[SegmentIndex + 1]);
		return seg.PointAt(SegmentParam);
	}


	/**
	 * @param SegmentIndex index of first vertex of the edge
	 * @param SegmentParam parameter in range [0,1] along segment
	 * @return point on the segment at the given parameter value
	 */
	TVector<T> GetSegmentPointUnitParam(int SegmentIndex, T SegmentParam) const
	{
		TSegment3<T> seg(Vertices[SegmentIndex], Vertices[SegmentIndex + 1]);
		return seg.PointBetween(SegmentParam);
	}



	/**
	 * @return the bounding box of the polyline Vertices
	 */
	TAxisAlignedBox3<T> GetBounds() const
	{
		TAxisAlignedBox3<T> box = TAxisAlignedBox3<T>::Empty();
		int NumVertices = Vertices.Num();
		for (int k = 0; k < NumVertices; ++k)
		{
			box.Contain(Vertices[k]);
		}
		return box;
	}



	/**
	 * @return the total perimeter length of the Polygon
	 */
	T Length() const
	{
		T length = 0;
		int N = SegmentCount();
		for (int i = 0; i < N; ++i)
		{
			length += Vertices[i].Distance(Vertices[i+1]);
		}
		return length;
	}



	/**
	 * SegmentIterator is used to iterate over the TSegment3<T> segments of the polyline
	 */
	class SegmentIterator
	{
	public:
		inline bool operator!()
		{
			return i < Polyline->SegmentCount();
		}
		inline TSegment3<T> operator*() const
		{
			check(Polyline != nullptr && i < Polyline->SegmentCount());
			return TSegment3<T>(Polyline->Vertices[i], Polyline->Vertices[i+1]);
		}
		inline SegmentIterator & operator++() 		// prefix
		{
			i++;
			return *this;
		}
		inline SegmentIterator operator++(int) 		// postfix
		{
			SegmentIterator copy(*this);
			i++;
			return copy;
		}
		inline bool operator==(const SegmentIterator & i3) { return i3.Polyline == Polyline && i3.i == i; }
		inline bool operator!=(const SegmentIterator & i3) { return i3.Polyline != Polyline || i3.i != i; }
	protected:
		const TPolyline3 * Polyline;
		int i;
		inline SegmentIterator(const TPolyline3 * p, int iCur) : Polyline(p), i(iCur) {}
		friend class TPolyline3;
	};
	friend class SegmentIterator;

	SegmentIterator SegmentItr() const
	{
		return SegmentIterator(this, 0);
	}

	/**
	 * Wrapper around SegmentIterator that has begin() and end() suitable for range-based for loop
	 */
	class SegmentEnumerable
	{
	public:
		const TPolyline3<T>* Polyline;
		SegmentEnumerable() : Polyline(nullptr) {}
		SegmentEnumerable(const TPolyline3<T> * p) : Polyline(p) {}
		SegmentIterator begin() { return Polyline->SegmentItr(); }
		SegmentIterator end() { return SegmentIterator(Polyline, Polyline->SegmentCount()); }
	};

	/**
	 * @return an object that can be used in a range-based for loop to iterate over the Segments of the Polyline
	 */
	SegmentEnumerable Segments() const
	{
		return SegmentEnumerable(this);
	}






	/**
	 * Calculate the squared distance from a point to the polyline
	 * @param QueryPoint the query point
	 * @param NearestSegIndexOut The index of the nearest segment
	 * @param NearestSegParamOut the parameter value of the nearest point on the segment
	 * @return squared distance to the polyline
	 */
	T DistanceSquared(const TVector<T>& QueryPoint, int& NearestSegIndexOut, T& NearestSegParamOut) const
	{
		NearestSegIndexOut = -1;
		NearestSegParamOut = TNumericLimits<T>::Max();
		T dist = TNumericLimits<T>::Max();
		int N = SegmentCount();
		for (int vi = 0; vi < N; ++vi)
		{
			// @todo can't we just use segment function here now?
			TSegment3<T> seg = TSegment3<T>(Vertices[vi], Vertices[vi+1]);
			T t = (QueryPoint - seg.Center).Dot(seg.Direction);
			T d = TNumericLimits<T>::Max();
			if (t >= seg.Extent)
			{
				d = UE::Geometry::DistanceSquared(seg.EndPoint(), QueryPoint);
			}
			else if (t <= -seg.Extent)
			{
				d = UE::Geometry::DistanceSquared(seg.StartPoint(), QueryPoint);
			}
			else
			{
				d = UE::Geometry::DistanceSquared(seg.PointAt(t), QueryPoint);
			}
			if (d < dist)
			{
				dist = d;
				NearestSegIndexOut = vi;
				NearestSegParamOut = TMathUtil<T>::Clamp(t, -seg.Extent, seg.Extent);
			}
		}
		return dist;
	}



	/**
	 * Calculate the squared distance from a point to the polyline
	 * @param QueryPoint the query point
	 * @return squared distance to the polyline
	 */
	T DistanceSquared(const TVector<T>& QueryPoint) const
	{
		int seg; T segt;
		return DistanceSquared(QueryPoint, seg, segt);
	}




	/**
	 * @return average edge length of all the edges of the Polygon
	 */
	T AverageEdgeLength() const
	{
		T avg = 0; int N = Vertices.Num();
		for (int i = 1; i < N; ++i) {
			avg += Vertices[i].Distance(Vertices[i - 1]);
		}
		return avg / (T)(N-1);
	}



	/**
	 * Produce a new polyline that is smoother than this one
	 */
	void SmoothSubdivide(TPolyline3<T>& NewPolyline) const
	{
		const T Alpha = (T)1 / (T)3;
		const T OneMinusAlpha = (T)2 / (T)3;

		int N = Vertices.Num() - 1;
		NewPolyline.Vertices.SetNum(2*N);
		NewPolyline.Vertices[0] = Vertices[0];
		int k = 1;
		for (int i = 1; i < N; ++i)
		{
			const TVector<T>& Prev = Vertices[i-1];
			const TVector<T>& Cur = Vertices[i];
			const TVector<T>& Next = Vertices[i+1];
			NewPolyline.Vertices[k++] = Alpha * Prev + OneMinusAlpha * Cur;
			NewPolyline.Vertices[k++] = OneMinusAlpha * Cur + Alpha * Next;
		}
		NewPolyline.Vertices[k] = Vertices[N];
	}

private:

	// Note: this function will be removed when Timestamp is removed
	inline void IncrementDeprecatedTimestamp()
	{
		PRAGMA_DISABLE_DEPRECATION_WARNINGS
		Timestamp++;
		PRAGMA_ENABLE_DEPRECATION_WARNINGS
	}
};

typedef TPolyline3<double> FPolyline3d;
typedef TPolyline3<float> FPolyline3f;

} // end namespace UE::Geometry
} // end namespace UE