include/svx/e3dsceneupdater.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_SVX_E3DSCENEUPDATER_HXX
  21 #define INCLUDED_SVX_E3DSCENEUPDATER_HXX
  22
  23 #include <svx/svxdllapi.h>
  24 #include <drawinglayer/geometry/viewinformation3d.hxx>
  25 #include <optional>
  26
  27 class SdrObject;
  28 class E3dScene;
  29
  30 /** Helper for 3d object changes affecting 2d geometry
  31
  32    This class is a helper to encapsulate 3D object changes which shall
  33    change the scene's 2D geometry. E.g. when moving one 3D object in a
  34    scene, the visualisation would not change since the scene's 2D
  35    attributes are defined by its 2D object transformation and the
  36    changed content would be projected to the same 2D bounds as
  37    before. To reflect the fact that the 2D positions may 'change' for
  38    the user's imagination, it is necessary to calculate a new 2D
  39    object transformation of the scene (the SnapRect) using the old 3D
  40    transformation stack and the possibly modified 3D content and to
  41    use it. This is only desirable if changes to the scene's content
  42    are intended to change the scene's 2D geometry attributes
  43 */
  44 class SVXCORE_DLLPUBLIC E3DModifySceneSnapRectUpdater
  45 {
  46     // the scene which may be changed. This gets set to the outmost scene
  47     // of the to-be-changed 3D object when the scene has a 3d transformation
  48     // stack at construction time. In all other cases it's set to zero and
  49     // no action needs to be taken
  50     E3dScene* mpScene;
  51
  52     // the 3d transformation stack at the time of construction, valid when
  53     // mpScene is not zero
  54     std::optional<drawinglayer::geometry::ViewInformation3D> mpViewInformation3D;
  55
  56 public:
  57     // the constructor evaluates and sets the members at construction time
  58     E3DModifySceneSnapRectUpdater(const SdrObject* mpObject);
  59
  60     // the destructor will take action if mpScene is not zero and modify the
  61     // 2D geometry of the target scene
  62     ~E3DModifySceneSnapRectUpdater();
  63 };
  64
  65 #endif // INCLUDED_SVX_E3DSCENEUPDATER_HXX
  66
  67 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */