triangle.h

// © Copyright 2010 - 2016 BlackTopp Studios Inc.
/* This file is part of The Mezzanine Engine.

    The Mezzanine Engine is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    The Mezzanine Engine is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with The Mezzanine Engine.  If not, see <http://www.gnu.org/licenses/>.
*/
/* The original authors have included a copy of the license specified above in the
   'Docs' folder. See 'gpl.txt'
*/
/* We welcome the use of the Mezzanine engine to anyone, including companies who wish to
   Build professional software and charge for their product.

   However there are some practical restrictions, so if your project involves
   any of the following you should contact us and we will try to work something
   out:
    - DRM or Copy Protection of any kind(except Copyrights)
    - Software Patents You Do Not Wish to Freely License
    - Any Kind of Linking to Non-GPL licensed Works
    - Are Currently In Violation of Another Copyright Holder's GPL License
    - If You want to change our code and not add a few hundred MB of stuff to
        your distribution

   These and other limitations could cause serious legal problems if you ignore
   them, so it is best to simply contact us or the Free Software Foundation, if
   you have any questions.

   Joseph Toppi - toppij@gmail.com
   John Blackwood - makoenergy02@gmail.com
*/
#ifndef _triangle_h
#define _triangle_h

#include "vector2.h"
#include "vector3.h"
#include "linesegment.h"

namespace Mezzanine
{
    ///////////////////////////////////////////////////////////////////////////////
    /// @brief A geometry math class for expressing a triangle in 2D space.
    /// @details
    ///////////////////////////////////////
    class MEZZ_LIB Triangle2D
    {
    public:
        ///////////////////////////////////////////////////////////////////////////////
        // Public Data Members

        /// @brief The first point in space making the triangle.
        Vector2 PointA;
        /// @brief The second point in space making the triangle.
        Vector2 PointB;
        /// @brief The third point in space making the triangle.
        Vector2 PointC;

        ///////////////////////////////////////////////////////////////////////////////
        // Construction and Destruction

        /// @brief Blank constructor.
        Triangle2D();
        /// @brief Descriptive constructor.
        /// @param A The first point in space making the triangle.
        /// @param B The second point in space making the triangle.
        /// @param C The third point in space making the triangle.
        Triangle2D(const Vector2& A, const Vector2& B, const Vector2& C);

        ///////////////////////////////////////////////////////////////////////////////
        // Utility

        /// @brief Gets the point in this triangle corresponding to the specified index.
        /// @exception If the index passed in is greater than 2, a PARAMETERS_RANGE_EXCEPTION will be thrown.
        /// @param Index The index of the point to retrieve.
        /// @return Returns a reference to a Vector2 containing the position of the specified point.
        Vector2& operator[](const Whole& Index);
        /// @brief Gets the point in this triangle corresponding to the specified index.
        /// @exception If the index passed in is greater than 2, a PARAMETERS_RANGE_EXCEPTION will be thrown.
        /// @param Index The index of the point to retrieve.
        /// @return Returns a const reference to a Vector2 containing the position of the specified point.
        const Vector2& operator[](const Whole& Index) const;
    };//Triangle2D

    ///////////////////////////////////////////////////////////////////////////////
    /// @brief A geometry math class for expressing a triangle in 3D space.
    /// @details
    ///////////////////////////////////////
    class MEZZ_LIB Triangle3D
    {
    public:
        ///////////////////////////////////////////////////////////////////////////////
        // Public Data Members

        /// @brief The first point in space making the triangle.
        Vector3 PointA;
        /// @brief The second point in space making the triangle.
        Vector3 PointB;
        /// @brief The third point in space making the triangle.
        Vector3 PointC;

        ///////////////////////////////////////////////////////////////////////////////
        // Construction and Destruction

        /// @brief Blank constructor.
        Triangle3D();
        /// @brief Descriptive constructor.
        /// @param A The first point in space making the triangle.
        /// @param B The second point in space making the triangle.
        /// @param C The third point in space making the triangle.
        Triangle3D(const Vector3& A, const Vector3& B, const Vector3& C);

        ///////////////////////////////////////////////////////////////////////////////
        // Utility

        /// @brief Gets the overlap of two triangles.
        /// @param Other The other triangle to compare with.
        /// @return Returns a line segment expressing the length where the two triangles overlap, or a zero'd out line segment if there is no overlap.
        LineSegment3D GetOverlap(const Triangle3D& Other) const;

        /// @brief Gets the point in this triangle corresponding to the specified index.
        /// @exception If the index passed in is greater than 2, a PARAMETERS_RANGE_EXCEPTION will be thrown.
        /// @param Index The index of the point to retrieve.
        /// @return Returns a reference to a Vector2 containing the position of the specified point.
        Vector3& operator[](const Whole& Index);
        /// @brief Gets the point in this triangle corresponding to the specified index.
        /// @exception If the index passed in is greater than 2, a PARAMETERS_RANGE_EXCEPTION will be thrown.
        /// @param Index The index of the point to retrieve.
        /// @return Returns a const reference to a Vector2 containing the position of the specified point.
        const Vector3& operator[](const Whole& Index) const;
    };//Triangle3D
}//Mezzanine

#endif