ConstraintInternal.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 ConstraintInternal.hpp
 * @brief Internal constraint component for Jolt Physics data storage
 *
 * This component is automatically created/destroyed via entt hooks when
 * constraint components are added/removed. Users should never directly
 * interact with this component.
 *
 * @author @EngineSquared
 * @version 0.1.1
 * @date 2025-12-04
 **************************************************************************/
 
#pragma once
 
// clang-format off
#include <Jolt/Jolt.h>
// clang-format on
 
#include <Jolt/Physics/Constraints/Constraint.h>
 
namespace Physics::Component {

enum class ConstraintType : uint8_t {
    Fixed,    
    Distance, 
    Point     
};

struct ConstraintInternal {
    JPH::Constraint *constraint = nullptr;

    ConstraintType type = ConstraintType::Fixed;

    bool broken = false;

    float breakForce = 0.0f;
    float breakTorque = 0.0f;

    ConstraintInternal() = default;

    ConstraintInternal(JPH::Constraint *c, ConstraintType t) : constraint(c), type(t) {}

    ConstraintInternal(JPH::Constraint *c, ConstraintType t, float force, float torque)
        : constraint(c), type(t), breakForce(force), breakTorque(torque)
    {
    }

    [[nodiscard]] bool IsValid() const { return constraint != nullptr; }

    [[nodiscard]] bool IsBreakable() const { return breakForce > 0.0f || breakTorque > 0.0f; }
};
 
} // namespace Physics::Component