Zivid::PointXYZW Struct Reference

Point with four coordinates as float. More...

#include <Zivid/Point.h>

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

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

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

Detailed Description

Point with four coordinates as float.

Storing the point coordinates in 4D can be useful in some scenarios. For example if the points are to be passed to a different library which expects 4 floats for point coordinates. It is also useful when applying 4x4 transformation matrices.

Member Typedef Documentation

ValueType

using Zivid::PointXYZW::ValueType = float

The type of the coordinate values.

Constructor & Destructor Documentation

PointXYZW() [1/2]

Zivid::PointXYZW::PointXYZW ( )

default

Constructor.

PointXYZW() [2/2]

Zivid::PointXYZW::PointXYZW ( float xCoord, float yCoord, float zCoord, float wCoord )

inline

Constructor.

Member Function Documentation

isNaN()

bool Zivid::PointXYZW::isNaN ( ) const

inline

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

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

operator!=()

ZIVID_UTILS_EXPORT bool Zivid::PointXYZW::operator!=

(

const PointXYZW &

rhs

)

const

Check for inequality.

operator==()

ZIVID_UTILS_EXPORT bool Zivid::PointXYZW::operator==

(

const PointXYZW &

rhs

)

const

Check for equality.

toString()

ZIVID_UTILS_EXPORT std::string Zivid::PointXYZW::toString

(

)

const

Get string representation.

Member Data Documentation

w

ValueType Zivid::PointXYZW::w

The w element of the point.

x

ValueType Zivid::PointXYZW::x

The x element of the point.

y

ValueType Zivid::PointXYZW::y

The y element of the point.

z

ValueType Zivid::PointXYZW::z

The z element of the point.

---

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

• Zivid/Point.h