/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef INCLUDED_DRAWINGLAYER_PRIMITIVE2D_GRIDPRIMITIVE2D_HXX
#define INCLUDED_DRAWINGLAYER_PRIMITIVE2D_GRIDPRIMITIVE2D_HXX

#include <drawinglayer/primitive2d/baseprimitive2d.hxx>
#include <basegfx/matrix/b2dhommatrix.hxx>
#include <basegfx/color/bcolor.hxx>
#include <vcl/bitmapex.hxx>

//////////////////////////////////////////////////////////////////////////////
// GridPrimitive2D class

namespace drawinglayer
{
	namespace primitive2d
	{
        /** GridPrimitive2D class

            This primitive is specialized to Grid visualisation. The graphic definition
            (Transform) contains the whole grid area, but will of course be combined
            with the visible area (Viewport) when decomposed. Also a reolution-dependent
            point reduction is used to not create too much grid visualisation data. This
            makes this primitive highly view-dependent and it dynamically buffers
            the last decomposition dependent from the Viewport used.
         */
		class GridPrimitive2D : 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 transparence) for grid cross points
			BitmapEx										maCrossMarker;

			/** the last used object to view transformtion and the last Viewport, 
                used from getDecomposition for decide buffering
             */
			basegfx::B2DHomMatrix							maLastObjectToViewTransformation;
			basegfx::B2DRange								maLastViewport;

		protected:
			/// create local decomposition
			virtual Primitive2DSequence create2DDecomposition(const geometry::ViewInformation2D& rViewInformation) const;

		public:
            /// constructor
			GridPrimitive2D(
				const basegfx::B2DHomMatrix& rTransform, 
				double fWidth,
				double fHeight,
				double fSmallestViewDistance,
				double fSmallestSubdivisionViewDistance,
				sal_uInt32 nSubdivisionsX,
				sal_uInt32 nSubdivisionsY,
				const basegfx::BColor& rBColor,
				const BitmapEx& 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 BitmapEx& getCrossMarker() const { return maCrossMarker; }

			/// compare operator
			virtual bool operator==(const BasePrimitive2D& rPrimitive) const;

			/// get 2d range
			virtual basegfx::B2DRange getB2DRange(const geometry::ViewInformation2D& rViewInformation) const;

			/// provide unique ID
			DeclPrimitrive2DIDBlock()

			/// Overload standard getDecomposition call to be view-dependent here
			virtual Primitive2DSequence get2DDecomposition(const geometry::ViewInformation2D& rViewInformation) const;
		};
	} // end of namespace primitive2d
} // end of namespace drawinglayer

//////////////////////////////////////////////////////////////////////////////

#endif //INCLUDED_DRAWINGLAYER_PRIMITIVE2D_GRIDPRIMITIVE2D_HXX

//////////////////////////////////////////////////////////////////////////////
// eof
