hierarchy_graph.h

Go to the documentation of this file.

 
#ifndef _XFORM_GRAPH_H_
#define _XFORM_GRAPH_H_
 
#include <identifiers/khandle.h>
#include <math/math_types.h>
 
struct frame_data;
 
typedef struct hierarchy_graph_view_node {
    khandle node_handle;
    khandle xform_handle;
 
    // An index into the view's nodes array. INVALID_ID if no parent.
    u32 parent_index;
 
    // darray An array of indices into the view's nodes array.
    u32* children;
} hierarchy_graph_view_node;
 
typedef struct hierarchy_graph_view {
    // darray A collective list of all view nodes.
    hierarchy_graph_view_node* nodes;
    // darray An array of indices into the nodes array.
    u32* root_indices;
} hierarchy_graph_view;
 
// LEFTOFF: This node structure and the graph below should
// likely be opaque to the outside. External references should
// only deal with handles and nothing more.
// A separate, read-only external "view" tree structure could be
// provided to anything that needs to know about the heirachy (i.e. an editor).
 
typedef struct hierarchy_graph {
    u32 nodes_allocated;
    // Node indices. Populated nodes will match index in the array. Invalid handle = empty slot.
    khandle* node_handles;
    // Parent indices in the internal node array.
    u32* parent_indices;
    // Levels within the hierarchy. 0 = a root node.
    // NOTE: might just keep this in debug builds only, but it might
    // be useful for something.
    u8* levels;
    // Flags to mark the node as dirty.
    b8* dirty_flags;
 
    // Handles to the transforms.
    // NOTE: This can be an invalid handle, meaning that this node
    // does not have a transform. This allows nodes to exist in the hierarchy
    // which do not have transforms (i.e. a skybox doesn't need one).
    khandle* xform_handles;
 
    // A view of the tree.
    hierarchy_graph_view view;
} hierarchy_graph;
 
KAPI b8 hierarchy_graph_create(hierarchy_graph* out_graph);
 
KAPI void hierarchy_graph_destroy(hierarchy_graph* graph);
 
KAPI void hierarchy_graph_update(hierarchy_graph* graph);
 
KAPI khandle hierarchy_graph_xform_handle_get(const hierarchy_graph* graph, khandle node_handle);
 
KAPI b8 hierarchy_graph_xform_local_matrix_get(const hierarchy_graph* graph, khandle node_handle, mat4* out_matrix);
 
KAPI khandle hierarchy_graph_parent_handle_get(const hierarchy_graph* graph, khandle node_handle);
 
KAPI khandle hierarchy_graph_parent_xform_handle_get(const hierarchy_graph* graph, khandle node_handle);
 
KAPI khandle hierarchy_graph_root_add(hierarchy_graph* graph);
 
KAPI khandle hierarchy_graph_root_add_with_xform(hierarchy_graph* graph, khandle xform_handle);
 
KAPI khandle hierarchy_graph_child_add(hierarchy_graph* graph, khandle parent_node_handle);
 
KAPI khandle hierarchy_graph_child_add_with_xform(hierarchy_graph* graph, khandle parent_node_handle, khandle xform_handle);
 
KAPI u32 hierarchy_graph_child_count_get(const hierarchy_graph* graph, khandle parent_node_handle);
 
KAPI b8 hierarchy_graph_child_get_by_index(const hierarchy_graph* graph, khandle parent_node_handle, u32 index, khandle* out_handle);
 
KAPI void hierarchy_graph_node_remove(hierarchy_graph* graph, khandle* node_handle, b8 release_xform);
 
KAPI quat hierarchy_graph_world_rotation_get(const hierarchy_graph* graph, khandle node_handle);
 
KAPI vec3 hierarchy_graph_world_position_get(const hierarchy_graph* graph, khandle node_handle);
 
KAPI vec3 hierarchy_graph_world_scale_get(const hierarchy_graph* graph, khandle node_handle);
 
#endif