BansheeEngine/BansheeUtility/Include/BsRay.h

#pragma once

#include "BsPrerequisitesUtil.h"
#include "BsVector3.h"

namespace BansheeEngine 
{
    /**
     * @brief	A ray in 3D space represented with an origin and direction.
     */
    class BS_UTILITY_EXPORT Ray
    {
    public:
        Ray()
			:mOrigin(Vector3::ZERO), mDirection(Vector3::UNIT_Z) 
		{ }

        Ray(const Vector3& origin, const Vector3& direction)
            :mOrigin(origin), mDirection(direction) 
		{ }

        void setOrigin(const Vector3& origin) { mOrigin = origin; } 
        const Vector3& getOrigin(void) const { return mOrigin; } 

        void setDirection(const Vector3& dir) { mDirection = dir; } 
        const Vector3& getDirection(void) const {return mDirection;} 

		/**
		 * @brief	Gets the position of a point t units along the ray.
		 */
		Vector3 getPoint(float t) const 
		{ 
			return Vector3(mOrigin + (mDirection * t));
		}
		
		/**
		 * @brief	Gets the position of a point t units along the ray.
		 */
		Vector3 operator*(float t) const 
		{ 
			return getPoint(t);
		}

		/**
		 * @brief	Transforms the ray by the given matrix.
		 */
		void transform(const Matrix4& matrix);

		/**
		 * @brief	Transforms the ray by the given matrix.
		 *
		 * @note	Provided matrix must be affine.
		 */
		void transformAffine(const Matrix4& matrix);

		/**
		 * @brief	Ray/plane intersection, returns boolean result and distance to intersection point.
		 */
		std::pair<bool, float> intersects(const Plane& p) const;

		/**
		 * @brief	Ray/sphere intersection, returns boolean result and distance to nearest intersection point.
		 */
		std::pair<bool, float> intersects(const Sphere& s) const;

		/**
		 * @brief	Ray/axis aligned box intersection, returns boolean result and distance to nearest intersection point.
		 */
		std::pair<bool, float> intersects(const AABox& box) const;

        /**
         * @brief	Ray/triangle intersection, returns boolean result and distance to intersection point.
         *
         * @param	a				Triangle first vertex.
         * @param	b				Triangle second vertex.
         * @param	c				Triangle third vertex.
         * @param	normal			The normal of the triangle. Doesn't need to be normalized.
         * @param	positiveSide	(optional) Should intersections with the positive side (normal facing) count.
         * @param	negativeSide	(optional) Should intersections with the negative side (opposite of normal facing) count.
         *
         * @return	Boolean result if intersection happened and distance to intersection point.
         */
        std::pair<bool, float> intersects(const Vector3& a, const Vector3& b, const Vector3& c, 
			const Vector3& normal, bool positiveSide = true, bool negativeSide = true) const;

	protected:
		Vector3 mOrigin;
		Vector3 mDirection;
    };
}