cbceda0a1743e18631edfda5426cc5af5bbcf0ad
[WebKit-https.git] / Source / WebCore / platform / graphics / chromium / cc / CCMathUtil.h
1 /*
2  * Copyright (C) 2012 Google Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1.  Redistributions of source code must retain the above copyright
8  *     notice, this list of conditions and the following disclaimer.
9  * 2.  Redistributions in binary form must reproduce the above copyright
10  *     notice, this list of conditions and the following disclaimer in the
11  *     documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
15  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
16  * DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
17  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
18  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
19  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
20  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
22  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23  */
24
25 #ifndef CCMathUtil_h
26 #define CCMathUtil_h
27
28 #include "FloatPoint.h"
29
30 namespace WebKit {
31 class WebTransformationMatrix;
32 }
33
34 namespace WebCore {
35
36 class IntRect;
37 class FloatRect;
38 class FloatQuad;
39
40 struct HomogeneousCoordinate {
41     HomogeneousCoordinate(double newX, double newY, double newZ, double newW)
42         : x(newX)
43         , y(newY)
44         , z(newZ)
45         , w(newW)
46     {
47     }
48
49     bool shouldBeClipped() const
50     {
51         return w <= 0;
52     }
53
54     FloatPoint cartesianPoint2d() const
55     {
56         if (w == 1)
57             return FloatPoint(x, y);
58
59         // For now, because this code is used privately only by CCMathUtil, it should never be called when w == 0, and we do not yet need to handle that case.
60         ASSERT(w);
61         double invW = 1.0 / w;
62         return FloatPoint(x * invW, y * invW);
63     }
64
65     double x;
66     double y;
67     double z;
68     double w;
69 };
70
71 // This class contains math helper functionality that does not belong in WebCore.
72 // It is possible that this functionality should be migrated to WebCore eventually.
73 class CCMathUtil {
74 public:
75
76     // Background: WebTransformationMatrix code in WebCore does not do the right thing in
77     // mapRect / mapQuad / projectQuad when there is a perspective projection that causes
78     // one of the transformed vertices to go to w < 0. In those cases, it is necessary to
79     // perform clipping in homogeneous coordinates, after applying the transform, before
80     // dividing-by-w to convert to cartesian coordinates.
81     //
82     // These functions return the axis-aligned rect that encloses the correctly clipped,
83     // transformed polygon.
84     static IntRect mapClippedRect(const WebKit::WebTransformationMatrix&, const IntRect&);
85     static FloatRect mapClippedRect(const WebKit::WebTransformationMatrix&, const FloatRect&);
86     static FloatRect projectClippedRect(const WebKit::WebTransformationMatrix&, const FloatRect&);
87
88     // Returns an array of vertices that represent the clipped polygon. After returning, indexes from
89     // 0 to numVerticesInClippedQuad are valid in the clippedQuad array. Note that
90     // numVerticesInClippedQuad may be zero, which means the entire quad was clipped, and
91     // none of the vertices in the array are valid.
92     static void mapClippedQuad(const WebKit::WebTransformationMatrix&, const FloatQuad& srcQuad, FloatPoint clippedQuad[8], int& numVerticesInClippedQuad);
93
94     static FloatRect computeEnclosingRectOfVertices(FloatPoint vertices[], int numVertices);
95     static FloatRect computeEnclosingClippedRect(const HomogeneousCoordinate& h1, const HomogeneousCoordinate& h2, const HomogeneousCoordinate& h3, const HomogeneousCoordinate& h4);
96
97     // NOTE: These functions do not do correct clipping against w = 0 plane, but they
98     // correctly detect the clipped condition via the boolean clipped.
99     static FloatQuad mapQuad(const WebKit::WebTransformationMatrix&, const FloatQuad&, bool& clipped);
100     static FloatQuad projectQuad(const WebKit::WebTransformationMatrix&, const FloatQuad&, bool& clipped);
101     static FloatPoint projectPoint(const WebKit::WebTransformationMatrix&, const FloatPoint&, bool& clipped);
102 };
103
104 } // namespace WebCore
105
106 #endif // #define CCMathUtil_h