Gazebo Rendering

API Reference

6.6.3
gz/rendering/ogre2/Ogre2Marker.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2019 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_RENDERING_OGRE2_OGREMARKER_HH_
19 #define GZ_RENDERING_OGRE2_OGREMARKER_HH_
20 
21 #include <memory>
24 
25 namespace ignition
26 {
27  namespace rendering
28  {
29  inline namespace IGNITION_RENDERING_VERSION_NAMESPACE {
30  //
31  // Forward declaration
32  class Ogre2MarkerPrivate;
33 
35  class IGNITION_RENDERING_OGRE2_VISIBLE Ogre2Marker
36  : public BaseMarker<Ogre2Geometry>
37  {
39  protected: Ogre2Marker();
40 
42  public: virtual ~Ogre2Marker();
43 
44  // Documentation inherited.
45  public: virtual void Init() override;
46 
47  // Documentation inherited.
48  public: virtual void PreRender() override;
49 
50  // Documentation inherited.
51  public: virtual void Destroy() override;
52 
53  // Documentation inherited.
54  public: virtual Ogre::MovableObject *OgreObject() const override;
55 
56  // Documentation inherited.
57  public: virtual MaterialPtr Material() const override;
58 
59  // Documentation inherited.
60  public: virtual void SetMaterial(
61  MaterialPtr _material, bool _unique) override;
62 
63  // Documentation inherited
64  public: virtual void SetPoint(unsigned int _index,
65  const gz::math::Vector3d &_value) override;
66 
67  // Documentation inherited
68  public: virtual void AddPoint(const gz::math::Vector3d &_pt,
69  const gz::math::Color &_color) override;
70 
71  // Documentation inherited
72  public: virtual void ClearPoints() override;
73 
74  // Documentation inherited
75  public: virtual void SetType(const MarkerType _markerType) override;
76 
77  // Documentation inherited
78  public: virtual MarkerType Type() const override;
79 
81  private: void Create();
82 
84  private: friend class Ogre2Scene;
85 
87  private: std::unique_ptr<Ogre2MarkerPrivate> dataPtr;
88  };
89  }
90  }
91 }
92 #endif
STL class.
Ogre 2.x implementation of a marker geometry.
Definition: gz/rendering/ogre2/Ogre2Marker.hh:35
Ogre2.x implementation of the scene class.
Definition: gz/rendering/ogre2/Ogre2Scene.hh:57
Definition: gz/rendering/ogre/OgreObject.hh:32
Base implementation of a Marker geometry.
Definition: gz/rendering/base/BaseMarker.hh:33
MarkerType
Enum for marker types.
Definition: gz/rendering/Marker.hh:35
Represents a surface material of a Geometry.
Definition: gz/rendering/Material.hh:47