CapsuleCollider.hpp

Go to the documentation of this file.

/**************************************************************************
 * EngineSquared v0.1.1
 *
 * EngineSquared is a software package, part of the Engine² organization.
 *
 * This file is part of the EngineSquared project that is under MIT License.
 * Copyright © 2025-present by @EngineSquared, All rights reserved.
 *
 * EngineSquared is a free software: you can redistribute it and/or modify
 * it under the terms of the MIT License. See the project's LICENSE file for
 * the full license text and details.
 *
 * @file CapsuleCollider.hpp
 * @brief Capsule collision shape component
 *
 * User-specified capsule collider for physics simulation.
 * Capsules are ideal for characters and cylindrical objects.
 *
 * @author @EngineSquared
 * @version 0.1.1
 * @date 2025-12-05
 **************************************************************************/
 
#pragma once
 
#include <glm/vec3.hpp>
 
namespace Physics::Component {

struct CapsuleCollider {
    float halfHeight = 0.5f;

    float radius = 0.25f;

    glm::vec3 offset{0.0f, 0.0f, 0.0f};

    CapsuleCollider() = default;

    CapsuleCollider(float hHeight, float r) : halfHeight(hHeight), radius(r) {}

    CapsuleCollider(float hHeight, float r, const glm::vec3 &localOffset)
        : halfHeight(hHeight), radius(r), offset(localOffset)
    {
    }

    [[nodiscard]] float GetTotalHeight() const { return (halfHeight + radius) * 2.0f; }

    [[nodiscard]] float GetCylinderHeight() const { return halfHeight * 2.0f; }

    [[nodiscard]] float GetDiameter() const { return radius * 2.0f; }

    void SetHeight(float capsuleHeight)
    {
        halfHeight = (capsuleHeight * 0.5f) - radius;
        if (halfHeight < 0.0f)
            halfHeight = 0.0f;
    }

    [[nodiscard]] bool IsValid() const { return halfHeight >= 0.0f && radius > 0.0f; }

    [[nodiscard]] bool IsSphere() const { return halfHeight == 0.0f; }

    static CapsuleCollider CreateFromHeight(float capsuleHeight, float r)
    {
        float hHeight = (capsuleHeight * 0.5f) - r;
        return CapsuleCollider(hHeight > 0.0f ? hHeight : 0.0f, r);
    }

    static CapsuleCollider AtOffset(float hHeight, float r, const glm::vec3 &localOffset)
    {
        return CapsuleCollider(hHeight, r, localOffset);
    }
};
 
} // namespace Physics::Component