Mech-Eye API 2.4.0
API reference documentation for Mech-Eye 3D Laser Profiler
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Public Attributes | List of all members
mmind::eye::FrameTransformation Struct Reference

Defines the rigid body transformations from one reference frame to another, including the rotation matrix and translation vector. More...

#include <CommonTypes.h>

Public Types

enum class  Axis { X , Y , Z }
 

Public Member Functions

 FrameTransformation (double rotateX, double rotateY, double rotateZ, double translateX, double translateY, double translateZ)
 
 FrameTransformation (const FrameTransformation &rhs)
 
FrameTransformationoperator= (const FrameTransformation &rhs)
 
void rotate (double theta, Axis rotationAxis)
 Rotates the reference frame of the point cloud.
 
void translate (double x, double y, double z)
 Translates the reference frame of the point cloud.
 
bool isValid () const
 Check if a custom reference frame has been set using Mech-Eye Viewer.
 

Public Attributes

double rotation [3][3] = {{1, 0, 0}, {0, 1, 0}, {0, 0, 1}}
 3*3 rotation matrix.
 
double translation [3] = {0, 0, 0}
 3*1 translation vector in [x(mm), y(mm), z(mm)].
 

Detailed Description

Defines the rigid body transformations from one reference frame to another, including the rotation matrix and translation vector.

Definition at line 91 of file CommonTypes.h.

Member Enumeration Documentation

◆ Axis

enum class mmind::eye::FrameTransformation::Axis
strong

Definition at line 120 of file CommonTypes.h.

Constructor & Destructor Documentation

◆ FrameTransformation() [1/2]

mmind::eye::FrameTransformation::FrameTransformation ( double rotateX,
double rotateY,
double rotateZ,
double translateX,
double translateY,
double translateZ )
inline

Definition at line 95 of file CommonTypes.h.

◆ FrameTransformation() [2/2]

mmind::eye::FrameTransformation::FrameTransformation ( const FrameTransformation & rhs)
inline

Definition at line 104 of file CommonTypes.h.

Member Function Documentation

◆ isValid()

bool mmind::eye::FrameTransformation::isValid ( ) const
inline

Check if a custom reference frame has been set using Mech-Eye Viewer.

Definition at line 173 of file CommonTypes.h.

◆ operator=()

FrameTransformation & mmind::eye::FrameTransformation::operator= ( const FrameTransformation & rhs)
inline

Definition at line 110 of file CommonTypes.h.

◆ rotate()

void mmind::eye::FrameTransformation::rotate ( double theta,
Axis rotationAxis )
inline

Rotates the reference frame of the point cloud.

Parameters
[in]thetaThe amount of rotation.
[in]rotationAxisThe axis around which the rotation is performed. X-, Y-, and Z-Axes can be input.

Definition at line 128 of file CommonTypes.h.

◆ translate()

void mmind::eye::FrameTransformation::translate ( double x,
double y,
double z )
inline

Translates the reference frame of the point cloud.

Parameters
[in]xThe amount of translation (in mm) along the X-axis.
[in]yThe amount of translation (in mm) along the Y-axis.
[in]zThe amount of translation (in mm) along the Z-axis.

Definition at line 163 of file CommonTypes.h.

Member Data Documentation

◆ rotation

double mmind::eye::FrameTransformation::rotation[3][3] = {{1, 0, 0}, {0, 1, 0}, {0, 0, 1}}

3*3 rotation matrix.

Definition at line 197 of file CommonTypes.h.

◆ translation

double mmind::eye::FrameTransformation::translation[3] = {0, 0, 0}

3*1 translation vector in [x(mm), y(mm), z(mm)].

Definition at line 198 of file CommonTypes.h.


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