drawinglayer/source/geometry/viewinformation3d.cxx

   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 #include <drawinglayer/geometry/viewinformation3d.hxx>
  21 #include <basegfx/range/b3drange.hxx>
  22 #include <basegfx/matrix/b3dhommatrix.hxx>
  23 #include <com/sun/star/geometry/AffineMatrix3D.hpp>
  24 #include <com/sun/star/geometry/RealRectangle3D.hpp>
  25 #include <basegfx/tools/canvastools.hxx>
  26 #include <rtl/instance.hxx>
  27
  28
  29 using namespace com::sun::star;
  30
  31
  32 namespace drawinglayer
  33 {
  34     namespace geometry
  35     {
  36         /** Implementation class for ViewInformation3D
  37         */
  38         class ImpViewInformation3D
  39         {
  40         private:
  41             // ViewInformation3D implementation can change refcount, so we have only
  42             // two memory regions for pairs of ViewInformation3D/ImpViewInformation3D
  43             friend class ::drawinglayer::geometry::ViewInformation3D;
  44
  45             // the 3D transformations
  46             // Object to World. This may change and being adapted when entering 3D transformation
  47             // groups
  48             basegfx::B3DHomMatrix                       maObjectTransformation;
  49
  50             // World to Camera. This includes VRP, VPN and VUV camera coordinate system
  51             basegfx::B3DHomMatrix                       maOrientation;
  52
  53             // Camera to Device with X,Y and Z [-1.0 .. 1.0]. This is the
  54             // 3D to 2D projection which may be parallel or perspective. When it is perspective,
  55             // the last line of the homogen matrix will NOT be unused
  56             basegfx::B3DHomMatrix                       maProjection;
  57
  58             // Device to View with X,Y and Z [0.0 .. 1.0]. This converts from -1 to 1 coordinates
  59             // in camera coordinate system to 0 to 1 in unit 2D coordinates. This way it stays
  60             // view-independent. To get discrete coordinates, the 2D transformation of a scene
  61             // as 2D object needs to be involved
  62             basegfx::B3DHomMatrix                       maDeviceToView;
  63
  64             // Object to View is the linear combination of all four transformations. It's
  65             // buffered to avoid too much matrix multiplying and created on demand
  66             basegfx::B3DHomMatrix                       maObjectToView;
  67
  68             // the point in time
  69             double                                      mfViewTime;
  70
  71             // the complete PropertyValue representation (if already created)
  72             uno::Sequence< beans::PropertyValue >       mxViewInformation;
  73
  74             // the extra PropertyValues; does not contain the transformations
  75             uno::Sequence< beans::PropertyValue >       mxExtendedInformation;
  76
  77             // the local UNO API strings
  78             static OUString getNamePropertyObjectTransformation()
  79             {
  80                 return OUString("ObjectTransformation");
  81             }
  82
  83             static OUString getNamePropertyOrientation()
  84             {
  85                 return OUString("Orientation");
  86             }
  87
  88             static OUString getNamePropertyProjection()
  89             {
  90                 return OUString("Projection");
  91             }
  92
  93             static OUString getNamePropertyProjection_30()
  94             {
  95                 return OUString("Projection30");
  96             }
  97
  98             static OUString getNamePropertyProjection_31()
  99             {
 100                 return OUString("Projection31");
 101             }
 102
 103             static OUString getNamePropertyProjection_32()
 104             {
 105                 return OUString("Projection32");
 106             }
 107
 108             static OUString getNamePropertyProjection_33()
 109             {
 110                 return OUString("Projection33");
 111             }
 112
 113             static OUString getNamePropertyDeviceToView()
 114             {
 115                 return OUString("DeviceToView");
 116             }
 117
 118             static OUString getNamePropertyTime()
 119             {
 120                 return OUString("Time");
 121             }
 122
 123             // a central PropertyValue parsing method to allow transportatin of
 124             // all ViewParameters using UNO API
 125             void impInterpretPropertyValues(const uno::Sequence< beans::PropertyValue >& rViewParameters)
 126             {
 127                 if(rViewParameters.hasElements())
 128                 {
 129                     const sal_Int32 nCount(rViewParameters.getLength());
 130                     sal_Int32 nExtendedInsert(0);
 131
 132                     // prepare extended information for filtering. Maximum size is nCount
 133                     mxExtendedInformation.realloc(nCount);
 134
 135                     for(sal_Int32 a(0); a < nCount; a++)
 136                     {
 137                         const beans::PropertyValue& rProp = rViewParameters[a];
 138
 139                         if(rProp.Name == getNamePropertyObjectTransformation())
 140                         {
 141                             css::geometry::AffineMatrix3D aAffineMatrix3D;
 142                             rProp.Value >>= aAffineMatrix3D;
 143                             maObjectTransformation = basegfx::unotools::homMatrixFromAffineMatrix3D(aAffineMatrix3D);
 144                         }
 145                         else if(rProp.Name == getNamePropertyOrientation())
 146                         {
 147                             css::geometry::AffineMatrix3D aAffineMatrix3D;
 148                             rProp.Value >>= aAffineMatrix3D;
 149                             maOrientation = basegfx::unotools::homMatrixFromAffineMatrix3D(aAffineMatrix3D);
 150                         }
 151                         else if(rProp.Name == getNamePropertyProjection())
 152                         {
 153                             // projection may be defined using a frustum in which case the last line of
 154                             // the 4x4 matrix is not (0,0,0,1). Since AffineMatrix3D does not support that,
 155                             // these four values need to be treated extra
 156                             const double f_30(maProjection.get(3, 0));
 157                             const double f_31(maProjection.get(3, 1));
 158                             const double f_32(maProjection.get(3, 2));
 159                             const double f_33(maProjection.get(3, 3));
 160
 161                             css::geometry::AffineMatrix3D aAffineMatrix3D;
 162                             rProp.Value >>= aAffineMatrix3D;
 163                             maProjection = basegfx::unotools::homMatrixFromAffineMatrix3D(aAffineMatrix3D);
 164
 165                             maProjection.set(3, 0, f_30);
 166                             maProjection.set(3, 1, f_31);
 167                             maProjection.set(3, 2, f_32);
 168                             maProjection.set(3, 3, f_33);
 169                         }
 170                         else if(rProp.Name == getNamePropertyProjection_30())
 171                         {
 172                             double f_30(0.0);
 173                             rProp.Value >>= f_30;
 174                             maProjection.set(3, 0, f_30);
 175                         }
 176                         else if(rProp.Name == getNamePropertyProjection_31())
 177                         {
 178                             double f_31(0.0);
 179                             rProp.Value >>= f_31;
 180                             maProjection.set(3, 1, f_31);
 181                         }
 182                         else if(rProp.Name == getNamePropertyProjection_32())
 183                         {
 184                             double f_32(0.0);
 185                             rProp.Value >>= f_32;
 186                             maProjection.set(3, 2, f_32);
 187                         }
 188                         else if(rProp.Name == getNamePropertyProjection_33())
 189                         {
 190                             double f_33(1.0);
 191                             rProp.Value >>= f_33;
 192                             maProjection.set(3, 3, f_33);
 193                         }
 194                         else if(rProp.Name == getNamePropertyDeviceToView())
 195                         {
 196                             css::geometry::AffineMatrix3D aAffineMatrix3D;
 197                             rProp.Value >>= aAffineMatrix3D;
 198                             maDeviceToView = basegfx::unotools::homMatrixFromAffineMatrix3D(aAffineMatrix3D);
 199                         }
 200                         else if(rProp.Name == getNamePropertyTime())
 201                         {
 202                             rProp.Value >>= mfViewTime;
 203                         }
 204                         else
 205                         {
 206                             // extra information; add to filtered information
 207                             mxExtendedInformation[nExtendedInsert++] = rProp;
 208                         }
 209                     }
 210
 211                     // extra information size is now known; realloc to final size
 212                     mxExtendedInformation.realloc(nExtendedInsert);
 213                 }
 214             }
 215
 216             // central method to create a Sequence of PropertyValues containing he complete
 217             // data set
 218             void impFillViewInformationFromContent()
 219             {
 220                 const bool bObjectTransformationUsed(!maObjectTransformation.isIdentity());
 221                 const bool bOrientationUsed(!maOrientation.isIdentity());
 222                 const bool bProjectionUsed(!maProjection.isIdentity());
 223                 const bool bDeviceToViewUsed(!maDeviceToView.isIdentity());
 224                 const bool bTimeUsed(0.0 < mfViewTime);
 225                 const bool bExtraInformation(mxExtendedInformation.hasElements());
 226
 227                 // projection may be defined using a frustum in which case the last line of
 228                 // the 4x4 matrix is not (0,0,0,1). Since AffineMatrix3D does not support that,
 229                 // these four values need to be treated extra
 230                 const bool bProjectionUsed_30(bProjectionUsed && !basegfx::fTools::equalZero(maProjection.get(3, 0)));
 231                 const bool bProjectionUsed_31(bProjectionUsed && !basegfx::fTools::equalZero(maProjection.get(3, 1)));
 232                 const bool bProjectionUsed_32(bProjectionUsed && !basegfx::fTools::equalZero(maProjection.get(3, 2)));
 233                 const bool bProjectionUsed_33(bProjectionUsed && !basegfx::fTools::equal(maProjection.get(3, 3), 1.0));
 234
 235                 sal_uInt32 nIndex(0);
 236                 const sal_uInt32 nCount(
 237                     (bObjectTransformationUsed ? 1 : 0) +
 238                     (bOrientationUsed ? 1 : 0) +
 239                     (bProjectionUsed ? 1 : 0) +
 240                     (bProjectionUsed_30 ? 1 : 0) +
 241                     (bProjectionUsed_31 ? 1 : 0) +
 242                     (bProjectionUsed_32 ? 1 : 0) +
 243                     (bProjectionUsed_33 ? 1 : 0) +
 244                     (bDeviceToViewUsed ? 1 : 0) +
 245                     (bTimeUsed ? 1 : 0) +
 246                     (bExtraInformation ? mxExtendedInformation.getLength() : 0));
 247
 248                 mxViewInformation.realloc(nCount);
 249
 250                 if(bObjectTransformationUsed)
 251                 {
 252                     css::geometry::AffineMatrix3D aAffineMatrix3D;
 253                     basegfx::unotools::affineMatrixFromHomMatrix3D(aAffineMatrix3D, maObjectTransformation);
 254                     mxViewInformation[nIndex].Name = getNamePropertyObjectTransformation();
 255                     mxViewInformation[nIndex].Value <<= aAffineMatrix3D;
 256                     nIndex++;
 257                 }
 258
 259                 if(bOrientationUsed)
 260                 {
 261                     css::geometry::AffineMatrix3D aAffineMatrix3D;
 262                     basegfx::unotools::affineMatrixFromHomMatrix3D(aAffineMatrix3D, maOrientation);
 263                     mxViewInformation[nIndex].Name = getNamePropertyOrientation();
 264                     mxViewInformation[nIndex].Value <<= aAffineMatrix3D;
 265                     nIndex++;
 266                 }
 267
 268                 if(bProjectionUsed)
 269                 {
 270                     css::geometry::AffineMatrix3D aAffineMatrix3D;
 271                     basegfx::unotools::affineMatrixFromHomMatrix3D(aAffineMatrix3D, maProjection);
 272                     mxViewInformation[nIndex].Name = getNamePropertyProjection();
 273                     mxViewInformation[nIndex].Value <<= aAffineMatrix3D;
 274                     nIndex++;
 275                 }
 276
 277                 if(bProjectionUsed_30)
 278                 {
 279                     mxViewInformation[nIndex].Name = getNamePropertyProjection_30();
 280                     mxViewInformation[nIndex].Value <<= maProjection.get(3, 0);
 281                     nIndex++;
 282                 }
 283
 284                 if(bProjectionUsed_31)
 285                 {
 286                     mxViewInformation[nIndex].Name = getNamePropertyProjection_31();
 287                     mxViewInformation[nIndex].Value <<= maProjection.get(3, 1);
 288                     nIndex++;
 289                 }
 290
 291                 if(bProjectionUsed_32)
 292                 {
 293                     mxViewInformation[nIndex].Name = getNamePropertyProjection_32();
 294                     mxViewInformation[nIndex].Value <<= maProjection.get(3, 2);
 295                     nIndex++;
 296                 }
 297
 298                 if(bProjectionUsed_33)
 299                 {
 300                     mxViewInformation[nIndex].Name = getNamePropertyProjection_33();
 301                     mxViewInformation[nIndex].Value <<= maProjection.get(3, 3);
 302                     nIndex++;
 303                 }
 304
 305                 if(bDeviceToViewUsed)
 306                 {
 307                     css::geometry::AffineMatrix3D aAffineMatrix3D;
 308                     basegfx::unotools::affineMatrixFromHomMatrix3D(aAffineMatrix3D, maDeviceToView);
 309                     mxViewInformation[nIndex].Name = getNamePropertyDeviceToView();
 310                     mxViewInformation[nIndex].Value <<= aAffineMatrix3D;
 311                     nIndex++;
 312                 }
 313
 314                 if(bTimeUsed)
 315                 {
 316                     mxViewInformation[nIndex].Name = getNamePropertyTime();
 317                     mxViewInformation[nIndex].Value <<= mfViewTime;
 318                     nIndex++;
 319                 }
 320
 321                 if(bExtraInformation)
 322                 {
 323                     const sal_Int32 nExtra(mxExtendedInformation.getLength());
 324
 325                     for(sal_Int32 a(0); a < nExtra; a++)
 326                     {
 327                         mxViewInformation[nIndex++] = mxExtendedInformation[a];
 328                     }
 329                 }
 330             }
 331
 332         public:
 333             ImpViewInformation3D(
 334                 const basegfx::B3DHomMatrix& rObjectTransformation,
 335                 const basegfx::B3DHomMatrix& rOrientation,
 336                 const basegfx::B3DHomMatrix& rProjection,
 337                 const basegfx::B3DHomMatrix& rDeviceToView,
 338                 double fViewTime,
 339                 const uno::Sequence< beans::PropertyValue >& rExtendedParameters)
 340             :   maObjectTransformation(rObjectTransformation),
 341                 maOrientation(rOrientation),
 342                 maProjection(rProjection),
 343                 maDeviceToView(rDeviceToView),
 344                 mfViewTime(fViewTime),
 345                 mxViewInformation(),
 346                 mxExtendedInformation()
 347             {
 348                 impInterpretPropertyValues(rExtendedParameters);
 349             }
 350
 351             explicit ImpViewInformation3D(const uno::Sequence< beans::PropertyValue >& rViewParameters)
 352             :   maObjectTransformation(),
 353                 maOrientation(),
 354                 maProjection(),
 355                 maDeviceToView(),
 356                 mfViewTime(),
 357                 mxViewInformation(rViewParameters),
 358                 mxExtendedInformation()
 359             {
 360                 impInterpretPropertyValues(rViewParameters);
 361             }
 362
 363             ImpViewInformation3D()
 364             :   maObjectTransformation(),
 365                 maOrientation(),
 366                 maProjection(),
 367                 maDeviceToView(),
 368                 mfViewTime(),
 369                 mxViewInformation(),
 370                 mxExtendedInformation()
 371             {
 372             }
 373
 374             const basegfx::B3DHomMatrix& getObjectTransformation() const { return maObjectTransformation; }
 375             const basegfx::B3DHomMatrix& getOrientation() const { return maOrientation; }
 376             const basegfx::B3DHomMatrix& getProjection() const { return maProjection; }
 377             const basegfx::B3DHomMatrix& getDeviceToView() const { return maDeviceToView; }
 378             double getViewTime() const { return mfViewTime; }
 379
 380             const basegfx::B3DHomMatrix& getObjectToView() const
 381             {
 382                 // on demand WorldToView creation
 383
 384                 if(maObjectToView.isIdentity())
 385                 {
 386                     const_cast< ImpViewInformation3D* >(this)->maObjectToView = maDeviceToView * maProjection * maOrientation * maObjectTransformation;
 387                 }
 388
 389                 return maObjectToView;
 390             }
 391
 392             const uno::Sequence< beans::PropertyValue >& getViewInformationSequence() const
 393             {
 394                 if(!mxViewInformation.hasElements())
 395                 {
 396                     const_cast< ImpViewInformation3D* >(this)->impFillViewInformationFromContent();
 397                 }
 398
 399                 return mxViewInformation;
 400             }
 401
 402             const uno::Sequence< beans::PropertyValue >& getExtendedInformationSequence() const
 403             {
 404                 return mxExtendedInformation;
 405             }
 406
 407             bool operator==(const ImpViewInformation3D& rCandidate) const
 408             {
 409                 return (maObjectTransformation == rCandidate.maObjectTransformation
 410                     && maOrientation == rCandidate.maOrientation
 411                     && maProjection == rCandidate.maProjection
 412                     && maDeviceToView == rCandidate.maDeviceToView
 413                     && mfViewTime == rCandidate.mfViewTime
 414                     && mxExtendedInformation == rCandidate.mxExtendedInformation);
 415             }
 416         };
 417     } // end of anonymous namespace
 418 } // end of namespace drawinglayer
 419
 420
 421 namespace drawinglayer
 422 {
 423     namespace geometry
 424     {
 425         namespace
 426         {
 427             struct theGlobalDefault :
 428                 public rtl::Static< ViewInformation3D::ImplType, theGlobalDefault > {};
 429         }
 430
 431         ViewInformation3D::ViewInformation3D(
 432             const basegfx::B3DHomMatrix& rObjectObjectTransformation,
 433             const basegfx::B3DHomMatrix& rOrientation,
 434             const basegfx::B3DHomMatrix& rProjection,
 435             const basegfx::B3DHomMatrix& rDeviceToView,
 436             double fViewTime,
 437             const uno::Sequence< beans::PropertyValue >& rExtendedParameters)
 438         :   mpViewInformation3D(ImpViewInformation3D(
 439                 rObjectObjectTransformation, rOrientation, rProjection,
 440                 rDeviceToView, fViewTime, rExtendedParameters))
 441         {
 442         }
 443
 444         ViewInformation3D::ViewInformation3D(const uno::Sequence< beans::PropertyValue >& rViewParameters)
 445         :   mpViewInformation3D(ImpViewInformation3D(rViewParameters))
 446         {
 447         }
 448
 449         ViewInformation3D::ViewInformation3D()
 450         :   mpViewInformation3D(theGlobalDefault::get())
 451         {
 452         }
 453
 454         ViewInformation3D::ViewInformation3D(const ViewInformation3D& rCandidate)
 455         :   mpViewInformation3D(rCandidate.mpViewInformation3D)
 456         {
 457         }
 458
 459         ViewInformation3D::~ViewInformation3D()
 460         {
 461         }
 462
 463         bool ViewInformation3D::isDefault() const
 464         {
 465             return mpViewInformation3D.same_object(theGlobalDefault::get());
 466         }
 467
 468         ViewInformation3D& ViewInformation3D::operator=(const ViewInformation3D& rCandidate)
 469         {
 470             mpViewInformation3D = rCandidate.mpViewInformation3D;
 471             return *this;
 472         }
 473
 474         bool ViewInformation3D::operator==(const ViewInformation3D& rCandidate) const
 475         {
 476             return rCandidate.mpViewInformation3D == mpViewInformation3D;
 477         }
 478
 479         const basegfx::B3DHomMatrix& ViewInformation3D::getObjectTransformation() const
 480         {
 481             return mpViewInformation3D->getObjectTransformation();
 482         }
 483
 484         const basegfx::B3DHomMatrix& ViewInformation3D::getOrientation() const
 485         {
 486             return mpViewInformation3D->getOrientation();
 487         }
 488
 489         const basegfx::B3DHomMatrix& ViewInformation3D::getProjection() const
 490         {
 491             return mpViewInformation3D->getProjection();
 492         }
 493
 494         const basegfx::B3DHomMatrix& ViewInformation3D::getDeviceToView() const
 495         {
 496             return mpViewInformation3D->getDeviceToView();
 497         }
 498
 499         const basegfx::B3DHomMatrix& ViewInformation3D::getObjectToView() const
 500         {
 501             return mpViewInformation3D->getObjectToView();
 502         }
 503
 504         double ViewInformation3D::getViewTime() const
 505         {
 506             return mpViewInformation3D->getViewTime();
 507         }
 508
 509         const uno::Sequence< beans::PropertyValue >& ViewInformation3D::getViewInformationSequence() const
 510         {
 511             return mpViewInformation3D->getViewInformationSequence();
 512         }
 513
 514         const uno::Sequence< beans::PropertyValue >& ViewInformation3D::getExtendedInformationSequence() const
 515         {
 516             return mpViewInformation3D->getExtendedInformationSequence();
 517         }
 518     } // end of namespace geometry
 519 } // end of namespace drawinglayer
 520
 521 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */