Matrix.hpp File Reference

Widgets related to Matrices. More...

Go to the source code of this file.

Typedefs
using	GuiMatrixViewFlags
	Flags for MatrixView GUI elements GuiMatrixViewFlags_.

Enumerations
enum	GuiMatrixViewFlags_ {   GuiMatrixViewFlags_None ,   GuiMatrixViewFlags_RowHeader ,   GuiMatrixViewFlags_ColumnHeader ,   GuiMatrixViewFlags_Header }
	Flags to select the MatrixView behaviour. More...

Functions
template<typename _Scalar , int _Rows, int _Cols>
bool	NAV::gui::widgets::InputMatrix (const char *label, Eigen::Matrix< _Scalar, _Rows, _Cols > *matrix, GuiMatrixViewFlags flags=GuiMatrixViewFlags_None, ImGuiTableFlags tableFlags=ImGuiTableFlags_None, float inputTextWidth=50.0F, double step=0.0, double step_fast=0.0, const char *format="%.6f", ImGuiInputTextFlags inputTextFlags=ImGuiInputTextFlags_None)
	Shows GUI elements to modify the coefficients of a matrix with.
template<typename _Scalar , int _Rows, int _Cols>
void	NAV::gui::widgets::MatrixView (const char *label, const Eigen::Matrix< _Scalar, _Rows, _Cols > *matrix, GuiMatrixViewFlags flags=GuiMatrixViewFlags_None, ImGuiTableFlags tableFlags=ImGuiTableFlags_None, const char *format="%.6f")
	Shows GUI elements to display the coefficients of a matrix.

Detailed Description

Widgets related to Matrices.

Author

T. Topp (topp@.nosp@m.ins..nosp@m.uni-s.nosp@m.tutt.nosp@m.gart..nosp@m.de)

Date

2021-10-04

Enumeration Type Documentation

GuiMatrixViewFlags_

enum GuiMatrixViewFlags_

Flags to select the MatrixView behaviour.

Enumerator
GuiMatrixViewFlags_None	None.
GuiMatrixViewFlags_RowHeader	Print the Row Header.
GuiMatrixViewFlags_ColumnHeader	Print the Col Header.
GuiMatrixViewFlags_Header	Print all Header.

Function Documentation

InputMatrix()

template<typename _Scalar , int _Rows, int _Cols>

bool NAV::gui::widgets::InputMatrix	(	const char *	label,
		Eigen::Matrix< _Scalar, _Rows, _Cols > *	matrix,
		GuiMatrixViewFlags	flags = GuiMatrixViewFlags_None,
		ImGuiTableFlags	tableFlags = ImGuiTableFlags_None,
		float	inputTextWidth = 50.0F,
		double	step = 0.0,
		double	step_fast = 0.0,
		const char *	format = "%.6f",
		ImGuiInputTextFlags	inputTextFlags = ImGuiInputTextFlags_None )

Shows GUI elements to modify the coefficients of a matrix with.

Template Parameters

_Scalar	Data Type of the matrix
_Rows	Amount of rows of the matrix
_Cols	Amount of cols of the matrix

Parameters

[in]	label	Label to display beside. Has to be unique (use # to hide text afterwards to append an uid)
[in,out]	matrix	Pointer to the matrix to modify
[in]	flags	Flags to modify the behavior of the whole element
[in]	tableFlags	Flags to modify the Table behaviour
[in]	inputTextWidth	With in px of each InputText
[in]	step	Step size of the InputText
[in]	step_fast	Fast step size of the InputText
[in]	format	Printf format to display the value with
[in]	inputTextFlags	InputText flags to modify the behavior of the input fields

Returns

True if the value was changed

MatrixView()

template<typename _Scalar , int _Rows, int _Cols>

void NAV::gui::widgets::MatrixView	(	const char *	label,
		const Eigen::Matrix< _Scalar, _Rows, _Cols > *	matrix,
		GuiMatrixViewFlags	flags = GuiMatrixViewFlags_None,
		ImGuiTableFlags	tableFlags = ImGuiTableFlags_None,
		const char *	format = "%.6f" )

Shows GUI elements to display the coefficients of a matrix.

Template Parameters

_Scalar	Data Type of the matrix
_Rows	Amount of rows of the matrix
_Cols	Amount of cols of the matrix

Parameters

[in]	label	Label to display beside. Has to be unique (use # to hide text afterwards to append an uid)
[in]	matrix	Pointer to the matrix to display
[in]	flags	Flags to modify the behavior of the whole element
[in]	tableFlags	Flags to modify the Table behaviour
[in]	format	Printf format to display the value with