Sphere.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_SPHERE_HH_
18 #define SDF_SPHERE_HH_
19 
20 #include <gz/math/Sphere.hh>
21 #include <gz/utils/ImplPtr.hh>
22 
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 {
34  {
36  public: Sphere();
37 
44  public: Errors Load(ElementPtr _sdf);
45 
48  public: double Radius() const;
49 
52  public: void SetRadius(const double _radius);
53 
56  public: const gz::math::Sphered &Shape() const;
57 
60  public: gz::math::Sphered &Shape();
61 
66  public: sdf::ElementPtr Element() const;
67 
73  public: sdf::ElementPtr ToElement() const;
74 
81  public: sdf::ElementPtr ToElement(sdf::Errors &_errors) const;
82 
84  GZ_UTILS_IMPL_PTR(dataPtr)
85  };
86  }
87 }
88 #endif
Error.hh
sdf
namespace for Simulation Description Format parser
Definition: Actor.hh:34
sdf_config.h
SDFORMAT_VISIBLE
#define SDFORMAT_VISIBLE
Definition: system_util.hh:25
sdf::SDF_VERSION_NAMESPACE::Element
class GZ_SDFORMAT_VISIBLE Element
Definition: Element.hh:51
sdf::SDF_VERSION_NAMESPACE::Errors
std::vector< Error > Errors
A vector of Error.
Definition: Types.hh:80
sdf::SDF_VERSION_NAMESPACE::Sphere
Sphere represents a sphere shape, and is usually accessed through a Geometry.
Definition: Sphere.hh:33
sdf::SDF_VERSION_NAMESPACE::ElementPtr
std::shared_ptr< Element > ElementPtr
Definition: Element.hh:55
Element.hh