include/svx/obj3d.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_OBJ3D_HXX
  21 #define INCLUDED_SVX_OBJ3D_HXX
  22
  23 #include <svx/svdoattr.hxx>
  24 #include <svx/svdobj.hxx>
  25 #include <basegfx/matrix/b3dhommatrix.hxx>
  26 #include <basegfx/range/b3drange.hxx>
  27 #include <basegfx/polygon/b3dpolypolygon.hxx>
  28 #include <svx/svxdllapi.h>
  29
  30 // Forward declarations
  31 class E3dScene;
  32
  33 namespace sdr::properties {
  34     class BaseProperties;
  35     class E3dCompoundProperties;
  36     class E3dExtrudeProperties;
  37     class E3dLatheProperties;
  38     class E3dSphereProperties;
  39 }
  40
  41 /*************************************************************************
  42 |*
  43 |* GeoData relevant for undo actions
  44 |*
  45 \************************************************************************/
  46
  47 class E3DObjGeoData : public SdrObjGeoData
  48 {
  49 public:
  50     basegfx::B3DRange           maLocalBoundVol;    // surrounding volume of the object
  51     basegfx::B3DHomMatrix       maTransformation;   // local transformations
  52
  53     E3DObjGeoData() {}
  54 };
  55
  56 /*************************************************************************
  57 |*
  58 |* Base class for 3D objects
  59 |*
  60 \************************************************************************/
  61
  62 class SVXCORE_DLLPUBLIC E3dObject : public SdrAttrObj
  63 {
  64 private:
  65     // Allow everything for E3dObjList and E3dDragMethod
  66     friend class E3dDragMethod;
  67
  68  protected:
  69     virtual std::unique_ptr<sdr::properties::BaseProperties> CreateObjectSpecificProperties() override;
  70
  71     basegfx::B3DRange           maLocalBoundVol;    // surrounding volume of the object (from the geometry generation)
  72     basegfx::B3DHomMatrix       maTransformation;   // local transformation
  73     basegfx::B3DHomMatrix       maFullTransform;    // global transformation (including. parents)
  74
  75     // Flags
  76     bool            mbTfHasChanged          : 1;
  77     bool            mbIsSelected            : 1;
  78
  79 protected:
  80     virtual basegfx::B3DRange RecalcBoundVolume() const;
  81
  82     // E3dObject is only a helper class (for E3DScene and E3DCompoundObject)
  83     // and no instances should be created from anyone, so i move the constructors
  84     // to protected area
  85     E3dObject(SdrModel& rSdrModel);
  86     E3dObject(SdrModel& rSdrModel, E3dObject const & rSource);
  87
  88     // protected destructor
  89     virtual ~E3dObject() override;
  90
  91 public:
  92     virtual void StructureChanged();
  93     virtual void SetTransformChanged();
  94     virtual void RecalcSnapRect() override;
  95
  96     virtual SdrInventor GetObjInventor() const override;
  97     virtual SdrObjKind GetObjIdentifier() const override;
  98     virtual void        TakeObjInfo(SdrObjTransformInfoRec& rInfo) const override;
  99     virtual void        NbcMove(const Size& rSize) override;
 100     virtual void NbcResize(const Point& rRef, const Fraction& xFact, const Fraction& yFact) override;
 101
 102     E3dScene* getParentE3dSceneFromE3dObject() const;
 103     virtual E3dScene* getRootE3dSceneFromE3dObject() const;
 104
 105     const basegfx::B3DRange& GetBoundVolume() const;
 106     void InvalidateBoundVolume();
 107
 108     // calculate complete transformation including all parents
 109     const basegfx::B3DHomMatrix& GetFullTransform() const;
 110
 111     // get and (re)set transformation matrix
 112     const basegfx::B3DHomMatrix& GetTransform() const { return maTransformation;}
 113     virtual void NbcSetTransform(const basegfx::B3DHomMatrix& rMatrix);
 114     virtual void SetTransform(const basegfx::B3DHomMatrix& rMatrix);
 115
 116     // 2D rotations, are implemented as a rotation around the Z axis
 117     // which is vertical to the screen, plus a shift of the scene.
 118     // This means that also the scene (E3dScene) must define this
 119     // routine as virtual in its class.
 120     virtual void NbcRotate(const Point& rRef, Degree100 nAngle, double sn, double cs) override;
 121
 122     // get wireframe polygon for local object. No transform is applied.
 123     basegfx::B3DPolyPolygon CreateWireframe() const;
 124
 125     // TakeObjName...() is for the display in the UI, for example "3 frames selected".
 126     virtual OUString TakeObjNameSingul() const override;
 127     virtual OUString TakeObjNamePlural() const override;
 128     virtual rtl::Reference<SdrObject> CloneSdrObject(SdrModel& rTargetModel) const override;
 129
 130     virtual std::unique_ptr<SdrObjGeoData> NewGeoData() const override;
 131     virtual void          SaveGeoData(SdrObjGeoData& rGeo) const override;
 132     virtual void          RestoreGeoData(const SdrObjGeoData& rGeo) override;
 133
 134     // get/set the selection
 135     bool GetSelected() const { return mbIsSelected; }
 136     virtual void SetSelected(bool bNew);
 137
 138     // break up
 139     virtual bool IsBreakObjPossible();
 140     virtual rtl::Reference<SdrAttrObj> GetBreakObj();
 141 };
 142
 143 /*************************************************************************
 144 |*
 145 |* Class for all compound objects (Cube, Lathe, Scene, Extrude)
 146 |* This class saves some ISA queries and accelerates the behaviour
 147 |* significantly, because all the attributes etc. are kept through this.
 148 |* The polygons may only keep attributes if they are directly
 149 |* subordinated to the scene.
 150 |*
 151 \************************************************************************/
 152
 153 class SVXCORE_DLLPUBLIC E3dCompoundObject : public E3dObject
 154 {
 155 private:
 156     // to allow sdr::properties::E3dCompoundProperties access to SetGeometryValid()
 157     friend class sdr::properties::E3dCompoundProperties;
 158     friend class sdr::properties::E3dExtrudeProperties;
 159     friend class sdr::properties::E3dLatheProperties;
 160     friend class sdr::properties::E3dSphereProperties;
 161
 162 protected:
 163     virtual std::unique_ptr<sdr::properties::BaseProperties> CreateObjectSpecificProperties() override;
 164
 165 protected:
 166     // convert given basegfx::B3DPolyPolygon to screen coor
 167     basegfx::B2DPolyPolygon TransformToScreenCoor(const basegfx::B3DPolyPolygon& rCandidate) const;
 168
 169     // protected destructor
 170     virtual ~E3dCompoundObject() override;
 171
 172 public:
 173     E3dCompoundObject(SdrModel& rSdrModel, E3dCompoundObject const & rSource);
 174     E3dCompoundObject(SdrModel& rSdrModel);
 175
 176     virtual basegfx::B2DPolyPolygon TakeXorPoly() const override;
 177     virtual sal_uInt32 GetHdlCount() const override;
 178     virtual void    AddToHdlList(SdrHdlList& rHdlList) const override;
 179
 180     virtual SdrObjKind GetObjIdentifier() const override;
 181     virtual void RecalcSnapRect() override;
 182
 183     virtual rtl::Reference<SdrObject> CloneSdrObject(SdrModel& rTargetModel) const override;
 184 };
 185
 186 #endif // INCLUDED_SVX_OBJ3D_HXX
 187
 188 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */