include/drawinglayer/geometry/viewinformation2d.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 <sal/config.h>
  25 #include <o3tl/cow_wrapper.hxx>
  26
  27 // predefines
  28
  29 namespace drawinglayer::geometry
  30 {
  31 class ImpViewInformation2D;
  32 }
  33
  34 namespace basegfx
  35 {
  36 class B2DHomMatrix;
  37 class B2DRange;
  38 }
  39
  40 namespace com::sun::star::beans
  41 {
  42 struct PropertyValue;
  43 }
  44
  45 namespace com::sun::star::drawing
  46 {
  47 class XDrawPage;
  48 }
  49
  50 namespace com::sun::star::uno
  51 {
  52 template <class interface_type> class Reference;
  53 template <typename> class Sequence;
  54 }
  55
  56 namespace drawinglayer::geometry
  57 {
  58 /** ViewInformation2D class
  59
  60     This class holds all view-relevant information for a 2d geometry.
  61     The most used data is for convenience offered directly using basegfx tooling classes.
  62 */
  63 class DRAWINGLAYERCORE_DLLPUBLIC ViewInformation2D
  64 {
  65 public:
  66     typedef o3tl::cow_wrapper<ImpViewInformation2D, o3tl::ThreadSafeRefCountingPolicy> ImplType;
  67
  68 private:
  69     /// pointer to private implementation class
  70     ImplType mpViewInformation2D;
  71
  72 public:
  73     /** Constructor: Create a ViewInformation2D
  74
  75         @param rObjectTransformation
  76         The Transformation from Object to World coordinates (normally logic coordinates).
  77
  78         @param rViewTransformation
  79         The Transformation from World to View coordinates (normally logic coordinates
  80         to discrete units, e.g. pixels).
  81
  82         @param rViewport
  83         The visible part of the view in World coordinates. If empty (getViewport().isEmpty())
  84         everything is visible. The data is in World coordinates.
  85
  86         @param rxDrawPage
  87         The currently displayed page. This information is needed e.g. due to existing PageNumber
  88         fields which need to be interpreted.
  89
  90         @param fViewTime
  91         The time the view is defined for. Default is 0.0. This parameter is used e.g. for
  92         animated objects
  93
  94         @param bReducedDisplayQuality
  95         Support reduced DisplayQuality, PropertyName is 'ReducedDisplayQuality'. This
  96         is used e.g. to allow to lower display quality for OverlayPrimitives and
  97         may lead to simpler decompositions in the local create2DDecomposition
  98         implementations of the primitives
  99
 100         @param bUseAntiAliasing
 101         Determine if to use AntiAliasing on target pixel device
 102
 103         @param bPixelSnapHairline
 104         Determine if to use PixelSnapHairline on target pixel device
 105     */
 106     /// default (empty) constructor
 107     ViewInformation2D();
 108
 109     /// copy constructor
 110     ViewInformation2D(const ViewInformation2D&);
 111
 112     ViewInformation2D(ViewInformation2D&&);
 113
 114     /// destructor
 115     ~ViewInformation2D();
 116
 117     /// assignment operator
 118     ViewInformation2D& operator=(const ViewInformation2D&);
 119     ViewInformation2D& operator=(ViewInformation2D&&);
 120
 121     /// compare operators
 122     bool operator==(const ViewInformation2D& rCandidate) const;
 123     bool operator!=(const ViewInformation2D& rCandidate) const { return !operator==(rCandidate); }
 124
 125     /// data access
 126     const basegfx::B2DHomMatrix& getObjectTransformation() const;
 127     void setObjectTransformation(const basegfx::B2DHomMatrix& rNew);
 128
 129     const basegfx::B2DHomMatrix& getViewTransformation() const;
 130     void setViewTransformation(const basegfx::B2DHomMatrix& rNew);
 131
 132     /// Empty viewport means everything is visible.
 133     const basegfx::B2DRange& getViewport() const;
 134     void setViewport(const basegfx::B2DRange& rNew);
 135
 136     double getViewTime() const;
 137     void setViewTime(double fNew);
 138
 139     const css::uno::Reference<css::drawing::XDrawPage>& getVisualizedPage() const;
 140     void setVisualizedPage(const css::uno::Reference<css::drawing::XDrawPage>& rNew);
 141
 142     /// On-demand prepared Object to View transformation and its inverse for convenience
 143     const basegfx::B2DHomMatrix& getObjectToViewTransformation() const;
 144     const basegfx::B2DHomMatrix& getInverseObjectToViewTransformation() const;
 145
 146     /// On-demand prepared Viewport in discrete units for convenience
 147     /// Empty viewport means everything is visible.
 148     const basegfx::B2DRange& getDiscreteViewport() const;
 149
 150     /// Support reduced DisplayQuality, PropertyName is 'ReducedDisplayQuality'.
 151     bool getReducedDisplayQuality() const;
 152     void setReducedDisplayQuality(bool bNew);
 153
 154     /// Determine if to use AntiAliasing on target pixel device, PropertyName is 'UseAntiAliasing'
 155     bool getUseAntiAliasing() const;
 156     void setUseAntiAliasing(bool bNew);
 157
 158     /// Determine if to use PixelSnapHairline on target pixel device, PropertyName is 'PixelSnapHairline'
 159     bool getPixelSnapHairline() const;
 160     void setPixelSnapHairline(bool bNew);
 161
 162     static void setGlobalAntiAliasing(bool bAntiAliasing, bool bTemporary);
 163     static bool getGlobalAntiAliasing();
 164     static void forwardPixelSnapHairline(bool bPixelSnapHairline);
 165 };
 166
 167 DRAWINGLAYERCORE_DLLPUBLIC ViewInformation2D
 168 createViewInformation2D(const css::uno::Sequence<css::beans::PropertyValue>& rViewParameters);
 169
 170 } // end of namespace drawinglayer::geometry
 171
 172 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */