source/simulation2/components/ICmpCinemaManager.h

   1 /* Copyright (C) 2017 Wildfire Games.
   2  * This file is part of 0 A.D.
   3  *
   4  * 0 A.D. is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * 0 A.D. is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 #ifndef INCLUDED_ICMPCINEMAMANAGER
  19 #define INCLUDED_ICMPCINEMAMANAGER
  20
  21 #include "simulation2/helpers/CinemaPath.h"
  22 #include "simulation2/system/Interface.h"
  23
  24 #include "ps/CStr.h"
  25
  26 /**
  27  * Component for CCinemaManager class
  28  * TODO: write description
  29  */
  30
  31 class ICmpCinemaManager : public IComponent
  32 {
  33 public:
  34         /**
  35         * Adds the path to the path list
  36         * @param CCinemaPath path data
  37         */
  38         virtual void AddPath(const CCinemaPath& path) = 0;
  39
  40         /**
  41         * Adds the path to the playlist
  42         * @param name path name
  43         */
  44         virtual void AddCinemaPathToQueue(const CStrW& name) = 0;
  45
  46         virtual void Play() = 0;
  47         virtual void Stop() = 0;
  48         virtual void PlayQueue(const float deltaRealTime, CCamera* camera) = 0;
  49
  50         /**
  51         * Checks the path name in the path list
  52         * @param name path name
  53         * @return true if path with that name exists, else false
  54         */
  55         virtual bool HasPath(const CStrW& name) const = 0;
  56
  57         /**
  58         * Clears the playlist
  59         */
  60         virtual void ClearQueue() = 0;
  61
  62         virtual const std::map<CStrW, CCinemaPath>& GetPaths() const = 0;
  63         virtual void SetPaths(const std::map<CStrW, CCinemaPath>& newPaths) = 0;
  64         virtual const std::list<CCinemaPath>& GetQueue() const = 0;
  65
  66         virtual bool IsEnabled() const = 0;
  67
  68         /**
  69         * Sets enable state of the cinema manager (shows/hide gui, show/hide rings, etc)
  70         * @param enable new state
  71         */
  72         virtual void SetEnabled(bool enabled) = 0;
  73
  74         DECLARE_INTERFACE_TYPE(CinemaManager)
  75 };
  76
  77 #endif // INCLUDED_ICMPCINEMAMANAGER