/Utilities/Datatypes/Advanced/IContains.cs

namespace Delta.Utilities.Datatypes.Advanced

{

	/// <summary>

	/// Interface IContains checks whether a Delta.Utilities.Datatypes 

	/// contains another datatype.

	/// </summary>

	public interface IContains

	{

		#region Contains (Public)

		/// <summary>

		/// Determines whether a Box contains another box or sphere

		/// </summary>

		/// <param name="box">Box to check against</param>

		/// <returns>Containment type (fully, partial or none)</returns>

		ContainmentType Contains(BoundingBox box);



		/// <summary>

		/// Determines whether a sphere contains another box or sphere

		/// </summary>

		/// <param name="sphere">Sphere to check against</param>

		/// <returns>Containment type (fully, partial or none)</returns>

		ContainmentType Contains(BoundingSphere sphere);



		/// <summary>

		/// Checks whether a box or sphere contains a vector position.

		/// </summary>

		/// <param name="position">Position to check against</param>

		/// <returns>Either the position is inside the box or sphere (

		/// <see cref="ContainmentType.Fully"/> is returned), or not (then

		/// <see cref="ContainmentType.None"/> is returned).</returns>

		ContainmentType Contains(Vector position);

		#endregion

	}

}