libignition-math2-dev 2.9.0+dfsg1-1 / usr / include / ignition / math2 / ignition / math / RotationSpline.hh

This file is indexed.

/usr/include/ignition/math2/ignition/math/RotationSpline.hh is in libignition-math2-dev 2.9.0+dfsg1-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
/*
 * Copyright (C) 2012-2014 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_ROTATIONSPLINE_HH_
#define IGNITION_MATH_ROTATIONSPLINE_HH_

#include <ignition/math/IndexException.hh>
#include <ignition/math/Quaternion.hh>

namespace ignition
{
  namespace math
  {
    // Forward declare private data
    class RotationSplinePrivate;

    /// \class RotationSpline RotationSpline.hh ignition/math/RotationSpline.hh
    /// \brief Spline for rotations
    class IGNITION_VISIBLE  RotationSpline
    {
      /// \brief Constructor. Sets the autoCalc to true
      public: RotationSpline();

      /// \brief Destructor. Nothing is done
      public: ~RotationSpline();

      /// \brief Adds a control point to the end of the spline.
      /// \param[in] _p control point
      public: void AddPoint(const Quaterniond &_p);

      /// \brief Gets the detail of one of the control points of the spline.
      /// \param[in] _index the index of the control point.
      /// \remarks This point must already exist in the spline.
      /// \throws IndexException if _index >= PointCount()
      /// \return a quaternion (out of bound index result in assertion)
      public: const Quaterniond &Point(unsigned int _index) const;

      /// \brief Gets the number of control points in the spline.
      /// \return the count
      public: unsigned int PointCount() const;

      /// \brief Clears all the points in the spline.
      public: void Clear();

      /// \brief Updates a single point in the spline.
      /// \remarks This point must already exist in the spline.
      /// \param[in] _index index
      /// \param[in] _value the new control point value
      /// \throws IndexException if _index >= PointCount()
      public: void UpdatePoint(unsigned int _index, const Quaterniond &_value);

      /// \brief Returns an interpolated point based on a parametric
      ///        value over the whole series.
      /// \remarks Given a t value between 0 and 1 representing the
      ///          parametric distance along the whole length of the spline,
      ///          this method returns an interpolated point.
      /// \param[in] _t Parametric value.
      /// \param[in] _useShortestPath Defines if rotation should take the
      ///        shortest possible path
      /// \return the rotation
      public: Quaterniond Interpolate(double _t, bool _useShortestPath = true);

      /// \brief Interpolates a single segment of the spline
      ///        given a parametric value.
      /// \param[in] _fromIndex The point index to treat as t = 0.
      ///        _fromIndex + 1 is deemed to be t = 1
      /// \param[in] _t Parametric value
      /// \param[in] _useShortestPath Defines if rotation should take the
      ///         shortest possible path
      /// \throws IndexException if _fromIndex >= PointCount()
      /// \return the rotation
      public: Quaterniond Interpolate(unsigned int _fromIndex, double _t,
          bool _useShortestPath = true);

      /// \brief Tells the spline whether it should automatically calculate
      ///        tangents on demand as points are added.
      /// \remarks The spline calculates tangents at each point automatically
      ///          based on the input points.  Normally it does this every
      ///          time a point changes. However, if you have a lot of points
      ///          to add in one go, you probably don't want to incur this
      ///          overhead and would prefer to defer the calculation until
      ///          you are finished setting all the points. You can do this
      ///          by calling this method with a parameter of 'false'. Just
      ///          remember to manually call the recalcTangents method when
      ///          you are done.
      /// \param[in] _autoCalc If true, tangents are calculated for you
      /// whenever a point changes. If false, you must call reclacTangents to
      /// recalculate them when it best suits.
      public: void AutoCalculate(bool _autoCalc);

      /// \brief Recalculates the tangents associated with this spline.
      /// \remarks If you tell the spline not to update on demand by calling
      /// setAutoCalculate(false) then you must call this after
      /// completing your updates to the spline points.
      public: void RecalcTangents();

      /// \brief Private data pointer
      private: RotationSplinePrivate *dataPtr;
    };
  }
}

#endif

APT Browse - Built by Thomas Orozco.