[chromium] Remove WebTransformationMatrix::mapPoint overrides
[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 #include "FloatPoint3D.h"
30
31 namespace WebKit {
32 class WebTransformationMatrix;
33 }
34
35 namespace WebCore {
36
37 class IntRect;
38 class FloatRect;
39 class FloatQuad;
40
41 struct HomogeneousCoordinate {
42     HomogeneousCoordinate(double newX, double newY, double newZ, double newW)
43         : x(newX)
44         , y(newY)
45         , z(newZ)
46         , w(newW)
47     {
48     }
49
50     bool shouldBeClipped() const
51     {
52         return w <= 0;
53     }
54
55     FloatPoint cartesianPoint2d() const
56     {
57         if (w == 1)
58             return FloatPoint(x, y);
59
60         // 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.
61         ASSERT(w);
62         double invW = 1.0 / w;
63         return FloatPoint(x * invW, y * invW);
64     }
65
66     FloatPoint3D cartesianPoint3d() const
67     {
68         if (w == 1)
69             return FloatPoint3D(x, y, z);
70
71         // 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.
72         ASSERT(w);
73         double invW = 1.0 / w;
74         return FloatPoint3D(x * invW, y * invW, z * invW);
75     }
76
77     double x;
78     double y;
79     double z;
80     double w;
81 };
82
83 // This class contains math helper functionality that does not belong in WebCore.
84 // It is possible that this functionality should be migrated to WebCore eventually.
85 class CCMathUtil {
86 public:
87
88     // Background: WebTransformationMatrix code in WebCore does not do the right thing in
89     // mapRect / mapQuad / projectQuad when there is a perspective projection that causes
90     // one of the transformed vertices to go to w < 0. In those cases, it is necessary to
91     // perform clipping in homogeneous coordinates, after applying the transform, before
92     // dividing-by-w to convert to cartesian coordinates.
93     //
94     // These functions return the axis-aligned rect that encloses the correctly clipped,
95     // transformed polygon.
96     static IntRect mapClippedRect(const WebKit::WebTransformationMatrix&, const IntRect&);
97     static FloatRect mapClippedRect(const WebKit::WebTransformationMatrix&, const FloatRect&);
98     static FloatRect projectClippedRect(const WebKit::WebTransformationMatrix&, const FloatRect&);
99
100     // Returns an array of vertices that represent the clipped polygon. After returning, indexes from
101     // 0 to numVerticesInClippedQuad are valid in the clippedQuad array. Note that
102     // numVerticesInClippedQuad may be zero, which means the entire quad was clipped, and
103     // none of the vertices in the array are valid.
104     static void mapClippedQuad(const WebKit::WebTransformationMatrix&, const FloatQuad& srcQuad, FloatPoint clippedQuad[8], int& numVerticesInClippedQuad);
105
106     static FloatRect computeEnclosingRectOfVertices(FloatPoint vertices[], int numVertices);
107     static FloatRect computeEnclosingClippedRect(const HomogeneousCoordinate& h1, const HomogeneousCoordinate& h2, const HomogeneousCoordinate& h3, const HomogeneousCoordinate& h4);
108
109     // NOTE: These functions do not do correct clipping against w = 0 plane, but they
110     // correctly detect the clipped condition via the boolean clipped.
111     static FloatQuad mapQuad(const WebKit::WebTransformationMatrix&, const FloatQuad&, bool& clipped);
112     static FloatPoint mapPoint(const WebKit::WebTransformationMatrix&, const FloatPoint&, bool& clipped);
113     static FloatPoint3D mapPoint(const WebKit::WebTransformationMatrix&, const FloatPoint3D&, bool& clipped);
114     static FloatQuad projectQuad(const WebKit::WebTransformationMatrix&, const FloatQuad&, bool& clipped);
115     static FloatPoint projectPoint(const WebKit::WebTransformationMatrix&, const FloatPoint&, bool& clipped);
116 };
117
118 } // namespace WebCore
119
120 #endif // #define CCMathUtil_h