office-gobmx/canvas/inc/parametricpolypolygon.hxx

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

#pragma once

#include <com/sun/star/lang/XServiceInfo.hpp>
#include <com/sun/star/rendering/XParametricPolyPolygon2D.hpp>
#include <comphelper/compbase.hxx>
#include <basegfx/polygon/b2dpolygon.hxx>

#include <canvas/canvastoolsdllapi.h>
#include <rtl/ref.hxx>
#include <utility>

namespace com::sun::star::rendering { class XGraphicDevice; }


/* Definition of ParametricPolyPolygon class */

namespace canvas
{
    typedef comphelper::WeakComponentImplHelper< css::rendering::XParametricPolyPolygon2D,
                                           css::lang::XServiceInfo > ParametricPolyPolygon_Base;

    class CANVASTOOLS_DLLPUBLIC ParametricPolyPolygon final : public ParametricPolyPolygon_Base
    {
    public:
        enum class GradientType
        {
            Linear,
            Elliptical,
            Rectangular
        };

        /** Structure of defining values for the ParametricPolyPolygon

            This is used to copy the state of the
            ParametricPolyPolygon atomically.
         */
        struct Values
        {
            Values( ::basegfx::B2DPolygon                               aGradientPoly,
                    const css::uno::Sequence< css::uno::Sequence< double > >& rColors,
                    const css::uno::Sequence< double >&                 rStops,
                    double                                              nAspectRatio,
                    GradientType                                        eType ) :
                maGradientPoly(std::move( aGradientPoly )),
                mnAspectRatio( nAspectRatio ),
                maColors( rColors ),
                maStops( rStops ),
                meType( eType )
            {
            }

            /// Polygonal gradient shape (ignored for linear and axial gradient)
            const ::basegfx::B2DPolygon                         maGradientPoly;

            /// Aspect ratio of gradient, affects scaling of innermost gradient polygon
            const double                                        mnAspectRatio;

            /// Gradient colors
            const css::uno::Sequence< css::uno::Sequence< double > >   maColors;

            /// Gradient color stops
            const css::uno::Sequence< double >                  maStops;

            /// Type of gradient to render (as e.g. linear grads are not represented by maGradientPoly)
            const GradientType                                  meType;
        };

        static css::uno::Sequence< OUString > getAvailableServiceNames();
        static rtl::Reference<ParametricPolyPolygon> create(
            const css::uno::Reference< css::rendering::XGraphicDevice >& rDevice,
            std::u16string_view rServiceName,
            const css::uno::Sequence< css::uno::Any >& rArgs );

        /// Dispose all internal references
        virtual void disposing(std::unique_lock<std::mutex>&) override;

        // XParametricPolyPolygon2D
        virtual css::uno::Reference< css::rendering::XPolyPolygon2D > SAL_CALL getOutline( double t ) override;
        virtual css::uno::Sequence< double > SAL_CALL getColor( double t ) override;
        virtual css::uno::Sequence< double > SAL_CALL getPointColor( const css::geometry::RealPoint2D& point ) override;
        virtual css::uno::Reference< css::rendering::XColorSpace > SAL_CALL getColorSpace() override;

        // XServiceInfo
        virtual OUString SAL_CALL getImplementationName(  ) override;
        virtual sal_Bool SAL_CALL supportsService( const OUString& ServiceName ) override;
        virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames(  ) override;

        /// Query all defining values of this object atomically
        Values getValues() const;

    private:
        virtual ~ParametricPolyPolygon() override; // we're a ref-counted UNO class. _We_ destroy ourselves.
        ParametricPolyPolygon(const ParametricPolyPolygon&) = delete;
        ParametricPolyPolygon& operator=( const ParametricPolyPolygon& ) = delete;

        static rtl::Reference<ParametricPolyPolygon> createLinearHorizontalGradient( const css::uno::Reference<
                                                                         css::rendering::XGraphicDevice >& rDevice,
                                                                      const css::uno::Sequence< css::uno::Sequence< double > >& colors,
                                                                      const css::uno::Sequence< double >& stops );
        static rtl::Reference<ParametricPolyPolygon> createEllipticalGradient( const css::uno::Reference<
                                                                   css::rendering::XGraphicDevice >& rDevice,
                                                                const css::uno::Sequence< css::uno::Sequence< double > >& colors,
                                                                const css::uno::Sequence< double >& stops,
                                                                double fAspect );
        static rtl::Reference<ParametricPolyPolygon> createRectangularGradient( const css::uno::Reference<
                                                                    css::rendering::XGraphicDevice >& rDevice,
                                                                 const css::uno::Sequence< css::uno::Sequence< double > >& colors,
                                                                 const css::uno::Sequence< double >& stops,
                                                                 double fAspect );

        /// Private, because objects can only be created from the static factories
        ParametricPolyPolygon( css::uno::Reference<
                                   css::rendering::XGraphicDevice >             xDevice,
                               const ::basegfx::B2DPolygon&                     rGradientPoly,
                               GradientType                                     eType,
                               const css::uno::Sequence< css::uno::Sequence< double > >&  colors,
                               const css::uno::Sequence< double >&              stops,
                               double                                           nAspectRatio );
        ParametricPolyPolygon( css::uno::Reference<
                                   css::rendering::XGraphicDevice >             xDevice,
                               GradientType                                     eType,
                               const css::uno::Sequence< css::uno::Sequence< double > >&  colors,
                               const css::uno::Sequence< double >&              stops );

        css::uno::Reference<
            css::rendering::XGraphicDevice >    mxDevice;

        /// All defining values of this object
        const Values                                         maValues;
    };
}

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */