Cylinder.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_CYLINDER_HH_
18 #define SDF_CYLINDER_HH_
19 
20 #include <ignition/math/Cylinder.hh>
21 #include <sdf/Error.hh>
22 #include <sdf/Element.hh>
23 #include <sdf/sdf_config.h>
24 
25 namespace sdf
26 {
27  // Inline bracket to help doxygen filtering.
28  inline namespace SDF_VERSION_NAMESPACE {
29  //
30 
31  // Forward declare private data class.
32  class CylinderPrivate;
33 
37  {
39  public: Cylinder();
40 
43  public: Cylinder(const Cylinder &_cylinder);
44 
47  public: Cylinder(Cylinder &&_cylinder) noexcept;
48 
50  public: virtual ~Cylinder();
51 
55  public: Cylinder &operator=(Cylinder &&_cylinder);
56 
60  public: Cylinder &operator=(const Cylinder &_cylinder);
61 
68  public: Errors Load(ElementPtr _sdf);
69 
72  public: double Radius() const;
73 
76  public: void SetRadius(const double _radius);
77 
80  public: double Length() const;
81 
84  public: void SetLength(const double _length);
85 
90  public: sdf::ElementPtr Element() const;
91 
94  public: const ignition::math::Cylinderd &Shape() const;
95 
98  public: ignition::math::Cylinderd &Shape();
99 
101  private: CylinderPrivate *dataPtr;
102  };
103  }
104 }
105 #endif
class SDFORMAT_VISIBLE Element
Definition: Element.hh:49
Cylinder represents a cylinder shape, and is usually accessed through a Geometry. ...
Definition: Cylinder.hh:36
std::shared_ptr< Element > ElementPtr
Definition: Element.hh:53
std::vector< Error > Errors
A vector of Error.
Definition: Types.hh:89
#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