Line data    Source code

       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 <list>
      22             : #include <map>
      23             : 
      24             : #include "ps/CStr.h"
      25             : #include "simulation2/helpers/CinemaPath.h"
      26             : #include "simulation2/system/Interface.h"
      27             : 
      28             : 
      29             : /**
      30             :  * Component for CCinemaManager class
      31             :  * TODO: write description
      32             :  */
      33             : 
      34           8 : class ICmpCinemaManager : public IComponent
      35             : {
      36             : public:
      37             :     /**
      38             :     * Adds the path to the path list
      39             :     * @param CCinemaPath path data
      40             :     */
      41             :     virtual void AddPath(const CCinemaPath& path) = 0;
      42             : 
      43             :     /**
      44             :     * Adds the path to the playlist
      45             :     * @param name path name
      46             :     */
      47             :     virtual void AddCinemaPathToQueue(const CStrW& name) = 0;
      48             : 
      49             :     virtual void Play() = 0;
      50             :     virtual void Stop() = 0;
      51             :     virtual void PlayQueue(const float deltaRealTime, CCamera* camera) = 0;
      52             : 
      53             :     /**
      54             :     * Checks the path name in the path list
      55             :     * @param name path name
      56             :     * @return true if path with that name exists, else false
      57             :     */
      58             :     virtual bool HasPath(const CStrW& name) const = 0;
      59             : 
      60             :     virtual void DeletePath(const CStrW& name) = 0;
      61             : 
      62             :     /**
      63             :     * Clears the playlist
      64             :     */
      65             :     virtual void ClearQueue() = 0;
      66             : 
      67             :     virtual const std::map<CStrW, CCinemaPath>& GetPaths() const = 0;
      68             :     virtual void SetPaths(const std::map<CStrW, CCinemaPath>& newPaths) = 0;
      69             :     virtual const std::list<CCinemaPath>& GetQueue() const = 0;
      70             : 
      71             :     virtual bool IsEnabled() const = 0;
      72             : 
      73             :     /**
      74             :     * Sets enable state of the cinema manager (shows/hide gui, show/hide rings, etc)
      75             :     * @param enable new state
      76             :     */
      77             :     virtual void SetEnabled(bool enabled) = 0;
      78             : 
      79         117 :     DECLARE_INTERFACE_TYPE(CinemaManager)
      80             : };
      81             : 
      82             : #endif // INCLUDED_ICMPCINEMAMANAGER