Loading...
Searching...
No Matches
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/Box.hh>
21#include <ignition/math/Vector3.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 {
30 //
31 // Forward declare private data class.
32 class BoxPrivate;
33
37 {
39 public: Box();
40
43 public: Box(const Box &_box);
44
47 public: Box(Box &&_box) noexcept;
48
52 public: Box &operator=(Box &&_box);
53
55 public: virtual ~Box();
56
60 public: Box &operator=(const Box &_box);
61
68 public: Errors Load(ElementPtr _sdf);
69
72 public: ignition::math::Vector3d Size() const;
73
76 public: void SetSize(const ignition::math::Vector3d &_size);
77
82 public: sdf::ElementPtr Element() const;
83
86 public: const ignition::math::Boxd &Shape() const;
87
90 public: ignition::math::Boxd &Shape();
91
93 private: BoxPrivate *dataPtr;
94 };
95 }
96}
97
98#endif
Box represents a box shape, and is usually accessed through a Geometry.
Definition Box.hh:37
sdf::ElementPtr Element() const
Get a pointer to the SDF element that was used during load.
void SetSize(const ignition::math::Vector3d &_size)
Set the box size in meters.
ignition::math::Vector3d Size() const
Get the box size in meters.
Box(const Box &_box)
Copy constructor.
Box & operator=(const Box &_box)
Assignment operator.
Box(Box &&_box) noexcept
Move constructor.
Box & operator=(Box &&_box)
Move assignment operator.
Box()
Constructor.
const ignition::math::Boxd & Shape() const
Get the Ignition Math representation of this Box.
virtual ~Box()
Destructor.
ignition::math::Boxd & Shape()
Get a mutable Ignition Math representation of this Box.
Errors Load(ElementPtr _sdf)
Load the box geometry based on a element pointer.
std::vector< Error > Errors
A vector of Error.
Definition Types.hh:89
std::shared_ptr< Element > ElementPtr
Definition Element.hh:53
namespace for Simulation Description Format parser
Definition Actor.hh:33
#define SDFORMAT_VISIBLE
Use to represent "symbol visible" if supported.
Definition system_util.hh:48