RigidBody.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 RigidBody.hpp
 * @brief Public RigidBody component for Jolt Physics simulation
 *
 * This component encapsulates all Jolt Physics settings and provides
 * a clean API for users. Internal Jolt data is managed via RigidBodyInternal.
 *
 * @author @EngineSquared
 * @version 0.1.1
 * @date 2025-10-28
 **************************************************************************/
 
#pragma once
 
#include "utils/Layers.hpp"
#include <Jolt/Physics/Body/MotionType.h>
#include <Jolt/Physics/EActivation.h>
#include <cstdint>
 
namespace Physics::Component {

using MotionType = JPH::EMotionType;

using Activation = JPH::EActivation;

struct RigidBody {
    //========================================================================
    // Motion Properties
    //========================================================================

    MotionType motionType = MotionType::Dynamic;

    Activation activation = Activation::Activate;
 
    //========================================================================
    // Mass Properties
    //========================================================================

    float mass = 1.0f;

    bool allowSleeping = true;
 
    //========================================================================
    // Material Properties
    //========================================================================

    float friction = 0.5f;

    float restitution = 0.0f;

    float linearDamping = 0.05f;

    float angularDamping = 0.05f;
 
    //========================================================================
    // Gravity
    //========================================================================

    float gravityFactor = 1.0f;
 
    //========================================================================
    // Layer (for collision filtering)
    //========================================================================

    uint16_t objectLayer = 0;
 
    //========================================================================
    // Helper Methods
    //========================================================================

    static RigidBody CreateStatic()
    {
        RigidBody rb;
        rb.motionType = MotionType::Static;
        rb.activation = Activation::DontActivate;
        rb.objectLayer = Utils::Layers::NON_MOVING;
        rb.mass = 0.0f;
        return rb;
    }

    static RigidBody CreateKinematic()
    {
        RigidBody rb;
        rb.motionType = MotionType::Kinematic;
        rb.activation = Activation::Activate;
        rb.objectLayer = Utils::Layers::MOVING;
        rb.mass = 0.0f;
        return rb;
    }

    static RigidBody CreateDynamic(float bodyMass = 1.0f)
    {
        RigidBody rb;
        rb.motionType = MotionType::Dynamic;
        rb.activation = Activation::Activate;
        rb.objectLayer = Utils::Layers::MOVING;
        rb.mass = bodyMass;
        return rb;
    }
};
 
} // namespace Physics::Component