blob: 0921c19ad070ce1272b57df44caab97d49b20bf1 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
|
/**
* @file transform_hierarchy.h
*/
#pragma once
#include "maths_types.h"
#include "ral.h"
#include "render_types.h"
#define MAX_TF_NODE_CHILDREN \
32 /** TEMP: Make it simpler to manage children in `transform_node`s */
typedef struct transform_hierarchy transform_hierarchy;
struct transform_node {
model_handle model; /** A handle back to what model this node represents */
transform tf;
mat4 local_matrix_tf; /** cached local affine transform */
mat4 world_matrix_tf; /** cached world-space affine transform */
struct transform_node* parent;
struct transform_node* children[MAX_TF_NODE_CHILDREN];
u32 n_children;
struct transform_hierarchy* tfh;
};
typedef struct transform_node transform_node;
// --- Lifecycle
/** @brief Allocates and returns an empty transform hierarchy with a root node */
transform_hierarchy* transform_hierarchy_create();
/**
* @brief recursively frees all the children and then finally itself
* @note in the future we can use an object pool for the nodes
*/
void transform_hierarchy_free(transform_hierarchy* tfh);
// --- Main usecase
/** @brief Updates matrices of any invalidated nodes based on the `is_dirty` flag inside `transform`
*/
void transform_hierarchy_propagate_transforms(transform_hierarchy* tfh);
// --- Queries
/** @brief Get a pointer to the root node */
transform_node* transform_hierarchy_root_node(transform_hierarchy* tfh);
// --- Mutations
transform_node* transform_hierarchy_add_node(transform_node* parent, model_handle model,
transform tf);
void transform_hierarchy_delete_node(transform_node* node);
// --- Traversal
/**
* @brief Perform a depth-first search traversal starting from `start_node`.
* @param start_node The starting node of the traversal.
* @param visit_node The function to call for each node visited. The callback should return false to
stop the traversal early.
* @param is_pre_order Indicates whether to do pre-order or post-order traversal i.e. when to call
the `visit_node` function.
* @param ctx_data An optional pointer to data that is be passed on each call to `visit_node`. Can
be used to carry additional information or context.
*
* @note The main use-cases are:
1. traversing the whole tree to update cached 4x4 affine transform matrices (post-order)
2. freeing child nodes after deleting a node in the tree (post-order)
3. debug pretty printing the whole tree (post-order)
*/
void transform_hierarchy_dfs(transform_node* start_node,
bool (*visit_node)(transform_node* node, void* ctx_data),
bool is_pre_order, void* ctx_data);
struct core;
void transform_hierarchy_debug_print(transform_node* start_node, struct core* core);
|
