include/drawinglayer/primitive2d/transformprimitive2d.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_DRAWINGLAYER_PRIMITIVE2D_TRANSFORMPRIMITIVE2D_HXX
  21 #define INCLUDED_DRAWINGLAYER_PRIMITIVE2D_TRANSFORMPRIMITIVE2D_HXX
  22
  23 #include <drawinglayer/drawinglayerdllapi.h>
  24
  25 #include <drawinglayer/primitive2d/groupprimitive2d.hxx>
  26 #include <basegfx/matrix/b2dhommatrix.hxx>
  27
  28
  29 namespace drawinglayer
  30 {
  31     namespace primitive2d
  32     {
  33         /** TransformPrimitive2D class
  34
  35             This is one of the basic grouping primitives and it provides
  36             embedding a sequence of primitives (a geometry) into a
  37             transformation. All renderers have to handle this, usually by
  38             building a current transformation stack (linear combination)
  39             and applying this to all to-be-rendered geometry. If not handling
  40             this, the output will be mostly wrong since this primitive is
  41             widely used.
  42
  43             It does transform by embedding an existing geometry into a
  44             transformation as Child-content. This allows re-usage of the
  45             refcounted Uno-Api primitives and their existing, buffered
  46             decompositions.
  47
  48             It could e.g. be used to show a single object geometry in 1000
  49             different, transformed states without the need to create those
  50             thousand primitive contents.
  51          */
  52         class DRAWINGLAYER_DLLPUBLIC TransformPrimitive2D : public GroupPrimitive2D
  53         {
  54         private:
  55             // the transformation to apply to the child geometry
  56             basegfx::B2DHomMatrix                   maTransformation;
  57
  58         public:
  59             /// constructor
  60             TransformPrimitive2D(
  61                 const basegfx::B2DHomMatrix& rTransformation,
  62                 const Primitive2DContainer& rChildren);
  63
  64             /// data read access
  65             const basegfx::B2DHomMatrix& getTransformation() const { return maTransformation; }
  66
  67             /// compare operator
  68             virtual bool operator==(const BasePrimitive2D& rPrimitive) const override;
  69
  70             /// get range
  71             virtual basegfx::B2DRange getB2DRange(const geometry::ViewInformation2D& rViewInformation) const override;
  72
  73             /// provide unique ID
  74             DeclPrimitive2DIDBlock()
  75         };
  76     } // end of namespace primitive2d
  77 } // end of namespace drawinglayer
  78
  79
  80 #endif //INCLUDED_DRAWINGLAYER_PRIMITIVE2D_TRANSFORMPRIMITIVE2D_HXX
  81
  82 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */