Plane.hh

Go to the documentation of this file.

/*
 * Copyright 2018 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 SDF_PLANE_HH_
#define SDF_PLANE_HH_

#include <ignition/math/Vector3.hh>
#include <ignition/math/Vector2.hh>
#include <sdf/Error.hh>
#include <sdf/Element.hh>
#include <sdf/sdf_config.h>

namespace sdf
{
  // Inline bracket to help doxygen filtering.
  inline namespace SDF_VERSION_NAMESPACE {
  //

  // Forward declare private data class.
  class PlanePrivate;

  class SDFORMAT_VISIBLE Plane
  {
    public: Plane();

    public: Plane(const Plane &_plane);

    public: Plane(Plane &&_plane) noexcept;

    public: virtual ~Plane();

    public: Plane &operator=(Plane &&_plane);

    public: Plane &operator=(const Plane &_plane);

    public: Errors Load(ElementPtr _sdf);

    public: ignition::math::Vector3d Normal() const;

    public: void SetNormal(const ignition::math::Vector3d &_normal);

    public: ignition::math::Vector2d Size() const;

    public: void SetSize(const ignition::math::Vector2d &_size);

    public: sdf::ElementPtr Element() const;

    private: PlanePrivate *dataPtr;
  };
  }
}
#endif