Zivid C++ API 2.9.0+4dbba385-1
Defining the Future of 3D Machine Vision
Public Types | Public Member Functions | Static Public Attributes | Friends | List of all members
Zivid::Settings::RegionOfInterest::Box::PointB Class Reference

A point such that the vector from PointO to PointB describes the second edge of the parallelogram More...

#include <Zivid/Settings.h>

Public Types

using ValueType = Zivid::PointXYZ
 The type of the underlying value More...
 

Public Member Functions

 PointB ()=default
 Default constructor More...
 
constexpr PointB (Zivid::PointXYZ value)
 Constructor More...
 
Zivid::PointXYZ value () const
 Get the value More...
 
bool hasValue () const
 Check if the value is set More...
 
void reset ()
 Reset the node to unset state More...
 
std::string toString () const
 Get the value as string More...
 
constexpr PointB (float x, float y, float z)
 Constructor More...
 
bool operator== (const PointB &other) const
 Comparison operator More...
 
bool operator!= (const PointB &other) const
 Comparison operator More...
 

Static Public Attributes

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

Friends

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

Detailed Description

A point such that the vector from PointO to PointB describes the second edge of the parallelogram

Member Typedef Documentation

◆ ValueType

The type of the underlying value

Constructor & Destructor Documentation

◆ PointB() [1/3]

Zivid::Settings::RegionOfInterest::Box::PointB::PointB ( )
default

Default constructor

◆ PointB() [2/3]

constexpr Zivid::Settings::RegionOfInterest::Box::PointB::PointB ( Zivid::PointXYZ  value)
inlineexplicitconstexpr

Constructor

◆ PointB() [3/3]

constexpr Zivid::Settings::RegionOfInterest::Box::PointB::PointB ( float  x,
float  y,
float  z 
)
inlineexplicitconstexpr

Constructor

Member Function Documentation

◆ hasValue()

bool Zivid::Settings::RegionOfInterest::Box::PointB::hasValue ( ) const

Check if the value is set

◆ operator!=()

bool Zivid::Settings::RegionOfInterest::Box::PointB::operator!= ( const PointB other) const
inline

Comparison operator

◆ operator==()

bool Zivid::Settings::RegionOfInterest::Box::PointB::operator== ( const PointB other) const
inline

Comparison operator

◆ reset()

void Zivid::Settings::RegionOfInterest::Box::PointB::reset ( )

Reset the node to unset state

◆ toString()

std::string Zivid::Settings::RegionOfInterest::Box::PointB::toString ( ) const

Get the value as string

◆ value()

Zivid::PointXYZ Zivid::Settings::RegionOfInterest::Box::PointB::value ( ) const

Get the value

If this object does not contain a value (see hasValue) then this method throws an exception.

Friends And Related Function Documentation

◆ DataModel::Detail::Befriend< PointB >

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

◆ operator<<

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

Operator to serialize the value to a stream

Member Data Documentation

◆ description

constexpr const char* Zivid::Settings::RegionOfInterest::Box::PointB::description
staticconstexpr
Initial value:
{
R"description(A point such that the vector from PointO to PointB describes the second edge of the parallelogram)description"
}

The description for this value

◆ name

constexpr const char* Zivid::Settings::RegionOfInterest::Box::PointB::name { "PointB" }
staticconstexpr

The name of this value

◆ nodeType

constexpr DataModel::NodeType Zivid::Settings::RegionOfInterest::Box::PointB::nodeType = DataModel::NodeType::leafValue
staticconstexpr

The type of this node

◆ path

constexpr const char* Zivid::Settings::RegionOfInterest::Box::PointB::path { "RegionOfInterest/Box/PointB" }
staticconstexpr

The full path for this value


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