#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_VOLUMES_SPHERE3_H
#define NUCLEX_GEOMETRY_VOLUMES_SPHERE3_H

#include "Nuclex/Geometry/Point3.h"
#include "Nuclex/Geometry/Math.h"
#include "Nuclex/Geometry/Volumes/Box3.h"

namespace Nuclex { namespace Geometry { namespace Volumes {

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

  /// <summary>Sphere in 3D space stored as a position and a radius</summary>
  template <typename TScalar>
  struct Sphere3 {

    /// <summary>A unit sphere located at the center of the coordinate system</summary>
    public: static const Sphere3<TScalar> Unit;
  
    /// <summary>Initializes a sphere using the specified position and radius</summary>
    /// <param name="center">Position of the sphere's center point</param>
    /// <param name="radius">Radius of the sphere</param>
    public: Sphere3(const Point3<TScalar> &center, TScalar radius) :
      Center(center), Radius(radius) {}

    /// <summary>Calculates the surface area of the sphere</summary>
    /// <returns>The surface area of the sphere</returns>
    public: TScalar GetArea() const {
      return Math<TScalar>::Pi * 4 * (this->Radius * this->Radius);
    }

    /// <summary>Calculates the volume of the sphere</summary>
    /// <returns>The volume of the sphere</returns>
    public: TScalar GetVolume() const {
      return Math<TScalar>::Pi * 4 * (this->Radius * this->Radius * this->Radius) / 3;
    }

    /// <summary>Returns the center of the sphere</summary>
    /// <returns>The center of the sphere</returns>
    /// <remarks>
    ///   Provided for consistency when accessing the volume via template code.
    ///   Use the public <see cref="Center" /> field when working with the Sphere3
    ///   class directly.
    /// </remarks>
    public: Point3<TScalar> GetCenter() const {
      return this->Center;
    }

    /// <summary>Offsets the entire sphere by the specified amount</summary>
    /// <param name="amountX">Amount the sphere will be offset on the X axis</param>
    /// <param name="amountY">Amount the sphere will be offset on the Y axis</param>
    /// <param name="amountZ">Amount the sphere will be offset on the Z axis</param>
    public: void ShiftBy(TScalar amountX, TScalar amountY, TScalar amountZ) {
      this->Center.X += amountX;
      this->Center.Y += amountY;
      this->Center.Z += amountZ;
    }

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

    /// <summary>Coordinates of the sphere's center</summary>
    public: Point3<TScalar> Center;
    /// <summary>Radius of the sphere</summary>
    public: TScalar Radius;

  };

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

  template<typename TScalar>
  const Sphere3<TScalar> Sphere3<TScalar>::Unit(Point3<TScalar>::Zero, 1);

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

}}} // namespace Nuclex::Geometry::Volumes

#endif // NUCLEX_GEOMETRY_VOLUMES_SPHERE3_H