CMS/Marlin
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Adds missing documentation to the point_t structure

Browse Source
This commit is contained in:
João Brázio 2016-07-22 15:19:20 +01:00
parent 39caef4279
commit efd3aabda8
1 changed files with 32 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
Marlin/point_t.h
View File

@ -23,18 +23,49 @@
#ifndef __POINT_T__ #ifndef __POINT_T__
#define __POINT_T__ #define __POINT_T__
/**
* @brief Cartesian Point
* @details Represents a three dimensional point on Cartesian coordinate system,
* using an additional fourth dimension for the extrusion length.
*
* @param x The x-coordinate of the point.
* @param y The y-coordinate of the point.
* @param z The z-coordinate of the point.
* @param e The e-coordinate of the point.
*/
struct point_t { struct point_t {
float x; float x;
float y; float y;
float z; float z;
float e; float e;
/**
* @brief Two dimensional point constructor
*
* @param x The x-coordinate of the point.
* @param y The y-coordinate of the point.
*/
point_t(float const x, float const y) point_t(float const x, float const y)
: point_t(x, y, NAN, NAN) {} : point_t(x, y, NAN, NAN) {}
/**
* @brief Three dimensional point constructor
*
* @param x The x-coordinate of the point.
* @param y The y-coordinate of the point.
* @param z The z-coordinate of the point.
*/
point_t(float const x, float const y, float const z) point_t(float const x, float const y, float const z)
: point_t(x, y, z, NAN) {} : point_t(x, y, z, NAN) {}
/**
* @brief Tree dimensional point constructor with extrusion length
*
* @param x The x-coordinate of the point.
* @param y The y-coordinate of the point.
* @param z The z-coordinate of the point.
* @param e The e-coordinate of the point.
*/
point_t(float const x, float const y, float const z, float const e) { point_t(float const x, float const y, float const z, float const e) {
this->x = x; this->x = x;
this->y = y; this->y = y;
@ -43,4 +74,4 @@ struct point_t {
} }
}; };
#endif #endif // __POINT_T__