anim_graph.h

#include <modkit/anim_graph.h>17 functions · 11 structs · 1 unions · 3 enums · 19 typedefs · 3 macros

Declarative, typed hierarchical animation state machines.

Functions

mk_anim_graph_createfunction

mk_anim_graph_t mk_anim_graph_create(const mk_anim_graph_desc *desc)

Create anim graph.

Parameter	Type	Description
desc	const mk_anim_graph_desc *	Configuration descriptor.

Returns The resulting handle or value.

mk_anim_graph_destroyfunction

void mk_anim_graph_destroy(mk_anim_graph_t graph)

Destroy the anim graph.

Parameter	Type	Description
graph	mk_anim_graph_t	Value for graph.

mk_anim_graph_load_assetfunction

mk_anim_graph_t mk_anim_graph_load_asset(const char *asset_id, mk_anim_json_error *error)

Load a loose path or mounted logical JSON asset through the asset system.

Parameter	Type	Description
asset_id	const char *	Value for asset ID.
error	mk_anim_json_error *	Value for error.

Returns The resulting handle or value.

mk_anim_graph_load_jsonfunction

mk_anim_graph_t mk_anim_graph_load_json(const char *json, mk_anim_json_error *error)

Load JSON for the anim graph.

Parameter	Type	Description
json	const char *	Value for JSON.
error	mk_anim_json_error *	Value for error.

Returns The resulting handle or value.

mk_anim_graph_validfunction

bool mk_anim_graph_valid(mk_anim_graph_t graph)

Perform the anim graph valid operation.

Parameter	Type	Description
graph	mk_anim_graph_t	Value for graph.

Returns True when the operation succeeds.

mk_anim_instance_createfunction

mk_anim_instance_t mk_anim_instance_create(mk_anim_world_t *world, mk_anim_graph_t graph)

Create anim instance.

Parameter	Type	Description
world	mk_anim_world_t *	Value for world.
graph	mk_anim_graph_t	Value for graph.

Returns The resulting handle or value.

mk_anim_instance_create_resolvedfunction

mk_anim_instance_t mk_anim_instance_create_resolved(mk_anim_world_t *world, const mk_anim_instance_desc *desc)

Create resolved for the anim instance.

Parameter	Type	Description
world	mk_anim_world_t *	Value for world.
desc	const mk_anim_instance_desc *	Configuration descriptor.

Returns The resulting handle or value.

mk_anim_instance_destroyfunction

void mk_anim_instance_destroy(mk_anim_world_t *world, mk_anim_instance_t instance)

Destroy the anim instance.

Parameter	Type	Description
world	mk_anim_world_t *	Value for world.
instance	mk_anim_instance_t	Value for instance.

mk_anim_instance_getfunction

mk_result mk_anim_instance_get(const mk_anim_world_t *world, mk_anim_instance_t instance, const char *variable, mk_anim_value_type type, mk_anim_value *value)

Get state from the anim instance.

Parameter	Type	Description
world	const mk_anim_world_t *	Value for world.
instance	mk_anim_instance_t	Value for instance.
variable	const char *	Value for variable.
type	mk_anim_value_type	Value for type.
value	mk_anim_value *	Value to use.

Returns MK_SUCCESS or an error result.

mk_anim_instance_setfunction

mk_result mk_anim_instance_set(mk_anim_world_t *world, mk_anim_instance_t instance, const char *variable, mk_anim_value_type type, mk_anim_value value)

Set state on the anim instance.

Parameter	Type	Description
world	mk_anim_world_t *	Value for world.
instance	mk_anim_instance_t	Value for instance.
variable	const char *	Value for variable.
type	mk_anim_value_type	Value for type.
value	mk_anim_value	Value to use.

Returns MK_SUCCESS or an error result.

mk_anim_instance_signalfunction

mk_result mk_anim_instance_signal(mk_anim_world_t *world, mk_anim_instance_t instance, const char *signal)

Perform the anim instance signal operation.

Parameter	Type	Description
world	mk_anim_world_t *	Value for world.
instance	mk_anim_instance_t	Value for instance.
signal	const char *	Value for signal.

Returns MK_SUCCESS or an error result.

mk_anim_instance_statefunction

const char * mk_anim_instance_state(const mk_anim_world_t *world, mk_anim_instance_t instance)

Perform the anim instance state operation.

Parameter	Type	Description
world	const mk_anim_world_t *	Value for world.
instance	mk_anim_instance_t	Value for instance.

Returns A borrowed pointer, or NULL when unavailable.

mk_anim_instance_validfunction

bool mk_anim_instance_valid(const mk_anim_world_t *world, mk_anim_instance_t instance)

Perform the anim instance valid operation.

Parameter	Type	Description
world	const mk_anim_world_t *	Value for world.
instance	mk_anim_instance_t	Value for instance.

Returns True when the operation succeeds.

mk_anim_world_countfunction

uint32_t mk_anim_world_count(const mk_anim_world_t *world)

Perform the anim world count operation.

Parameter	Type	Description
world	const mk_anim_world_t *	Value for world.

Returns The resulting value.

mk_anim_world_createfunction

mk_anim_world_t * mk_anim_world_create(const mk_anim_world_desc *desc)

Create anim world.

Parameter	Type	Description
desc	const mk_anim_world_desc *	Configuration descriptor.

Returns A borrowed pointer, or NULL when unavailable.

mk_anim_world_destroyfunction

void mk_anim_world_destroy(mk_anim_world_t *world)

Destroy the anim world.

Parameter	Type	Description
world	mk_anim_world_t *	Value for world.

mk_anim_world_stepfunction

void mk_anim_world_step(mk_anim_world_t *world, float dt)

Perform the anim world step operation.

Parameter	Type	Description
world	mk_anim_world_t *	Value for world.
dt	float	Value for dt.

Structs

mk_anim_condition_descstruct

Data for anim condition desc.

Field	Type	Description
type	mk_anim_condition_type	The type.
name	const char *	Variable or signal name.
comparison	mk_anim_compare	The comparison.
value	mk_anim_value	The value.

mk_anim_graphstruct

Data for anim graph.

Field	Type	Description
id	uint32_t	The ID.

mk_anim_graph_descstruct

Data for anim graph desc.

Field	Type	Description
variables	const mk_anim_variable_desc *	The variables.
variable_count	uint32_t	The variable count.
states	const mk_anim_state_desc *	The states.
state_count	uint32_t	The state count.
transitions	const mk_anim_transition_desc *	The transitions.
transition_count	uint32_t	The transition count.
initial_state	uint32_t	A leaf or root state.

mk_anim_instancestruct

Data for anim instance.

Field	Type	Description
id	uint32_t	The ID.

mk_anim_instance_descstruct

Data for anim instance desc.

Field	Type	Description
graph	mk_anim_graph_t	The graph.
callback_resolver	mk_anim_callback_resolver_fn	The callback resolver.
timeline_resolver	mk_anim_timeline_resolver_fn	The timeline resolver.
resolver_user_data	void *	The resolver user data.

mk_anim_json_errorstruct

Data for anim JSON error.

Field	Type	Description
offset	size_t	The offset.
message	char	The message.

mk_anim_state_descstruct

Data for anim state desc.

Field	Type	Description
name	const char *	The name.
parent	uint32_t	MK_ANIM_STATE_NONE for a root state.
on_enter	mk_anim_state_callback_fn	The on enter.
on_update	mk_anim_state_callback_fn	The on update.
on_exit	mk_anim_state_callback_fn	The on exit.
user_data	void *	The user data.
timeline	const char *	Optional name resolved per instance.

mk_anim_timeline_bindingstruct

Timeline states restart/play on entry and pause on exit.

Animation graphs do not step tween worlds; the application remains responsible for their clocks.

Field	Type	Description
world	mk_tween_world_t *	The world.
timeline	mk_tween_t	The timeline.
destroy_with_instance	bool	Destroy the timeline with its animation instance.

mk_anim_transition_descstruct

Data for anim transition desc.

Field	Type	Description
from_state	uint32_t	The from state.
to_state	uint32_t	The to state.
priority	int32_t	The priority.
conditions	const mk_anim_condition_desc *	All conditions must pass.
condition_count	uint32_t	The condition count.

mk_anim_variable_descstruct

Data for anim variable desc.

Field	Type	Description
name	const char *	The name.
type	mk_anim_value_type	The type.
initial	mk_anim_value	The initial.

mk_anim_world_descstruct

Data for anim world desc.

Field	Type	Description
capacity	uint32_t	0 selects 128.
signal_capacity_per_instance	uint32_t	0 selects 32.

Unions

mk_anim_valueunion

Data for anim value.

Field	Type	Description
boolean	bool	The boolean.
integer	int32_t	The integer.
number	float	The number.

Enums

mk_anim_compareenum

Values for anim compare.

Value	Description
MK_ANIM_COMPARE_EQUAL	Selects equal.
MK_ANIM_COMPARE_NOT_EQUAL	Selects not equal.
MK_ANIM_COMPARE_LESS	Selects less.
MK_ANIM_COMPARE_LESS_EQUAL	Selects less equal.
MK_ANIM_COMPARE_GREATER	Selects greater.
MK_ANIM_COMPARE_GREATER_EQUAL	Selects greater equal.

mk_anim_condition_typeenum

Values for anim condition type.

Value	Description
MK_ANIM_CONDITION_VARIABLE	Selects variable.
MK_ANIM_CONDITION_SIGNAL	Selects signal.

mk_anim_value_typeenum

Values for anim value type.

Value	Description
MK_ANIM_BOOL	Selects bool.
MK_ANIM_INT	Selects int.
MK_ANIM_FLOAT	Selects float.

Typedefs

mk_anim_callback_resolver_fntypedef

typedef bool(*) mk_anim_callback_resolver_fn(void *user_data, const char *callback_name, mk_anim_state_callback_fn *out_callback, void **out_callback_user_data)

Callback used for anim callback resolver.

mk_anim_comparetypedef

typedef enum mk_anim_compare mk_anim_compare

Values for anim compare.

mk_anim_condition_desctypedef

typedef struct mk_anim_condition_desc mk_anim_condition_desc

Data for anim condition desc.

mk_anim_condition_typetypedef

typedef enum mk_anim_condition_type mk_anim_condition_type

Values for anim condition type.

mk_anim_graph_desctypedef

typedef struct mk_anim_graph_desc mk_anim_graph_desc

Data for anim graph desc.

mk_anim_graph_ttypedef

typedef struct mk_anim_graph mk_anim_graph_t

Data for anim graph.

mk_anim_instance_desctypedef

typedef struct mk_anim_instance_desc mk_anim_instance_desc

Data for anim instance desc.

mk_anim_instance_ttypedef

typedef struct mk_anim_instance mk_anim_instance_t

Data for anim instance.

mk_anim_json_errortypedef

typedef struct mk_anim_json_error mk_anim_json_error

Data for anim JSON error.

mk_anim_state_callback_fntypedef

typedef void(*) mk_anim_state_callback_fn(mk_anim_instance_t instance, const char *state, float dt, void *user_data)

Callback used for anim state callback.

mk_anim_state_desctypedef

typedef struct mk_anim_state_desc mk_anim_state_desc

Data for anim state desc.

mk_anim_timeline_bindingtypedef

typedef struct mk_anim_timeline_binding mk_anim_timeline_binding

Timeline states restart/play on entry and pause on exit.

Animation graphs do not step tween worlds; the application remains responsible for their clocks.

mk_anim_timeline_resolver_fntypedef

typedef bool(*) mk_anim_timeline_resolver_fn(void *user_data, const char *timeline_name, mk_anim_timeline_binding *out_binding)

Callback used for anim timeline resolver.

mk_anim_transition_desctypedef

typedef struct mk_anim_transition_desc mk_anim_transition_desc

Data for anim transition desc.

mk_anim_valuetypedef

typedef union mk_anim_value mk_anim_value

Data for anim value.

mk_anim_value_typetypedef

typedef enum mk_anim_value_type mk_anim_value_type

Values for anim value type.

mk_anim_variable_desctypedef

typedef struct mk_anim_variable_desc mk_anim_variable_desc

Data for anim variable desc.

mk_anim_world_desctypedef

typedef struct mk_anim_world_desc mk_anim_world_desc

Data for anim world desc.

mk_anim_world_ttypedef

typedef struct mk_anim_world mk_anim_world_t

Type used for anim world.

Macros

MK_ANIM_GRAPH_INVALIDdefine

MK_ANIM_GRAPH_INVALID

Invalid sentinel for anim graph.

MK_ANIM_INSTANCE_INVALIDdefine

MK_ANIM_INSTANCE_INVALID

Invalid sentinel for anim instance.

MK_ANIM_STATE_NONEdefine

MK_ANIM_STATE_NONE

Constant for anim state none.