PageRenderTime 145ms CodeModel.GetById 40ms app.highlight 5ms RepoModel.GetById 96ms app.codeStats 0ms

/Utilities/Datatypes/Advanced/IContains.cs

#
C# | 34 lines | 11 code | 2 blank | 21 comment | 0 complexity | 406452103759d332b09ee651660568ab MD5 | raw file
 1namespace Delta.Utilities.Datatypes.Advanced
 2{
 3	/// <summary>
 4	/// Interface IContains checks whether a Delta.Utilities.Datatypes 
 5	/// contains another datatype.
 6	/// </summary>
 7	public interface IContains
 8	{
 9		#region Contains (Public)
10		/// <summary>
11		/// Determines whether a Box contains another box or sphere
12		/// </summary>
13		/// <param name="box">Box to check against</param>
14		/// <returns>Containment type (fully, partial or none)</returns>
15		ContainmentType Contains(BoundingBox box);
16
17		/// <summary>
18		/// Determines whether a sphere contains another box or sphere
19		/// </summary>
20		/// <param name="sphere">Sphere to check against</param>
21		/// <returns>Containment type (fully, partial or none)</returns>
22		ContainmentType Contains(BoundingSphere sphere);
23
24		/// <summary>
25		/// Checks whether a box or sphere contains a vector position.
26		/// </summary>
27		/// <param name="position">Position to check against</param>
28		/// <returns>Either the position is inside the box or sphere (
29		/// <see cref="ContainmentType.Fully"/> is returned), or not (then
30		/// <see cref="ContainmentType.None"/> is returned).</returns>
31		ContainmentType Contains(Vector position);
32		#endregion
33	}
34}