include/drawinglayer/primitive2d/primitivetools2d.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 #pragma once
  21
  22 #include <drawinglayer/drawinglayerdllapi.h>
  23
  24 #include <drawinglayer/primitive2d/baseprimitive2d.hxx>
  25 #include <basegfx/matrix/b2dhommatrix.hxx>
  26
  27
  28 namespace drawinglayer::primitive2d
  29 {
  30         /** DiscreteMetricDependentPrimitive2D class
  31
  32             tooling class for BufferedDecompositionPrimitive2D based classes which are view-dependent
  33             regarding the size of a discrete unit. The implementation of get2DDecomposition
  34             guards the buffered local decomposition and ensures that a create2DDecomposition
  35             implementation may use an up-to-date DiscreteUnit accessible using getDiscreteUnit()
  36          */
  37         class DRAWINGLAYER_DLLPUBLIC DiscreteMetricDependentPrimitive2D : public BufferedDecompositionPrimitive2D
  38         {
  39         private:
  40             /** the last used fDiscreteUnit definitions for decomposition. Since this
  41                 is checked and updated from get2DDecomposition() it will be current and
  42                 usable in create2DDecomposition()
  43              */
  44             double                                  mfDiscreteUnit;
  45
  46         public:
  47             /// constructor
  48             DiscreteMetricDependentPrimitive2D()
  49             :   BufferedDecompositionPrimitive2D(),
  50                 mfDiscreteUnit(0.0)
  51             {
  52             }
  53
  54             /// data read access
  55             double getDiscreteUnit() const { return mfDiscreteUnit; }
  56
  57             /// Override standard getDecomposition to be view-dependent here
  58             virtual void get2DDecomposition(Primitive2DDecompositionVisitor& rVisitor, const geometry::ViewInformation2D& rViewInformation) const override;
  59         };
  60
  61         /** ViewportDependentPrimitive2D class
  62
  63             tooling class for BufferedDecompositionPrimitive2D based classes which are view-dependent
  64             regarding the viewport. The implementation of get2DDecomposition
  65             guards the buffered local decomposition and ensures that a create2DDecomposition
  66             implementation may use an up-to-date Viewport accessible using getViewport()
  67          */
  68         class DRAWINGLAYER_DLLPUBLIC ViewportDependentPrimitive2D : public BufferedDecompositionPrimitive2D
  69         {
  70         private:
  71             /** the last used Viewport definition for decomposition. Since this
  72                 is checked and updated from get2DDecomposition() it will be current and
  73                 usable in create2DDecomposition()
  74              */
  75             basegfx::B2DRange                       maViewport;
  76
  77         public:
  78             /// constructor
  79             ViewportDependentPrimitive2D()
  80             :   BufferedDecompositionPrimitive2D(),
  81                 maViewport()
  82             {
  83             }
  84
  85             /// data read access
  86             const basegfx::B2DRange& getViewport() const { return maViewport; }
  87
  88             /// Override standard getDecomposition to be view-dependent here
  89             virtual void get2DDecomposition(Primitive2DDecompositionVisitor& rVisitor, const geometry::ViewInformation2D& rViewInformation) const override;
  90         };
  91
  92         /** ViewTransformationDependentPrimitive2D class
  93
  94             tooling class for BufferedDecompositionPrimitive2D based classes which are view-dependent
  95             regarding the complete Viewtransformation. The implementation of get2DDecomposition
  96             guards the buffered local decomposition and ensures that a create2DDecomposition
  97             implementation may use an up-to-date ViewTransformation accessible using getViewTransformation()
  98          */
  99         class DRAWINGLAYER_DLLPUBLIC ViewTransformationDependentPrimitive2D : public BufferedDecompositionPrimitive2D
 100         {
 101         private:
 102             /** the last used ViewTransformation definition for decomposition. Since this
 103                 is checked and updated from get2DDecomposition() it will be current and
 104                 usable in create2DDecomposition()
 105              */
 106             basegfx::B2DHomMatrix                   maViewTransformation;
 107
 108         public:
 109             /// constructor
 110             ViewTransformationDependentPrimitive2D()
 111             :   BufferedDecompositionPrimitive2D(),
 112                 maViewTransformation()
 113             {
 114             }
 115
 116             /// data read access
 117             const basegfx::B2DHomMatrix& getViewTransformation() const { return maViewTransformation; }
 118
 119             /// Override standard getDecomposition to be view-dependent here
 120             virtual void get2DDecomposition(Primitive2DDecompositionVisitor& rVisitor, const geometry::ViewInformation2D& rViewInformation) const override;
 121         };
 122
 123         /** ObjectAndViewTransformationDependentPrimitive2D class
 124
 125             tooling class for BufferedDecompositionPrimitive2D based classes which are view-dependent
 126             and Object-Transform dependent. The implementation of get2DDecomposition
 127             guards the buffered local decomposition and ensures that a create2DDecomposition
 128             implementation may use an up-to-date ViewTransformation accessible using getViewTransformation()
 129             and an object transformation via getObjectTransformation()
 130          */
 131         class DRAWINGLAYER_DLLPUBLIC ObjectAndViewTransformationDependentPrimitive2D : public BufferedDecompositionPrimitive2D
 132         {
 133         private:
 134             /** the last used ViewTransformation and the last ObjectTransformation
 135                 definition for decomposition. Since this is checked and updated from
 136                 get2DDecomposition() it will be current and usable in create2DDecomposition()
 137              */
 138             basegfx::B2DHomMatrix                   maViewTransformation;
 139             basegfx::B2DHomMatrix                   maObjectTransformation;
 140
 141         public:
 142             /// constructor
 143             ObjectAndViewTransformationDependentPrimitive2D()
 144             :   BufferedDecompositionPrimitive2D(),
 145                 maViewTransformation(),
 146                 maObjectTransformation()
 147             {
 148             }
 149
 150             /// data read access
 151             const basegfx::B2DHomMatrix& getViewTransformation() const { return maViewTransformation; }
 152             const basegfx::B2DHomMatrix& getObjectTransformation() const { return maObjectTransformation; }
 153
 154             /// Override standard getDecomposition to be view-dependent here
 155             virtual void get2DDecomposition(Primitive2DDecompositionVisitor& rVisitor, const geometry::ViewInformation2D& rViewInformation) const override;
 156         };
 157 } // end of namespace drawinglayer::primitive2d
 158
 159 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */