vcl::Region Class Reference

#include <region.hxx>

Public Member Functions
	Region (bool bIsNull=false)
	Region (const tools::Rectangle &rRect)
	Region (const tools::Polygon &rPolygon)
	Region (const tools::PolyPolygon &rPolyPoly)
	Region (const basegfx::B2DPolyPolygon &)
	Region (const vcl::Region &rRegion)
	Region (vcl::Region &&rRegion) noexcept
	~Region ()
const basegfx::B2DPolyPolygon *	getB2DPolyPolygon () const
const tools::PolyPolygon *	getPolyPolygon () const
const RegionBand *	getRegionBand () const
tools::PolyPolygon	GetAsPolyPolygon () const
basegfx::B2DPolyPolygon	GetAsB2DPolyPolygon () const
const RegionBand *	GetAsRegionBand () const
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
void	SetEmpty ()
void	SetNull ()
bool	IsRectangle () const
tools::Rectangle	GetBoundRect () const
bool	HasPolyPolygonOrB2DPolyPolygon () const
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) noexcept
vcl::Region &	operator= (const tools::Rectangle &rRect)
bool	operator== (const vcl::Region &rRegion) const
bool	operator!= (const vcl::Region &rRegion) const

Static Public Member Functions
static vcl::Region	GetRegionFromPolyPolygon (const tools::PolyPolygon &rPolyPoly)

Private Member Functions
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

Private Attributes
std::shared_ptr< basegfx::B2DPolyPolygon >	mpB2DPolyPolygon
std::shared_ptr< tools::PolyPolygon >	mpPolyPolygon
std::shared_ptr< RegionBand >	mpRegionBand
bool	mbIsNull: 1

Friends
class	::OutputDevice
class	::vcl::Window
class	::Bitmap
VCL_DLLPUBLIC SvStream &	ReadRegion (SvStream &rIStm, vcl::Region &rRegion)
VCL_DLLPUBLIC SvStream &	WriteRegion (SvStream &rOStm, const vcl::Region &rRegion)

Detailed Description

Definition at line 43 of file region.hxx.

Constructor & Destructor Documentation

vcl::Region::Region ( bool  bIsNull = false )

explicit

Definition at line 310 of file region.cxx.

vcl::Region::Region ( const tools::Rectangle &  rRect )

explicit

Definition at line 318 of file region.cxx.

References tools::Rectangle::IsEmpty(), and mpRegionBand.

vcl::Region::Region ( const tools::Polygon &  rPolygon )

explicit

Definition at line 327 of file region.cxx.

References tools::Polygon::GetSize(), and ImplCreatePolyPolyRegion().

vcl::Region::Region ( const tools::PolyPolygon &  rPolyPoly )

explicit

Definition at line 340 of file region.cxx.

References tools::PolyPolygon::Count(), and ImplCreatePolyPolyRegion().

vcl::Region::Region ( const basegfx::B2DPolyPolygon &  rPolyPoly )

explicit

Definition at line 353 of file region.cxx.

References basegfx::B2DPolyPolygon::count(), and ImplCreatePolyPolyRegion().

vcl::Region::Region ( const vcl::Region &  rRegion )

default

vcl::Region::Region ( vcl::Region &&  rRegion )

noexcept

Definition at line 368 of file region.cxx.

vcl::Region::~Region ( )

default

Member Function Documentation

void vcl::Region::Exclude

(

const tools::Rectangle &

rRegion

)

Definition at line 675 of file region.cxx.

References vcl::unotools::b2DRectangleFromRectangle(), tools::Rectangle::Bottom(), basegfx::B2DPolyPolygon::count(), basegfx::utils::createPolygonFromRect(), tools::Rectangle::IsEmpty(), tools::Rectangle::Left(), basegfx::utils::prepareForPolygonOperation(), tools::Rectangle::Right(), basegfx::utils::solvePolygonOperationDiff(), and tools::Rectangle::Top().

Referenced by ImplStdBorderWindowView::DrawWindow(), vcl::Window::ImplCalcOverlapRegion(), vcl::Window::ImplExcludeWindowRegion(), vcl::Window::ImplPosSizeWindow(), vcl::Window::ImplScroll(), and ImplBorderWindow::InvalidateBorder().

void vcl::Region::Exclude

(

const vcl::Region &

rRegion

)

Definition at line 1042 of file region.cxx.

References basegfx::B2DPolyPolygon::count(), GetAsB2DPolyPolygon(), getRegionBand(), HasPolyPolygonOrB2DPolyPolygon(), IsEmpty(), IsNull(), basegfx::utils::prepareForPolygonOperation(), and basegfx::utils::solvePolygonOperationDiff().

basegfx::B2DPolyPolygon vcl::Region::GetAsB2DPolyPolygon

(

)

const

Definition at line 1289 of file region.cxx.

Referenced by clipMetafileContentAgainstOwnRegions(), Exclude(), GDIMetaFile::GetChecksum(), Intersect(), SalGraphics::mirror(), operator==(), Union(), and XOr().

tools::PolyPolygon vcl::Region::GetAsPolyPolygon

(

)

const

Definition at line 1261 of file region.cxx.

Referenced by operator==(), GDIMetaFile::Rotate(), and vcl::WriteRegion().

const RegionBand * vcl::Region::GetAsRegionBand

(

)

const

Definition at line 1317 of file region.cxx.

References vcl::ImplCreateRegionBandFromPolyPolygon().

const basegfx::B2DPolyPolygon* vcl::Region::getB2DPolyPolygon ( ) const

inline

Definition at line 79 of file region.hxx.

Referenced by Intersect(), OutputDevice::LogicToPixel(), operator<<(), operator==(), OutputDevice::PixelToLogic(), and vcl::WriteRegion().

tools::Rectangle vcl::Region::GetBoundRect

(

)

const

Definition at line 1214 of file region.cxx.

References basegfx::fround(), basegfx::B2DRange::getMaxX(), basegfx::B2DRange::getMaxY(), basegfx::B2DRange::getMinX(), basegfx::B2DRange::getMinY(), basegfx::utils::getRange(), and basegfx::B2DRange::isEmpty().

Referenced by vcl::Window::ClipToPaintRegion(), GDIMetaFile::GetBoundRect(), ToolBox::ImplDrawConstantBackground(), Edit::ImplPaintBorder(), vcl::Window::Invalidate(), ScrollBar::PreNotify(), vcl::Window::PushPaintHelper(), vcl::Window::Show(), and MetafileXmlDump::writeXml().

const tools::PolyPolygon* vcl::Region::getPolyPolygon ( ) const

inline

Definition at line 80 of file region.hxx.

Referenced by Intersect(), OutputDevice::LogicToPixel(), operator<<(), operator==(), OutputDevice::PixelToLogic(), and vcl::WriteRegion().

const RegionBand* vcl::Region::getRegionBand ( ) const

inline

Definition at line 81 of file region.hxx.

Referenced by Exclude(), Intersect(), OutputDevice::LogicToPixel(), operator<<(), operator==(), OutputDevice::PixelToLogic(), Union(), vcl::WriteRegion(), and XOr().

vcl::Region vcl::Region::GetRegionFromPolyPolygon ( const tools::PolyPolygon &  rPolyPoly )

static

Definition at line 1727 of file region.cxx.

References tools::PolyPolygon::Count(), i, vcl::ImplPolygonRectTest(), and XOr().

void vcl::Region::GetRegionRectangles

(

RectangleVector &

rTarget

)

const

Definition at line 1659 of file region.cxx.

References RegionBand::GetRegionRectangles().

Referenced by Printer::DrawDeviceMask(), OutputDevice::ImplPrintTransparent(), vcl::Window::ImplSysObjClip(), OutputDevice::LogicToPixel(), SalGraphics::mirror(), operator<<(), OutputDevice::PixelToLogic(), and OutputDevice::ReMirror().

bool vcl::Region::HasPolyPolygonOrB2DPolyPolygon ( ) const

inline

Definition at line 110 of file region.hxx.

Referenced by Exclude(), GDIMetaFile::GetChecksum(), Intersect(), SalGraphics::mirror(), GDIMetaFile::Rotate(), Union(), vcl::WriteRegion(), and XOr().

basegfx::B2DPolyPolygon vcl::Region::ImplCreateB2DPolyPolygonFromRegionBand ( ) const

private

Definition at line 303 of file region.cxx.

References tools::PolyPolygon::getB2DPolyPolygon().

tools::PolyPolygon vcl::Region::ImplCreatePolyPolygonFromRegionBand ( ) const

private

Definition at line 281 of file region.cxx.

References tools::PolyPolygon::Insert(), and rectangle().

void vcl::Region::ImplCreatePolyPolyRegion ( const tools::PolyPolygon &  rPolyPoly )

private

Definition at line 379 of file region.cxx.

References tools::PolyPolygon::Count(), tools::PolyPolygon::GetBoundRect(), and tools::PolyPolygon::IsRect().

Referenced by Region().

void vcl::Region::ImplCreatePolyPolyRegion ( const basegfx::B2DPolyPolygon &  rPolyPoly )

private

Definition at line 405 of file region.cxx.

References basegfx::B2DPolyPolygon::count(), basegfx::B2DPolyPolygon::getB2DRange(), and basegfx::B2DRange::isEmpty().

void vcl::Region::Intersect

(

const tools::Rectangle &

rRegion

)

Definition at line 584 of file region.cxx.

References tools::Rectangle::Bottom(), tools::PolyPolygon::Clip(), basegfx::utils::clipPolyPolygonOnRange(), tools::PolyPolygon::Count(), tools::Rectangle::IsEmpty(), tools::Rectangle::Left(), tools::Rectangle::Right(), and tools::Rectangle::Top().

Referenced by GDIMetaFile::Clip(), OutputDevice::ClipToDeviceBounds(), PaintHelper::DoPaint(), OutputDevice::DrawText(), vcl::Window::ExpandPaintClipRegion(), vcl::Window::GetActiveClipRegion(), vcl::Window::ImplCalcOverlapRegion(), vcl::Window::ImplClipBoundaries(), SVMConverter::ImplConvertFromSVM1(), ToolBox::ImplDrawBackground(), vcl::Window::ImplExcludeWindowRegion(), vcl::Window::ImplIntersectWindowClipRegion(), vcl::Window::ImplIntersectWindowRegion(), vcl::Window::ImplInvalidate(), vcl::Window::ImplMoveInvalidateRegion(), vcl::Window::ImplPaintToDevice(), vcl::Window::ImplPosSizeWindow(), Edit::ImplRepaint(), vcl::Window::ImplScroll(), vcl::Window::ImplSysObjClip(), vcl::Window::InitClipRegion(), Intersect(), OutputDevice::IntersectClipRegion(), IsOver(), lcl_canPaint(), and vcl::Window::SaveBackground().

void vcl::Region::Intersect

(

const vcl::Region &

rRegion

)

Definition at line 923 of file region.cxx.

References basegfx::utils::clipPolyPolygonOnPolyPolygon(), basegfx::B2DPolyPolygon::count(), GetAsB2DPolyPolygon(), getB2DPolyPolygon(), getPolyPolygon(), RegionBand::getRectangleCount(), getRegionBand(), HasPolyPolygonOrB2DPolyPolygon(), Intersect(), IsEmpty(), and IsNull().

bool vcl::Region::IsEmpty

(

)

const

Definition at line 228 of file region.cxx.

Referenced by clipMetafileContentAgainstOwnRegions(), PaintHelper::DoPaint(), Exclude(), vcl::Window::ExpandPaintClipRegion(), vcl::Window::ImplCalcToTop(), vcl::Window::ImplClipBoundaries(), vcl::Window::ImplInvalidate(), vcl::Window::ImplInvalidateOverlapFrameRegion(), vcl::Window::ImplMoveAllInvalidateRegions(), vcl::Window::ImplPosSizeWindow(), Edit::ImplRepaint(), vcl::Window::ImplScroll(), vcl::Window::ImplSysObjClip(), vcl::Window::ImplValidate(), OutputDevice::InitClipRegion(), vcl::Window::InitClipRegion(), Intersect(), vcl::Window::Invalidate(), IsOver(), OutputDevice::LogicToPixel(), operator<<(), operator==(), OutputDevice::PixelToLogic(), vcl::PDFWriterImpl::playMetafile(), TabControl::PreNotify(), vcl::Window::SaveBackground(), vcl::Window::SetWindowRegionPixel(), vcl::Window::Show(), Union(), vcl::WriteRegion(), and XOr().

bool vcl::Region::IsInside

(

const Point &

rPoint

)

const

Definition at line 1336 of file region.cxx.

References RegionBand::IsInside().

bool vcl::Region::IsNull ( ) const

inline

Definition at line 102 of file region.hxx.

Referenced by vcl::Window::ClipToPaintRegion(), ImplAnimView::draw(), OutputDevice::DrawText(), ImplAnimView::drawToPos(), Exclude(), Edit::ImplPaintBorder(), Intersect(), OutputDevice::IntersectClipRegion(), vcl::Window::Invalidate(), OutputDevice::LogicToPixel(), operator==(), OutputDevice::PixelToLogic(), OutputDevice::SetClipRegion(), vcl::Window::SetWindowRegionPixel(), Union(), vcl::WriteRegion(), and XOr().

bool vcl::Region::IsOver

(

const tools::Rectangle &

rRect

)

const

Definition at line 1367 of file region.cxx.

References Intersect(), and IsEmpty().

Referenced by OutputDevice::DrawText().

bool vcl::Region::IsRectangle

(

)

const

Definition at line 1391 of file region.cxx.

References basegfx::utils::isRectangle().

void vcl::Region::Move	(	long	nHorzMove,
		long	nVertMove
	)

Definition at line 414 of file region.cxx.

References basegfx::B2DPolyPolygon::count(), tools::PolyPolygon::Count(), basegfx::utils::createTranslateB2DHomMatrix(), tools::PolyPolygon::Move(), RegionBand::Move(), and basegfx::B2DPolyPolygon::transform().

Referenced by vcl::Window::GetActiveClipRegion(), vcl::Window::GetPaintRegion(), vcl::Window::GetWindowClipRegionPixel(), vcl::Window::ImplMoveAllInvalidateRegions(), vcl::Window::ImplMoveInvalidateRegion(), Edit::ImplPaintBorder(), OutputDevice::ImplPixelToDevicePixel(), vcl::Window::ImplScroll(), vcl::Window::ImplSysObjClip(), Slider::ImplUpdateRects(), MetaClipRegionAction::Move(), MetaISectRegionClipRegionAction::Move(), OutputDevice::MoveClipRegion(), and vcl::Window::SaveBackground().

bool vcl::Region::operator!= ( const vcl::Region &  rRegion ) const

inline

Definition at line 121 of file region.hxx.

References operator==().

Region & vcl::Region::operator= ( const vcl::Region &  rRegion )

default

Region & vcl::Region::operator= ( vcl::Region &&  rRegion )

noexcept

Definition at line 1428 of file region.cxx.

Region & vcl::Region::operator=

(

const tools::Rectangle &

rRect

)

Definition at line 1439 of file region.cxx.

References tools::Rectangle::IsEmpty().

bool vcl::Region::operator==

(

const vcl::Region &

rRegion

)

const

Definition at line 1449 of file region.cxx.

References GetAsB2DPolyPolygon(), GetAsPolyPolygon(), getB2DPolyPolygon(), getPolyPolygon(), getRegionBand(), IsEmpty(), and IsNull().

Referenced by operator!=().

void vcl::Region::Scale	(	double	fScaleX,
		double	fScaleY
	)

Definition at line 461 of file region.cxx.

References basegfx::B2DPolyPolygon::count(), tools::PolyPolygon::Count(), basegfx::utils::createScaleB2DHomMatrix(), basegfx::fTools::equalZero(), tools::PolyPolygon::Scale(), RegionBand::Scale(), and basegfx::B2DPolyPolygon::transform().

Referenced by MetaClipRegionAction::Scale(), and MetaISectRegionClipRegionAction::Scale().

void vcl::Region::SetEmpty

(

)

Definition at line 1417 of file region.cxx.

Referenced by vcl::Window::ImplMoveAllInvalidateRegions(), SalGraphics::mirror(), vcl::ReadRegion(), and OpenGLContext::reset().

void vcl::Region::SetNull

(

)

Definition at line 1408 of file region.cxx.

Referenced by vcl::Window::GetWindowClipRegionPixel(), and vcl::ReadRegion().

void vcl::Region::Union

(

const tools::Rectangle &

rRegion

)

Definition at line 508 of file region.cxx.

References vcl::unotools::b2DRectangleFromRectangle(), tools::Rectangle::Bottom(), basegfx::B2DPolyPolygon::count(), basegfx::utils::createPolygonFromRect(), tools::Rectangle::IsEmpty(), tools::Rectangle::Left(), basegfx::utils::prepareForPolygonOperation(), tools::Rectangle::Right(), basegfx::utils::solvePolygonOperationOr(), and tools::Rectangle::Top().

Referenced by Bitmap::CreateRegion(), PaintHelper::DoPaint(), vcl::Window::ImplCalcOverlapRegion(), vcl::Window::ImplIntersectAndUnionOverlapWindows(), vcl::Window::ImplIntersectAndUnionOverlapWindows2(), vcl::Window::ImplMoveAllInvalidateRegions(), Edit::ImplRepaint(), vcl::Window::ImplScroll(), Slider::ImplUpdateRects(), OutputDevice::LogicToPixel(), SalGraphics::mirror(), OutputDevice::PixelToLogic(), ScrollBar::PreNotify(), TabControl::PreNotify(), and OutputDevice::ReMirror().

void vcl::Region::Union

(

const vcl::Region &

rRegion

)

Definition at line 837 of file region.cxx.

References basegfx::B2DPolyPolygon::count(), GetAsB2DPolyPolygon(), getRegionBand(), HasPolyPolygonOrB2DPolyPolygon(), IsEmpty(), IsNull(), basegfx::utils::prepareForPolygonOperation(), and basegfx::utils::solvePolygonOperationOr().

void vcl::Region::XOr

(

const tools::Rectangle &

rRegion

)

Definition at line 754 of file region.cxx.

References vcl::unotools::b2DRectangleFromRectangle(), tools::Rectangle::Bottom(), basegfx::B2DPolyPolygon::count(), basegfx::utils::createPolygonFromRect(), tools::Rectangle::IsEmpty(), tools::Rectangle::Left(), basegfx::utils::prepareForPolygonOperation(), tools::Rectangle::Right(), basegfx::utils::solvePolygonOperationXor(), and tools::Rectangle::Top().

Referenced by GetRegionFromPolyPolygon().

bool vcl::Region::XOr

(

const vcl::Region &

rRegion

)

Definition at line 1125 of file region.cxx.

References basegfx::B2DPolyPolygon::count(), GetAsB2DPolyPolygon(), getRegionBand(), HasPolyPolygonOrB2DPolyPolygon(), IsEmpty(), IsNull(), basegfx::utils::prepareForPolygonOperation(), and basegfx::utils::solvePolygonOperationXor().

Friends And Related Function Documentation

friend class ::Bitmap

friend

Definition at line 48 of file region.hxx.

friend class ::OutputDevice

friend

Definition at line 46 of file region.hxx.

friend class ::vcl::Window

friend

Definition at line 47 of file region.hxx.

VCL_DLLPUBLIC SvStream& ReadRegion ( SvStream &  rIStm, vcl::Region &  rRegion  )

friend

Definition at line 1523 of file region.cxx.

VCL_DLLPUBLIC SvStream& WriteRegion ( SvStream &  rOStm, const vcl::Region &  rRegion  )

friend

Definition at line 1587 of file region.cxx.

Member Data Documentation

bool vcl::Region::mbIsNull

private

Definition at line 58 of file region.hxx.

std::shared_ptr< basegfx::B2DPolyPolygon > vcl::Region::mpB2DPolyPolygon

private

Definition at line 52 of file region.hxx.

std::shared_ptr< tools::PolyPolygon > vcl::Region::mpPolyPolygon

private

Definition at line 54 of file region.hxx.

Referenced by vcl::ReadRegion().

std::shared_ptr< RegionBand > vcl::Region::mpRegionBand

private

Definition at line 56 of file region.hxx.

Referenced by vcl::ReadRegion(), and Region().

---

The documentation for this class was generated from the following files:

• region.hxx
• region.cxx