libcore/DisplayObjectContainer.h

   1 // DisplayObjectContainer.h: Container of DisplayObjects.
   2 //
   3 //   Copyright (C) 2005, 2006, 2007, 2008, 2009, 2010 Free Software
   4 //   Foundation, Inc
   5 //
   6 // This program is free software; you can redistribute it and/or modify
   7 // it under the terms of the GNU General Public License as published by
   8 // the Free Software Foundation; either version 3 of the License, or
   9 // (at your option) any later version.
  10 //
  11 // This program is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 // GNU General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU General Public License
  17 // along with this program; if not, write to the Free Software
  18 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19
  20 // Stateful live Sprite instance
  21
  22 #ifndef GNASH_DISPLAYOBJECTCONTAINER_H
  23 #define GNASH_DISPLAYOBJECTCONTAINER_H
  24
  25 #ifdef HAVE_CONFIG_H
  26 #include "gnashconfig.h"
  27 #endif
  28
  29 #include "DisplayList.h"
  30 #include "InteractiveObject.h"
  31
  32 #ifdef USE_SWFTREE
  33 # include "tree.hh"
  34 #endif
  35
  36 // Forward declarations
  37 namespace gnash {
  38 }
  39
  40 namespace gnash {
  41
  42 class DisplayObjectContainer : public InteractiveObject
  43 {
  44
  45 public:
  46
  47     DisplayObjectContainer(as_object* object, DisplayObject* parent)
  48         :
  49         InteractiveObject(object, parent)
  50     {
  51         assert(object);
  52     }
  53
  54     virtual ~DisplayObjectContainer();
  55
  56     /// Remove the DisplayObject at the specified depth.
  57     //
  58     /// This is the implementation of the AS3-only method
  59     /// DisplayObjectContainer.removeChildAt().
  60     //
  61     /// @param index    The depth from which to remove a DisplayObject.
  62     /// @return         The removed DisplayObject (reflects the AS return)
  63     DisplayObject* removeChildAt(int index);
  64
  65     /// Remove the specified child DisplayObject.
  66     //
  67     /// TODO: should be a function of DisplayObjectContainer
  68     /// This is the implementation of the AS3-only method
  69     /// DisplayObjectContainer.removeChild(), but can also be used for
  70     /// AS2.
  71     //
  72     /// @param obj      The DisplayObject to remove.
  73     /// @return         The removed DisplayObject (reflects the AS return)
  74     DisplayObject* removeChild(DisplayObject* obj);
  75
  76     /// Add a child DisplayObject at the next suitable index (AS2: depth).
  77     //
  78     /// TODO: should be a function of DisplayObjectContainer
  79     /// This is the implementation of the AS3-only method
  80     /// DisplayObjectContainer.addChild(), but can also be used for
  81     /// AS2.
  82     //
  83     /// @param obj      The DisplayObject to add.
  84     /// @return         The added DisplayObject (reflects the AS return)
  85     DisplayObject* addChild(DisplayObject* obj);
  86
  87     /// Add a child DisplayObject at the specified index (AS2: depth).
  88     //
  89     /// TODO: should be a function of DisplayObjectContainer
  90     /// This is the implementation of the AS3-only method
  91     /// DisplayObjectContainer.addChild(), but can also be used for
  92     /// AS2.
  93     //
  94     /// @param obj      The DisplayObject to add.
  95     /// @param index    The index (depth) at which to add the DisplayObject.
  96     /// @return         The added DisplayObject (reflects the AS return)
  97     DisplayObject* addChildAt(DisplayObject* obj, int index);
  98
  99     size_t numChildren() const {
 100         return _displayList.size();
 101     }
 102
 103 #ifdef USE_SWFTREE
 104     // Override to append display list info, see dox in DisplayObject.h
 105     virtual InfoTree::iterator getMovieInfo(InfoTree& tr,
 106             InfoTree::iterator it);
 107 #endif
 108
 109
 110 protected:
 111
 112     // TODO: make private and move all DisplayList functions to this class.
 113     DisplayList _displayList;
 114
 115 };
 116
 117 } // namespace gnash
 118
 119 #endif