Line data    Source code

       1             : /* Copyright (C) 2018 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_ICMPRANGEOVERLAYRENDERER
      19             : #define INCLUDED_ICMPRANGEOVERLAYRENDERER
      20             : 
      21             : #include "ps/CStrIntern.h"
      22             : #include "simulation2/system/Interface.h"
      23             : 
      24           0 : class ICmpRangeOverlayRenderer : public IComponent
      25             : {
      26             : public:
      27             :     /**
      28             :      * Add a range overlay to this entity, for example for an aura or attack.
      29             :      */
      30             :     virtual void AddRangeOverlay(float radius, const std::string& texture, const std::string& textureMask, float thickness) = 0;
      31             : 
      32             :     /**
      33             :      * Delete all range overlays.
      34             :      */
      35             :     virtual void ResetRangeOverlays() = 0;
      36             : 
      37             :     /**
      38             :      * Updates the overlay color to match the player color.
      39             :      */
      40             :     virtual void UpdateColor() = 0;
      41             : 
      42         116 :     DECLARE_INTERFACE_TYPE(RangeOverlayRenderer)
      43             : };
      44             : 
      45             : #endif // INCLUDED_ICMPRANGEOVERLAYRENDERER