SphereCollider.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 SphereCollider.hpp
 * @brief Sphere collision shape component
 *
 * User-specified sphere collider for physics simulation.
 * Spheres are the most efficient collision shape.
 *
 * @author @EngineSquared
 * @version 0.1.1
 * @date 2025-12-05
 **************************************************************************/
 
#pragma once
 
#include <glm/vec3.hpp>
 
namespace Physics::Component {

struct SphereCollider {
    float radius = 0.5f;

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

    SphereCollider() = default;

    explicit SphereCollider(float r) : radius(r) {}

    SphereCollider(float r, const glm::vec3 &localOffset) : radius(r), offset(localOffset) {}

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

    void SetDiameter(float diameter) { radius = diameter * 0.5f; }

    [[nodiscard]] bool IsValid() const { return radius > 0.0f; }
 
    //=========================================================================
    // Factory methods
    //=========================================================================

    static SphereCollider Unit() { return SphereCollider(1.0f); }

    static SphereCollider Ball(float r) { return SphereCollider(r); }

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