Skip to content

Commit

Permalink
docs: add documentation for AxisAlignedBoundingBox
Browse files Browse the repository at this point in the history
  • Loading branch information
lmichaelis committed Sep 21, 2024
1 parent e71fde1 commit 0f9b54a
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions ZenKit/Boxes.cs
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,28 @@

namespace ZenKit
{
/// <summary>
/// Represents an <see href="https://en.wikipedia.org/wiki/Minimum_bounding_box#Axis-aligned_minimum_bounding_box">axis-aligned bounding box</see>.
/// </summary>
[Serializable]
[StructLayout(LayoutKind.Sequential)]
public struct AxisAlignedBoundingBox
{
/// <summary>
/// Constructs a new axis-aligned bounding box from a given minimum and maximum coordinate.
/// </summary>
/// <param name="min">The coordinate of the minimum corner of the bounding box.</param>
/// <param name="max">The coordinate of the maximum corner of the bounding box.</param>
public AxisAlignedBoundingBox(Vector3 min, Vector3 max)
{
Min = min;
Max = max;
}

/// <summary>The coordinate of the minimum corner of the bounding box.</summary>
public Vector3 Min;

/// <summary>The coordinate of the maximum corner of the bounding box.</summary>
public Vector3 Max;
}

Expand Down

0 comments on commit 0f9b54a

Please sign in to comment.