Surface.hh

/*
** TowBowlTactics, a turn-based strategy football game.
**
** Copyright (C) 2006-2010 The TBT Team.
**
** This program 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.
**
** The complete GNU General Public Licence Notice can be found as the
** `NOTICE' file in the root directory.
**
** The TBT Team consists of people listed in the `AUTHORS' file.
*/

#ifndef SURFACE_HH_
# define SURFACE_HH_

# include <SDL.h>
# include "tools.hh"

class VirtualSurface;

class Surface
{
public:
  Surface();
  Surface(SDL_Surface* surf, double zoom = 1., double angle = 0., const std::string& filename = "");
  Surface(const std::string filename, double zoom = 1., double angle = 0.);
  Surface(int width, int height);
  virtual ~Surface();

  // On-copy methods.
  Surface(const Surface& s);
  Surface& operator=(const Surface& s);

  Point         getPos() const;

  Point         getSize() const;

  const Rect&   getRect() const;

  virtual Rect  getScreenRect() const;

  
  double        getZoom() const;
  double        getAngle() const;
  int           getZ() const;
  SDL_Surface*  getSDLSurface();

  virtual void  setPos(const Point& pos);
  void          setPos(int x, int y);
  void          setSize(const Point& size);
  virtual void  setZoom(double zoom);
  virtual void  setAngle(double angle);
  virtual void  setZ(int z);

  void      setInheritAlpha(bool enabled);

  virtual void  enable();
  virtual void  disable();
  bool      isEnabled() const;
  
  virtual void  show();
  virtual void  hide();
  // !@brief Whether it is displayed or not.
  bool          isShown() const;

  void create(int width, int height, SDL_Surface* ref_surface = NULL);

  void load(const std::string filename, double zoom = 1., double angle = 0.);

  void free();

  virtual void  update();
  
  virtual void blit(Surface& to);
  virtual void blit(Surface& to, const Rect& to_rect, const Rect& from_rect);

  friend std::ostream& operator<< (std::ostream& os, const Surface& s);
  
protected:

  
  virtual void render() {}

  // Sort by Z component. Used by VirtualSurface.
  struct ZSort : public std::binary_function<const Surface*, const Surface*, bool>
  {
    bool operator()(const Surface* lhs, const Surface* rhs);
  };

  // Sort by filename-zoom-angle. Used by ResourceCenter
  struct ImgSort : public std::binary_function<const Surface*, const Surface*, bool>
  {
    bool operator()(const Surface& lhs, const Surface& rhs);    
  };

  virtual Rect  getRenderRect() const;

  void blitAlpha(SDL_Surface *src_surf, SDL_Surface *dst_surf,
         SDL_Rect* src_rect, unsigned dst_x, unsigned dst_y);

  SDL_Surface*  surf_;

private:
  std::string   filename_;
  Rect          rect_;          
  Rect          orig_rect_;     
  double        zoom_;
  double        angle_;
  int           z_;
  bool      inherit_alpha_;
  bool      enabled_;
  bool          show_;

protected:
  bool            redraw_all_;
  VirtualSurface* parent_;

  friend class VirtualSurface;
  friend class ResourceCenter; // for stats
};

#endif /* !SURFACE_HH_ */