office-gobmx/include/vcl/region.hxx
Noel Grandin bd28564be8 loplugin:returnconstant in vcl
Change-Id: I597ef6d75d1c21cdc15a91bf7f549bc14c851506
Reviewed-on: https://gerrit.libreoffice.org/58086
Tested-by: Jenkins
Reviewed-by: Noel Grandin <noel.grandin@collabora.co.uk>
2018-07-27 11:42:27 +02:00

169 lines
6.1 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_VCL_REGION_HXX
#define INCLUDED_VCL_REGION_HXX
#include <tools/gen.hxx>
#include <vcl/dllapi.h>
#include <basegfx/polygon/b2dpolypolygon.hxx>
#include <memory>
class ImplRegionBand;
class RegionBand;
namespace tools {
class Polygon;
class PolyPolygon;
}
namespace vcl { class Window; }
class OutputDevice;
class Bitmap;
typedef std::vector< tools::Rectangle > RectangleVector;
namespace vcl {
class VCL_DLLPUBLIC Region
{
private:
friend class ::OutputDevice;
friend class ::vcl::Window;
friend class ::Bitmap;
// possible contents
std::shared_ptr< basegfx::B2DPolyPolygon >
mpB2DPolyPolygon;
std::shared_ptr< tools::PolyPolygon >
mpPolyPolygon;
std::shared_ptr< RegionBand >
mpRegionBand;
bool mbIsNull : 1;
// helpers
SAL_DLLPRIVATE void ImplCreatePolyPolyRegion( const tools::PolyPolygon& rPolyPoly );
SAL_DLLPRIVATE void ImplCreatePolyPolyRegion( const basegfx::B2DPolyPolygon& rPolyPoly );
SAL_DLLPRIVATE tools::PolyPolygon ImplCreatePolyPolygonFromRegionBand() const;
SAL_DLLPRIVATE basegfx::B2DPolyPolygon ImplCreateB2DPolyPolygonFromRegionBand() const;
public:
explicit Region(bool bIsNull = false); // default creates empty region, with true a null region is created
explicit Region(const tools::Rectangle& rRect);
explicit Region(const tools::Polygon& rPolygon);
explicit Region(const tools::PolyPolygon& rPolyPoly);
explicit Region(const basegfx::B2DPolyPolygon&);
Region(const vcl::Region& rRegion);
Region(vcl::Region&& rRegion);
~Region();
// direct access to contents
const basegfx::B2DPolyPolygon* getB2DPolyPolygon() const { return mpB2DPolyPolygon.get(); }
const tools::PolyPolygon* getPolyPolygon() const { return mpPolyPolygon.get(); }
const RegionBand* getRegionBand() const { return mpRegionBand.get(); }
// access with converters, the asked data will be created from the most
// valuable data, buffered and returned
const tools::PolyPolygon GetAsPolyPolygon() const;
const basegfx::B2DPolyPolygon GetAsB2DPolyPolygon() const;
const RegionBand* GetAsRegionBand() const;
// manipulators
void Move( long nHorzMove, long nVertMove );
void Scale( double fScaleX, double fScaleY );
void Union( const tools::Rectangle& rRegion );
void Intersect( const tools::Rectangle& rRegion );
void Exclude( const tools::Rectangle& rRegion );
void XOr( const tools::Rectangle& rRegion );
void Union( const vcl::Region& rRegion );
void Intersect( const vcl::Region& rRegion );
void Exclude( const vcl::Region& rRegion );
bool XOr( const vcl::Region& rRegion );
bool IsEmpty() const;
bool IsNull() const { return mbIsNull;}
void SetEmpty();
void SetNull();
bool IsRectangle() const;
tools::Rectangle GetBoundRect() const;
bool HasPolyPolygonOrB2DPolyPolygon() const { return (getB2DPolyPolygon() || getPolyPolygon()); }
void GetRegionRectangles(RectangleVector& rTarget) const;
bool IsInside( const Point& rPoint ) const;
bool IsOver( const tools::Rectangle& rRect ) const;
vcl::Region& operator=( const vcl::Region& rRegion );
vcl::Region& operator=( vcl::Region&& rRegion );
vcl::Region& operator=( const tools::Rectangle& rRect );
bool operator==( const vcl::Region& rRegion ) const;
bool operator!=( const vcl::Region& rRegion ) const { return !(Region::operator==( rRegion )); }
friend VCL_DLLPUBLIC SvStream& ReadRegion( SvStream& rIStm, vcl::Region& rRegion );
friend VCL_DLLPUBLIC SvStream& WriteRegion( SvStream& rOStm, const vcl::Region& rRegion );
/* workaround: faster conversion for PolyPolygons
* if half of the Polygons contained in rPolyPoly are actually
* rectangles, then the returned vcl::Region will be constructed by
* XOr'ing the contained Polygons together; in the case of
* only Rectangles this can be up to eight times faster than
* Region( const tools::PolyPolygon& ).
* Caution: this is only useful if the vcl::Region is known to be
* changed to rectangles; e.g. if being set as clip region
*/
static vcl::Region GetRegionFromPolyPolygon( const tools::PolyPolygon& rPolyPoly );
};
} /* namespace vcl */
template< typename charT, typename traits >
inline std::basic_ostream<charT, traits> & operator <<(
std::basic_ostream<charT, traits> & stream, const vcl::Region& rRegion)
{
if (rRegion.IsEmpty())
return stream << "EMPTY";
if (rRegion.getB2DPolyPolygon())
return stream << "B2DPolyPolygon("
<< *rRegion.getB2DPolyPolygon()
<< ")";
if (rRegion.getPolyPolygon())
return stream << "unimplemented";
if (rRegion.getRegionBand())
{ // inlined because RegionBand is private to vcl
stream << "RegionBand(";
RectangleVector rects;
rRegion.GetRegionRectangles(rects);
if (rects.empty())
stream << "EMPTY";
for (size_t i = 0; i < rects.size(); ++i)
stream << "[" << i << "] " << rects[i];
stream << ")";
}
return stream;
}
#endif // INCLUDED_VCL_REGION_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */