point.h

Go to the documentation of this file.

/*
 MCL
 Copyright (c) 2012-18, Enzo De Sena
 All rights reserved.
 
 Authors: Enzo De Sena, enzodesena@gmail.com
 */

#ifndef MCL_POINT_H
#define MCL_POINT_H

#include "mcltypes.h"

namespace mcl {

class Triplet {
public:
  Triplet() noexcept;
  
  Triplet(Real x, Real y, Real z) noexcept;
  
  bool Equals(const Triplet& other_point) const noexcept;
  
  // Getter methods.
  Real x() const noexcept { return x_; }
  Real y() const noexcept { return y_; }
  Real z() const noexcept { return z_; }

  void SetX(const Real value) noexcept { x_ = value; }
  void SetY(const Real value) noexcept { y_ = value; }
  void SetZ(const Real value) noexcept { z_ = value; }

  Real norm() const noexcept;
  
  Real theta() const noexcept;
  
  Real phi() const noexcept;
  
  void Normalize() noexcept;

private:
  Real x_;
  Real y_;
  Real z_;
};
  
  
  
typedef Triplet Point;
  
Point RotateAboutX(const Point&, Real) noexcept;

Point RotateAboutY(const Point&, Real) noexcept;

Point RotateAboutZ(const Point&, Real) noexcept;

Point Rotate(const Point&, Real phi,
                     Real theta, Real psi) noexcept;

Real DotProduct(Point, Point) noexcept;
Real Distance(Point, Point) noexcept;
Real Theta(Point, Point) noexcept;
Real Phi(Point, Point) noexcept;
Real AngleBetweenDirections(Real theta_a, Real phi_a,
                                   Real theta_b, Real phi_b) noexcept;
Real AngleBetweenPoints(Point, Point) noexcept;

Point PointOnLine(const Point point_a, const Point point_b,
                          const Real distance) noexcept;

Point Sum(const Point point_a, const Point point_b) noexcept;

Point Subtract(const Point point_a, const Point point_b) noexcept;

Point Multiply(const Point point, const Real constant) noexcept;

Point PointSpherical(Real r, Real theta, Real phi) noexcept;

Point Projection(const Point& vector,
                         const Point& plane_normal_vector) noexcept;

Point Normalized(Point point) noexcept;

Point IntersectionPlaneLine(const Point& line_point,
                            const Point& line_direction,
                            const Point& plane_point,
                            const Point& plane_normal) noexcept;

bool IntersectionPlaneLineExists(const Point& line_point,
                                 const Point& line_direction,
                                 const Point& plane_point,
                                 const Point& plane_normal) noexcept;
  
bool PointTest();
  
  
} // namespace mcl

#endif