Box.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_BOX_HH_
18 #define SDF_BOX_HH_
19 
20 #include <ignition/math/Vector3.hh>
21 #include <sdf/Error.hh>
22 #include <sdf/Element.hh>
23 #include <sdf/sdf_config.h>
24 
25 namespace sdf
26 {
27  // Inline bracke to help doxygen filtering.
28  inline namespace SDF_VERSION_NAMESPACE {
29  //
30  // Forward declare private data class.
31  class BoxPrivate;
32 
36  {
38  public: Box();
39 
42  public: Box(const Box &_box);
43 
46  public: Box(Box &&_box) noexcept;
47 
51  public: Box &operator=(Box &&_box);
52 
54  public: virtual ~Box();
55 
59  public: Box &operator=(const Box &_box);
60 
67  public: Errors Load(ElementPtr _sdf);
68 
71  public: ignition::math::Vector3d Size() const;
72 
75  public: void SetSize(const ignition::math::Vector3d &_size);
76 
81  public: sdf::ElementPtr Element() const;
82 
84  private: BoxPrivate *dataPtr;
85  };
86  }
87 }
88 
89 #endif
class SDFORMAT_VISIBLE Element
Definition: Element.hh:47
std::shared_ptr< Element > ElementPtr
Definition: Element.hh:51
std::vector< Error > Errors
A vector of Error.
Definition: Types.hh:74
Box represents a box shape, and is usually accessed through a Geometry.
Definition: Box.hh:35
#define SDFORMAT_VISIBLE
Use to represent "symbol visible" if supported.
Definition: system_util.hh:48
namespace for Simulation Description Format parser
Definition: AirPressure.hh:25