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 <gz/math/Plane.hh>
21 #include <gz/math/Vector3.hh>
22 #include <gz/math/Vector2.hh>
23 #include <gz/utils/ImplPtr.hh>
24 #include <sdf/Error.hh>
25 #include <sdf/Element.hh>
26 #include <sdf/sdf_config.h>
27 
28 namespace sdf
29 {
30  // Inline bracket to help doxygen filtering.
31  inline namespace SDF_VERSION_NAMESPACE {
32  //
33 
37  {
39  public: Plane();
40 
47  public: Errors Load(ElementPtr _sdf);
48 
53  public: gz::math::Vector3d Normal() const;
54 
59  public: void SetNormal(const gz::math::Vector3d &_normal);
60 
63  public: gz::math::Vector2d Size() const;
64 
67  public: void SetSize(const gz::math::Vector2d &_size);
68 
73  public: sdf::ElementPtr Element() const;
74 
77  public: const gz::math::Planed &Shape() const;
78 
81  public: gz::math::Planed &Shape();
82 
88  public: sdf::ElementPtr ToElement() const;
89 
96  public: sdf::ElementPtr ToElement(sdf::Errors &_errors) const;
97 
99  GZ_UTILS_IMPL_PTR(dataPtr)
100  };
101  }
102 }
103 #endif
Plane represents a plane shape, and is usually accessed through a Geometry.
Definition: Plane.hh:37
gz::math::Planed & Shape()
Get a mutable Gazebo Math representation of this Plane.
const gz::math::Planed & Shape() const
Get the Gazebo Math representation of this Plane.
sdf::ElementPtr Element() const
Get a pointer to the SDF element that was used during load.
gz::math::Vector3d Normal() const
Get the plane normal vector.
Errors Load(ElementPtr _sdf)
Load the plane geometry based on a element pointer.
sdf::ElementPtr ToElement(sdf::Errors &_errors) const
Create and return an SDF element filled with data from this plane.
sdf::ElementPtr ToElement() const
Create and return an SDF element filled with data from this plane.
void SetSize(const gz::math::Vector2d &_size)
Set the plane size in meters.
gz::math::Vector2d Size() const
Get the plane size in meters.
void SetNormal(const gz::math::Vector3d &_normal)
Set the plane normal vector.
std::vector< Error > Errors
A vector of Error.
Definition: Types.hh:95
std::shared_ptr< Element > ElementPtr
Definition: Element.hh:55
namespace for Simulation Description Format parser
Definition: Actor.hh:35
#define SDFORMAT_VISIBLE
Use to represent "symbol visible" if supported.
Definition: system_util.hh:25