Line data    Source code

       1             : /* Copyright (C) 2021 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_ICMPWATERMANAGER
      19             : #define INCLUDED_ICMPWATERMANAGER
      20             : 
      21             : #include "simulation2/system/Interface.h"
      22             : 
      23             : #include "simulation2/helpers/Position.h"
      24             : 
      25           8 : class ICmpWaterManager : public IComponent
      26             : {
      27             : public:
      28             :     /**
      29             :      * Recompute all the water information (foam...)
      30             :      */
      31             :     virtual void RecomputeWaterData() = 0;
      32             : 
      33             :     /**
      34             :      * Set the height of the water level, as a constant value across the whole map.
      35             :      */
      36             :     virtual void SetWaterLevel(entity_pos_t h) = 0;
      37             : 
      38             :     /**
      39             :      * Get the current water level at the given point.
      40             :      */
      41             :     virtual entity_pos_t GetWaterLevel(entity_pos_t x, entity_pos_t z) const = 0;
      42             : 
      43             :     /**
      44             :      * Get the current water level at the given point.
      45             :      */
      46             :     virtual float GetExactWaterLevel(float x, float z) const = 0;
      47             : 
      48         151 :     DECLARE_INTERFACE_TYPE(WaterManager)
      49             : };
      50             : 
      51             : #endif // INCLUDED_ICMPWATERMANAGER