Zivid C++ API 2.9.0+4dbba385-1
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::FX Class Reference

Focal length in x More...

#include <Zivid/CameraIntrinsics.h>

Public Types

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

Public Member Functions

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

Static Public Member Functions

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

Static Public Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue
 The type of this node More...
 
static constexpr const char * path { "CameraMatrix/FX" }
 The full path for this value More...
 
static constexpr const char * name { "FX" }
 The name of this value More...
 
static constexpr const char * description { R"description(Focal length in x)description" }
 The description for this value More...
 

Friends

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

Detailed Description

Focal length in x

Member Typedef Documentation

◆ ValueType

The type of the underlying value

Constructor & Destructor Documentation

◆ FX() [1/2]

Zivid::CameraIntrinsics::CameraMatrix::FX::FX ( )
default

Default constructor

◆ FX() [2/2]

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

Constructor

Member Function Documentation

◆ operator!=()

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

Comparison operator

◆ operator<()

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

Comparison operator

◆ operator<=()

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

Comparison operator

◆ operator==()

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

Comparison operator

◆ operator>()

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

Comparison operator

◆ operator>=()

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

Comparison operator

◆ toString()

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

Get the value as string

◆ validRange()

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

The range of valid values for FX

◆ value()

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

Get the value

Friends And Related Function Documentation

◆ DataModel::Detail::Befriend< FX >

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

◆ operator<<

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

Operator to serialize the value to a stream

Member Data Documentation

◆ description

constexpr const char* Zivid::CameraIntrinsics::CameraMatrix::FX::description { R"description(Focal length in x)description" }
staticconstexpr

The description for this value

◆ name

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

The name of this value

◆ nodeType

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

The type of this node

◆ path

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

The full path for this value


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