Program Listing for File rotation.hpp

↰ Return to documentation for file (include/tf2_2d/rotation.hpp)

/*
 * Software License Agreement (BSD License)
 *
 *  Copyright (c) 2019, Locus Robotics
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above
 *     copyright notice, this list of conditions and the following
 *     disclaimer in the documentation and/or other materials provided
 *     with the distribution.
 *   * Neither the name of the copyright holder nor the names of its
 *     contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 *  COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 *  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 *  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *  POSSIBILITY OF SUCH DAMAGE.
 */
#ifndef TF2_2D__ROTATION_HPP_
#define TF2_2D__ROTATION_HPP_

#include <tf2/LinearMath/Scalar.h>
#include <Eigen/Core>

#include <tf2_2d/vector2.hpp>


namespace tf2_2d
{

class Rotation
{
public:
  Rotation();

  explicit Rotation(const tf2Scalar angle);

  Rotation operator-() const;

  Rotation & operator+=(const Rotation & rhs);

  Rotation & operator-=(const Rotation & rhs);

  Rotation & operator*=(const tf2Scalar rhs);

  Rotation & operator/=(const tf2Scalar rhs);

  bool operator==(const Rotation & other) const;

  bool operator!=(const Rotation & other) const;

  tf2Scalar distance2(const Rotation & other) const;

  tf2Scalar distance(const Rotation & other) const;

  Vector2 rotate(const Vector2 & vec) const;

  Vector2 unrotate(const Vector2 & vec) const;

  Rotation inverse() const;

  Rotation absolute() const;

  Rotation lerp(const Rotation & other, const tf2Scalar ratio) const;

  const tf2Scalar & getAngle() const;
  const tf2Scalar & angle() const {return getAngle();}

  void setAngle(const tf2Scalar angle);

  void setMax(const Rotation & other);

  void setMin(const Rotation & other);

  void setValue(const tf2Scalar angle);

  void setZero();

  bool isZero() const;

  bool fuzzyZero() const;

  Eigen::Matrix2d getRotationMatrix() const;

  Eigen::Matrix3d getHomogeneousMatrix() const;

private:
  tf2Scalar angle_;
  mutable tf2Scalar cos_angle_;
  mutable tf2Scalar sin_angle_;

  Rotation(const tf2Scalar angle, tf2Scalar cos_angle, tf2Scalar sin_angle);

  Rotation & wrap();

  void populateTrigCache() const;
};

Rotation operator+(Rotation lhs, const Rotation & rhs);

Rotation operator-(Rotation lhs, const Rotation & rhs);

Rotation operator*(Rotation lhs, const tf2Scalar rhs);

Rotation operator*(const tf2Scalar lhs, Rotation rhs);

Rotation operator/(Rotation lhs, const tf2Scalar rhs);

Vector2 operator*(const Rotation & lhs, const Vector2 & rhs);

std::ostream & operator<<(std::ostream & stream, const Rotation & rotation);

}  // namespace tf2_2d

#include <tf2_2d/rotation_impl.hpp>

#endif  // TF2_2D__ROTATION_HPP_