Scene.h

/*
 * Gamedev Framework (gf)
 * Copyright (C) 2016-2021 Julien Bernard
 *
 * This software is provided 'as-is', without any express or implied
 * warranty.  In no event will the authors be held liable for any damages
 * arising from the use of this software.
 *
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 *
 * 1. The origin of this software must not be misrepresented; you must not
 *    claim that you wrote the original software. If you use this software
 *    in a product, an acknowledgment in the product documentation would be
 *    appreciated but is not required.
 * 2. Altered source versions must be plainly marked as such, and must not be
 *    misrepresented as being the original software.
 * 3. This notice may not be removed or altered from any source distribution.
 */
#ifndef GF_SCENE_H
#define GF_SCENE_H

#include "Action.h"
#include "EntityContainer.h"
#include "Event.h"
#include "GraphicsApi.h"
#include "ModelContainer.h"
#include "RenderWindow.h"
#include "RenderStates.h"
#include "Time.h"
#include "ViewContainer.h"
#include "Views.h"
#include "Window.h"

namespace gf {
#ifndef DOXYGEN_SHOULD_SKIP_THIS
inline namespace v1 {
#endif

  class GF_GRAPHICS_API Scene {
  public:
    Scene(Vector2i initialSize);

    virtual ~Scene();

    void processEvent(Event& event);

    void handleActions(Window& window);

    void update(Time time);

    void render(RenderTarget& target, const RenderStates &states = RenderStates());

    void setFramebufferSize(gf::Vector2i size);

    void setClearColor(gf::Color4f color) {
      m_clear = color;
    }

    gf::Color4f getClearColor() const {
      return m_clear;
    }

    void setActive(bool active = true);

    bool isActive() const;

    void pause();

    void resume();

    bool isPaused() const;

    void hide();

    void show();

    bool isHidden() const;

    void addView(AdaptativeView& view) {
      m_views.addView(view);
    }

    void addAction(Action& action) {
      m_actions.addAction(action);
    }

    void addModel(Model& model) {
      m_models.addModel(model);
    }

    void addWorldEntity(Entity& entity) {
      m_worldEntities.addEntity(entity);
    }

    Entity* removeWorldEntity(Entity* entity) {
      return m_worldEntities.removeEntity(entity);
    }

    void addHudEntity(Entity& entity) {
      m_hudEntities.addEntity(entity);
    }

    Entity* removeHudEntity(Entity* entity) {
      return m_hudEntities.removeEntity(entity);
    }

    void setWorldViewCenter(Vector2f center);

    void setWorldViewSize(Vector2f size);

  protected:
    void renderWorldEntities(RenderTarget& target, const RenderStates &states);

    void renderHudEntities(RenderTarget& target, const RenderStates &states);

    View& getWorldView() {
      return m_worldView;
    }

    View& getHudView() {
      return m_hudView;
    }

    virtual bool doEarlyProcessEvent(Event& event);

    virtual void doProcessEvent(Event& event);

    virtual void doHandleActions(Window& window);

    virtual void doUpdate(Time time);

    virtual void doRender(RenderTarget& target, const RenderStates &states);

    virtual void doPause();

    virtual void doResume();

    virtual void doHide();

    virtual void doShow();

    virtual void onActivityChange(bool active);

  private:
    friend class SceneManager;

    bool m_active;

    enum class Status {
      Paused,
      Resumed,
    };

    Status m_status;

    enum class Visibility {
      Shown,
      Hidden,
    };

    Visibility m_visibility;

    ActionContainer m_actions;
    Action m_closeWindowAction;

    ModelContainer m_models;

    ExtendView m_worldView;
    ScreenView m_hudView;
    ViewContainer m_views;

    EntityContainer m_worldEntities;
    EntityContainer m_hudEntities;

    Color4f m_clear;
  };

#ifndef DOXYGEN_SHOULD_SKIP_THIS
}
#endif
}


#endif // GF_SCENE_H