include/basegfx/matrix/b2dhommatrix.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_MATRIX_B2DHOMMATRIX_HXX
  21 #define INCLUDED_BASEGFX_MATRIX_B2DHOMMATRIX_HXX
  22
  23 #include <sal/config.h>
  24
  25 #include <ostream>
  26
  27 #include <sal/types.h>
  28 #include <o3tl/cow_wrapper.hxx>
  29 #include <basegfx/basegfxdllapi.h>
  30
  31 namespace basegfx
  32 {
  33     class B2DTuple;
  34     class Impl2DHomMatrix;
  35
  36     class SAL_WARN_UNUSED BASEGFX_DLLPUBLIC B2DHomMatrix
  37     {
  38     public:
  39         typedef o3tl::cow_wrapper< Impl2DHomMatrix > ImplType;
  40
  41     private:
  42         ImplType                                     mpImpl;
  43
  44     public:
  45         B2DHomMatrix();
  46         B2DHomMatrix(const B2DHomMatrix& rMat);
  47         B2DHomMatrix(B2DHomMatrix&& rMat);
  48         ~B2DHomMatrix();
  49
  50         /** Convenience creator for declaration of the matrix that is commonly
  51             used by web standards (SVG, CSS, HTML).
  52
  53            Values a,b,c,d,e,f represent the following values in the matrix:
  54               [a,c,e]      [a,c,e]
  55               [b,d,f]  or  [b,d,f]
  56                            [0,0,1]
  57
  58         */
  59         static B2DHomMatrix abcdef(double da, double db, double dc, double dd, double de, double df)
  60         {
  61             return B2DHomMatrix(da, dc, de, db, dd, df);
  62         }
  63
  64         // Convenience accessor for value at 0,0 position in the matrix
  65         double a() { return get(0,0); }
  66         // Convenience accessor for value at 1,0 position in the matrix
  67         double b() { return get(1,0); }
  68         // Convenience accessor for value at 0,1 position in the matrix
  69         double c() { return get(0,1); }
  70         // Convenience accessor for value at 1,1 position in the matrix
  71         double d() { return get(1,1); }
  72         // Convenience accessor for value at 0,2 position in the matrix
  73         double e() { return get(0,2); }
  74         // Convenience accessor for value at 1,2 position in the matrix
  75         double f() { return get(1,2); }
  76
  77         /** constructor to allow setting all needed values for a 3x2 matrix at once. The
  78             parameter f_0x1 e.g. is the same as using set(0, 1, f)
  79          */
  80         B2DHomMatrix(double f_0x0, double f_0x1, double f_0x2, double f_1x0, double f_1x1, double f_1x2);
  81
  82         double get(sal_uInt16 nRow, sal_uInt16 nColumn) const;
  83         void set(sal_uInt16 nRow, sal_uInt16 nColumn, double fValue);
  84
  85         /** allow setting all needed values for a 3x2 matrix in one call. The
  86             parameter f_0x1 e.g. is the same as using set(0, 1, f)
  87          */
  88         void set3x2(double f_0x0, double f_0x1, double f_0x2, double f_1x0, double f_1x1, double f_1x2);
  89
  90         // test if last line is default to see if last line needs to be
  91         // involved in calculations
  92         bool isLastLineDefault() const;
  93
  94         // reset to a standard matrix
  95         bool isIdentity() const;
  96         void identity();
  97
  98         bool isInvertible() const;
  99         bool invert();
 100
 101         void rotate(double fRadiant);
 102
 103         void translate(double fX, double fY);
 104         void translate(const B2DTuple& rTuple);
 105
 106         void scale(double fX, double fY);
 107         void scale(const B2DTuple& rTuple);
 108
 109         // Shearing-Matrices
 110         void shearX(double fSx);
 111         void shearY(double fSy);
 112
 113         B2DHomMatrix& operator+=(const B2DHomMatrix& rMat);
 114         B2DHomMatrix& operator-=(const B2DHomMatrix& rMat);
 115
 116         bool operator==(const B2DHomMatrix& rMat) const;
 117         bool operator!=(const B2DHomMatrix& rMat) const;
 118
 119         B2DHomMatrix& operator*=(double fValue);
 120         B2DHomMatrix& operator/=(double fValue);
 121
 122         // matrix multiplication from the left to the local
 123         B2DHomMatrix& operator*=(const B2DHomMatrix& rMat);
 124
 125         // assignment operator
 126         B2DHomMatrix& operator=(const B2DHomMatrix& rMat);
 127         B2DHomMatrix& operator=(B2DHomMatrix&& rMat);
 128
 129         // Help routine to decompose given homogen 3x3 matrix to components. A correction of
 130         // the components is done to avoid inaccuracies.
 131         bool decompose(B2DTuple& rScale, B2DTuple& rTranslate, double& rRotate, double& rShearX) const;
 132     };
 133
 134     inline B2DHomMatrix operator*(const B2DHomMatrix& rMatA, const B2DHomMatrix& rMatB)
 135     {
 136         B2DHomMatrix aMul(rMatB);
 137         aMul *= rMatA;
 138         return aMul;
 139     }
 140
 141     template<typename charT, typename traits>
 142     std::basic_ostream<charT, traits> & operator <<(
 143         std::basic_ostream<charT, traits> & stream, B2DHomMatrix const & matrix)
 144     {
 145         return stream
 146             << '[' << matrix.get(0, 0) << ' ' << matrix.get(0, 1) << ' '
 147             << matrix.get(0, 2) << "; " << matrix.get(1, 0) << ' '
 148             << matrix.get(1, 1) << ' ' << matrix.get(1, 2) << "; "
 149             << matrix.get(2, 0) << ' ' << matrix.get(2, 1) << ' '
 150             << matrix.get(2, 2) << ']';
 151     }
 152 } // end of namespace basegfx
 153
 154 #endif // INCLUDED_BASEGFX_MATRIX_B2DHOMMATRIX_HXX
 155
 156 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */