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 <ignition/utils/ImplPtr.hh>
22#include <sdf/Error.hh>
23#include <sdf/Element.hh>
24#include <sdf/sdf_config.h>
25
26namespace sdf
27{
28 // Inline bracket to help doxygen filtering.
29 inline namespace SDF_VERSION_NAMESPACE {
33 {
35 public: Cylinder();
36
43 public: Errors Load(ElementPtr _sdf);
44
47 public: double Radius() const;
48
51 public: void SetRadius(const double _radius);
52
55 public: double Length() const;
56
59 public: void SetLength(const double _length);
60
65 public: sdf::ElementPtr Element() const;
66
69 public: const ignition::math::Cylinderd &Shape() const;
70
73 public: ignition::math::Cylinderd &Shape();
74
76 IGN_UTILS_IMPL_PTR(dataPtr)
77 };
78 }
79}
80#endif
Cylinder represents a cylinder shape, and is usually accessed through a Geometry.
Definition: Cylinder.hh:33
double Radius() const
Get the cylinder's radius in meters.
Errors Load(ElementPtr _sdf)
Load the cylinder geometry based on a element pointer.
Cylinder()
Constructor.
double Length() const
Get the cylinder's length in meters.
void SetRadius(const double _radius)
Set the cylinder's radius in meters.
ignition::math::Cylinderd & Shape()
Get a mutable Ignition Math representation of this Cylinder.
sdf::ElementPtr Element() const
Get a pointer to the SDF element that was used during load.
void SetLength(const double _length)
Set the cylinder's length in meters.
const ignition::math::Cylinderd & Shape() const
Get the Ignition Math representation of this Cylinder.
std::vector< Error > Errors
A vector of Error.
Definition: Types.hh:106
std::shared_ptr< Element > ElementPtr
Definition: Element.hh:54
namespace for Simulation Description Format parser
Definition: Actor.hh:34
#define SDFORMAT_VISIBLE
Use to represent "symbol visible" if supported.
Definition: system_util.hh:41