Compacted affine matrix describing the Common Vision Blox coordinate system. More...

#include <cvb/affine_matrix_2d.hpp>

Public Member Functions
	AffineMatrix2D () noexcept=default
	Default constructor for empty affine matrix.

	AffineMatrix2D (Cvb::Matrix2D matrix, Vector2D< double > translation) noexcept
	Define an affine matrix.

Cvb::Matrix2D	Matrix () const noexcept
	Get the transformation part of the affine matrix.

void	SetMatrix (Cvb::Matrix2D matrix) noexcept
	Set the transformation part of the affine matrix.

Vector2D< double >	Translation () const noexcept
	Get the translation part of the affine matrix.

void	SetTranslation (Vector2D< double > translation) noexcept
	Set the translation part of the affine matrix.

void	Invert ()
	Invert this affine transformation in-place if possible.

AffineMatrix2D	Inverse ()
	Gets the inverse of this affine transformation if possible.

bool	IsTranslation () const noexcept
	Check if this affine matrix only describes a translation.

bool	operator== (const AffineMatrix2D &affineMatrix) const noexcept
	Compares to an other matrix.

bool	operator!= (const AffineMatrix2D &affineMatrix) const noexcept
	Compares to an other matrix.

AffineMatrix2D &	operator+= (const AffineMatrix2D &affineMatrix) noexcept
	Adds and assigns to this affine matrix.

AffineMatrix2D &	operator-= (const AffineMatrix2D &affineMatrix) noexcept
	Subtracts and assigns to this affine matrix.

AffineMatrix2D &	operator*= (const AffineMatrix2D &affineMatrix) noexcept
	Multiplies and assigns to this affine matrix.

AffineMatrix2D &	operator*= (const double &value) noexcept
	Multiplies and assigns to this affine matrix.

AffineMatrix2D &	operator/= (const double &value) noexcept
	Divides each element of this affine matrix by the given value.

Static Public Member Functions
static AffineMatrix2D	Identity () noexcept
	The identity element.

Related Symbols
(Note that these are not member symbols.)
AffineMatrix2D	operator+ (const AffineMatrix2D &lhs, const AffineMatrix2D &rhs) noexcept
	Add two affine matrices.

AffineMatrix2D	operator- (const AffineMatrix2D &lhs, const AffineMatrix2D &rhs) noexcept
	Subtract two affine matrices.

AffineMatrix2D	operator* (const AffineMatrix2D &lhs, const AffineMatrix2D &rhs) noexcept
	Multiply two affine matrices.

Point2D< double >	operator* (const AffineMatrix2D &lhs, const Point2D< double > &rhs) noexcept
	Multiply affine matrix with 2D point.

AffineMatrix2D	operator* (const AffineMatrix2D &lhs, const double &rhs) noexcept
	Multiply affine matrix with scalar.

AffineMatrix2D	operator* (const double &lhs, const AffineMatrix2D &rhs) noexcept
	Multiply scalar with affine matrix .

AffineMatrix2D	operator/ (const AffineMatrix2D &lhs, const double &rhs)
	Divide affine matrix by scalar.

Detailed Description

Compacted affine matrix describing the Common Vision Blox coordinate system.

Constructor & Destructor Documentation

◆ AffineMatrix2D() [1/2]

AffineMatrix2D ( )

defaultnoexcept

Default constructor for empty affine matrix.

Exceptions

Does	not throw any exception.

◆ AffineMatrix2D() [2/2]

AffineMatrix2D	(	Cvb::Matrix2D	matrix,
		Vector2D< double >	translation )

inlinenoexcept

Define an affine matrix.

Parameters

[in]	matrix	The transformation part.
[in]	translation	The translation part.

Exceptions

Does	not throw any exception.

Member Function Documentation

◆ Identity()

static AffineMatrix2D Identity ( )

inlinestaticnoexcept

The identity element.

Returns: An identity matrix.

Exceptions

Does	not throw any exception.

◆ Inverse()

AffineMatrix2D Inverse ( )

inline

Gets the inverse of this affine transformation if possible.

Exceptions

Any	exception derived from std::exception including CvbException.

Returns: Inverse.

Might cause division by zero.

◆ Invert()

void Invert ( )

inline

Invert this affine transformation in-place if possible.

Exceptions

Any	exception derived from std::exception including CvbException.

Might cause division by zero.

◆ IsTranslation()

bool IsTranslation ( ) const

inlinenoexcept

Check if this affine matrix only describes a translation.

Returns: bool True if this affine matrix corresponds to a pure translation, false otherwise.

Exceptions

Does	not throw any exception.

◆ Matrix()

Cvb::Matrix2D Matrix ( ) const

inlinenoexcept

Get the transformation part of the affine matrix.

Returns: The transformation matrix.

Exceptions

Does	not throw any exception.

◆ operator!=()

bool operator!= ( const AffineMatrix2D & affineMatrix ) const

inlinenoexcept

Compares to an other matrix.

Parameters

[in] affineMatrix Other matrix.

Returns: True if not equal, otherwise false.

Exceptions

Does	not throw any exception.

◆ operator*=() [1/2]

AffineMatrix2D & operator*= ( const AffineMatrix2D & affineMatrix )

inlinenoexcept

Multiplies and assigns to this affine matrix.

Parameters

[in] affineMatrix Other affine matrix.

Returns: This affine matrix.

Exceptions

Does	not throw any exception.

◆ operator*=() [2/2]

AffineMatrix2D & operator*= ( const double & value )

inlinenoexcept

Multiplies and assigns to this affine matrix.

Parameters

[in] value Factor.

Returns: This affine matrix.

Exceptions

Does	not throw any exception.

◆ operator+=()

AffineMatrix2D & operator+= ( const AffineMatrix2D & affineMatrix )

inlinenoexcept

Adds and assigns to this affine matrix.

Parameters

[in] affineMatrix Other affine matrix.

Returns: This affine matrix.

Exceptions

Does	not throw any exception.

◆ operator-=()

AffineMatrix2D & operator-= ( const AffineMatrix2D & affineMatrix )

inlinenoexcept

Subtracts and assigns to this affine matrix.

Parameters

[in] affineMatrix Other affine matrix.

Returns: This affine matrix.

Exceptions

Does	not throw any exception.

◆ operator/=()

AffineMatrix2D & operator/= ( const double & value )

inlinenoexcept

Divides each element of this affine matrix by the given value.

Parameters

[in] value Divisor.

Returns: This affine matrix.

Exceptions

Does	not throw any exception.

◆ operator==()

bool operator== ( const AffineMatrix2D & affineMatrix ) const

inlinenoexcept

Compares to an other matrix.

Parameters

[in] affineMatrix Other matrix.

Returns: True if equal, otherwise false.

Exceptions

Does	not throw any exception.

◆ SetMatrix()

void SetMatrix ( Cvb::Matrix2D matrix )

inlinenoexcept

Set the transformation part of the affine matrix.

Parameters

[in] matrix The transformation matrix.

Exceptions

Does	not throw any exception.

◆ SetTranslation()

void SetTranslation ( Vector2D< double > translation )

inlinenoexcept

Set the translation part of the affine matrix.

Parameters

[in] translation The 2D translation part.

Exceptions

Does	not throw any exception.

◆ Translation()

Vector2D< double > Translation ( ) const

inlinenoexcept

Get the translation part of the affine matrix.

Returns: The 2D translation part.

Exceptions

Does	not throw any exception.

Friends And Related Symbol Documentation

◆ operator*() [1/4]

AffineMatrix2D operator*	(	const AffineMatrix2D &	lhs,
		const AffineMatrix2D &	rhs )

Multiply two affine matrices.

Parameters

[in]	lhs	Right hand side affine matrix.
[in]	rhs	Left hand side affine matrix.

Returns: The computation result.

Exceptions

Does	not throw any exception.

◆ operator*() [2/4]

AffineMatrix2D operator*	(	const AffineMatrix2D &	lhs,
		const double &	rhs )

Multiply affine matrix with scalar.

Parameters

[in]	lhs	Right hand side affine matrix.
[in]	rhs	Left hand side value.

Returns: The computation result.

Exceptions

Does	not throw any exception.

◆ operator*() [3/4]

Point2D< double > operator*	(	const AffineMatrix2D &	lhs,
		const Point2D< double > &	rhs )

Multiply affine matrix with 2D point.

Parameters

[in]	lhs	Right hand side affine matrix.
[in]	rhs	Left hand side point.

Returns: The computation result.

Exceptions

Does	not throw any exception.

◆ operator*() [4/4]

AffineMatrix2D operator*	(	const double &	lhs,
		const AffineMatrix2D &	rhs )

Multiply scalar with affine matrix .

Parameters

[in]	lhs	Right hand side value.
[in]	rhs	Left hand side affine matrix.

Returns: The computation result.

Exceptions

Does	not throw any exception.

◆ operator+()

AffineMatrix2D operator+	(	const AffineMatrix2D &	lhs,
		const AffineMatrix2D &	rhs )

Add two affine matrices.

Parameters

[in]	lhs	Right hand side affine matrix.
[in]	rhs	Left hand side affine matrix.

Returns: The computation result.

Exceptions

Does	not throw any exception.

◆ operator-()

AffineMatrix2D operator-	(	const AffineMatrix2D &	lhs,
		const AffineMatrix2D &	rhs )

Subtract two affine matrices.

Parameters

[in]	lhs	Right hand side affine matrix.
[in]	rhs	Left hand side affine matrix.

Returns: The computation result.

Exceptions

Does	not throw any exception.

◆ operator/()

AffineMatrix2D operator/	(	const AffineMatrix2D &	lhs,
		const double &	rhs )

Divide affine matrix by scalar.

Parameters

[in]	lhs	Right hand side affine matrix.
[in]	rhs	Left hand side value.

Returns: The computation result.

Exceptions

Does	not throw any exception.

Public Member Functions

Static Public Member Functions

Related Symbols

Detailed Description

Constructor & Destructor Documentation

◆ AffineMatrix2D() [1/2]

◆ AffineMatrix2D() [2/2]

Member Function Documentation

◆ Identity()

◆ Inverse()

◆ Invert()

◆ IsTranslation()

◆ Matrix()

◆ operator!=()

◆ operator*=() [1/2]

◆ operator*=() [2/2]

◆ operator+=()

◆ operator-=()

◆ operator/=()

◆ operator==()

◆ SetMatrix()

◆ SetTranslation()

◆ Translation()

Friends And Related Symbol Documentation

◆ operator*() [1/4]

◆ operator*() [2/4]

◆ operator*() [3/4]

◆ operator*() [4/4]

◆ operator+()

◆ operator-()

◆ operator/()