dlist.h

Go to the documentation of this file.

// 
//   Copyright (C) 2005, 2006 Free Software Foundation, Inc.
// 
// 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.
// 
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
//
// 
//



#ifndef GNASH_DLIST_H
#define GNASH_DLIST_H


#include "container.h"
#include "types.h"
#include "impl.h"

#include <list>
#include <iosfwd>

namespace gnash {

typedef boost::intrusive_ptr<character> DisplayItem;

//
class DisplayList {

public:

        //
        void    place_character(
                character* ch,
                uint16_t depth,
                const cxform& color_xform,
                const matrix& mat,
                float ratio,
                uint16_t clip_depth);

        //
        void replace_character(
                character* ch,
                uint16_t depth,
                bool use_cxform,
                const cxform& color_xform,
                bool use_matrix,
                const matrix& mat,
                float ratio,
                uint16_t clip_depth);

        void swap_characters(character* ch, character* ch2);

        void    move_display_object(
                uint16_t depth,
                bool use_cxform,
                const cxform& color_xform,
                bool use_matrix,
                const matrix& mat,
                float ratio,
                uint16_t clip_depth);

        void    remove_display_object(uint16_t depth);

        void clear();

        //Vitaly:
        // It is executed only before the second and the subsequent
        // execution of execute_frame_tags(0) for sprite_instance
        // with frame count > 1.
        // Deletes the display objects created during execution 
        // of frames 2,... and not displayed in the 1-st frame.
        // Macromedia Flash does not call remove display object tag
        // for 1-st frame
        void clear_unaffected(std::vector<uint16>& affected_depths);

        void reset();

        void advance(float delta_time);

        void display();

        character* get_character_at_depth(int depth);

        const character* get_character_at_depth(int depth) const {
                return const_cast<DisplayList*>(this)->get_character_at_depth(depth);
        }

        character* get_character_by_name(const std::string& name);

        const character* get_character_by_name(const std::string& name) const
        {
                return const_cast<DisplayList*>(this)->get_character_by_name(name);
        }

        character* get_character_by_name_i(const std::string& name);

        //
        template <class V>
        inline void visitForward(V& visitor);

        //
        template <class V>
        inline void visitBackward(V& visitor);

        void dump(std::ostream& os) const;

        void get_invalidated_bounds(rect* bounds, bool force);
        

        size_t size() const { 
                return _characters.size();
        }

        //
        int getNextHighestDepth() const;

private:

        typedef std::list<DisplayItem> container_type;
        typedef container_type::iterator iterator;
        typedef container_type::const_iterator const_iterator;
        typedef container_type::reverse_iterator reverse_iterator;
        typedef container_type::const_reverse_iterator const_reverse_iterator;

        container_type _characters;


};

template <class V>
void
DisplayList::visitForward(V& visitor)
{
        for (iterator it = _characters.begin(),
                        itEnd = _characters.end();
                it != itEnd; ++it)
        {
                DisplayItem& di = *it;
                if ( ! visitor(di.get()) )
                {
                        break;
                }
        }
}

template <class V>
void
DisplayList::visitBackward(V& visitor)
{
        for (reverse_iterator it = _characters.rbegin(),
                        itEnd = _characters.rend();
                it != itEnd; ++it)
        {
                DisplayItem& di = *it;

                //if ( ! di.get() ) continue;

                if ( ! visitor(di.get()) )
                {
                        break;

// The following logic must be implemented in the VISITOR,
// not in the visiting function !!
// (Vitaly, did you mean to do this in the MouseEntityFinder?)
#if 0
                        // Can so happens that the uppermost depth contains shape
                        // and under it the button lays
                        // therefore we skip empty(no events) depth
                        if (di->can_handle_mouse_event())
                        {
                                break;
                        }
#endif
                }
        }
}

}


#endif // GNASH_DLIST_H



// Local Variables:
// mode: C++
// c-basic-offset: 8 
// tab-width: 8
// indent-tabs-mode: t
// End:

---