libcore/swf/DisplayListTag.h

   1 // DisplayListTag.h: DisplayList tag, for Gnash.
   2 //
   3 //   Copyright (C) 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
   4 //
   5 // This program is free software; you can redistribute it and/or modify
   6 // it under the terms of the GNU General Public License as published by
   7 // the Free Software Foundation; either version 3 of the License, or
   8 // (at your option) any later version.
   9 //
  10 // This program is distributed in the hope that it will be useful,
  11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 // GNU General Public License for more details.
  14 //
  15 // You should have received a copy of the GNU General Public License
  16 // along with this program; if not, write to the Free Software
  17 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  18
  19 #ifndef GNASH_SWF_DISPLAYLISTTAG_H
  20 #define GNASH_SWF_DISPLAYLISTTAG_H
  21
  22 #include "ControlTag.h" // for inheritance
  23
  24
  25 // Forward declarations
  26 namespace gnash {
  27         class MovieClip;
  28 }
  29
  30 namespace gnash {
  31 namespace SWF {
  32
  33 /// DisplayList tag
  34 //
  35 /// DisplayList tags are all versions of PlaceObject and RemoveObject.
  36 /// They modify the DisplayList of a movie or sprite by
  37 /// placing, moving, replacing or removing DisplayObjects at depths.
  38 ///
  39 ///
  40 class DisplayListTag : public ControlTag
  41 {
  42 public:
  43
  44         DisplayListTag(int depth)
  45                 :
  46                 _depth(depth)
  47         {}
  48
  49         virtual ~DisplayListTag() {}
  50
  51     /// All DisplayList tags are state tags.
  52         virtual void executeState(MovieClip* m, DisplayList& dlist) const = 0;
  53
  54         /// Return the depth affected by this DisplayList tag
  55         //
  56         /// NOTE: the returned depth is always in the
  57         ///       static depth zone (DisplayObject::staticDepthOffset .. -1)
  58         int getDepth() const { return _depth; }
  59
  60 protected:
  61
  62         int _depth;
  63
  64 };
  65
  66 } // namespace gnash::SWF
  67 } // namespace gnash
  68
  69
  70 #endif // GNASH_SWF_DISPLAYLISTTAG_H
  71
  72
  73 // Local Variables:
  74 // mode: C++
  75 // indent-tabs-mode: t
  76 // End: