PageRenderTime 69ms CodeModel.GetById 27ms RepoModel.GetById 1ms app.codeStats 0ms

/Utilities/Datatypes/Advanced/IContains.cs

#
C# | 34 lines | 11 code | 2 blank | 21 comment | 0 complexity | 406452103759d332b09ee651660568ab MD5 | raw file
Possible License(s): Apache-2.0
  1. namespace 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. /// <summary>
  17. /// Determines whether a sphere contains another box or sphere
  18. /// </summary>
  19. /// <param name="sphere">Sphere to check against</param>
  20. /// <returns>Containment type (fully, partial or none)</returns>
  21. ContainmentType Contains(BoundingSphere sphere);
  22. /// <summary>
  23. /// Checks whether a box or sphere contains a vector position.
  24. /// </summary>
  25. /// <param name="position">Position to check against</param>
  26. /// <returns>Either the position is inside the box or sphere (
  27. /// <see cref="ContainmentType.Fully"/> is returned), or not (then
  28. /// <see cref="ContainmentType.None"/> is returned).</returns>
  29. ContainmentType Contains(Vector position);
  30. #endregion
  31. }
  32. }