/* -*- 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 <drawinglayer/drawinglayerdllapi.h>

#include <drawinglayer/primitive2d/BufferedDecompositionPrimitive2D.hxx>

#include <basegfx/matrix/b2dhommatrix.hxx>

#include <basegfx/color/bcolor.hxx>

#include <vcl/bitmap.hxx>

// GridPrimitive2D class

namespace drawinglayer::primitive2d

{

        /** GridPrimitive2D class

            This primitive is specialized to grid visualization. The graphic definition

            (Transform) contains the whole grid area, but will of course be combined

            with the visible area (Viewport) when decomposed. Also a resolution-dependent

            point reduction is used to not create too much grid visualization data. This

            makes this primitive highly view-dependent and it dynamically buffers

            the last decomposition depending on the Viewport used.

         */

        class DRAWINGLAYER_DLLPUBLIC GridPrimitive2D final : public BufferedDecompositionPrimitive2D

        {

        private:

            /// The geometry definition for the grid area

            basegfx::B2DHomMatrix                           maTransform;

            /// grid layout definitions

            double                                          mfWidth;

            double                                          mfHeight;

            double                                          mfSmallestViewDistance;

            double                                          mfSmallestSubdivisionViewDistance;

            sal_uInt32                                      mnSubdivisionsX;

            sal_uInt32                                      mnSubdivisionsY;

            /// Grid color for single-pixel grid points

            basegfx::BColor                                 maBColor;

            /// The Bitmap (with transparency) for grid cross points

            Bitmap                                          maCrossMarker;

            /** the last used object to view transformation and the last Viewport,

                used from getDecomposition to decide buffering

             */

            basegfx::B2DHomMatrix                           maLastObjectToViewTransformation;

            basegfx::B2DRange                               maLastViewport;

            /// create local decomposition

            virtual Primitive2DReference create2DDecomposition(const geometry::ViewInformation2D& rViewInformation) const override;

        public:

            /// constructor

            GridPrimitive2D(

                basegfx::B2DHomMatrix aTransform,

                double fWidth,

                double fHeight,

                double fSmallestViewDistance,

                double fSmallestSubdivisionViewDistance,

                sal_uInt32 nSubdivisionsX,

                sal_uInt32 nSubdivisionsY,

                const basegfx::BColor& rBColor,

                const Bitmap& rCrossMarker);

            /// data read access

            const basegfx::B2DHomMatrix& getTransform() const { return maTransform; }

            double getWidth() const { return mfWidth; }

            double getHeight() const { return mfHeight; }

            double getSmallestViewDistance() const { return mfSmallestViewDistance; }

            double getSmallestSubdivisionViewDistance() const { return mfSmallestSubdivisionViewDistance; }

            sal_uInt32 getSubdivisionsX() const { return mnSubdivisionsX; }

            sal_uInt32 getSubdivisionsY() const { return mnSubdivisionsY; }

            const basegfx::BColor& getBColor() const { return maBColor; }

            const Bitmap& getCrossMarker() const { return maCrossMarker; }

            /// compare operator

            virtual bool operator==(const BasePrimitive2D& rPrimitive) const override;

            /// get 2d range

            virtual basegfx::B2DRange getB2DRange(const geometry::ViewInformation2D& rViewInformation) const override;

            /// provide unique ID

            virtual sal_uInt32 getPrimitive2DID() const override;

            /// Override standard getDecomposition to be view-dependent here

            virtual void get2DDecomposition(Primitive2DDecompositionVisitor& rVisitor, const geometry::ViewInformation2D& rViewInformation) const override;

        };

} // end of namespace drawinglayer::primitive2d

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