Gazebo Gazebo

API Reference

6.16.0
gz/sim/Primitives.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2021 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 
18 #ifndef GZ_GAZEBO_PRIMITIVES_HH_
19 #define GZ_GAZEBO_PRIMITIVES_HH_
20 
21 #include <gz/sim/config.hh>
22 #include <gz/sim/Export.hh>
23 
24 #include <string>
25 
26 namespace ignition
27 {
28  namespace gazebo
29  {
30  // Inline bracket to help doxygen filtering.
31  inline namespace IGNITION_GAZEBO_VERSION_NAMESPACE {
32 
34  enum class IGNITION_GAZEBO_VISIBLE PrimitiveShape
35  {
36  kBox,
37  kCapsule,
38  kCylinder,
39  kEllipsoid,
40  kSphere,
41  };
42 
44  enum class IGNITION_GAZEBO_VISIBLE PrimitiveLight
45  {
47  kPoint,
48  kSpot,
49  };
50 
56  std::string IGNITION_GAZEBO_VISIBLE
57  getPrimitiveShape(const PrimitiveShape &_type);
58 
64  std::string IGNITION_GAZEBO_VISIBLE
65  getPrimitiveLight(const PrimitiveLight &_type);
66 
74  std::string IGNITION_GAZEBO_VISIBLE
75  getPrimitive(const std::string &_typeName);
76  }
77  } // namespace gazebo
78 } // namespace ignition
79 
80 
81 #endif // IGNITION_GAZEBO_PRIMITIVES_HH_
82 
83 
This library is part of the Gazebo project.
STL class.
std::string getPrimitive(const std::string &_typeName)
Return an SDF string of one of the available primitive shape or light types.
std::string getPrimitiveLight(const PrimitiveLight &_type)
Return an SDF string of one of the available primitive light types.
std::string getPrimitiveShape(const PrimitiveShape &_type)
Return an SDF string of one of the available primitive shape types.
PrimitiveShape
Enumeration of available primitive shape types.
Definition: gz/sim/Primitives.hh:34
PrimitiveLight
Enumeration of available primitive light types.
Definition: gz/sim/Primitives.hh:44