include/basegfx/polygon/WaveLine.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  */
  10
  11 #pragma once
  12
  13 #include <basegfx/basegfxdllapi.h>
  14 #include <basegfx/polygon/b2dpolygon.hxx>
  15 #include <basegfx/range/b2drectangle.hxx>
  16
  17 namespace basegfx
  18 {
  19 // Creates a polygon of a wave line in the input rectangle.
  20 //
  21 // The polygon is created with points at the center of the rectangle,
  22 // and the quadratic control points at the upper and lower side. See
  23 // the diagram below.
  24 //
  25 // *----Q---------------Q------------*
  26 // |                                 |
  27 // |P-------P-------P-------P-------P|
  28 // |                                 |
  29 // *------------Q---------------Q----*
  30 //
  31 // P is the point
  32 // Q is the quadratic bezier control point
  33 //
  34 BASEGFX_DLLPUBLIC B2DPolygon createWaveLinePolygon(basegfx::B2DRectangle const& rRectangle);
  35
  36 } // end of namespace basegfx
  37
  38 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */