TorusStateSpace.h

/*********************************************************************
 * Software License Agreement (BSD License)
 *
 *  Copyright (c) 2021,
 *  Max Planck Institute for Intelligent Systems (MPI-IS).
 *  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 MPI-IS 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 OWNER 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.
 *********************************************************************/
 
/* Author: Andreas Orthey */
 
#ifndef OMPL_BASE_SPACES_TORUS_STATE_SPACE_
#define OMPL_BASE_SPACES_TORUS_STATE_SPACE_
 
#include <ompl/base/StateSpace.h>
#include <ompl/base/spaces/SO2StateSpace.h>
 
namespace ompl
{
    namespace base
    {
        class TorusStateSampler : public StateSampler
        {
        public:
            TorusStateSampler(const StateSpace *space);
 
            void sampleUniform(State *state) override;
 
            void sampleUniformNear(State *state, const State *near, double distance) override;
 
            void sampleGaussian(State *state, const State *mean, double stdDev) override;
        };
 
        class TorusStateSpace : public CompoundStateSpace
        {
        public:
            class StateType : public CompoundStateSpace::StateType
            {
            public:
                StateType() = default;
 
                double getS1() const
                {
                    return as<SO2StateSpace::StateType>(0)->value;
                }
                double getS2() const
                {
                    return as<SO2StateSpace::StateType>(1)->value;
                }
 
                void setS1(double s)
                {
                    as<SO2StateSpace::StateType>(0)->value = s;
                }
                void setS2(double s)
                {
                    as<SO2StateSpace::StateType>(1)->value = s;
                }
                void setS1S2(double s, double t)
                {
                    setS1(s);
                    setS2(t);
                }
            };
 
            TorusStateSpace(double majorRadius = 1, double minorRadius = 0.5);
 
            virtual ~TorusStateSpace() override = default;
 
            StateSamplerPtr allocDefaultStateSampler() const override;
 
            double distance(const State *state1, const State *state2) const override;
 
            State *allocState() const override;
 
            double getMajorRadius() const;
 
            double getMinorRadius() const;
 
            /* \brief Convert a state to a 3D vector to visualize the state
             * space. */
            Eigen::Vector3f toVector(const State *state) const;
 
        private:
            double majorRadius_;
 
            double minorRadius_;
        };
    }
}
 
#endif