summaryrefslogtreecommitdiff
path: root/svgio/source/svgreader/svgclippathnode.cxx
blob: af7ea5cacb05557808448e72f88d2163b4714ad6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

#include <svgclippathnode.hxx>
#include <drawinglayer/primitive2d/transformprimitive2d.hxx>
#include <drawinglayer/primitive2d/maskprimitive2d.hxx>
#include <basegfx/matrix/b2dhommatrixtools.hxx>
#include <drawinglayer/geometry/viewinformation2d.hxx>
#include <drawinglayer/processor2d/contourextractor2d.hxx>
#include <basegfx/polygon/b2dpolypolygoncutter.hxx>
#include <basegfx/polygon/b2dpolygontools.hxx>
#include <o3tl/string_view.hxx>

namespace svgio::svgreader
{
        SvgClipPathNode::SvgClipPathNode(
            SvgDocument& rDocument,
            SvgNode* pParent)
        :   SvgNode(SVGToken::ClipPathNode, rDocument, pParent),
            maSvgStyleAttributes(*this),
            maClipPathUnits(SvgUnits::userSpaceOnUse)
        {
        }

        SvgClipPathNode::~SvgClipPathNode()
        {
        }

        const SvgStyleAttributes* SvgClipPathNode::getSvgStyleAttributes() const
        {
            return &maSvgStyleAttributes;
        }

        void SvgClipPathNode::parseAttribute(SVGToken aSVGToken, const OUString& aContent)
        {
            // call parent
            SvgNode::parseAttribute(aSVGToken, aContent);

            // read style attributes
            maSvgStyleAttributes.parseStyleAttribute(aSVGToken, aContent);

            // parse own
            switch(aSVGToken)
            {
                case SVGToken::Style:
                {
                    readLocalCssStyle(aContent);
                    break;
                }
                case SVGToken::Transform:
                {
                    const basegfx::B2DHomMatrix aMatrix(readTransform(aContent, *this));

                    if(!aMatrix.isIdentity())
                    {
                        setTransform(aMatrix);
                    }
                    break;
                }
                case SVGToken::ClipPathUnits:
                {
                    if(!aContent.isEmpty())
                    {
                        if(o3tl::equalsIgnoreAsciiCase(o3tl::trim(aContent), commonStrings::aStrUserSpaceOnUse))
                        {
                            setClipPathUnits(SvgUnits::userSpaceOnUse);
                        }
                        else if(o3tl::equalsIgnoreAsciiCase(o3tl::trim(aContent), commonStrings::aStrObjectBoundingBox))
                        {
                            setClipPathUnits(SvgUnits::objectBoundingBox);
                        }
                    }
                    break;
                }
                default:
                {
                    break;
                }
            }
        }

        void SvgClipPathNode::decomposeSvgNode(drawinglayer::primitive2d::Primitive2DContainer& rTarget, bool bReferenced) const
        {
            drawinglayer::primitive2d::Primitive2DContainer aNewTarget;

            // decompose children
            SvgNode::decomposeSvgNode(aNewTarget, bReferenced);

            if(aNewTarget.empty())
                return;

            if(getTransform())
            {
                // create embedding group element with transformation
                const drawinglayer::primitive2d::Primitive2DReference xRef(
                    new drawinglayer::primitive2d::TransformPrimitive2D(
                        *getTransform(),
                        std::move(aNewTarget)));

                rTarget.push_back(xRef);
            }
            else
            {
                // append to current target
                rTarget.append(aNewTarget);
            }
        }

        void SvgClipPathNode::apply(
            drawinglayer::primitive2d::Primitive2DContainer& rContent,
            const std::optional<basegfx::B2DHomMatrix>& pTransform) const
        {
            if (rContent.empty() || Display::None == getDisplay())
                return;

            const drawinglayer::geometry::ViewInformation2D aViewInformation2D;
            drawinglayer::primitive2d::Primitive2DContainer aClipTarget;
            basegfx::B2DPolyPolygon aClipPolyPolygon;

            // get clipPath definition as primitives
            decomposeSvgNode(aClipTarget, true);

            if(!aClipTarget.empty())
            {
                // extract filled polygons as base for a mask PolyPolygon
                drawinglayer::processor2d::ContourExtractor2D aExtractor(aViewInformation2D, true);

                aExtractor.process(aClipTarget);

                const basegfx::B2DPolyPolygonVector& rResult(aExtractor.getExtractedContour());
                const sal_uInt32 nSize(rResult.size());

                if(nSize > 1)
                {
                    // merge to single clipPolyPolygon
                    aClipPolyPolygon = basegfx::utils::mergeToSinglePolyPolygon(rResult);
                }
                else if (nSize != 0)
                {
                    aClipPolyPolygon = rResult[0];
                }
            }

            if(aClipPolyPolygon.count())
            {
                if (SvgUnits::objectBoundingBox == getClipPathUnits())
                {
                    // clip is object-relative, transform using content transformation
                    const basegfx::B2DRange aContentRange(rContent.getB2DRange(aViewInformation2D));

                    aClipPolyPolygon.transform(
                        basegfx::utils::createScaleTranslateB2DHomMatrix(
                            aContentRange.getRange(),
                            aContentRange.getMinimum()));
                }
                else // userSpaceOnUse
                {
                    // #i124852#
                    if(pTransform)
                    {
                        aClipPolyPolygon.transform(*pTransform);
                    }
                }

                // #i124313# try to avoid creating an embedding to a MaskPrimitive2D if
                // possible; MaskPrimitive2D processing is potentially expensive
                bool bCreateEmbedding(true);
                bool bAddContent(true);

                if(basegfx::utils::isRectangle(aClipPolyPolygon))
                {
                    // ClipRegion is a rectangle, thus it is not expensive to tell
                    // if the content is completely inside or outside of it; get ranges
                    const basegfx::B2DRange aClipRange(aClipPolyPolygon.getB2DRange());
                    const basegfx::B2DRange aContentRange(
                        rContent.getB2DRange(
                            aViewInformation2D));

                    if(aClipRange.isInside(aContentRange))
                    {
                        // completely contained, no need to clip at all, so no need for embedding
                        bCreateEmbedding = false;
                    }
                    else if(aClipRange.overlaps(aContentRange))
                    {
                        // overlap; embedding needed. ClipRegion can be minimized by using
                        // the intersection of the ClipRange and the ContentRange. Minimizing
                        // the ClipRegion potentially enhances further processing since
                        // usually clip operations are expensive.
                        basegfx::B2DRange aCommonRange(aContentRange);

                        aCommonRange.intersect(aClipRange);
                        aClipPolyPolygon = basegfx::B2DPolyPolygon(basegfx::utils::createPolygonFromRect(aCommonRange));
                    }
                    else
                    {
                        // not inside and no overlap -> completely outside
                        // no need for embedding, no need for content at all
                        bCreateEmbedding = false;
                        bAddContent = false;
                    }
                }
                else
                {
                    // ClipRegion is not a simple rectangle, it would be possible but expensive to
                    // tell if the content needs clipping or not. It is also dependent of
                    // the content's decomposition. To do this, a processor would be needed that
                    // is capable if processing the given sequence of primitives and decide
                    // if all is inside or all is outside. Such a ClipProcessor could be written,
                    // but for now just create the embedding
                }

                if(bCreateEmbedding)
                {
                    // redefine target. Use MaskPrimitive2D with created clip
                    // geometry. Using the automatically set mbIsClipPathContent at
                    // SvgStyleAttributes the clip definition is without fill, stroke,
                    // and strokeWidth and forced to black
                    rContent = drawinglayer::primitive2d::Primitive2DContainer {
                        drawinglayer::primitive2d::Primitive2DReference(
                            new drawinglayer::primitive2d::MaskPrimitive2D(
                                std::move(aClipPolyPolygon),
                                std::move(rContent)))
                    };
                }
                else
                {
                    if(!bAddContent)
                    {
                        rContent.clear();
                    }
                }
            }
            else
            {
                // An empty clipping path will completely clip away the element that had
                // the clip-path property applied. (Svg spec)
                rContent.clear();
            }
        }

} // end of namespace svgio::svgreader

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */