Plane.hh
Go to the documentation of this file.
1 /*
2  * Copyright 2018 Open Source Robotics Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *
16  */
17 #ifndef SDF_PLANE_HH_
18 #define SDF_PLANE_HH_
19 
20 #include <ignition/math/Plane.hh>
21 #include <ignition/math/Vector3.hh>
22 #include <ignition/math/Vector2.hh>
23 #include <sdf/Error.hh>
24 #include <sdf/Element.hh>
25 #include <sdf/sdf_config.h>
26 
27 namespace sdf
28 {
29  // Inline bracket to help doxygen filtering.
30  inline namespace SDF_VERSION_NAMESPACE {
31  //
32 
33  // Forward declare private data class.
34  class PlanePrivate;
35 
39  {
41  public: Plane();
42 
45  public: Plane(const Plane &_plane);
46 
49  public: Plane(Plane &&_plane) noexcept;
50 
52  public: virtual ~Plane();
53 
57  public: Plane &operator=(Plane &&_plane);
58 
62  public: Plane &operator=(const Plane &_plane);
63 
70  public: Errors Load(ElementPtr _sdf);
71 
76  public: ignition::math::Vector3d Normal() const;
77 
82  public: void SetNormal(const ignition::math::Vector3d &_normal);
83 
86  public: ignition::math::Vector2d Size() const;
87 
90  public: void SetSize(const ignition::math::Vector2d &_size);
91 
96  public: sdf::ElementPtr Element() const;
97 
100  public: const ignition::math::Planed &Shape() const;
101 
104  public: ignition::math::Planed &Shape();
105 
107  private: PlanePrivate *dataPtr;
108  };
109  }
110 }
111 #endif
class SDFORMAT_VISIBLE Element
Definition: Element.hh:49
Plane represents a plane shape, and is usually accessed through a Geometry.
Definition: Plane.hh:38
std::shared_ptr< Element > ElementPtr
Definition: Element.hh:53
std::vector< Error > Errors
A vector of Error.
Definition: Types.hh:74
#define SDFORMAT_VISIBLE
Use to represent "symbol visible" if supported.
Definition: system_util.hh:48
namespace for Simulation Description Format parser
Definition: Actor.hh:32