engine-api/html/seq_8h_source.html

#pragma once

#include "seq_core.h"

#include "seq_manager.h"

#include <hpp/source_location.hpp>


namespace seq

{

auto start(seq_action action,

           const seq_scope_policy& scope_policy = {},

           hpp::source_location location = hpp::source_location::current()) -> seq_id_t;


auto queue(seq_action action,

           const seq_scope_policy& scope_policy = {},

           hpp::source_location location = hpp::source_location::current()) -> seq_id_t;


void stop(seq_id_t id);


void pause(seq_id_t id);


void resume(seq_id_t id);


void stop_when_finished(seq_id_t id);


void stop_and_finish(seq_id_t id, duration_t finish_after = 0ms);


void update(duration_t delta);


void update(duraiton_secs_t delta);


void shutdown();


auto is_stopping(seq_id_t id) -> bool;


auto is_running(seq_id_t id) -> bool;


auto is_paused(seq_id_t id) -> bool;


auto is_finished(seq_id_t id) -> bool;


auto has_action_with_scope(const std::string& scope_id) -> bool;


void set_speed_multiplier(seq_id_t id, float speed_multiplier = 1.0f);


auto get_speed_multiplier(seq_id_t id) -> float;


auto get_elapsed(seq_id_t id) -> duration_t;


void set_elapsed(seq_id_t id, duration_t duration);


void update(seq_id_t id, duration_t duration);


auto get_duration(seq_id_t id) -> duration_t;


auto get_overflow(seq_id_t id) -> duration_t;


auto get_percent(seq_id_t id) -> float;


namespace manager

{

void push(seq_manager& mgr);


void pop();

} // namespace manager


namespace scope

{

void push(const std::string& scope);


void close(const std::string& scope);


void pop();


void clear();


auto get_current() -> const std::string&;


void stop_all(const std::string& scope);


void pause_all(const std::string& scope);


void resume_all(const std::string& scope);


void pause_all(const std::string& scope, const std::string& key);


void resume_all(const std::string& scope, const std::string& key);


void stop_and_finish_all(const std::string& scope);


void stop_when_finished_all(const std::string& scope);

} // namespace scope


} // namespace seq

seq::manager::pop
void pop()
Pops the top sequence manager from the stack.
Definition seq.cpp:203

seq::manager::push
void push(seq_manager &mgr)
Pushes a sequence manager to the stack.
Definition seq.cpp:199

seq::scope::pause_all
void pause_all(const std::string &scope)
Pauses all actions within the specified scope.
Definition seq.cpp:165

seq::scope::stop_when_finished_all
void stop_when_finished_all(const std::string &scope)
Marks all actions within the specified scope to stop when they finish.
Definition seq.cpp:190

seq::scope::push
void push(const std::string &scope)
Pushes a new scope to the stack.
Definition seq.cpp:135

seq::scope::stop_all
void stop_all(const std::string &scope)
Stops all actions within the specified scope.
Definition seq.cpp:160

seq::scope::get_current
auto get_current() -> const std::string &
Gets the name of the current scope.
Definition seq.cpp:155

seq::scope::pop
void pop()
Pops the current scope from the stack.
Definition seq.cpp:140

seq::scope::close
void close(const std::string &scope)
Closes the specified scope.
Definition seq.cpp:145

seq::scope::clear
void clear()
Clears all scopes from the stack.
Definition seq.cpp:150

seq::scope::resume_all
void resume_all(const std::string &scope)
Resumes all actions within the specified scope.
Definition seq.cpp:170

seq::scope::stop_and_finish_all
void stop_and_finish_all(const std::string &scope)
Stops and finishes all actions within the specified scope.
Definition seq.cpp:185

seq
Provides a sequence-based action management system for controlling and scheduling actions.
Definition seq_internal.cpp:7

seq::seq_id_t
size_t seq_id_t
Represents a unique identifier for sequence actions.
Definition seq_common.h:53

seq::update
void update(seq_id_t id, duration_t delta)
Updates the elapsed duration of a specific action.
Definition seq.cpp:100

seq::is_finished
auto is_finished(seq_id_t id) -> bool
Checks if the action has finished.
Definition seq.cpp:60

seq::duraiton_secs_t
std::chrono::duration< float > duraiton_secs_t
Represents a duration in seconds as a floating-point value.
Definition seq_common.h:35

seq::set_elapsed
void set_elapsed(seq_id_t id, duration_t duration)
Sets the elapsed duration of an action.
Definition seq.cpp:85

seq::is_paused
auto is_paused(seq_id_t id) -> bool
Checks if the action is paused.
Definition seq.cpp:55

seq::resume
void resume(const seq_id_t id)
Resumes the action associated with the given ID.
Definition seq.cpp:30

seq::get_duration
auto get_duration(seq_id_t id) -> duration_t
Gets the total duration of an action.
Definition seq.cpp:90

seq::get_overflow
auto get_overflow(seq_id_t id) -> duration_t
Gets the overflow duration of an action.
Definition seq.cpp:95

seq::stop_and_finish
void stop_and_finish(seq_id_t id, duration_t finish_after)
Stops the action after a specified duration.
Definition seq.cpp:40

seq::is_running
auto is_running(seq_id_t id) -> bool
Checks if the action is running.
Definition seq.cpp:50

seq::shutdown
void shutdown()
Shuts down the action management system, stopping all actions.
Definition seq.cpp:128

seq::set_speed_multiplier
void set_speed_multiplier(seq_id_t id, float speed_multiplier)
Sets the speed multiplier for an action.
Definition seq.cpp:70

seq::queue
auto queue(seq_action action, const seq_scope_policy &scope_policy, hpp::source_location location) -> seq_id_t
Queues a new action.
Definition seq.cpp:14

seq::is_stopping
auto is_stopping(seq_id_t id) -> bool
Checks if the action is stopping.
Definition seq.cpp:45

seq::get_speed_multiplier
auto get_speed_multiplier(seq_id_t id) -> float
Gets the speed multiplier of an action.
Definition seq.cpp:75

seq::get_elapsed
auto get_elapsed(seq_id_t id) -> duration_t
Gets the elapsed duration of an action.
Definition seq.cpp:80

seq::stop_when_finished
void stop_when_finished(seq_id_t id)
Marks the action to stop when it finishes.
Definition seq.cpp:35

seq::has_action_with_scope
auto has_action_with_scope(const std::string &scope_id) -> bool
Checks if there is an action associated with the given scope ID.
Definition seq.cpp:65

seq::get_percent
auto get_percent(seq_id_t id) -> float
Gets the percentage completion of an action.
Definition seq.cpp:105

seq::stop
void stop(seq_id_t id)
Stops the action associated with the given ID.
Definition seq.cpp:20

seq::duration_t
std::chrono::nanoseconds duration_t
Represents a duration in nanoseconds.
Definition seq_common.h:41

seq::pause
void pause(const seq_id_t id)
Pauses the action associated with the given ID.
Definition seq.cpp:25

start
std::vector< math::vec3 > start
Definition particle_system_soa.cpp:366

seq_core.h

seq_manager.h