xref: /aoo4110/main/drawinglayer/inc/drawinglayer/primitive2d/wallpaperprimitive2d.hxx (revision b1cdbd2c)

/**************************************************************
 *
 * 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
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/



#ifndef INCLUDED_DRAWINGLAYER_PRIMITIVE2D_WALLPAPERPRIMITIVE2D_HXX
#define INCLUDED_DRAWINGLAYER_PRIMITIVE2D_WALLPAPERPRIMITIVE2D_HXX

#include <drawinglayer/drawinglayerdllapi.h>
#include <drawinglayer/primitive2d/primitivetools2d.hxx>
#include <vcl/bitmapex.hxx>
#include <vcl/wall.hxx>

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

namespace drawinglayer
{
	namespace primitive2d
	{
		/** WallpaperBitmapPrimitive2D class

			This is a specialized primtive for the Wallpaper definitions included in
			VCL and Metafiles. The extraordinary about the bitmap definition part of
			the Wallpaper is that it uses PIXEL size of the given Bitmap and not
			the logic and/or discrete size derived by PrefMapMode/PrefSize methods.
			To emulate this, a ViewTransformation dependent primitive is needed which
			takes over the correct scaling(s).

			Since a specialized primitive is needed anyways, i opted to also add the
			layouting which is dependent from WallpaperStyle; thus it does not need
			to be handled anywhere else in the future.
		 */
		class DRAWINGLAYER_DLLPUBLIC WallpaperBitmapPrimitive2D : public ViewTransformationDependentPrimitive2D
		{
		private:
			basegfx::B2DRange					maObjectRange;
			BitmapEx							maBitmapEx;
			WallpaperStyle						meWallpaperStyle;

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

		public:
            /// constructor
			WallpaperBitmapPrimitive2D(
				const basegfx::B2DRange& rObjectRange,
				const BitmapEx& rBitmapEx,
				WallpaperStyle eWallpaperStyle);

			/// data read access
			const basegfx::B2DRange& getLocalObjectRange() const { return maObjectRange; }
			const BitmapEx& getBitmapEx() const { return maBitmapEx ; }
			WallpaperStyle getWallpaperStyle() const { return meWallpaperStyle; }

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

			/// get B2Drange
			virtual basegfx::B2DRange getB2DRange(const geometry::ViewInformation2D& rViewInformation) const;

			/// provide unique ID
			DeclPrimitrive2DIDBlock()
		};
	} // end of namespace primitive2d
} // end of namespace drawinglayer

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

#endif // INCLUDED_DRAWINGLAYER_PRIMITIVE2D_WALLPAPERPRIMITIVE2D_HXX

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