ConstraintSettings.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 ConstraintSettings.hpp
 * @brief Common settings structure for all constraint types
 *
 * This file provides the base configuration for physics constraints including
 * stiffness, damping, and breaking force/torque thresholds.
 *
 * @author @EngineSquared
 * @version 0.1.1
 * @date 2025-12-04
 **************************************************************************/
 
#pragma once
 
#include <cmath>
#include <cstdint>
#include <limits>
 
namespace Physics::Component {

struct ConstraintSettings {
    //========================================================================
    // Spring Properties
    //========================================================================

    float stiffness = 1.0f;

    float damping = 0.0f;
 
    //========================================================================
    // Breaking Thresholds
    //========================================================================

    float breakForce = 0.0f;

    float breakTorque = 0.0f;
 
    //========================================================================
    // Collision Settings
    //========================================================================

    bool enableCollision = false;
 
    //========================================================================
    // Factory Methods
    //========================================================================

    [[nodiscard]] static ConstraintSettings Rigid()
    {
        ConstraintSettings settings;
        settings.stiffness = 1.0f;
        settings.damping = 0.0f;
        settings.breakForce = 0.0f;
        settings.breakTorque = 0.0f;
        return settings;
    }

    [[nodiscard]] static ConstraintSettings Breakable(float force, float torque = 0.0f)
    {
        ConstraintSettings settings;
        settings.stiffness = 1.0f;
        settings.damping = 0.0f;
        settings.breakForce = force;
        settings.breakTorque = torque;
        return settings;
    }

    [[nodiscard]] static ConstraintSettings Soft(float stiff = 0.5f, float damp = 0.1f)
    {
        ConstraintSettings settings;
        settings.stiffness = stiff;
        settings.damping = damp;
        settings.breakForce = 0.0f;
        settings.breakTorque = 0.0f;
        return settings;
    }

    [[nodiscard]] bool IsBreakable() const
    {
        const bool forceBreakable = breakForce > 0.0f && std::isfinite(breakForce);
        const bool torqueBreakable = breakTorque > 0.0f && std::isfinite(breakTorque);
        return forceBreakable || torqueBreakable;
    }

    [[nodiscard]] bool IsRigid() const { return stiffness >= 1.0f && damping <= 0.0f; }
};
 
} // namespace Physics::Component