VirtualSurface.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 VIRTUALSURFACE_HH_
# define VIRTUALSURFACE_HH_

# include "Surface.hh"

class VirtualSurface : public Surface
{
public:
  VirtualSurface();
  VirtualSurface(const std::string& name, SDL_Surface* surf);
  VirtualSurface(const std::string& name, int width, int height);
  virtual ~VirtualSurface();

  void addChild(Surface* child);
  void removeChild(Surface* child);
  int getChildrenNb() const;

  void updateChildZOrder();

  virtual void enable();
  virtual void show();
  virtual void setZoom(double zoom);
  virtual void update();
  virtual void render();

  void invalidate(const Rect& zone);
  void invalidate(const Point& pos, const Point& size);

  template <class Class>
  struct TraverseCallback {
    typedef void (Class::*Method)(Surface *);
  };

  template <class Class>
  void traverse(VirtualSurface *root, Class* object,
                typename TraverseCallback<Class>::Method method)
  {
    VirtualSurface *s;
    SurfaceList::iterator it;

    for (it = children_list_.begin(); it != children_list_.end(); ++it)
      {
        s = dynamic_cast<VirtualSurface *>(*it);
        if (s != 0)
          s->traverse(s, object, method);
        (object->*method)(*it);
      }
  }
  
protected:
  void unlockChildrenList();

  typedef std::vector<Surface*> SurfaceList;
  SurfaceList   children_list_;

  typedef std::vector<Rect> RectList;
  RectList      invalidated_surf_;

  bool          children_list_lock_;  
  bool          sort_children_;       
  SurfaceList   children_to_add_;     

  std::string   name_;
};

#endif /* !VIRTUALSURFACE_HH_ */