Zivid C++ API 2.6.1+6cec8609-3
Defining the Future of 3D Machine Vision
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Friends | List of all members
Zivid::CameraIntrinsics::CameraMatrix::CX Class Reference

x coordinate of the principal point More...

#include <Zivid/CameraIntrinsics.h>

Public Types

using ValueType = double
 The type of the underlying value More...
 

Public Member Functions

 CX ()=default
 Default constructor More...
 
constexpr CX (double value)
 Constructor More...
 
double value () const
 Get the value More...
 
std::string toString () const
 Get the value as string More...
 
bool operator== (const CX &other) const
 Comparison operator More...
 
bool operator!= (const CX &other) const
 Comparison operator More...
 
bool operator< (const CX &other) const
 Comparison operator More...
 
bool operator> (const CX &other) const
 Comparison operator More...
 

Static Public Member Functions

static constexpr Range< double > validRange ()
 The range of valid values for CX More...
 

Static Public Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue
 The type of this node More...
 
static constexpr const char * path { "CameraMatrix/CX" }
 The full path for this value More...
 
static constexpr const char * name { "CX" }
 The name of this value More...
 
static constexpr const char * description
 The description for this value More...
 

Friends

struct DataModel::Detail::Befriend< CX >
 
std::ostream & operator<< (std::ostream &stream, const CX &value)
 Operator to serialize the value to a stream More...
 

Detailed Description

x coordinate of the principal point

Member Typedef Documentation

◆ ValueType

The type of the underlying value

Constructor & Destructor Documentation

◆ CX() [1/2]

Zivid::CameraIntrinsics::CameraMatrix::CX::CX ( )
default

Default constructor

◆ CX() [2/2]

constexpr Zivid::CameraIntrinsics::CameraMatrix::CX::CX ( double  value)
inlineexplicitconstexpr

Constructor

Member Function Documentation

◆ operator!=()

bool Zivid::CameraIntrinsics::CameraMatrix::CX::operator!= ( const CX other) const
inline

Comparison operator

◆ operator<()

bool Zivid::CameraIntrinsics::CameraMatrix::CX::operator< ( const CX other) const
inline

Comparison operator

◆ operator==()

bool Zivid::CameraIntrinsics::CameraMatrix::CX::operator== ( const CX other) const
inline

Comparison operator

◆ operator>()

bool Zivid::CameraIntrinsics::CameraMatrix::CX::operator> ( const CX other) const
inline

Comparison operator

◆ toString()

std::string Zivid::CameraIntrinsics::CameraMatrix::CX::toString ( ) const

Get the value as string

◆ validRange()

static constexpr Range< double > Zivid::CameraIntrinsics::CameraMatrix::CX::validRange ( )
inlinestaticconstexpr

The range of valid values for CX

◆ value()

double Zivid::CameraIntrinsics::CameraMatrix::CX::value ( ) const

Get the value

Friends And Related Function Documentation

◆ DataModel::Detail::Befriend< CX >

friend struct DataModel::Detail::Befriend< CX >
friend

◆ operator<<

std::ostream & operator<< ( std::ostream &  stream,
const CX value 
)
friend

Operator to serialize the value to a stream

Member Data Documentation

◆ description

constexpr const char* Zivid::CameraIntrinsics::CameraMatrix::CX::description
staticconstexpr
Initial value:
{
R"description(x coordinate of the principal point)description"
}

The description for this value

◆ name

constexpr const char* Zivid::CameraIntrinsics::CameraMatrix::CX::name { "CX" }
staticconstexpr

The name of this value

◆ nodeType

constexpr DataModel::NodeType Zivid::CameraIntrinsics::CameraMatrix::CX::nodeType = DataModel::NodeType::leafValue
staticconstexpr

The type of this node

◆ path

constexpr const char* Zivid::CameraIntrinsics::CameraMatrix::CX::path { "CameraMatrix/CX" }
staticconstexpr

The full path for this value


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