CartoType C++ API 7.8.2, 2022-03-25
for Windows, Linux, Qt and other platforms supporting C++ development
Public Member Functions | Public Attributes | List of all members
CartoType::TPoint Class Reference

#include <cartotype_base.h>

Inheritance diagram for CartoType::TPoint:
CartoType::TOutlinePoint

Public Member Functions

constexpr TPoint () noexcept
 
constexpr TPoint (int32_t aX, int32_t aY) noexcept
 
constexpr bool operator== (const TPoint &aPoint) const noexcept
 
constexpr bool operator!= (const TPoint &aPoint) const noexcept
 
void operator+= (const TPoint &aPoint) noexcept
 
void operator-= (const TPoint &aPoint) noexcept
 
constexpr bool operator< (const TPoint &aPoint) const noexcept
 
constexpr bool operator> (const TPoint &aPoint) const noexcept
 
constexpr uint64_t ComparisonValue () const noexcept
 

Public Attributes

int32_t iX { 0 }
 
int32_t iY { 0 }
 

Detailed Description

A point in two-dimensional space.

Constructor & Destructor Documentation

◆ TPoint() [1/2]

constexpr CartoType::TPoint::TPoint ( )
inlineconstexprnoexcept

Create a point with coordinates (0,0).

◆ TPoint() [2/2]

constexpr CartoType::TPoint::TPoint ( int32_t  aX,
int32_t  aY 
)
inlineconstexprnoexcept

Create a point, specifying coordinates.

Member Function Documentation

◆ ComparisonValue()

constexpr uint64_t CartoType::TPoint::ComparisonValue ( ) const
inlineconstexprnoexcept

Return a single number which can be used to sort points into order.

◆ operator!=()

constexpr bool CartoType::TPoint::operator!= ( const TPoint aPoint) const
inlineconstexprnoexcept

The inequality operator.

◆ operator+=()

void CartoType::TPoint::operator+= ( const TPoint aPoint)
inlinenoexcept

Offset a point by another point, treated as a positive vector.

◆ operator-=()

void CartoType::TPoint::operator-= ( const TPoint aPoint)
inlinenoexcept

Offset a point by another point, treated as a negative vector.

◆ operator<()

constexpr bool CartoType::TPoint::operator< ( const TPoint aPoint) const
inlineconstexprnoexcept

The less-than operator, ordering points by x coordinate, then y coordinate.

◆ operator==()

constexpr bool CartoType::TPoint::operator== ( const TPoint aPoint) const
inlineconstexprnoexcept

The equality operator.

◆ operator>()

constexpr bool CartoType::TPoint::operator> ( const TPoint aPoint) const
inlineconstexprnoexcept

The greater-than operator, ordering points by x coordinate, then y coordinate.

Member Data Documentation

◆ iX

int32_t CartoType::TPoint::iX { 0 }

The x coordinate.

◆ iY

int32_t CartoType::TPoint::iY { 0 }

The y coordinate.


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