HitboxUtils.hpp

Go to the documentation of this file.

///
/// @file HitboxUtils.hpp
/// @brief Utility functions for hitbox calculations
/// @namespace utl
///
 
#pragma once
 
#include <utility>
 
namespace utl
{
    ///
    /// @brief Calculate the center position of a sprite
    /// @param x Sprite X position
    /// @param y Sprite Y position
    /// @param spriteWidth Sprite width
    /// @param spriteHeight Sprite height
    /// @param scale Sprite scale
    /// @return Pair of (centerX, centerY)
    ///
    inline std::pair<float, float> calculateSpriteCenter(const float x, const float y, const float spriteWidth,
                                                         const float spriteHeight, const float scale)
    {
        return {x + (spriteWidth * scale) / 2.0f, y + (spriteHeight * scale) / 2.0f};
    }
 
    ///
    /// @brief Calculate hitbox offsets to center the hitbox on the sprite
    /// @param spriteWidth Sprite width
    /// @param spriteHeight Sprite height
    /// @param scale Sprite scale
    /// @return Pair of (offsetX, offsetY)
    ///
    inline std::pair<float, float> calculateHitboxOffsets(const float spriteWidth, const float spriteHeight,
                                                          const float scale)
    {
        return {(spriteWidth * scale) / 2.0f, (spriteHeight * scale) / 2.0f};
    }
 
    ///
    /// @brief Calculate hitbox offsets relative to sprite position
    /// @param x Sprite X position
    /// @param y Sprite Y position
    /// @param spriteWidth Sprite width
    /// @param spriteHeight Sprite height
    /// @param scale Sprite scale
    /// @return Pair of (offsetX, offsetY) relative to sprite position
    ///
    inline std::pair<float, float> calculateHitboxOffsetsRelative(const float x, const float y, const float spriteWidth,
                                                                  const float spriteHeight, const float scale)
    {
        auto [centerX, centerY] = calculateSpriteCenter(x, y, spriteWidth, spriteHeight, scale);
        return {centerX - x, centerY - y};
    }
} // namespace utl