Box.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 GAZEBO_MATH_BOX_HH_
#define GAZEBO_MATH_BOX_HH_

#include <iostream>
#include <ignition/math/Box.hh>

#include "gazebo/math/Vector3.hh"
#include "gazebo/util/system.hh"

#ifndef _WIN32
  #pragma GCC diagnostic push
  #pragma GCC diagnostic ignored "-Wdeprecated-declarations"
#endif

namespace gazebo
{
  namespace math
  {

    // cppcheck-suppress noConstructor
    class GZ_MATH_VISIBLE Box
    {
      public: Box() GAZEBO_DEPRECATED(8.0);

      public: Box(const Vector3 &_vec1, const Vector3 &_vec2)
          GAZEBO_DEPRECATED(8.0);

      public: Box(const ignition::math::Box &_box) GAZEBO_DEPRECATED(8.0);

      public: Box(const Box &_b) GAZEBO_DEPRECATED(8.0);

      public: virtual ~Box();

      public: double GetXLength() const;

      public: double GetYLength() const;

      public: double GetZLength() const;

      public: math::Vector3 GetSize() const;

      public: math::Vector3 GetCenter() const;

      public: void Merge(const Box &_box);

      public: ignition::math::Box Ign() const;

      public: Box &operator=(const ignition::math::Box &_b);

      public: Box &operator =(const Box &_b);

      public: Box operator+(const Box &_b) const;

      public: const Box &operator+=(const Box &_b);

      public: bool operator==(const Box &_b) const;

      public: Box operator-(const Vector3 &_v);

      public: bool Contains(const math::Vector3 &_p) const;

      public: friend std::ostream &operator<<(std::ostream &_out,
                                               const gazebo::math::Box &_b)
      {
        _out << "Min[" << _b.min << "] Max[" << _b.max << "]";

        return _out;
      }

      public: Vector3 min;

      public: Vector3 max;

      private: enum Extent {EXTENT_NULL, EXTENT_FINITE};

      private: Extent extent;
    };
  }
}

#ifndef _WIN32
  #pragma GCC diagnostic pop
#endif
#endif