CartoType C++ API 8.8-7-gb35e4dc71
for Windows, Linux, Qt and other platforms supporting C++ development
Public Member Functions | List of all members
CartoTypeCore::ClipRegion Class Reference

#include <cartotype_path.h>

Public Member Functions

 ClipRegion (const Rect &aRect)
 
 ClipRegion (const MPath &aPath)
 
const RectBounds () const noexcept
 
const OutlinePath () const noexcept
 
bool IsRect () const noexcept
 
bool IsEmpty () const noexcept
 
bool Contains (const Point &aPoint) const noexcept
 

Detailed Description

A clip region. This class enables optimisations: detemining whether the clip region is an axis-aligned rectangle, and getting the bounding box.

Constructor & Destructor Documentation

◆ ClipRegion() [1/2]

CartoTypeCore::ClipRegion::ClipRegion ( const Rect aRect)

Creates a clip region from an axis-aligned rectangle.

◆ ClipRegion() [2/2]

CartoTypeCore::ClipRegion::ClipRegion ( const MPath aPath)

Creates a clip region from a path in map units.

Member Function Documentation

◆ Bounds()

const Rect & CartoTypeCore::ClipRegion::Bounds ( ) const
inlinenoexcept

Returns the bounding box of this clip region.

◆ Contains()

bool CartoTypeCore::ClipRegion::Contains ( const Point aPoint) const
inlinenoexcept

Returns true if this clip region contains aPoint.

◆ IsEmpty()

bool CartoTypeCore::ClipRegion::IsEmpty ( ) const
inlinenoexcept

Returns true if this clip region is empty.

◆ IsRect()

bool CartoTypeCore::ClipRegion::IsRect ( ) const
inlinenoexcept

Returns true if this clip region is an axis-aligned rectangle.

◆ Path()

const Outline & CartoTypeCore::ClipRegion::Path ( ) const
inlinenoexcept

Returns the clip region as a path.


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