scene.h

Go to the documentation of this file.

/*!****************************************************************//*!*
 * \file   scene.h
 * \brief  Scene class defintion module.
 * 
 * \author Sabitov Kirill
 * \date   02 July 2022
 *********************************************************************/
 
#pragma once
 
#include <entt.hpp>
#include "base.h"
 
namespace scl
{
    class event;
    class scene_object;
    class frame_buffer;
    class shader;
    class mesh;
 
    using scene_object_handle = entt::entity;
 
    class scene
    {
        friend class scene_object;
        friend class scene_serializer;
        friend class scene_hierarchy_window;
 
    private: 
        entt::registry Registry {}; 
        int     ViewportId { 30 };             
        int     ViewportWidth { 16 };          
        int     ViewportHeight { 16 };         
        vec3    EnviromentAmbient { 0.1f };    
        float   UpdateDelay {};                
    public: 
        int GetViewportId() const { return ViewportId; }
        const vec3 &GetEnviromentAmbient() const { return EnviromentAmbient; }
 
        void SetViewportId(int ViewportId) { this->ViewportId = ViewportId; }
        void SetEnviromentAmbient(const vec3 &EnviromentAmbient) { this->EnviromentAmbient = EnviromentAmbient; }
 
    private:  
        /*!*
         * Perform scene scripts OnUpdate functions calls function.
         * 
         * \param None.
         * \return None.
         */
        void CallUpdate();
 
    public:
        scene();
 
        ~scene();
 
        /*!*
         * Perform scene rendering function.
         *
         * \param None.
         * \return None.
         */
        void Render();
 
        /*!*
         * Scene update function.
         *
         * \param None.
         * \return None.
         */
        void Update();
 
        /*!*
         * Create scene object function.
         * 
         * \param Name - object name (mainly for debug purpose).
         * \return created object.
         */
        scene_object CreateObject(const std::string &Name = "");
 
        /*!*
         * Get first scene object with specified name (ordered by creating time) or create new, if nothing found function.
         * 
         * \param Name - name of getting/creating object.
         * \return found/created scene object.
         */
        scene_object CreaetOrGetObject(const std::string &Name);
 
        /*!*
         * Get scene object by its handle function.
         * 
         * \param SceneObjectEntity - handle of getting scene object.
         * \return scene object.
         */
        scene_object GetSceneObject(scene_object_handle SceneObjectHandle);
 
        void RemoveObject(scene_object &Object);
    };
}