SphericalCoordinates.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2012 Open Source Robotics Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
*/
#ifndef IGNITION_MATH_SPHERICALCOORDINATES_HH_
#define IGNITION_MATH_SPHERICALCOORDINATES_HH_

#include <memory>
#include <string>

#include <ignition/math/Angle.hh>
#include <ignition/math/Vector3.hh>
#include <ignition/math/Helpers.hh>
#include <ignition/math/config.hh>

namespace ignition
{
  namespace math
  {
    // Inline bracket to help doxygen filtering.
    inline namespace IGNITION_MATH_VERSION_NAMESPACE {
    //
    class SphericalCoordinatesPrivate;

    class IGNITION_MATH_VISIBLE SphericalCoordinates
    {
      public: enum SurfaceType
              {
                EARTH_WGS84 = 1
              };

      public: enum CoordinateType
              {
                SPHERICAL = 1,

                ECEF = 2,

                GLOBAL = 3,

                LOCAL = 4,

                LOCAL2 = 5
              };

      public: SphericalCoordinates();

      public: explicit SphericalCoordinates(const SurfaceType _type);

      public: SphericalCoordinates(const SurfaceType _type,
                                   const ignition::math::Angle &_latitude,
                                   const ignition::math::Angle &_longitude,
                                   const double _elevation,
                                   const ignition::math::Angle &_heading);

      public: SphericalCoordinates(const SphericalCoordinates &_sc);

      public: ~SphericalCoordinates();

      public: ignition::math::Vector3d SphericalFromLocalPosition(
                  const ignition::math::Vector3d &_xyz) const;

      public: ignition::math::Vector3d GlobalFromLocalVelocity(
                  const ignition::math::Vector3d &_xyz) const;

      public: static SurfaceType Convert(const std::string &_str);

      public: static std::string Convert(SurfaceType _type);

      public: static double Distance(const ignition::math::Angle &_latA,
                                     const ignition::math::Angle &_lonA,
                                     const ignition::math::Angle &_latB,
                                     const ignition::math::Angle &_lonB);

      public: SurfaceType Surface() const;

      public: ignition::math::Angle LatitudeReference() const;

      public: ignition::math::Angle LongitudeReference() const;

      public: double ElevationReference() const;

      public: ignition::math::Angle HeadingOffset() const;

      public: void SetSurface(const SurfaceType &_type);

      public: void SetLatitudeReference(const ignition::math::Angle &_angle);

      public: void SetLongitudeReference(const ignition::math::Angle &_angle);

      public: void SetElevationReference(const double _elevation);

      public: void SetHeadingOffset(const ignition::math::Angle &_angle);

      public: ignition::math::Vector3d LocalFromSphericalPosition(
                  const ignition::math::Vector3d &_latLonEle) const;

      public: ignition::math::Vector3d LocalFromGlobalVelocity(
                  const ignition::math::Vector3d &_xyz) const;

      public: void UpdateTransformationMatrix();

      public: ignition::math::Vector3d
              PositionTransform(const ignition::math::Vector3d &_pos,
                  const CoordinateType &_in, const CoordinateType &_out) const;

      public: ignition::math::Vector3d VelocityTransform(
                  const ignition::math::Vector3d &_vel,
                  const CoordinateType &_in, const CoordinateType &_out) const;

      public: bool operator==(const SphericalCoordinates &_sc) const;

      public: bool operator!=(const SphericalCoordinates &_sc) const;

      public: SphericalCoordinates &operator=(
        const SphericalCoordinates &_sc);


#ifdef _WIN32
// Disable warning C4251 which is triggered by
// std::unique_ptr
#pragma warning(push)
#pragma warning(disable: 4251)
#endif
      private: std::unique_ptr<SphericalCoordinatesPrivate> dataPtr;
#ifdef _WIN32
#pragma warning(pop)
#endif
    };
    }
  }
}
#endif