Update with current status

[gnash.git] / libcore / swf / ShapeRecord.h

//
//   Copyright (C) 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012
//   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 3 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_SWF_SHAPERECORD_H
#define GNASH_SWF_SHAPERECORD_H

#include "Geometry.h"
#include "LineStyle.h"
#include "FillStyle.h"
#include "SWFRect.h"

#include <vector>


namespace gnash {
    class movie_definition;
    class RunResources;
}

namespace gnash {
namespace SWF {



class Subshape {

public:
    typedef std::vector<FillStyle> FillStyles;
    typedef std::vector<LineStyle> LineStyles;
    typedef std::vector<Path> Paths;

    const FillStyles& fillStyles() const {
        return _fillStyles;
    }

    FillStyles& fillStyles() {
        return _fillStyles;
    }

    const LineStyles& lineStyles() const {
        return _lineStyles;
    }

    LineStyles& lineStyles() {
        return _lineStyles;
    }

    const Paths& paths() const {
        return _paths;
    }

    Paths& paths() {
        return _paths;
    }

    /// For DynamicShape
    //
    /// TODO: rewrite DynamicShape to push paths when they're
    /// finished and drop this.
    Path& currentPath() {
        return _paths.back();
    }

    void addFillStyle(const FillStyle& fs);

    void addPath(const Path& path) {
        _paths.push_back(path);
    }

    void addLineStyle(const LineStyle& ls) {
        _lineStyles.push_back(ls);
    }

    void clear() {
        _fillStyles.clear();
        _lineStyles.clear();
        _paths.clear();
    }

    SWFRect computeBounds(int swfVersion) const;

private:
    FillStyles _fillStyles;
    LineStyles _lineStyles;
    Paths _paths;
};



/// Holds information needed to draw a shape.
//
/// This does not correspond exactly to parsed record in a SWF file, but
/// is used to create both mutable and immutable shapes.
//
/// A ShapeRecord should have enough methods to implement the AS3 Graphics
/// object (the drawing API of Shape and Sprite). This is restricted to
/// adding fills, paths and line styles (which must be constructed outside
/// this ShapeRecord before being added) and clearing everything. There
/// is no support for removing single elements.
//
/// ShapeRecord objects are not ref-counted, so they may be stack-allocated
/// or used in smart pointers.
//
/// A shape can have sub-shapes. This can happen when there are multiple
/// layers of the same frame count. Flash combines them to one single shape.
/// The problem with sub-shapes is, that outlines can be hidden by other
/// layers so they must be rendered separately. In order to be sure outlines
/// are show correctly, draw the subshapes contained in the ShapeRecord in
/// sequence.
class ShapeRecord
{
public:
    typedef Subshape::FillStyles FillStyles;
    typedef Subshape::LineStyles LineStyles;
    typedef Subshape::Paths Paths;
    typedef std::vector<Subshape> Subshapes;

    /// Construct a ShapeRecord.
    //
    /// This should only really be used for DynamicShapes.
    //
    /// Ideally all immutable ShapeRecords should be constructed with the
    /// ctor taking an SWFStream, but some tag formats do not allow this.
    ShapeRecord();

    /// Construct a ShapeRecord from a SWFStream.
    //
    /// This is useful for constructing immutable tags.
    ShapeRecord(SWFStream& in, SWF::TagType tag, movie_definition& m,
            const RunResources& r);


    ~ShapeRecord();

    /// Parse path data from a SWFStream.
    //
    /// This is used by DefineMorphShapeTag as part of parsing its
    /// more complex ShapeRecords.
    void read(SWFStream& in, SWF::TagType tag, movie_definition& m,
            const RunResources& r);

    const Subshapes& subshapes() const {
        return _subshapes;
    }

    void addSubshape(const Subshape& subshape) {
        _subshapes.push_back(subshape);
    }

    const SWFRect& getBounds() const {
        return _bounds;
    }

    /// Set to the lerp of two ShapeRecords.
    //
    /// Used in shape morphing.
    void setLerp(const ShapeRecord& a, const ShapeRecord& b,
            const double ratio);

    /// Reset all shape data.
    void clear();

    void setBounds(const SWFRect& bounds) {
        _bounds = bounds;
    }

    bool pointTest(std::int32_t x, std::int32_t y,
                   const SWFMatrix& wm) const {
        for (const Subshape& subshape : _subshapes) {

            if (geometry::pointTest(subshape.paths(), subshape.lineStyles(), x, y, wm)) {
                    return true;
            }
        }
        return false;
    }

private:

    unsigned readStyleChange(SWFStream& in, size_t num_fill_bits, size_t numStyles);

    /// Shape record flags for use in parsing.
    enum ShapeRecordFlags {
        SHAPE_END = 0x00,
        SHAPE_MOVE = 0x01,
        SHAPE_FILLSTYLE0_CHANGE = 0x02,
        SHAPE_FILLSTYLE1_CHANGE = 0x04,
        SHAPE_LINESTYLE_CHANGE = 0x08,
        SHAPE_HAS_NEW_STYLES = 0x10
    };

    SWFRect _bounds;
    Subshapes _subshapes;
};

std::ostream& operator<<(std::ostream& o, const ShapeRecord& sh);

} // namespace SWF
} // namespace gnash

#endif