72 lines
2.4 KiB
C++
72 lines
2.4 KiB
C++
/// This Source Code Form is subject to the terms of the Mozilla Public
|
|
/// License, v. 2.0.If a copy of the MPL was not distributed with this
|
|
/// file, You can obtain one at https ://mozilla.org/MPL/2.0/.
|
|
|
|
#ifndef SPHERICAL_H
|
|
#define SPHERICAL_H
|
|
|
|
#include "Angle.h"
|
|
#include "Polar.h"
|
|
|
|
namespace Passer {
|
|
|
|
struct Vector3;
|
|
|
|
/// @brief A spherical vector
|
|
/// @details
|
|
/// This is a vector in 3D space using a spherical coordinate system.
|
|
/// It consists of a distance and the polar and elevation angles from a
|
|
/// reference direction. The reference direction is typically thought of
|
|
/// as a forward direction.
|
|
struct Spherical {
|
|
public:
|
|
/// @brief The distance in meters
|
|
/// @remark The distance should never be negative
|
|
float distance;
|
|
/// @brief The angle in the horizontal plane in degrees, clockwise rotation
|
|
/// @details The angle is automatically normalized to -180 .. 180
|
|
Angle horizontalAngle;
|
|
/// @brief The angle in the vertical plane in degrees. Positive is upward.
|
|
/// @details The angle is automatically normalized to -180 .. 180
|
|
Angle verticalAngle;
|
|
|
|
/// @brief Create a new spherical vector with zero degrees and distance
|
|
Spherical();
|
|
/// @brief Create a new spherical vector
|
|
/// @param distance The distance in meters
|
|
/// @param horizontalAngle The angle in the horizontal plane in degrees,
|
|
/// clockwise rotation
|
|
/// @param verticalAngle The angle in the vertical plan in degrees,
|
|
/// zero is forward, positive is upward
|
|
Spherical(float distance, Angle horizontalAngle, Angle verticalAngle);
|
|
/// @brief Convert polar coordinates to spherical coordinates
|
|
/// @param polar The polar coordinate
|
|
Spherical(Polar polar);
|
|
/// @brief Convert 3D carthesian coordinates to spherical coordinates
|
|
/// @param v Vector in 3D carthesian coordinates;
|
|
Spherical(Vector3 v);
|
|
|
|
/// @brief A spherical vector with zero degree angles and distance
|
|
const static Spherical zero;
|
|
|
|
/// @brief Negate the vector
|
|
/// @return The negated vector
|
|
/// This will rotate the vector by 180 degrees horizontally and
|
|
/// vertically. Distance will stay the same.
|
|
Spherical operator-();
|
|
|
|
/// <summary>
|
|
/// The distance between two vectors
|
|
/// </summary>
|
|
/// <param name="v1">The first vector</param>
|
|
/// <param name="v2">The second vector</param>
|
|
/// <returns>The distance between the two vectors</returns>
|
|
// static float Distance(const Spherical &s1, const Spherical &s2);
|
|
};
|
|
|
|
} // namespace Passer
|
|
using namespace Passer;
|
|
|
|
#include "Vector3.h"
|
|
|
|
#endif |