line_segment.h

/*
**  UICore
**  Copyright (c) 1997-2015 The UICore Team
**
**  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.
**
**  Note: Some of the libraries UICore may link to may have additional
**  requirements or restrictions.
**
**  File Author(s):
**
**    Mark Page
*/

#pragma once

namespace uicore
{
    template<typename Type>
    class LineSegment2x;

    template<typename Type>
    class LineSegment3x;

    template<typename Type>
    class Vec2;

    template<typename Type>
    class Vec3;

    template<typename Type>
    class Rectx;

    template<typename Type>
    class LineSegment3x
    {
    public:
        Vec3<Type> p;

        // \brief End point on the line
        Vec3<Type> q;

        LineSegment3x() : p(), q() {}
        LineSegment3x(const LineSegment3x<Type> &copy) : p(copy.p), q(copy.q) {}
        LineSegment3x(const Vec3<Type> &point_p, const Vec3<Type> &point_q) : p(point_p), q(point_q) {}

        Vec3<Type> midpoint() const { return Vec3<Type>((q.x + p.x) / ((Type)2), (q.y + p.y) / ((Type)2), (q.z + p.z) / ((Type)2)); };

        Type point_distance(const Vec3<Type> &point, Vec3<Type> &dest_intercept) const;

        LineSegment3x<Type> &operator = (const LineSegment3x<Type>& copy) { p = copy.p; q = copy.q; return *this; }

        bool operator == (const LineSegment3x<Type>& line) const { return ((p == line.p) && (q == line.q)); }

        bool operator != (const LineSegment3x<Type>& line) const { return ((p != line.p) || (q != line.q)); }
    };

    template<typename Type>
    class LineSegment2x
    {
    public:
        Vec2<Type> p;

        // \brief End point on the line
        Vec2<Type> q;

        LineSegment2x() : p(), q() {}
        LineSegment2x(const LineSegment2x<Type> &copy) : p(copy.p), q(copy.q) {}
        LineSegment2x(const Vec2<Type> &point_p, const Vec2<Type> &point_q) : p(point_p), q(point_q) {}

        Vec2<Type> midpoint() const { return Vec2<Type>((q.x + p.x) / ((Type)2), (q.y + p.y) / ((Type)2)); };

        Type point_distance(const Vec2<Type> &point);

        bool collinear(const LineSegment2x<Type> &second) const;

        bool intersects(const LineSegment2x<Type> &second, bool collinear_intersect) const;

        Vec2<Type> intersection(const LineSegment2x<Type> &second, bool &intersect) const;

        Type point_right_of_line(const Vec2<Type> &point) const { return (q.x - p.x) * (point.y - p.y) - (point.x - p.x) * (q.y - p.y); }

        Vec2<Type> normal() const;

        LineSegment2x<Type> &clip(const Rectx<Type> &rect, bool &clipped);

        LineSegment2x<Type> &operator = (const LineSegment2x<Type>& copy) { p = copy.p; q = copy.q; return *this; }

        bool operator == (const LineSegment2x<Type>& line) const { return ((p == line.p) && (q == line.q)); }

        bool operator != (const LineSegment2x<Type>& line) const { return ((p != line.p) || (q != line.q)); }
    };

    class LineSegment2 : public LineSegment2x<int>
    {
    public:
        LineSegment2() : LineSegment2x<int>() {}
        LineSegment2(const LineSegment2x<int> &copy) : LineSegment2x<int>(copy) {}
        LineSegment2(const Vec2<int> &point_p, const Vec2<int> &point_q) : LineSegment2x<int>(point_p, point_q) {}
    };

    class LineSegment2f : public LineSegment2x<float>
    {
    public:
        LineSegment2f() : LineSegment2x<float>() {}
        LineSegment2f(const LineSegment2x<float> &copy) : LineSegment2x<float>(copy) {}
        LineSegment2f(const Vec2<float> &point_p, const Vec2<float> &point_q) : LineSegment2x<float>(point_p, point_q) {}
    };

    class LineSegment2d : public LineSegment2x<double>
    {
    public:
        LineSegment2d() : LineSegment2x<double>() {}
        LineSegment2d(const LineSegment2x<double> &copy) : LineSegment2x<double>(copy) {}
        LineSegment2d(const Vec2<double> &point_p, const Vec2<double> &point_q) : LineSegment2x<double>(point_p, point_q) {}
    };

    class LineSegment3 : public LineSegment3x<int>
    {
    public:
        LineSegment3() : LineSegment3x<int>() {}
        LineSegment3(const LineSegment3x<int> &copy) : LineSegment3x<int>(copy) {}
        LineSegment3(const Vec3<int> &point_p, const Vec3<int> &point_q) : LineSegment3x<int>(point_p, point_q) {}
    };

    class LineSegment3f : public LineSegment3x<float>
    {
    public:
        LineSegment3f() : LineSegment3x<float>() {}
        LineSegment3f(const LineSegment3x<float> &copy) : LineSegment3x<float>(copy) {}
        LineSegment3f(const Vec3<float> &point_p, const Vec3<float> &point_q) : LineSegment3x<float>(point_p, point_q) {}
    };

    class LineSegment3d : public LineSegment3x<double>
    {
    public:
        LineSegment3d() : LineSegment3x<double>() {}
        LineSegment3d(const LineSegment3x<double> &copy) : LineSegment3x<double>(copy) {}
        LineSegment3d(const Vec3<double> &point_p, const Vec3<double> &point_q) : LineSegment3x<double>(point_p, point_q) {}
    };
}