slideshow/source/engine/transitions/clippingfunctor.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_SLIDESHOW_SOURCE_ENGINE_TRANSITIONS_CLIPPINGFUNCTOR_HXX
  21 #define INCLUDED_SLIDESHOW_SOURCE_ENGINE_TRANSITIONS_CLIPPINGFUNCTOR_HXX
  22
  23 #include <basegfx/numeric/ftools.hxx>
  24 #include <basegfx/vector/b2dsize.hxx>
  25 #include <basegfx/matrix/b2dhommatrix.hxx>
  26 #include <basegfx/polygon/b2dpolypolygontools.hxx>
  27 #include <transitioninfo.hxx>
  28 #include <parametricpolypolygon.hxx>
  29
  30
  31 namespace slideshow
  32 {
  33     namespace internal
  34     {
  35         /** Generates the final clipping polygon.
  36
  37             This class serves as the functor, which generates the
  38             final clipping polygon from a given ParametricPolyPolygon
  39             and a TransitionInfo.
  40
  41             The ParametricPolyPolygon can be obtained from the
  42             ParametricPolyPolygonFactory, see there.
  43
  44             The TransitionInfo further parameterizes the polygon
  45             generated by the ParametricPolyPolygon, with common
  46             modifications such as rotation, flipping, or change of
  47             direction. This allows the ParametricPolyPolygonFactory to
  48             provide only prototypical shapes, with the ClippingFunctor
  49             further customizing the output.
  50          */
  51         class ClippingFunctor
  52         {
  53         public:
  54             ClippingFunctor(
  55                 const ParametricPolyPolygonSharedPtr&   rPolygon,
  56                 const TransitionInfo&                   rTransitionInfo,
  57                 bool                                    bDirectionForward,
  58                 bool                                    bModeIn );
  59
  60             /** Generate clip polygon.
  61
  62                 @param nValue
  63                 Value to generate the polygon for. Must be in the
  64                 range [0,1].
  65
  66                 @param rTargetSize
  67                 Size the clip polygon should cover. This is typically
  68                 the size of the object the effect is applied on.
  69              */
  70             ::basegfx::B2DPolyPolygon operator()( double                    nValue,
  71                                                   const ::basegfx::B2DSize& rTargetSize );
  72
  73         private:
  74             ParametricPolyPolygonSharedPtr     mpParametricPoly;
  75             ::basegfx::B2DHomMatrix            maStaticTransformation;
  76             // AW: Not needed
  77             // ::basegfx::B2DPolyPolygon          maBackgroundRect;
  78             bool                               mbForwardParameterSweep;
  79             bool                               mbSubtractPolygon;
  80             const bool                         mbScaleIsotrophically;
  81             bool                               mbFlip;
  82         };
  83
  84     }
  85 }
  86
  87 #endif // INCLUDED_SLIDESHOW_SOURCE_ENGINE_TRANSITIONS_CLIPPINGFUNCTOR_HXX
  88
  89 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */