scene.h

Go to the documentation of this file.

#pragma once
 
#include "assets/kasset_types.h"
#include "audio/kaudio_types.h"
#include "core_resource_types.h"
#include "defines.h"
#include "graphs/hierarchy_graph.h"
#include "identifiers/khandle.h"
#include "kresources/kresource_types.h"
#include "math/math_types.h"
#include "resources/debug/debug_grid.h"
#include "systems/static_mesh_system.h"
 
struct frame_data;
struct render_packet;
struct directional_light;
struct point_light;
struct skybox;
struct water_plane;
struct camera;
struct scene_config;
struct terrain;
struct ray;
struct raycast_result;
struct transform;
struct viewport;
struct geometry_render_data;
 
typedef enum scene_state {
    SCENE_STATE_UNINITIALIZED,
    SCENE_STATE_INITIALIZED,
    SCENE_STATE_LOADING,
    SCENE_STATE_LOADED,
    SCENE_STATE_UNLOADING,
    SCENE_STATE_UNLOADED
} scene_state;
 
typedef struct scene_attachment {
    scene_node_attachment_type attachment_type;
    // Handle into the hierarchy graph.
    khandle hierarchy_node_handle;
    // A handle indexing into the resource array of the given type (i.e. meshes).
    khandle resource_handle;
 
    u32 tag_count;
    kname* tags;
} scene_attachment;
 
typedef enum scene_flag {
    SCENE_FLAG_NONE = 0,
    /* @brief Indicates if the scene can be saved once modified
     * (i.e. read-only would be used for runtime, writing would
     * be used in editor, etc.)
     */
    SCENE_FLAG_READONLY = 1
} scene_flag;
 
// Bitwise flags to be used on scene load, etc.
typedef u32 scene_flags;
 
typedef struct scene_node_metadata {
    u32 index;
    // Metadata considered stale/non-existant if INVALID_ID_U64
    u64 uniqueid;
 
    // The name of the node.
    kname name;
} scene_node_metadata;
 
typedef struct scene_static_mesh_metadata {
    kname resource_name;
    kname package_name;
} scene_static_mesh_metadata;
 
typedef struct scene_terrain_metadata {
    kname name;
    kname resource_name;
    kname package_name;
} scene_terrain_metadata;
 
typedef struct scene_skybox_metadata {
    kname cubemap_name;
    kname package_name;
} scene_skybox_metadata;
 
typedef struct scene_water_plane_metadata {
    u32 reserved;
} scene_water_plane_metadata;
 
struct scene_audio_emitter;
struct scene_volume;
struct scene_hit_sphere;
 
typedef struct scene {
    u32 id;
    scene_flags flags;
 
    scene_state state;
    b8 enabled;
 
    kname name;
    char* description;
 
    // darray of directional lights.
    struct directional_light* dir_lights;
    // Array of scene attachments for directional lights.
    scene_attachment* directional_light_attachments;
 
    // darray of point lights.
    struct point_light* point_lights;
    // Array of scene attachments for point lights.
    scene_attachment* point_light_attachments;
 
    // darray of audio emitters.
    struct scene_audio_emitter* audio_emitters;
    // Array of scene attachments for audio_emitters.
    scene_attachment* audio_emitter_attachments;
 
    // darray of static meshes.
    kstatic_mesh_instance* static_meshes;
    // Array of scene attachments for meshes.
    scene_attachment* mesh_attachments;
    // Array of mesh metadata.
    scene_static_mesh_metadata* mesh_metadata;
 
    // darray of terrains.
    struct terrain* terrains;
    // Array of scene attachments for terrains.
    scene_attachment* terrain_attachments;
    // Array of terrain metadata.
    scene_terrain_metadata* terrain_metadata;
 
    // darray of skyboxes.
    struct skybox* skyboxes;
    // Array of scene attachments for skyboxes.
    scene_attachment* skybox_attachments;
    // Array of skybox metadata.
    scene_skybox_metadata* skybox_metadata;
 
    // darray of water planes.
    struct water_plane* water_planes;
    // Array of scene attachments for water planes.
    scene_attachment* water_plane_attachments;
    // Array of water plane metadata.
    scene_water_plane_metadata* water_plane_metadata;
 
    // darray of volumes.
    struct scene_volume* volumes;
    // Array of scene attachments for volumes.
    scene_attachment* volume_attachments;
 
    // darray of hit spheres.
    struct scene_hit_sphere* hit_spheres;
    // Array of scene attachments for hit spheres.
    scene_attachment* hit_sphere_attachments;
 
    // A grid for the scene.
    debug_grid grid;
 
    // A pointer to the scene configuration resource.
    kasset_scene* config;
 
    hierarchy_graph hierarchy;
 
    // An array of node metadata, indexed by hierarchy graph handle.
    // Marked as unused by id == INVALID_ID
    // Size of this array is always highest id+1. Does not shrink on node destruction.
    scene_node_metadata* node_metadata;
 
    // The number of node_metadatas currently allocated.
    u32 node_metadata_count;
 
} scene;
 
KAPI b8 scene_create(kasset_scene* config, scene_flags flags, scene* out_scene);
 
KAPI b8 scene_initialize(scene* scene);
 
KAPI b8 scene_load(scene* scene);
 
KAPI b8 scene_unload(scene* scene, b8 immediate);
 
KAPI void scene_destroy(scene* s);
 
KAPI b8 scene_update(scene* scene, const struct frame_data* p_frame_data);
 
KAPI void scene_render_frame_prepare(scene* scene, const struct frame_data* p_frame_data);
 
KAPI void scene_update_lod_from_view_position(scene* scene, const struct frame_data* p_frame_data, vec3 view_position, f32 near_clip, f32 far_clip);
 
KAPI b8 scene_raycast(scene* scene, const struct ray* r, struct raycast_result* out_result);
 
KAPI b8 scene_debug_render_data_query(scene* scene, u32* data_count, struct geometry_render_data** debug_geometries);
 
KAPI b8 scene_mesh_render_data_query(const scene* scene, const frustum* f, vec3 center, struct frame_data* p_frame_data, u32* out_count, struct geometry_render_data** out_geometries);
KAPI b8 scene_mesh_render_data_query_from_line(const scene* scene, vec3 direction, vec3 center, f32 radius, struct frame_data* p_frame_data, u32* out_count, struct geometry_render_data** out_geometries);
 
KAPI b8 scene_terrain_render_data_query(const scene* scene, const frustum* f, vec3 center, struct frame_data* p_frame_data, u32* out_count, struct geometry_render_data** out_terrain_geometries);
KAPI b8 scene_terrain_render_data_query_from_line(const scene* scene, vec3 direction, vec3 center, f32 radius, struct frame_data* p_frame_data, u32* out_count, struct geometry_render_data** out_geometries);
 
KAPI b8 scene_water_plane_query(const scene* scene, const frustum* f, vec3 center, struct frame_data* p_frame_data, u32* out_count, struct water_plane*** out_water_planes);
 
KAPI b8 scene_node_xform_get_by_name(const scene* scene, kname name, khandle* out_xform_handle);
KAPI b8 scene_node_xform_get(const scene* scene, khandle node_handle, khandle* out_xform_handle);
KAPI b8 scene_node_local_matrix_get(const scene* scene, khandle node_handle, mat4* out_matrix);
KAPI b8 scene_node_local_matrix_get_by_name(const scene* scene, kname name, mat4* out_matrix);
 
KAPI b8 scene_node_exists(const scene* s, kname name);
KAPI b8 scene_node_child_count_get(const scene* s, kname name, u32* out_child_count);
KAPI b8 scene_node_child_name_get_by_index(const scene* s, kname name, u32 index, kname* out_child_name);
 
KAPI b8 scene_save(scene* s);