Zivid::PointXY Struct Reference

Point with two coordinates as float. More...

#include <Zivid/Point.h>

Public Types
using	ValueType = float
	The type of the coordinate values.

Public Member Functions
	PointXY ()=default
	Constructor.
constexpr	PointXY (float xCoord, float yCoord)
	Constructor.
bool	isNaN () const
	Check if the point is Not-a-Number (invalid)
ZIVID_CORE_EXPORT std::string	toString () const
	Get string representation.
ZIVID_CORE_EXPORT bool	operator== (const PointXY &rhs) const
	Check for equality.
ZIVID_CORE_EXPORT bool	operator!= (const PointXY &rhs) const
	Check for inequality.

Public Attributes
ValueType	x
	The x element of the point.
ValueType	y
	The y element of the point.

Detailed Description

Point with two coordinates as float.

Member Typedef Documentation

ValueType

using Zivid::PointXY::ValueType = float

The type of the coordinate values.

Constructor & Destructor Documentation

PointXY() [1/2]

Zivid::PointXY::PointXY ( )

default

Constructor.

PointXY() [2/2]

Zivid::PointXY::PointXY ( float xCoord, float yCoord )

inlineconstexpr

Constructor.

Member Function Documentation

isNaN()

bool Zivid::PointXY::isNaN ( ) const

inline

Check if the point is Not-a-Number (invalid)

A point is defined as NaN if the y-coordinate is NaN

operator!=()

ZIVID_CORE_EXPORT bool Zivid::PointXY::operator!=

(

const PointXY &

rhs

)

const

Check for inequality.

operator==()

ZIVID_CORE_EXPORT bool Zivid::PointXY::operator==

(

const PointXY &

rhs

)

const

Check for equality.

toString()

ZIVID_CORE_EXPORT std::string Zivid::PointXY::toString

(

)

const

Get string representation.

Member Data Documentation

x

ValueType Zivid::PointXY::x

The x element of the point.

y

ValueType Zivid::PointXY::y

The y element of the point.

---

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

• Zivid/Point.h