Ignition Rendering

API Reference

5.1.0
OgreMarker.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 IGNITION_RENDERING_OGRE_OGREMARKER_HH_
19 #define IGNITION_RENDERING_OGRE_OGREMARKER_HH_
20 
21 #include <memory>
25 
26 namespace ignition
27 {
28  namespace rendering
29  {
30  inline namespace IGNITION_RENDERING_VERSION_NAMESPACE {
31  //
32  // Forward declaration
33  class OgreMarkerPrivate;
34 
36  class IGNITION_RENDERING_OGRE_VISIBLE OgreMarker
37  : public BaseMarker<OgreGeometry>
38  {
40  protected: OgreMarker();
41 
43  public: virtual ~OgreMarker();
44 
45  // Documentation inherited.
46  public: virtual void Init() override;
47 
48  // Documentation inherited.
49  public: virtual void PreRender() override;
50 
51  // Documentation inherited.
52  public: virtual void Destroy() override;
53 
54  // Documentation inherited.
55  public: virtual Ogre::MovableObject *OgreObject() const override;
56 
57  // Documentation inherited.
58  public: virtual MaterialPtr Material() const override;
59 
60  // Documentation inherited.
61  public: virtual void SetMaterial(
62  MaterialPtr _material, bool _unique) override;
63 
64  // Documentation inherited
65  public: virtual void SetPoint(unsigned int _index,
66  const ignition::math::Vector3d &_value) override;
67 
68  // Documentation inherited
69  public: virtual void AddPoint(const ignition::math::Vector3d &_pt,
70  const ignition::math::Color &_color) override;
71 
72  // Documentation inherited
73  public: virtual void ClearPoints() override;
74 
75  // Documentation inherited
76  public: virtual void SetType(const MarkerType _markerType) override;
77 
78  // Documentation inherited
79  public: virtual MarkerType Type() const override;
80 
82  private: void Create();
83 
85  private: friend class OgreScene;
86 
88  private: std::unique_ptr<OgreMarkerPrivate> dataPtr;
89  };
90  }
91  }
92 }
93 #endif
Base implementation of a Marker geometry.
Definition: BaseMarker.hh:33
MarkerType
Enum for marker types.
Definition: Marker.hh:35
Ogre implementation of a marker geometry.
Definition: OgreMarker.hh:36
Definition: OgreObject.hh:32
Definition: OgreScene.hh:39
Represents a surface material of a Geometry.
Definition: Material.hh:47