office-gobmx/include/drawinglayer/primitive2d/maskprimitive2d.hxx
Tor Lillqvist 3f0678bfc8 Some spelling corrections
Change-Id: Ie77596a51a6a37e9f59a6ba14bdde7994efd29ad
2014-05-29 14:29:43 +03:00

79 lines
2.9 KiB
C++

/* -*- 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 .
*/
#ifndef INCLUDED_DRAWINGLAYER_PRIMITIVE2D_MASKPRIMITIVE2D_HXX
#define INCLUDED_DRAWINGLAYER_PRIMITIVE2D_MASKPRIMITIVE2D_HXX
#include <drawinglayer/drawinglayerdllapi.h>
#include <drawinglayer/primitive2d/groupprimitive2d.hxx>
#include <basegfx/polygon/b2dpolypolygon.hxx>
namespace drawinglayer
{
namespace primitive2d
{
/** MaskPrimitive2D class
This is the central masking primitive. It's a grouping
primitive and contains a PolyPolygon which defines the visible
area. Only visualisation parts of the Child primitive sequence
inside of the mask PolyPolygon is defined to be visible.
This primitive should be handled by a renderer. If it is not handled,
it decomposes to its Child content, and thus the visualisation would
contaiun no clips.
The geometrc range of this primitive is completely defined by the Mask
PolyPolygon since by definition nothing outside of the mask is visible.
*/
class DRAWINGLAYER_DLLPUBLIC MaskPrimitive2D : public GroupPrimitive2D
{
private:
/// the mask PolyPolygon
basegfx::B2DPolyPolygon maMask;
public:
/// constructor
MaskPrimitive2D(
const basegfx::B2DPolyPolygon& rMask,
const Primitive2DSequence& rChildren);
/// data read access
const basegfx::B2DPolyPolygon& getMask() const { return maMask; }
/// compare operator
virtual bool operator==(const BasePrimitive2D& rPrimitive) const SAL_OVERRIDE;
/// get range
virtual basegfx::B2DRange getB2DRange(const geometry::ViewInformation2D& rViewInformation) const SAL_OVERRIDE;
/// provide unique ID
DeclPrimitive2DIDBlock()
};
} // end of namespace primitive2d
} // end of namespace drawinglayer
#endif //INCLUDED_DRAWINGLAYER_PRIMITIVE2D_MASKPRIMITIVE2D_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */