supertux/src/supertux/screen.hpp

//  SuperTux
//  Copyright (C) 2006 Matthias Braun <matze@braunis.de>
//
//  This program is free software: you can redistribute it and/or modify
//  it under the terms of the GNU General Public License as published by
//  the Free Software Foundation, either version 3 of the License, or
//  (at your option) any later version.
//
//  This program is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.
//
//  You should have received a copy of the GNU General Public License
//  along with this program.  If not, see <http://www.gnu.org/licenses/>.

#ifndef HEADER_SUPERTUX_SUPERTUX_SCREEN_HPP
#define HEADER_SUPERTUX_SUPERTUX_SCREEN_HPP

#include "sdk/integration.hpp"

class Compositor;
class Controller;
union SDL_Event;

/**
 * Abstract base class for code the MainLoop runs exclusively and full-screen.
 *
 * Examples of Screens are: The TitleScreen, a WorldMap, a level's
 * GameSession, a TextScroller, ...
 */
class Screen
{
public:
  virtual ~Screen()
  {}

  /**
   * gets called before this screen gets activated (which is at least once
   * before the first draw or update call
   */
  virtual void setup()
  {}
  /** gets called when the current screen is temporarily suspended */
  virtual void leave()
  {}

  /**
   * gets called once per frame. The screen should draw itself in this function.
   * State changes should not be done in this function, but rather in update
   */
  virtual void draw(Compositor& compositor) = 0;

  /**
   * gets called for once (per logical) frame. Screens should do their state
   * updates and logic here
   */
  virtual void update(float dt_sec, const Controller& controller) = 0;

  /**
   * gets called whenever an SDL event occurs
   */
  virtual void event(const SDL_Event& ev) {}

  /**
   * gets called whenever the game window is resized or resolution settings are changed
   */
  virtual void on_window_resize() {}

  /** 
   * Gives details about what the user is doing right now.
   * 
   * @returns activity details for presence integrations
   */
  virtual IntegrationStatus get_status() const = 0;
};

#endif

/* EOF */