include/drawinglayer/geometry/viewinformation3d.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_DRAWINGLAYER_GEOMETRY_VIEWINFORMATION3D_HXX
  21 #define INCLUDED_DRAWINGLAYER_GEOMETRY_VIEWINFORMATION3D_HXX
  22
  23 #include <drawinglayer/drawinglayerdllapi.h>
  24
  25 #include <sal/config.h>
  26 #include <o3tl/cow_wrapper.hxx>
  27
  28
  29 // predefines
  30
  31 namespace drawinglayer { namespace geometry {
  32     class ImpViewInformation3D;
  33 }}
  34
  35 namespace basegfx {
  36     class B3DHomMatrix;
  37 }
  38
  39 namespace com::sun::star::beans { struct PropertyValue; }
  40 namespace com::sun::star::uno { template <typename > class Sequence; }
  41
  42 namespace drawinglayer
  43 {
  44     namespace geometry
  45     {
  46         /** ViewInformation3D class
  47
  48             This class holds all view-relevant information for a 3d geometry. It works
  49             together with UNO API definitions and supports holding a sequence of PropertyValues.
  50             The most used data is for convenience offered directly using basegfx tooling classes.
  51             It is an implementation to support the sequence of PropertyValues used in a
  52             css::graphic::XPrimitive3D for C++ implementations working with those
  53         */
  54         class DRAWINGLAYER_DLLPUBLIC ViewInformation3D
  55         {
  56         public:
  57             typedef o3tl::cow_wrapper< ImpViewInformation3D, o3tl::ThreadSafeRefCountingPolicy > ImplType;
  58
  59         private:
  60             /// pointer to private implementation class
  61             ImplType mpViewInformation3D;
  62
  63         public:
  64             /** Constructor: Create a ViewInformation3D
  65
  66                 @param rObjectTransformation
  67                 The Transformation from Object to World coordinates (normally logic coordinates).
  68
  69                 @param rOrientation
  70                 A part of the 3D ViewTransformation, the World to Camera coordinates transformation
  71                 which holds the camera coordinate system.
  72
  73                 @param rProjection
  74                 A part of the 3D ViewTransformation, the Camera to Device transformation which
  75                 transforms coordinates to a [0.0 .. 1.0] device range in X,Y and Z. Z may be used
  76                 as source for Z-Buffers. This transformation may be e.g. a parallel projection,
  77                 but also a perspective one and thus may use the last line of the matrix.
  78
  79                 @param rDeviceToView
  80                 A part of the 3D ViewTransformation, the Device to View transformation which normally
  81                 translates and scales from [0.0 .. 1.0] range in X,Y and Z to discrete position and
  82                 size.
  83
  84                 rOrientation, rProjection and rDeviceToView define the 3D transformation pipeline
  85                 and are normally used multiplied together to have a direct transformation from
  86                 World to View coordinates
  87
  88                 @param fViewTime
  89                 The time the view is defined for. Default is 0.0. This parameter is used e.g. for
  90                 animated objects
  91
  92                 @param rExtendedParameters
  93                 A sequence of property values which allows holding various other parameters besides
  94                 the obvious and needed ones above. For this constructor none of the other parameters
  95                 should be added as data. The constructor will parse the given parameters and if
  96                 data for the other parameters is given, the value in rExtendedParameters will
  97                 be preferred and overwrite the given parameter
  98             */
  99             ViewInformation3D(
 100                 const basegfx::B3DHomMatrix& rObjectTransformation,
 101                 const basegfx::B3DHomMatrix& rOrientation,
 102                 const basegfx::B3DHomMatrix& rProjection,
 103                 const basegfx::B3DHomMatrix& rDeviceToView,
 104                 double fViewTime,
 105                 const css::uno::Sequence< css::beans::PropertyValue >& rExtendedParameters);
 106
 107             /** Constructor: Create a ViewInformation3D
 108
 109                 @param rViewParameters
 110                 A sequence of property values which allows holding any combination of local and various
 111                 other parameters. This constructor is feeded completely with a sequence of PropertyValues
 112                 which will be parsed to be able to offer the most used ones in a convenient way.
 113             */
 114             explicit ViewInformation3D(const css::uno::Sequence< css::beans::PropertyValue >& rViewParameters);
 115
 116             /// default (empty) constructor
 117             ViewInformation3D();
 118
 119             /// copy constructor
 120             ViewInformation3D(const ViewInformation3D&);
 121
 122             ViewInformation3D(ViewInformation3D&&);
 123
 124             /// destructor
 125             ~ViewInformation3D();
 126
 127             // checks if the incarnation is default constructed
 128             bool isDefault() const;
 129
 130             /// assignment operator
 131             ViewInformation3D& operator=(const ViewInformation3D&);
 132             ViewInformation3D& operator=(ViewInformation3D&&);
 133
 134             /// compare operators
 135             bool operator==(const ViewInformation3D& rCandidate) const;
 136             bool operator!=(const ViewInformation3D& rCandidate) const { return !operator==(rCandidate); }
 137
 138             /// data access
 139             const basegfx::B3DHomMatrix& getObjectTransformation() const;
 140             const basegfx::B3DHomMatrix& getOrientation() const;
 141             const basegfx::B3DHomMatrix& getProjection() const;
 142             const basegfx::B3DHomMatrix& getDeviceToView() const;
 143             double getViewTime() const;
 144
 145             /// for convenience, the linear combination of the above four transformations is offered
 146             const basegfx::B3DHomMatrix& getObjectToView() const;
 147
 148             /** Get the uno::Sequence< beans::PropertyValue > which contains all ViewInformation
 149
 150                 Use this call if You need to extract all contained ViewInformation. The ones
 151                 directly supported for convenience will be added to the ones only available
 152                 as PropertyValues. This set completely describes this ViewInformation3D and
 153                 can be used for complete information transport over UNO API.
 154             */
 155             const css::uno::Sequence< css::beans::PropertyValue >& getViewInformationSequence() const;
 156
 157             /** Get the uno::Sequence< beans::PropertyValue > which contains only ViewInformation
 158                 not offered directly
 159
 160                 Use this call if You only need ViewInformation which is not offered conveniently,
 161                 but only exists as PropertyValue. This is e.g. used to create partially updated
 162                 incarnations of ViewInformation3D without losing the only with PropertyValues
 163                 defined data. It does not contain a complete description.
 164             */
 165             const css::uno::Sequence< css::beans::PropertyValue >& getExtendedInformationSequence() const;
 166         };
 167     } // end of namespace geometry
 168 } // end of namespace drawinglayer
 169
 170
 171 #endif //INCLUDED_DRAWINGLAYER_GEOMETRY_VIEWINFORMATION3D_HXX
 172
 173 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */