slideshow/source/engine/transitions/clippingfunctor.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: clippingfunctor.hxx,v $
  10  * $Revision: 1.6 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #if ! defined INCLUDED_SLIDESHOW_CLIPPINGFUNCTOR_HXX
  32 #define INCLUDED_SLIDESHOW_CLIPPINGFUNCTOR_HXX
  33
  34 #include <basegfx/numeric/ftools.hxx>
  35 #include <basegfx/vector/b2dsize.hxx>
  36 #include <basegfx/matrix/b2dhommatrix.hxx>
  37 #include <basegfx/polygon/b2dpolypolygontools.hxx>
  38 #include <transitioninfo.hxx>
  39 #include <parametricpolypolygon.hxx>
  40
  41
  42 namespace slideshow
  43 {
  44     namespace internal
  45     {
  46         /** Generates the final clipping polygon.
  47
  48             This class serves as the functor, which generates the
  49             final clipping polygon from a given ParametricPolyPolygon
  50             and a TransitionInfo.
  51
  52             The ParametricPolyPolygon can be obtained from the
  53             ParametricPolyPolygonFactory, see there.
  54
  55             The TransitionInfo further parameterizes the polygon
  56             generated by the ParametricPolyPolygon, with common
  57             modifications such as rotation, flipping, or change of
  58             direction. This allows the ParametricPolyPolygonFactory to
  59             provide only prototypical shapes, with the ClippingFunctor
  60             further customizing the output.
  61          */
  62         class ClippingFunctor
  63         {
  64         public:
  65             ClippingFunctor(
  66                 const ParametricPolyPolygonSharedPtr&   rPolygon,
  67                 const TransitionInfo&                   rTransitionInfo,
  68                 bool                                    bDirectionForward,
  69                 bool                                    bModeIn );
  70
  71             /** Generate clip polygon.
  72
  73                 @param nValue
  74                 Value to generate the polygon for. Must be in the
  75                 range [0,1].
  76
  77                 @param rTargetSize
  78                 Size the clip polygon should cover. This is typically
  79                 the size of the object the effect is applied on.
  80              */
  81             ::basegfx::B2DPolyPolygon operator()( double                                        nValue,
  82                                                   const ::basegfx::B2DSize& rTargetSize );
  83
  84         private:
  85             ParametricPolyPolygonSharedPtr     mpParametricPoly;
  86             ::basegfx::B2DHomMatrix            maStaticTransformation;
  87             // AW: Not needed
  88             // ::basegfx::B2DPolyPolygon          maBackgroundRect;
  89             bool                               mbForwardParameterSweep;
  90             bool                               mbSubtractPolygon;
  91             const bool                         mbScaleIsotrophically;
  92             bool                               mbFlip;
  93         };
  94
  95     }
  96 }
  97
  98 #endif /* INCLUDED_SLIDESHOW_CLIPPINGFUNCTOR_HXX */