Provides internal utilities for managing seq_action objects. These methods allow for direct control over actions' state, progression, and other properties. More...

#include <seq_private.h>

Static Public Member Functions
static void	start (seq_action &action)
	Starts a given action.

static void	stop (seq_action &action)
	Stops a given action.

static void	stop_and_finished (seq_action &action)
	Marks a given action as stopped and finished.

static void	stop_when_finished (seq_action &action)
	Marks a given action to stop when finished.

static void	resume (seq_action &action, bool force=false)
	Resumes a given action, optionally forcing the resume.

static void	resume (seq_action &action, const std::string &key)
	Resumes a given action with a specific key.

static void	pause (seq_action &action)
	Pauses a given action.

static void	pause (seq_action &action, const std::string &key)
	Pauses a given action with a specific key.

static void	pause_forced (seq_action &action)
	Forcibly pauses a given action.

static void	pause_forced (seq_action &action, const std::string &key)
	Forcibly pauses a given action with a specific key.

static void	set_speed_multiplier (seq_action &action, float speed_multiplier)
	Sets the speed multiplier for a given action.

static auto	get_speed_multiplier (const seq_action &action) -> float
	Gets the speed multiplier of a given action.

static auto	get_state (const seq_action &action) -> state_t
	Gets the current state of a given action.

static auto	is_stop_when_finished_requested (const seq_action &action) -> bool
	Checks if the action is requested to stop when finished.

static auto	is_stop_and_finished_requested (const seq_action &action) -> bool
	Checks if the action is requested to stop and finish.

static auto	is_running (const seq_action &action) -> bool
	Checks if the action is currently running.

static auto	is_paused (const seq_action &action) -> bool
	Checks if the action is currently paused.

static auto	is_finished (const seq_action &action) -> bool
	Checks if the action is finished.

static auto	update (seq_action &action, duration_t delta) -> state_t
	Updates a given action with a time delta.

static void	set_elapsed (seq_action &self, duration_t elapsed)
	Sets the elapsed time of a given action.

static void	update_elapsed (seq_action &self, duration_t update_time)
	Updates the elapsed time of a given action.

static auto	get_elapsed (const seq_action &self) -> duration_t
	Gets the elapsed time of a given action.

static auto	get_duration (const seq_action &self) -> duration_t
	Gets the total duration of a given action.

static auto	get_overflow (const seq_action &self) -> duration_t
	Computes the overflow duration of a given action if it exceeds its total duration.

Detailed Description

Provides internal utilities for managing seq_action objects. These methods allow for direct control over actions' state, progression, and other properties.

Definition at line 16 of file seq_private.h.

Member Function Documentation

◆ get_duration()

static auto seq::seq_private::get_duration ( const seq_action & self ) -> duration_t

inlinestatic

Gets the total duration of a given action.

Parameters

self	The action to query.

Returns: The total duration of the action.

Definition at line 240 of file seq_private.h.

◆ get_elapsed()

static auto seq::seq_private::get_elapsed ( const seq_action & self ) -> duration_t

inlinestatic

Gets the elapsed time of a given action.

Parameters

self	The action to query.

Returns: The elapsed time of the action.

Definition at line 230 of file seq_private.h.

◆ get_overflow()

static auto seq::seq_private::get_overflow ( const seq_action & self ) -> duration_t

inlinestatic

Computes the overflow duration of a given action if it exceeds its total duration.

Parameters

self	The action to query.

Returns: The overflow duration, or zero if the action has not overflowed.

Definition at line 250 of file seq_private.h.

◆ get_speed_multiplier()

static auto seq::seq_private::get_speed_multiplier ( const seq_action & action ) -> float

inlinestatic

Gets the speed multiplier of a given action.

Parameters

action The action to query.

Returns: The current speed multiplier of the action.

Definition at line 129 of file seq_private.h.

◆ get_state()

static auto seq::seq_private::get_state ( const seq_action & action ) -> state_t

inlinestatic

Gets the current state of a given action.

Parameters

action The action to query.

Returns: The current state of the action.

Definition at line 139 of file seq_private.h.

◆ is_finished()

static auto seq::seq_private::is_finished ( const seq_action & action ) -> bool

inlinestatic

Checks if the action is finished.

Parameters

action The action to query.

Returns: True if the action is finished, false otherwise.

Definition at line 189 of file seq_private.h.

◆ is_paused()

static auto seq::seq_private::is_paused ( const seq_action & action ) -> bool

inlinestatic

Checks if the action is currently paused.

Parameters

action The action to query.

Returns: True if the action is paused, false otherwise.

Definition at line 179 of file seq_private.h.

◆ is_running()

static auto seq::seq_private::is_running ( const seq_action & action ) -> bool

inlinestatic

Checks if the action is currently running.

Parameters

action The action to query.

Returns: True if the action is running, false otherwise.

Definition at line 169 of file seq_private.h.

◆ is_stop_and_finished_requested()

static auto seq::seq_private::is_stop_and_finished_requested ( const seq_action & action ) -> bool

inlinestatic

Checks if the action is requested to stop and finish.

Parameters

action The action to query.

Returns: True if the action is requested to stop and finish, false otherwise.

Definition at line 159 of file seq_private.h.

◆ is_stop_when_finished_requested()

static auto seq::seq_private::is_stop_when_finished_requested ( const seq_action & action ) -> bool

inlinestatic

Checks if the action is requested to stop when finished.

Parameters

action The action to query.

Returns: True if the action is requested to stop when finished, false otherwise.

Definition at line 149 of file seq_private.h.

◆ pause() [1/2]

static void seq::seq_private::pause ( seq_action & action )

inlinestatic

Pauses a given action.

Parameters

action The action to pause.

Definition at line 78 of file seq_private.h.

◆ pause() [2/2]

static void seq::seq_private::pause	(	seq_action &	action,
		const std::string &	key )

inlinestatic

Pauses a given action with a specific key.

Parameters

action	The action to pause.
key	The key associated with the action.

Definition at line 88 of file seq_private.h.

◆ pause_forced() [1/2]

static void seq::seq_private::pause_forced ( seq_action & action )

inlinestatic

Forcibly pauses a given action.

Parameters

action The action to forcibly pause.

Definition at line 97 of file seq_private.h.

◆ pause_forced() [2/2]

static void seq::seq_private::pause_forced	(	seq_action &	action,
		const std::string &	key )

inlinestatic

Forcibly pauses a given action with a specific key.

Parameters

action	The action to forcibly pause.
key	The key associated with the action.

Definition at line 107 of file seq_private.h.

◆ resume() [1/2]

static void seq::seq_private::resume	(	seq_action &	action,
		bool	force = false )

inlinestatic

Resumes a given action, optionally forcing the resume.

Parameters

action	The action to resume.
force	If true, forces the action to resume (default is false).

Definition at line 59 of file seq_private.h.

◆ resume() [2/2]

static void seq::seq_private::resume	(	seq_action &	action,
		const std::string &	key )

inlinestatic

Resumes a given action with a specific key.

Parameters

action	The action to resume.
key	The key associated with the action.

Definition at line 69 of file seq_private.h.

◆ set_elapsed()

static void seq::seq_private::set_elapsed	(	seq_action &	self,
		duration_t	elapsed )

inlinestatic

Sets the elapsed time of a given action.

Parameters

self	The action to modify.
elapsed	The elapsed time to set.

Definition at line 210 of file seq_private.h.

◆ set_speed_multiplier()

static void seq::seq_private::set_speed_multiplier	(	seq_action &	action,
		float	speed_multiplier )

inlinestatic

Sets the speed multiplier for a given action.

Parameters

action	The action to modify.
speed_multiplier	The speed multiplier to set (clamped between 0.0f and 100.0f).

Definition at line 117 of file seq_private.h.

◆ start()

static void seq::seq_private::start ( seq_action & action )

inlinestatic

Starts a given action.

Parameters

action The action to start.

Definition at line 22 of file seq_private.h.

◆ stop()

static void seq::seq_private::stop ( seq_action & action )

inlinestatic

Stops a given action.

Parameters

action The action to stop.

Definition at line 31 of file seq_private.h.

◆ stop_and_finished()

static void seq::seq_private::stop_and_finished ( seq_action & action )

inlinestatic

Marks a given action as stopped and finished.

Parameters

action The action to mark.

Definition at line 40 of file seq_private.h.

◆ stop_when_finished()

static void seq::seq_private::stop_when_finished ( seq_action & action )

inlinestatic

Marks a given action to stop when finished.

Parameters

action The action to mark.

Definition at line 49 of file seq_private.h.

◆ update()

static auto seq::seq_private::update	(	seq_action &	action,
		duration_t	delta ) -> state_t

inlinestatic

Updates a given action with a time delta.

Parameters

action	The action to update.
delta	The time delta to apply.

Returns: The current state of the action after the update.

Definition at line 200 of file seq_private.h.

◆ update_elapsed()

static void seq::seq_private::update_elapsed	(	seq_action &	self,
		duration_t	update_time )

inlinestatic

Updates the elapsed time of a given action.

Parameters

self	The action to modify.
update_time	The time to add to the elapsed duration.

Definition at line 220 of file seq_private.h.

The documentation for this struct was generated from the following file:

C:/Workspace/github/UnravelEngine/UnravelEngine/engine/core/seq/seq_private.h

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ get_duration()

◆ get_elapsed()

◆ get_overflow()

◆ get_speed_multiplier()

◆ get_state()

◆ is_finished()

◆ is_paused()

◆ is_running()

◆ is_stop_and_finished_requested()

◆ is_stop_when_finished_requested()

◆ pause() [1/2]

◆ pause() [2/2]

◆ pause_forced() [1/2]

◆ pause_forced() [2/2]

◆ resume() [1/2]

◆ resume() [2/2]

◆ set_elapsed()

◆ set_speed_multiplier()

◆ start()

◆ stop()

◆ stop_and_finished()

◆ stop_when_finished()

◆ update()

◆ update_elapsed()