c8f86675fcfb2e3b753e0f56dc419b53e1ce27f3
[WebKit-https.git] / WebCore / platform / graphics / Path.h
1 /*
2  * Copyright (C) 2003, 2006 Apple Computer, Inc.  All rights reserved.
3  *                     2006 Rob Buis <buis@kde.org>
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
25  */
26
27 #ifndef Path_h
28 #define Path_h
29
30 #if PLATFORM(CG)
31 typedef struct CGPath PlatformPath;
32 #elif PLATFORM(QT)
33 class QPainterPath;
34 typedef QPainterPath PlatformPath;
35 #else
36 typedef void PlatformPath;
37 #endif
38
39 namespace WebCore {
40
41     class AffineTransform;
42     class FloatPoint;
43     class FloatSize;
44     class FloatRect;
45     class String;
46
47     enum WindRule {
48         RULE_NONZERO = 0,
49         RULE_EVENODD = 1
50     };
51
52     enum PathElementType {
53         PathElementMoveToPoint,
54         PathElementAddLineToPoint,
55         PathElementAddQuadCurveToPoint,
56         PathElementAddCurveToPoint,
57         PathElementCloseSubpath
58     };
59
60     struct PathElement {
61         PathElementType type;
62         FloatPoint* points;
63     };
64
65     typedef void (*PathApplierFunction) (void* info, const PathElement*);
66
67     class Path {
68     public:
69         Path();
70         ~Path();
71
72         Path(const Path&);
73         Path& operator=(const Path&);
74
75         bool contains(const FloatPoint&, WindRule rule = RULE_NONZERO) const;
76         FloatRect boundingRect() const;
77         
78         float length();
79         FloatPoint pointAtLength(float length, bool& ok);
80
81         void clear();
82         bool isEmpty() const;
83
84         void moveTo(const FloatPoint&);
85         void addLineTo(const FloatPoint&);
86         void addQuadCurveTo(const FloatPoint& controlPoint, const FloatPoint& point);
87         void addBezierCurveTo(const FloatPoint& controlPoint1, const FloatPoint& controlPoint2, const FloatPoint&);
88         void addArcTo(const FloatPoint&, const FloatPoint&, float radius);
89         void closeSubpath();
90
91         void addArc(const FloatPoint&, float radius, float startAngle, float endAngle, bool clockwise);
92         void addRect(const FloatRect&);
93         void addEllipse(const FloatRect&);
94
95         void translate(const FloatSize&);
96
97         void setWindingRule(WindRule rule) { m_rule = rule; }
98         WindRule windingRule() const { return m_rule; }
99
100         String debugString() const;
101
102         PlatformPath* platformPath() const { return m_path; }
103
104         static Path createRoundedRectangle(const FloatRect&, const FloatSize& roundingRadii);
105         static Path createRectangle(const FloatRect&);
106         static Path createEllipse(const FloatPoint& center, float rx, float ry);
107         static Path createCircle(const FloatPoint& center, float r);
108         static Path createLine(const FloatPoint&, const FloatPoint&);
109
110         void apply(void* info, PathApplierFunction) const;
111         void transform(const AffineTransform&);
112
113     private:
114         PlatformPath* m_path;
115         WindRule m_rule;
116     };
117
118 }
119
120 #endif