Code/Engine/Foundation/Math/BoundingBoxSphere.h - dev - redgpu/ezEngine

Code/Engine/Foundation/Math/BoundingBoxSphere.h
96 строк4 KB
Jan Krassnigg
Fixed Typo in ezBoundingBoxSphere
30 янв 2025, 22:53
30 янв 2025, 22:536ce84ec
#pragma once

#include <Foundation/Math/Mat4.h>
#include <Foundation/Math/Vec4.h>

/// \brief A combination of a bounding box and a bounding sphere with the same center.
///
/// This class uses less memory than storying a bounding box and sphere separate.

template <typename Type>
class ezBoundingBoxSphereTemplate
{
public:
  // Means this object can be copied using memcpy instead of copy construction.
  EZ_DECLARE_POD_TYPE();

  using ComponentType = Type;

public:
  /// \brief Default constructor does not initialize anything.
  ezBoundingBoxSphereTemplate(); // [tested]

  ezBoundingBoxSphereTemplate(const ezBoundingBoxSphereTemplate& rhs);

  void operator=(const ezBoundingBoxSphereTemplate& rhs);

  /// \brief Constructs the bounds from the given box. The sphere radius is calculated from the box extends.
  ezBoundingBoxSphereTemplate(const ezBoundingBoxTemplate<Type>& box); // [tested]

  /// \brief Constructs the bounds from the given sphere. The box extends are calculated from the sphere radius.
  ezBoundingBoxSphereTemplate(const ezBoundingSphereTemplate<Type>& sphere); // [tested]

  /// \brief Creates an object with all zero values. These are valid bounds around the origin with no volume.
  [[nodiscard]] static ezBoundingBoxSphereTemplate<Type> MakeZero();

  /// \brief Creates an 'invalid' object, ie one with negative extents/radius. Invalid objects can be made valid through ExpandToInclude().
  [[nodiscard]] static ezBoundingBoxSphereTemplate<Type> MakeInvalid();

  /// \brief Creates an object from the given center point and extents.
  [[nodiscard]] static ezBoundingBoxSphereTemplate<Type> MakeFromCenterExtents(const ezVec3Template<Type>& vCenter, const ezVec3Template<Type>& vBoxHalfExtents, Type fSphereRadius);

  /// \brief Creates an object that contains all the provided points.
  [[nodiscard]] static ezBoundingBoxSphereTemplate<Type> MakeFromPoints(const ezVec3Template<Type>* pPoints, ezUInt32 uiNumPoints, ezUInt32 uiStride = sizeof(ezVec3Template<Type>));

  /// \brief Creates an object from another bounding box.
  [[nodiscard]] static ezBoundingBoxSphereTemplate<Type> MakeFromBox(const ezBoundingBoxTemplate<Type>& box);

  /// \brief Creates an object from another bounding sphere.
  [[nodiscard]] static ezBoundingBoxSphereTemplate<Type> MakeFromSphere(const ezBoundingSphereTemplate<Type>& sphere);

  /// \brief Creates an object from another bounding box and a sphere.
  [[nodiscard]] static ezBoundingBoxSphereTemplate<Type> MakeFromBoxAndSphere(const ezBoundingBoxTemplate<Type>& box, const ezBoundingSphereTemplate<Type>& sphere);


#if EZ_ENABLED(EZ_MATH_CHECK_FOR_NAN)
  void AssertNotNaN() const
  {
    EZ_ASSERT_ALWAYS(!IsNaN(), "This object contains NaN values. This can happen when you forgot to initialize it before using it. Please check that "
                               "all code-paths properly initialize this object.");
  }
#endif

  /// \brief Checks whether the bounds is in an invalid state.
  bool IsValid() const; // [tested]

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

  /// \brief Returns the bounding box.
  const ezBoundingBoxTemplate<Type> GetBox() const; // [tested]

  /// \brief Returns the bounding sphere.
  const ezBoundingSphereTemplate<Type> GetSphere() const; // [tested]

  /// \brief Expands the bounds such that the given bounds are inside it.
  void ExpandToInclude(const ezBoundingBoxSphereTemplate& rhs); // [tested]

  /// \brief Transforms the bounds in its local space.
  void Transform(const ezMat4Template<Type>& mTransform); // [tested]

public:
  ezVec3Template<Type> m_vCenter;
  Type m_fSphereRadius;
  ezVec3Template<Type> m_vBoxHalfExtents;
};

/// \brief Checks whether this bounds and the other are identical.
template <typename Type>
bool operator==(const ezBoundingBoxSphereTemplate<Type>& lhs, const ezBoundingBoxSphereTemplate<Type>& rhs); // [tested]

/// \brief Checks whether this bounds and the other are not identical.
template <typename Type>
bool operator!=(const ezBoundingBoxSphereTemplate<Type>& lhs, const ezBoundingBoxSphereTemplate<Type>& rhs); // [tested]


#include <Foundation/Math/Implementation/BoundingBoxSphere_inl.h>