Extrinsic parameters describing the pose of a camera in 3D space, expressed as a rotation quaternion and a translation vector. More...

#include <Zivid/CameraExtrinsics.h>

Classes
class	Rw
	Unit quaternion representing the rotational component of the camera pose. More...
class	Tw
	Translation vector representing the translational component of the camera pose. More...

Public Types
using	Descendants

Public Member Functions
	CameraExtrinsics ()
	Default constructor.
	CameraExtrinsics (const std::string &fileName)
	Construct CameraExtrinsics by loading from file.
std::string	serialize () const
	Serialize to a string.
template<typename... Args>
	CameraExtrinsics (Args &&...args)
	Constructor taking variadic number of arguments.
template<typename... Args>
void	set (Args &&...args)
	Set multiple arguments.
template<typename... Args>
CameraExtrinsics	copyWith (Args &&...args) const
	Returns a copy of this object with the given argument(s) set to the new value(s)
const Rw &	rw () const
	Get Rw.
Rw &	rw ()
	Get Rw.
CameraExtrinsics &	set (const Rw &value)
	Set Rw.
CameraExtrinsics &	set (const Rw::W &value)
	Set Rw::W.
CameraExtrinsics &	set (const Rw::X &value)
	Set Rw::X.
CameraExtrinsics &	set (const Rw::Y &value)
	Set Rw::Y.
CameraExtrinsics &	set (const Rw::Z &value)
	Set Rw::Z.
const Tw &	tw () const
	Get Tw.
Tw &	tw ()
	Get Tw.
CameraExtrinsics &	set (const Tw &value)
	Set Tw.
CameraExtrinsics &	set (const Tw::X &value)
	Set Tw::X.
CameraExtrinsics &	set (const Tw::Y &value)
	Set Tw::Y.
CameraExtrinsics &	set (const Tw::Z &value)
	Set Tw::Z.
template<typename T, typename std::enable_if< std::is_same< T, CameraExtrinsics::Rw >::value, int >::type = 0>
const CameraExtrinsics::Rw &	get () const
template<typename T, typename std::enable_if< std::is_same< T, CameraExtrinsics::Rw::W >::value, int >::type = 0>
const CameraExtrinsics::Rw::W &	get () const
template<typename T, typename std::enable_if< std::is_same< T, CameraExtrinsics::Rw::X >::value, int >::type = 0>
const CameraExtrinsics::Rw::X &	get () const
template<typename T, typename std::enable_if< std::is_same< T, CameraExtrinsics::Rw::Y >::value, int >::type = 0>
const CameraExtrinsics::Rw::Y &	get () const
template<typename T, typename std::enable_if< std::is_same< T, CameraExtrinsics::Rw::Z >::value, int >::type = 0>
const CameraExtrinsics::Rw::Z &	get () const
template<typename T, typename std::enable_if< std::is_same< T, CameraExtrinsics::Tw >::value, int >::type = 0>
const CameraExtrinsics::Tw &	get () const
template<typename T, typename std::enable_if< std::is_same< T, CameraExtrinsics::Tw::X >::value, int >::type = 0>
const CameraExtrinsics::Tw::X &	get () const
template<typename T, typename std::enable_if< std::is_same< T, CameraExtrinsics::Tw::Y >::value, int >::type = 0>
const CameraExtrinsics::Tw::Y &	get () const
template<typename T, typename std::enable_if< std::is_same< T, CameraExtrinsics::Tw::Z >::value, int >::type = 0>
const CameraExtrinsics::Tw::Z &	get () const
template<size_t i, typename std::enable_if< i==0, int >::type = 0>
const CameraExtrinsics::Rw &	get () const
template<size_t i, typename std::enable_if< i==1, int >::type = 0>
const CameraExtrinsics::Tw &	get () const
template<typename F>
void	forEach (const F &f) const
	Run the given function on each direct member with the value of the member as parameter.
template<typename F>
void	forEach (const F &f)
	Run the given function on each direct member with the value of the member as parameter.
bool	operator== (const CameraExtrinsics &other) const
	Equality operator.
bool	operator!= (const CameraExtrinsics &other) const
	Inequality operator.
std::string	toString () const
	Get the value as string.
void	save (const std::string &fileName) const
	Save to the given file.
void	load (const std::string &fileName)
	Load from the given file.

Static Public Member Functions
static CameraExtrinsics	fromSerialized (const std::string &value)
	Construct a new CameraExtrinsics instance from a previously serialized string.

Static Public Attributes
static constexpr DataModel::NodeType	nodeType = DataModel::NodeType::group
	The type of this node.
static constexpr const char *	path { "" }
	The full path for this value.
static constexpr const char *	name { "CameraExtrinsics" }
	The name of this value.
static constexpr const char *	description
	The description for this value.
static constexpr size_t	version { 1 }

Friends
struct	DataModel::Detail::Befriend< CameraExtrinsics >
std::ostream &	operator<< (std::ostream &stream, const CameraExtrinsics &value)
	Operator to send the value as string to a stream.

Detailed Description

Extrinsic parameters describing the pose of a camera in 3D space, expressed as a rotation quaternion and a translation vector.

Member Typedef Documentation

◆ Descendants

using Zivid::CameraExtrinsics::Descendants

Initial value:

 std::tuple<
            CameraExtrinsics::Rw,
            CameraExtrinsics::Rw::W,
            CameraExtrinsics::Rw::X,
            CameraExtrinsics::Rw::Y,
            CameraExtrinsics::Rw::Z,
            CameraExtrinsics::Tw,
            CameraExtrinsics::Tw::X,
            CameraExtrinsics::Tw::Y,
            CameraExtrinsics::Tw::Z>

Constructor & Destructor Documentation

◆ CameraExtrinsics() [1/3]

Zivid::CameraExtrinsics::CameraExtrinsics ( )

Default constructor.

◆ CameraExtrinsics() [2/3]

Zivid::CameraExtrinsics::CameraExtrinsics ( const std::string & fileName )

explicit

Construct CameraExtrinsics by loading from file.

◆ CameraExtrinsics() [3/3]

template<typename... Args>

Zivid::CameraExtrinsics::CameraExtrinsics ( Args &&... args )

inlineexplicit

Constructor taking variadic number of arguments.

One or more descendant types can be provided. All types not provided will be set to their default value. The result is the same as default constructing CameraExtrinsics then invoking set(args).

The provided arguments must be descendants of CameraExtrinsics. These types can be provided:

Member Function Documentation

◆ copyWith()

template<typename... Args>

CameraExtrinsics Zivid::CameraExtrinsics::copyWith ( Args &&... args ) const

inline

Returns a copy of this object with the given argument(s) set to the new value(s)

Creates a copy of this CameraExtrinsics object, then invokes set(args) on the copy, and finally returns the copy. This method does not modify the original object.

The provided arguments must be descendants of CameraExtrinsics. These types can be provided:

◆ forEach() [1/2]

template<typename F>

void Zivid::CameraExtrinsics::forEach ( const F & f )

inline

Run the given function on each direct member with the value of the member as parameter.

◆ forEach() [2/2]

template<typename F>

void Zivid::CameraExtrinsics::forEach ( const F & f ) const

inline

Run the given function on each direct member with the value of the member as parameter.

◆ fromSerialized()

CameraExtrinsics Zivid::CameraExtrinsics::fromSerialized ( const std::string & value )

staticnodiscard

Construct a new CameraExtrinsics instance from a previously serialized string.

◆ get() [1/11]

template<typename T, typename std::enable_if< std::is_same< T, CameraExtrinsics::Rw >::value, int >::type = 0>

const CameraExtrinsics::Rw & Zivid::CameraExtrinsics::get ( ) const

inline

◆ get() [2/11]

template<typename T, typename std::enable_if< std::is_same< T, CameraExtrinsics::Rw::W >::value, int >::type = 0>

const CameraExtrinsics::Rw::W & Zivid::CameraExtrinsics::get ( ) const

inline

◆ get() [3/11]

template<typename T, typename std::enable_if< std::is_same< T, CameraExtrinsics::Rw::X >::value, int >::type = 0>

const CameraExtrinsics::Rw::X & Zivid::CameraExtrinsics::get ( ) const

inline

◆ get() [4/11]

template<typename T, typename std::enable_if< std::is_same< T, CameraExtrinsics::Rw::Y >::value, int >::type = 0>

const CameraExtrinsics::Rw::Y & Zivid::CameraExtrinsics::get ( ) const

inline

◆ get() [5/11]

template<typename T, typename std::enable_if< std::is_same< T, CameraExtrinsics::Rw::Z >::value, int >::type = 0>

const CameraExtrinsics::Rw::Z & Zivid::CameraExtrinsics::get ( ) const

inline

◆ get() [6/11]

template<typename T, typename std::enable_if< std::is_same< T, CameraExtrinsics::Tw >::value, int >::type = 0>

const CameraExtrinsics::Tw & Zivid::CameraExtrinsics::get ( ) const

inline

◆ get() [7/11]

template<typename T, typename std::enable_if< std::is_same< T, CameraExtrinsics::Tw::X >::value, int >::type = 0>

const CameraExtrinsics::Tw::X & Zivid::CameraExtrinsics::get ( ) const

inline

◆ get() [8/11]

template<typename T, typename std::enable_if< std::is_same< T, CameraExtrinsics::Tw::Y >::value, int >::type = 0>

const CameraExtrinsics::Tw::Y & Zivid::CameraExtrinsics::get ( ) const

inline

◆ get() [9/11]

template<typename T, typename std::enable_if< std::is_same< T, CameraExtrinsics::Tw::Z >::value, int >::type = 0>

const CameraExtrinsics::Tw::Z & Zivid::CameraExtrinsics::get ( ) const

inline

◆ get() [10/11]

template<size_t i, typename std::enable_if< i==0, int >::type = 0>

const CameraExtrinsics::Rw & Zivid::CameraExtrinsics::get ( ) const

inline

◆ get() [11/11]

template<size_t i, typename std::enable_if< i==1, int >::type = 0>

const CameraExtrinsics::Tw & Zivid::CameraExtrinsics::get ( ) const

inline

◆ load()

void Zivid::CameraExtrinsics::load ( const std::string & fileName )

Load from the given file.

◆ operator!=()

bool Zivid::CameraExtrinsics::operator!= ( const CameraExtrinsics & other ) const

Inequality operator.

◆ operator==()

bool Zivid::CameraExtrinsics::operator== ( const CameraExtrinsics & other ) const

Equality operator.

◆ rw() [1/2]

Rw & Zivid::CameraExtrinsics::rw ( )

inline

Get Rw.

◆ rw() [2/2]

const Rw & Zivid::CameraExtrinsics::rw ( ) const

inline

Get Rw.

◆ save()

void Zivid::CameraExtrinsics::save ( const std::string & fileName ) const

Save to the given file.

◆ serialize()

std::string Zivid::CameraExtrinsics::serialize ( ) const

Serialize to a string.

See also fromSerialized. The returned string is formatted in YAML, and is compatible with the contents of files saved using save.

◆ set() [1/10]

template<typename... Args>

void Zivid::CameraExtrinsics::set ( Args &&... args )

inline

Set multiple arguments.

The method invokes set(arg) with each of the provided arguments.

The provided arguments must be descendants of CameraExtrinsics. These types can be provided:

◆ set() [2/10]

CameraExtrinsics & Zivid::CameraExtrinsics::set ( const Rw & value )

inline

Set Rw.

◆ set() [3/10]

CameraExtrinsics & Zivid::CameraExtrinsics::set ( const Rw::W & value )

inline

Set Rw::W.

◆ set() [4/10]

CameraExtrinsics & Zivid::CameraExtrinsics::set ( const Rw::X & value )

inline

Set Rw::X.

◆ set() [5/10]

CameraExtrinsics & Zivid::CameraExtrinsics::set ( const Rw::Y & value )

inline

Set Rw::Y.

◆ set() [6/10]

CameraExtrinsics & Zivid::CameraExtrinsics::set ( const Rw::Z & value )

inline

Set Rw::Z.

◆ set() [7/10]

CameraExtrinsics & Zivid::CameraExtrinsics::set ( const Tw & value )

inline

Set Tw.

◆ set() [8/10]

CameraExtrinsics & Zivid::CameraExtrinsics::set ( const Tw::X & value )

inline

Set Tw::X.

◆ set() [9/10]

CameraExtrinsics & Zivid::CameraExtrinsics::set ( const Tw::Y & value )

inline

Set Tw::Y.

◆ set() [10/10]

CameraExtrinsics & Zivid::CameraExtrinsics::set ( const Tw::Z & value )

inline

Set Tw::Z.

◆ toString()

std::string Zivid::CameraExtrinsics::toString ( ) const

Get the value as string.

◆ tw() [1/2]

Tw & Zivid::CameraExtrinsics::tw ( )

inline

Get Tw.

◆ tw() [2/2]

const Tw & Zivid::CameraExtrinsics::tw ( ) const

inline

Get Tw.

◆ DataModel::Detail::Befriend< CameraExtrinsics >

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

friend

◆ operator<<

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

friend

Operator to send the value as string to a stream.

Member Data Documentation

◆ description

const char* Zivid::CameraExtrinsics::description

staticconstexpr

Initial value:

{
            R"description(Extrinsic parameters describing the pose of a camera in 3D space, expressed as a rotation quaternion and a translation vector.
)description"
        }

The description for this value.

◆ name

const char* Zivid::CameraExtrinsics::name { "CameraExtrinsics" }

staticconstexpr

The name of this value.

◆ nodeType

DataModel::NodeType Zivid::CameraExtrinsics::nodeType = DataModel::NodeType::group

staticconstexpr

The type of this node.

◆ path

const char* Zivid::CameraExtrinsics::path { "" }

staticconstexpr

The full path for this value.

◆ version

size_t Zivid::CameraExtrinsics::version { 1 }

staticconstexpr

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

Zivid/CameraExtrinsics.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Descendants

Constructor & Destructor Documentation

◆ CameraExtrinsics() [1/3]

◆ CameraExtrinsics() [2/3]

◆ CameraExtrinsics() [3/3]

Member Function Documentation

◆ copyWith()

◆ forEach() [1/2]

◆ forEach() [2/2]

◆ fromSerialized()

◆ get() [1/11]

◆ get() [2/11]

◆ get() [3/11]

◆ get() [4/11]

◆ get() [5/11]

◆ get() [6/11]

◆ get() [7/11]

◆ get() [8/11]

◆ get() [9/11]

◆ get() [10/11]

◆ get() [11/11]

◆ load()

◆ operator!=()

◆ operator==()

◆ rw() [1/2]

◆ rw() [2/2]

◆ save()

◆ serialize()

◆ set() [1/10]

◆ set() [2/10]

◆ set() [3/10]

◆ set() [4/10]

◆ set() [5/10]

◆ set() [6/10]

◆ set() [7/10]

◆ set() [8/10]

◆ set() [9/10]

◆ set() [10/10]

◆ toString()

◆ tw() [1/2]

◆ tw() [2/2]

Friends And Related Symbol Documentation

◆ DataModel::Detail::Befriend< CameraExtrinsics >

◆ operator<<

Member Data Documentation

◆ description

◆ name

◆ nodeType

◆ path

◆ version