Visual.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_VISUAL_HH_
18 #define SDF_VISUAL_HH_
19 
20 #include <memory>
21 #include <string>
22 #include <ignition/math/Pose3.hh>
23 #include "sdf/Box.hh"
24 #include "sdf/Cylinder.hh"
25 #include "sdf/Element.hh"
26 #include "sdf/Material.hh"
27 #include "sdf/Plane.hh"
28 #include "sdf/SemanticPose.hh"
29 #include "sdf/Sphere.hh"
30 #include "sdf/Types.hh"
31 #include "sdf/sdf_config.h"
32 #include "sdf/system_util.hh"
33 
34 namespace sdf
35 {
36  // Inline bracket to help doxygen filtering.
37  inline namespace SDF_VERSION_NAMESPACE {
38  //
39 
40  // Forward declarations.
41  class VisualPrivate;
42  class Geometry;
43  struct PoseRelativeToGraph;
44 
46  {
48  public: Visual();
49 
52  public: Visual(const Visual &_visual);
53 
56  public: Visual(Visual &&_visual) noexcept;
57 
61  public: Visual &operator=(Visual &&_visual);
62 
66  public: Visual &operator=(const Visual &_visual);
67 
69  public: ~Visual();
70 
77  public: Errors Load(ElementPtr _sdf);
78 
82  public: std::string Name() const;
83 
87  public: void SetName(const std::string &_name) const;
88 
91  public: bool CastShadows() const;
92 
95  public: void SetCastShadows(bool _castShadows);
96 
99  public: float Transparency() const;
100 
103  public: void SetTransparency(float _transparency);
104 
107  public: const Geometry *Geom() const;
108 
111  public: void SetGeom(const Geometry &_geom);
112 
117  public: const ignition::math::Pose3d &RawPose() const;
118 
122  public: void SetRawPose(const ignition::math::Pose3d &_pose);
123 
128  public: const std::string &PoseRelativeTo() const;
129 
134  public: void SetPoseRelativeTo(const std::string &_frame);
135 
139  public: sdf::SemanticPose SemanticPose() const;
140 
145  public: sdf::ElementPtr Element() const;
146 
151  public: sdf::Material *Material() const;
152 
155  public: void SetMaterial(const sdf::Material &_material);
156 
159  public: uint32_t VisibilityFlags() const;
160 
163  public: void SetVisibilityFlags(uint32_t _flags);
164 
169  public: void SetHasLaserRetro(bool _laserRetro);
170 
173  public: bool HasLaserRetro() const;
174 
177  public: double LaserRetro() const;
178 
181  public: void SetLaserRetro(double _laserRetro);
182 
187  private: void SetXmlParentName(const std::string &_xmlParentName);
188 
193  private: void SetPoseRelativeToGraph(
194  std::weak_ptr<const PoseRelativeToGraph> _graph);
195 
199  friend class Link;
200 
202  private: VisualPrivate *dataPtr = nullptr;
203  };
204  }
205 }
206 #endif
class SDFORMAT_VISIBLE Element
Definition: Element.hh:49
Geometry provides access to a shape, such as a Box.
Definition: Geometry.hh:69
Definition: Visual.hh:45
This class contains visual material properties.
Definition: Material.hh:45
#define SDFORMAT_VISIBLE
Use to represent "symbol visible" if supported.
Definition: system_util.hh:48
SemanticPose is a data structure that can be used by different DOM objects to resolve poses on a Pose...
Definition: SemanticPose.hh:53
std::shared_ptr< Element > ElementPtr
Definition: Element.hh:53
namespace for Simulation Description Format parser
Definition: Actor.hh:32
std::vector< Error > Errors
A vector of Error.
Definition: Types.hh:95