Field to encapsulate a 4x4 matrix, same as Matrix4Field for backward compatibility. More...
#include <mlFields.h>
Public Member Functions | |
| MatrixField () | |
| Default constructor, do not use it. | |
| MatrixField (const std::string &name) | |
Constructor, creates a field with a name to manage a 4x4 matrix. | |
| void | setStringValue (const std::string &stringValue) |
Sets the field value to stringValue="a11 a12 ... a44". | |
| void | setMatrixValue (const Matrix4 &matrixValue) |
Sets the value of the field to matrixValue. | |
| void | setMatrix4Value (const Matrix4 &matrixValue) |
Sets the value of the field to matrixValue; same as setMatrixValue for symmetry to other fields. | |
| void | updateMatrix4Value (const Matrix4 &matrixValue) |
Sets the value of the field to matrixValue, but only touch field if the new value is different from the old value. | |
| std::string | getStringValue () const |
| Returns the value of the field as a string value. | |
| const Matrix4 & | getMatrixValue () const |
| Returns the value of the field. | |
| const Matrix4 & | getMatrix4Value () const |
| Returns the value of the field; same as getMatrixValue for symmetry to other fields. | |
Deprecated | |
| void | setMat4fValue (const Matrix4 &value) |
| void | setMat4Value (const Matrix4 &value) |
| const Matrix4 & | getMat4Value () const |
| MatrixField (const std::string &name, Matrix4 *valuePtr) | |
Protected Member Functions | |
| virtual void | setValueFromField (const Field &field) |
| Reimplementation from Field which copies the field value more efficiently. | |
Detailed Description
Field to encapsulate a 4x4 matrix, same as Matrix4Field for backward compatibility.
Definition at line 2008 of file mlFields.h.
Constructor & Destructor Documentation
| ml::MatrixField::MatrixField | ( | ) |
Default constructor, do not use it.
| ml::MatrixField::MatrixField | ( | const std::string & | name | ) |
Constructor, creates a field with a name to manage a 4x4 matrix.
Default value is the unit matrix.
| ml::MatrixField::MatrixField | ( | const std::string & | name, |
| Matrix4 * | valuePtr | ||
| ) |
- Deprecated:
- Use MatrixField(const std::string &name) instead.
Member Function Documentation
| const Matrix4& ml::MatrixField::getMat4Value | ( | ) | const [inline] |
- Deprecated:
- Use getMatrix4Value instead.
Definition at line 2079 of file mlFields.h.
| const Matrix4& ml::MatrixField::getMatrix4Value | ( | ) | const |
Returns the value of the field; same as getMatrixValue for symmetry to other fields.
| const Matrix4& ml::MatrixField::getMatrixValue | ( | ) | const |
Returns the value of the field.
| std::string ml::MatrixField::getStringValue | ( | ) | const [virtual] |
Returns the value of the field as a string value.
setStringValue must be able to reinterpret this returned string correctly.
Implements ml::Field.
| void ml::MatrixField::setMat4fValue | ( | const Matrix4 & | value | ) | [inline] |
- Deprecated:
- Use setMatrix4Value instead.
Definition at line 2073 of file mlFields.h.
| void ml::MatrixField::setMat4Value | ( | const Matrix4 & | value | ) | [inline] |
- Deprecated:
- Use setMatrix4Value instead.
Definition at line 2076 of file mlFields.h.
| void ml::MatrixField::setMatrix4Value | ( | const Matrix4 & | matrixValue | ) |
Sets the value of the field to matrixValue; same as setMatrixValue for symmetry to other fields.
| void ml::MatrixField::setMatrixValue | ( | const Matrix4 & | matrixValue | ) |
Sets the value of the field to matrixValue.
| void ml::MatrixField::setStringValue | ( | const std::string & | stringValue | ) | [virtual] |
Sets the field value to stringValue="a11 a12 ... a44".
If less than 16 valid numbers can be scanned in string then all components are set to 0.
Implements ml::Field.
| virtual void ml::MatrixField::setValueFromField | ( | const Field & | field | ) | [protected, virtual] |
| void ml::MatrixField::updateMatrix4Value | ( | const Matrix4 & | matrixValue | ) |
Sets the value of the field to matrixValue, but only touch field if the new value is different from the old value.
(NOTE that values must be identical to avoid touching the field!)
The documentation for this class was generated from the following file:
- MeVis/Foundation/Sources/ML/include/mlFields.h
