Code/Engine/Foundation/SimdMath/SimdBSphere.h - dev - redgpu/ezEngine

Code/Engine/Foundation/SimdMath/SimdBSphere.h
99 строк4 KB
Ingrater
Clang-format fixes and update to 18.1.1 (#1234)
10 мар 2024, 15:51
10 мар 2024, 15:512f16acf
#pragma once

#include <Foundation/SimdMath/SimdTransform.h>

class EZ_FOUNDATION_DLL ezSimdBSphere
{
public:
  EZ_DECLARE_POD_TYPE();

  /// \brief Default constructor does not initialize any data.
  ezSimdBSphere();

  /// \brief Creates a sphere with the given radius around the given center.
  ezSimdBSphere(const ezSimdVec4f& vCenter, const ezSimdFloat& fRadius); // [tested]

  /// \brief Creates a sphere at the origin with radius zero.
  [[nodiscard]] static ezSimdBSphere MakeZero();

  /// \brief Creates an 'invalid' sphere, with its center at the given position and a negative radius.
  ///
  /// Such a sphere can be made 'valid' through ExpandToInclude(), but be aware that the originally provided center position
  /// will always be part of the sphere.
  [[nodiscard]] static ezSimdBSphere MakeInvalid(const ezSimdVec4f& vCenter = ezSimdVec4f::MakeZero()); // [tested]

  /// \brief Creates a sphere with the provided center and radius.
  [[nodiscard]] static ezSimdBSphere MakeFromCenterAndRadius(const ezSimdVec4f& vCenter, const ezSimdFloat& fRadius); // [tested]

  /// \brief Creates a bounding sphere around the provided points.
  ///
  /// The center of the sphere will be at the 'center of mass' of all the points, and the radius will be the distance to the
  /// farthest point from there.
  [[nodiscard]] static ezSimdBSphere MakeFromPoints(const ezSimdVec4f* pPoints, ezUInt32 uiNumPoints, ezUInt32 uiStride = sizeof(ezSimdVec4f));


public:
  /// \brief Sets the bounding sphere to invalid values.
  [[deprecated("Use MakeInvalid() instead.")]] void SetInvalid(); // [tested]

  /// \brief Returns whether the sphere has valid values.
  bool IsValid() const; // [tested]

  /// \brief Returns whether any value is NaN.
  bool IsNaN() const; // [tested]

  /// \brief Returns the center
  ezSimdVec4f GetCenter() const; // [tested]

  /// \brief Returns the radius
  ezSimdFloat GetRadius() const; // [tested]

  /// \brief Initializes the sphere to be the bounding sphere of all the given points.
  [[deprecated("Use MakeFromPoints() instead.")]] void SetFromPoints(const ezSimdVec4f* pPoints, ezUInt32 uiNumPoints, ezUInt32 uiStride = sizeof(ezSimdVec4f));

  /// \brief Increases the sphere's radius to include this point.
  void ExpandToInclude(const ezSimdVec4f& vPoint); // [tested]

  /// \brief Increases the sphere's radius to include all given points. Does NOT change its position, thus the resulting sphere might be not
  /// a very tight fit. More efficient than calling this for every point individually.
  void ExpandToInclude(const ezSimdVec4f* pPoints, ezUInt32 uiNumPoints, ezUInt32 uiStride = sizeof(ezSimdVec4f)); // [tested]

  /// \brief Increases this sphere's radius, such that it encloses the other sphere.
  void ExpandToInclude(const ezSimdBSphere& rhs); // [tested]

public:
  /// \brief Transforms the sphere in its local space.
  void Transform(const ezSimdTransform& t); // [tested]

  /// \brief Transforms the sphere in its local space.
  void Transform(const ezSimdMat4f& mMat); // [tested]

public:
  /// \brief Computes the distance of the point to the sphere's surface. Returns negative values for points inside the sphere.
  ezSimdFloat GetDistanceTo(const ezSimdVec4f& vPoint) const; // [tested]

  /// \brief Returns the distance between the two spheres. Zero for spheres that are exactly touching each other, negative values for
  /// overlapping spheres.
  ezSimdFloat GetDistanceTo(const ezSimdBSphere& rhs) const; // [tested]

  /// \brief Returns true if the given point is inside the sphere.
  bool Contains(const ezSimdVec4f& vPoint) const; // [tested]

  /// \brief Returns whether the other sphere is completely inside this sphere.
  bool Contains(const ezSimdBSphere& rhs) const; // [tested]

  /// \brief Checks whether the two objects overlap.
  bool Overlaps(const ezSimdBSphere& rhs) const; // [tested]

  /// \brief Clamps the given position to the volume of the sphere. The resulting point will always be inside the sphere, but have the
  /// closest distance to the original point.
  [[nodiscard]] ezSimdVec4f GetClampedPoint(const ezSimdVec4f& vPoint); // [tested]

  [[nodiscard]] bool operator==(const ezSimdBSphere& rhs) const;        // [tested]
  [[nodiscard]] bool operator!=(const ezSimdBSphere& rhs) const;        // [tested]

public:
  ezSimdVec4f m_CenterAndRadius;
};

#include <Foundation/SimdMath/Implementation/SimdBSphere_inl.h>