Skip to content

Class atlas::physics::physics_engine

ClassList > atlas > physics > physics_engine

The manager class for all physics engines. Manages the physics contexts and the collision engines.

  • #include <physics_engine.hpp>

Public Functions

Type Name
physics_engine () = default
physics_engine (const jolt_settings & p_settings, const ref< physics_context > & p_engine, const ref< physics_api > & p_user_api)
void physics_step ()
Runs a single frame of the simulation. Should at minimum be called 60 fps. If below, it must be called twice.
void run_contact_add ()
Allows for contacts to be handled by the user right after physics_step has fully run.
void start_runtime ()
The runtime is specifically the way to start the physics, utilizing defined data from level_scene and eventually any scene to create a physics scene and manage physics step.
void stop_runtime ()
Deletes all physics bodies and shapes. Preps itself for runtime to be called again.

Public Functions Documentation

function physics_engine [1/2]

atlas::physics::physics_engine::physics_engine () = default

function physics_engine [2/2]

atlas::physics::physics_engine::physics_engine (
    const jolt_settings & p_settings,
    const ref < physics_context > & p_engine,
    const ref < physics_api > & p_user_api
)

function physics_step

Runs a single frame of the simulation. Should at minimum be called 60 fps. If below, it must be called twice. 

void atlas::physics::physics_engine::physics_step ()

function run_contact_add

Allows for contacts to be handled by the user right after physics_step has fully run. 

void atlas::physics::physics_engine::run_contact_add ()

Warning:

It is important that these stay distict until we have a job manager to maintain them.

function start_runtime

The runtime is specifically the way to start the physics, utilizing defined data from level_scene and eventually any scene to create a physics scene and manage physics step. 

void atlas::physics::physics_engine::start_runtime ()

function stop_runtime

Deletes all physics bodies and shapes. Preps itself for runtime to be called again. 

void atlas::physics::physics_engine::stop_runtime ()

The documentation for this class was generated from the following file TheAtlasEngine/atlas/physics/physics_3d/physics_engine.hpp