Zivid C++ API 2.13.1+18e79e79-1
Zivid::VectorXYZ Struct Reference

Vector with three coordinates as float. More...

#include <Zivid/Vector.h>

Inheritance diagram for Zivid::VectorXYZ:
Zivid::NormalXYZ

Public Types

using ValueType = float
 The type of the coordinate values.
 

Public Member Functions

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

Public Attributes

ValueType x
 The x element of the vector.
 
ValueType y
 The y element of the vector.
 
ValueType z
 The z element of the vector.
 

Detailed Description

Vector with three coordinates as float.

Member Typedef Documentation

◆ ValueType

The type of the coordinate values.

Constructor & Destructor Documentation

◆ VectorXYZ() [1/2]

Zivid::VectorXYZ::VectorXYZ ( )
default

Constructor.

◆ VectorXYZ() [2/2]

Zivid::VectorXYZ::VectorXYZ ( float xCoord,
float yCoord,
float zCoord )
inline

Constructor.

Member Function Documentation

◆ isNaN()

bool Zivid::VectorXYZ::isNaN ( ) const
inline

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

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

◆ operator!=()

ZIVID_CORE_EXPORT bool Zivid::VectorXYZ::operator!= ( const VectorXYZ & rhs) const

Check for inequality.

◆ operator==()

ZIVID_CORE_EXPORT bool Zivid::VectorXYZ::operator== ( const VectorXYZ & rhs) const

Check for equality.

◆ toString()

ZIVID_CORE_EXPORT std::string Zivid::VectorXYZ::toString ( ) const

Get string representation.

Member Data Documentation

◆ x

ValueType Zivid::VectorXYZ::x

The x element of the vector.

◆ y

ValueType Zivid::VectorXYZ::y

The y element of the vector.

◆ z

ValueType Zivid::VectorXYZ::z

The z element of the vector.


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