ICmpWaterManager.h

Go to the documentation of this file.

/* Copyright (C) 2021 Wildfire Games.
 * This file is part of 0 A.D.
 *
 * 0 A.D. 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 2 of the License, or
 * (at your option) any later version.
 *
 * 0 A.D. 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 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef INCLUDED_ICMPWATERMANAGER
#define INCLUDED_ICMPWATERMANAGER
 
#include "simulation2/system/Interface.h"
 
#include "simulation2/helpers/Position.h"
 
class ICmpWaterManager : public IComponent
{
public:
    /**
     * Recompute all the water information (foam...)
     */
    virtual void RecomputeWaterData() = 0;
 
    /**
     * Set the height of the water level, as a constant value across the whole map.
     */
    virtual void SetWaterLevel(entity_pos_t h) = 0;
 
    /**
     * Get the current water level at the given point.
     */
    virtual entity_pos_t GetWaterLevel(entity_pos_t x, entity_pos_t z) const = 0;
 
    /**
     * Get the current water level at the given point.
     */
    virtual float GetExactWaterLevel(float x, float z) const = 0;
 
    DECLARE_INTERFACE_TYPE(WaterManager)
};
 
#endif // INCLUDED_ICMPWATERMANAGER