include/basegfx/tools/canvastools.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_BASEGFX_TOOLS_CANVASTOOLS_HXX
  21 #define INCLUDED_BASEGFX_TOOLS_CANVASTOOLS_HXX
  22
  23 #include <com/sun/star/uno/Reference.hxx>
  24 #include <com/sun/star/uno/Sequence.hxx>
  25 #include <basegfx/basegfxdllapi.h>
  26
  27
  28 namespace com { namespace sun { namespace star { namespace geometry
  29 {
  30     struct AffineMatrix2D;
  31     struct AffineMatrix3D;
  32     struct Matrix2D;
  33     struct RealPoint2D;
  34     struct RealSize2D;
  35     struct RealRectangle2D;
  36     struct RealRectangle3D;
  37     struct IntegerPoint2D;
  38     struct IntegerSize2D;
  39     struct IntegerRectangle2D;
  40     struct RealBezierSegment2D;
  41 } } } }
  42
  43 namespace com { namespace sun { namespace star { namespace rendering
  44 {
  45     class  XGraphicDevice;
  46     class  XPolyPolygon2D;
  47 } } } }
  48
  49 namespace com { namespace sun { namespace star { namespace awt
  50 {
  51     struct Point;
  52     struct Size;
  53     struct Rectangle;
  54 } } } }
  55
  56 namespace basegfx
  57 {
  58     class B2DHomMatrix;
  59     class B3DHomMatrix;
  60     class B2DVector;
  61     class B2DPoint;
  62     class B2DRange;
  63     class B3DRange;
  64     class B2IBox;
  65     class B2IVector;
  66     class B2IPoint;
  67     class B2IRange;
  68     class B2DPolygon;
  69     class B2DPolyPolygon;
  70
  71     namespace unotools
  72     {
  73         // Polygon conversions
  74
  75
  76         BASEGFX_DLLPUBLIC ::com::sun::star::uno::Reference< ::com::sun::star::rendering::XPolyPolygon2D >
  77             xPolyPolygonFromB2DPolygon( const ::com::sun::star::uno::Reference<
  78                                             ::com::sun::star::rendering::XGraphicDevice >&  xGraphicDevice,
  79                                         const ::basegfx::B2DPolygon&                        rPoly    );
  80
  81         BASEGFX_DLLPUBLIC ::com::sun::star::uno::Reference< ::com::sun::star::rendering::XPolyPolygon2D >
  82             xPolyPolygonFromB2DPolyPolygon( const ::com::sun::star::uno::Reference<
  83                                                  ::com::sun::star::rendering::XGraphicDevice >&     xGraphicDevice,
  84                                             const ::basegfx::B2DPolyPolygon&                    rPolyPoly    );
  85
  86
  87         BASEGFX_DLLPUBLIC ::com::sun::star::uno::Sequence<
  88               ::com::sun::star::uno::Sequence<
  89                   ::com::sun::star::geometry::RealBezierSegment2D > >
  90                     bezierSequenceSequenceFromB2DPolyPolygon( const ::basegfx::B2DPolyPolygon& rPolyPoly );
  91
  92         BASEGFX_DLLPUBLIC ::com::sun::star::uno::Sequence<
  93               ::com::sun::star::uno::Sequence<
  94                   ::com::sun::star::geometry::RealPoint2D > >
  95                     pointSequenceSequenceFromB2DPolyPolygon( const ::basegfx::B2DPolyPolygon& rPolyPoly );
  96
  97         BASEGFX_DLLPUBLIC ::basegfx::B2DPolygon polygonFromPoint2DSequence(
  98             const ::com::sun::star::uno::Sequence<
  99                 ::com::sun::star::geometry::RealPoint2D >& rPoints );
 100
 101         BASEGFX_DLLPUBLIC ::basegfx::B2DPolyPolygon polyPolygonFromPoint2DSequenceSequence(
 102             const ::com::sun::star::uno::Sequence<
 103                 ::com::sun::star::uno::Sequence< ::com::sun::star::geometry::RealPoint2D > >& rPoints );
 104
 105         BASEGFX_DLLPUBLIC ::basegfx::B2DPolygon polygonFromBezier2DSequence(
 106             const ::com::sun::star::uno::Sequence<
 107                 ::com::sun::star::geometry::RealBezierSegment2D >& rPoints );
 108
 109         BASEGFX_DLLPUBLIC ::basegfx::B2DPolyPolygon polyPolygonFromBezier2DSequenceSequence(
 110             const ::com::sun::star::uno::Sequence<
 111                 ::com::sun::star::uno::Sequence< ::com::sun::star::geometry::RealBezierSegment2D > >& rPoints );
 112
 113         BASEGFX_DLLPUBLIC ::basegfx::B2DPolyPolygon b2DPolyPolygonFromXPolyPolygon2D(
 114             const ::com::sun::star::uno::Reference<
 115                      ::com::sun::star::rendering::XPolyPolygon2D >& rPoly );
 116
 117         // Matrix conversions
 118
 119
 120         BASEGFX_DLLPUBLIC ::com::sun::star::geometry::AffineMatrix2D&
 121             affineMatrixFromHomMatrix( ::com::sun::star::geometry::AffineMatrix2D&  matrix,
 122                                        const ::basegfx::B2DHomMatrix&               transform);
 123
 124         BASEGFX_DLLPUBLIC ::com::sun::star::geometry::AffineMatrix3D& affineMatrixFromHomMatrix3D(
 125             ::com::sun::star::geometry::AffineMatrix3D& matrix,
 126             const ::basegfx::B3DHomMatrix& transform);
 127
 128         BASEGFX_DLLPUBLIC ::basegfx::B2DHomMatrix&
 129             homMatrixFromAffineMatrix( ::basegfx::B2DHomMatrix&                             transform,
 130                                        const ::com::sun::star::geometry::AffineMatrix2D&    matrix );
 131
 132         BASEGFX_DLLPUBLIC ::basegfx::B3DHomMatrix homMatrixFromAffineMatrix3D( const ::com::sun::star::geometry::AffineMatrix3D& matrix );
 133
 134         BASEGFX_DLLPUBLIC ::com::sun::star::geometry::Matrix2D&
 135             matrixFromHomMatrix( ::com::sun::star::geometry::Matrix2D& matrix,
 136                                  const ::basegfx::B2DHomMatrix&        transform);
 137
 138         // Geometry conversions
 139
 140
 141         BASEGFX_DLLPUBLIC ::com::sun::star::geometry::RealSize2D        size2DFromB2DSize( const ::basegfx::B2DVector& );
 142         BASEGFX_DLLPUBLIC ::com::sun::star::geometry::RealPoint2D       point2DFromB2DPoint( const ::basegfx::B2DPoint& );
 143         BASEGFX_DLLPUBLIC ::com::sun::star::geometry::RealRectangle2D   rectangle2DFromB2DRectangle( const ::basegfx::B2DRange& );
 144         BASEGFX_DLLPUBLIC ::com::sun::star::geometry::RealRectangle3D   rectangle3DFromB3DRectangle( const ::basegfx::B3DRange& );
 145
 146         BASEGFX_DLLPUBLIC ::basegfx::B2DPoint       b2DPointFromRealPoint2D( const ::com::sun::star::geometry::RealPoint2D& );
 147         BASEGFX_DLLPUBLIC ::basegfx::B2DRange       b2DRectangleFromRealRectangle2D( const ::com::sun::star::geometry::RealRectangle2D& );
 148         BASEGFX_DLLPUBLIC ::basegfx::B3DRange       b3DRectangleFromRealRectangle3D( const ::com::sun::star::geometry::RealRectangle3D& );
 149
 150         BASEGFX_DLLPUBLIC ::com::sun::star::geometry::IntegerSize2D         integerSize2DFromB2ISize( const ::basegfx::B2IVector& );
 151
 152         BASEGFX_DLLPUBLIC ::basegfx::B2IVector      b2ISizeFromIntegerSize2D( const ::com::sun::star::geometry::IntegerSize2D& );
 153         BASEGFX_DLLPUBLIC ::basegfx::B2IRange       b2IRectangleFromIntegerRectangle2D( const ::com::sun::star::geometry::IntegerRectangle2D& );
 154
 155         BASEGFX_DLLPUBLIC ::basegfx::B2IRange       b2IRectangleFromAwtRectangle( const ::com::sun::star::awt::Rectangle& );
 156
 157         // Geometry comparisons
 158
 159
 160         /** Return smalltest integer range, which completely contains
 161             given floating point range.
 162
 163             @param rRange
 164             Input range. Values must be within the representable
 165             bounds of sal_Int32
 166
 167             @return the closest integer range, which completely
 168             contains rRange.
 169          */
 170         BASEGFX_DLLPUBLIC ::basegfx::B2IRange   b2ISurroundingRangeFromB2DRange( const ::basegfx::B2DRange& rRange );
 171
 172         /** Return smalltest integer box, which completely contains
 173             given floating point range.
 174
 175             @param rRange
 176             Input range. Values must be within the representable
 177             bounds of sal_Int32
 178
 179             @return the closest integer box, which completely contains
 180             rRange. Note that this box will contain all pixel affected
 181             by a polygon fill operation over the input range.
 182          */
 183         BASEGFX_DLLPUBLIC ::basegfx::B2IBox     b2ISurroundingBoxFromB2DRange( const ::basegfx::B2DRange& rRange );
 184
 185         /** Return smalltest B2DRange with integer values, which
 186             completely contains given floating point range.
 187
 188             @param rRange
 189             Input range.
 190
 191             @return the closest B2DRange with integer coordinates,
 192             which completely contains rRange.
 193          */
 194         BASEGFX_DLLPUBLIC ::basegfx::B2DRange   b2DSurroundingIntegerRangeFromB2DRange( const ::basegfx::B2DRange& rRange );
 195
 196     }
 197 }
 198
 199 #endif // INCLUDED_BASEGFX_TOOLS_CANVASTOOLS_HXX
 200
 201 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */