BLI_math_axis_angle_types.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#pragma once

 
#include <ostream>
 
#include "BLI_math_angle_types.hh"
#include "BLI_math_basis_types.hh"
#include "BLI_math_vector_types.hh"
 
namespace blender::math {
 
template<typename T, typename AngleT> struct AxisAngleBase {
  using vec3_type = VecBase<T, 3>;
 
 private:
  vec3_type axis_ = {0, 1, 0};
  AngleT angle_ = AngleT::identity();
 
 public:
  AxisAngleBase() = default;

  AxisAngleBase(const AxisSigned axis, const AngleT &angle);

  AxisAngleBase(const vec3_type &axis, const AngleT &angle);

  AxisAngleBase(const vec3_type &from, const vec3_type &to);

 
  static AxisAngleBase identity()
  {
    return {};
  }

 
  const vec3_type &axis() const
  {
    return axis_;
  }
 
  const AngleT &angle() const
  {
    return angle_;
  }

 
  BLI_STRUCT_EQUALITY_OPERATORS_2(AxisAngleBase, axis_, angle_)
 
  friend std::ostream &operator<<(std::ostream &stream, const AxisAngleBase &rot)
  {
    return stream << "AxisAngle(axis=" << rot.axis() << ", angle=" << rot.angle() << ")";
  }
};
 
using AxisAngle = AxisAngleBase<float, AngleRadianBase<float>>;
using AxisAngleCartesian = AxisAngleBase<float, AngleCartesianBase<float>>;
 
}  // namespace blender::math