#pragma region CPL License
/*
Nuclex Native Framework
Copyright (C) 2002-2015 Nuclex Development Labs

This library is free software; you can redistribute it and/or
modify it under the terms of the IBM Common Public License as
published by the IBM Corporation; either version 1.0 of the
License, or (at your option) any later version.

This library 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
IBM Common Public License for more details.

You should have received a copy of the IBM Common Public
License along with this library
*/
#pragma endregion // CPL License

#ifndef NUCLEX_GEOMETRY_LINES_RAY2_H
#define NUCLEX_GEOMETRY_LINES_RAY2_H

#include "Nuclex/Geometry/Config.h"
#include "Nuclex/Geometry/Point2.h"
#include "Nuclex/Geometry/Vector2.h"

namespace Nuclex { namespace Geometry { namespace Lines {

  // ------------------------------------------------------------------------------------------- //

  /// <summary>2D ray defined by a starting point and a direction</summary>
  template <typename TScalar>
  struct Ray2 {

    /// <summary>Initializes a ray using the specified coordinates</summary>
    /// <param name="origin">Position at which the ray begins</param>
    /// <param name="direction">Direction into which the ray extends</param>
    public: Ray2(const Point2<TScalar> &origin, const Vector2<TScalar> &direction) :
      Origin(origin), Direction(direction) {}

    /// <summary>Offsets the entire ray by the specified amount</summary>
    /// <param name="offsetX">Amount the ray will be offset on the X axis</param>
    /// <param name="offsetY">Amount the ray will be offset on the Y axis</param>
    public: void ShiftBy(TScalar offsetX, TScalar offsetY) {
      this->Origin.X += offsetX;
      this->Origin.Y += offsetY;
    }

    /// <summary>Offsets the entire ray by the specified amount</summary>
    /// <param name="offset">Amount the ray will be offset</param>
    public: void ShiftBy(const Vector2<TScalar> &offset) {
      this->Origin += offset;
    }

    /// <summary>Coordinates at which the ray begins</summary>
    public: Point2<TScalar> Origin;
    /// <summary>Direction into which the ray entends</summary>
    public: Vector2<TScalar> Direction;

  };

  // ------------------------------------------------------------------------------------------- //

}}} // namespace Nuclex::Geometry::Lines

#endif // NUCLEX_GEOMETRY_LINES_RAY2_H