NodeTransform Class Reference
A transformation node. More...
#include <ignition/common/NodeTransform.hh>
Public Member Functions | |
| NodeTransform (const math::Matrix4d &_mat, const std::string &_sid="_default_", const NodeTransformType _type=MATRIX) | |
| Constructor. More... | |
| NodeTransform (const NodeTransform &_other) | |
| Copy constructor. More... | |
| NodeTransform (const NodeTransformType _type=MATRIX) | |
| Constructor. More... | |
| ~NodeTransform () | |
| Destructor. More... | |
| math::Matrix4d | Get () const |
| Returns the transformation matrix. More... | |
| math::Matrix4d | operator() () const |
| Matrix cast operator. More... | |
| math::Matrix4d | operator* (const math::Matrix4d &_m) const |
| Matrix multiplication operator. More... | |
| math::Matrix4d | operator* (const NodeTransform &_t) const |
| Node transform multiplication operator. More... | |
| NodeTransform & | operator= (const NodeTransform &_other) |
| Copy assignment. More... | |
| void | PrintSource () const |
| Prints the transform matrix to standard out. More... | |
| void | RecalculateMatrix () |
| Sets the transform matrix from the source according to the type. More... | |
| void | Set (const math::Matrix4d &_mat) |
| Assign a transformation. More... | |
| void | SetComponent (const unsigned int _idx, const double _value) |
| Set a transformation matrix component value. More... | |
| void | SetSID (const std::string &_sid) |
| Set the SID. More... | |
| void | SetSourceValues (const math::Matrix4d &_mat) |
| Set source data values. More... | |
| void | SetSourceValues (const math::Vector3d &_axis, const double _angle) |
| Sets source matrix values from roation. More... | |
| void | SetSourceValues (const math::Vector3d &_vec) |
| Set source data values. More... | |
| void | SetType (const NodeTransformType _type) |
| Set transform type. More... | |
| std::string | SID () const |
| Returns the SID. More... | |
| NodeTransformType | Type () const |
| Returns the transformation type. More... | |
Detailed Description
A transformation node.
Constructor & Destructor Documentation
◆ NodeTransform() [1/3]
|
explicit |
Constructor.
- Parameters
-
[in] _type the type of transform
◆ NodeTransform() [2/3]
| NodeTransform | ( | const NodeTransform & | _other | ) |
Copy constructor.
- Parameters
-
[in] _other NodeTransform to copy
◆ NodeTransform() [3/3]
| NodeTransform | ( | const math::Matrix4d & | _mat, |
| const std::string & | _sid = "_default_", |
||
| const NodeTransformType | _type = MATRIX |
||
| ) |
Constructor.
- Parameters
-
[in] _mat the matrix [in] _sid identifier [in] _type the type of transform
◆ ~NodeTransform()
| ~NodeTransform | ( | ) |
Destructor.
Member Function Documentation
◆ Get()
| math::Matrix4d Get | ( | ) | const |
Returns the transformation matrix.
- Returns
- the matrix
◆ operator()()
| math::Matrix4d operator() | ( | ) | const |
Matrix cast operator.
- Returns
- the transform
◆ operator*() [1/2]
| math::Matrix4d operator* | ( | const math::Matrix4d & | _m | ) | const |
Matrix multiplication operator.
- Parameters
-
[in] _m a matrix
- Returns
- transform matrix multiplied by _m
◆ operator*() [2/2]
| math::Matrix4d operator* | ( | const NodeTransform & | _t | ) | const |
Node transform multiplication operator.
- Parameters
-
[in] _t a transform
- Returns
- transform matrix multiplied by _t's transform
◆ operator=()
| NodeTransform& operator= | ( | const NodeTransform & | _other | ) |
Copy assignment.
- Parameters
-
[in] _ther NodeTransform to copy
◆ PrintSource()
| void PrintSource | ( | ) | const |
Prints the transform matrix to standard out.
◆ RecalculateMatrix()
| void RecalculateMatrix | ( | ) |
Sets the transform matrix from the source according to the type.
◆ Set()
| void Set | ( | const math::Matrix4d & | _mat | ) |
Assign a transformation.
- Parameters
-
[in] _mat the transform
◆ SetComponent()
| void SetComponent | ( | const unsigned int | _idx, |
| const double | _value | ||
| ) |
Set a transformation matrix component value.
- Parameters
-
[in] _idx the component index [in] _value the value
◆ SetSID()
| void SetSID | ( | const std::string & | _sid | ) |
Set the SID.
- Parameters
-
[in] _sid the sid
◆ SetSourceValues() [1/3]
| void SetSourceValues | ( | const math::Matrix4d & | _mat | ) |
Set source data values.
- Parameters
-
[in] _mat the values
◆ SetSourceValues() [2/3]
| void SetSourceValues | ( | const math::Vector3d & | _axis, |
| const double | _angle | ||
| ) |
Sets source matrix values from roation.
- Parameters
-
[in] _axis of rotation [in] _angle of rotation
◆ SetSourceValues() [3/3]
| void SetSourceValues | ( | const math::Vector3d & | _vec | ) |
Set source data values.
- Parameters
-
[in] _vec the values
◆ SetType()
| void SetType | ( | const NodeTransformType | _type | ) |
Set transform type.
- Parameters
-
[in] _type the type
◆ SID()
| std::string SID | ( | ) | const |
Returns the SID.
- Returns
- the SID
◆ Type()
| NodeTransformType Type | ( | ) | const |
Returns the transformation type.
- Returns
- the type
The documentation for this class was generated from the following file: