Gazebo Rendering

API Reference

8.2.1
OgreCapsule.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_RENDERING_OGRE_OGRECAPSULE_HH_
19 #define GZ_RENDERING_OGRE_OGRECAPSULE_HH_
20 
21 #include <memory>
25 
26 namespace Ogre
27 {
28  class MovableObject;
29 }
30 
31 namespace gz
32 {
33  namespace rendering
34  {
35  inline namespace GZ_RENDERING_VERSION_NAMESPACE {
36  // Forward declaration
37  class OgreCapsulePrivate;
38 
40  class GZ_RENDERING_OGRE_VISIBLE OgreCapsule
41  : public BaseCapsule<OgreGeometry>
42  {
44  protected: OgreCapsule();
45 
47  public: virtual ~OgreCapsule();
48 
49  // Documentation inherited.
50  public: virtual void Init() override;
51 
52  // Documentation inherited.
53  public: virtual void Destroy() override;
54 
55  // Documentation inherited.
56  public: virtual Ogre::MovableObject *OgreObject() const override;
57 
58  // Documentation inherited.
59  public: virtual void PreRender() override;
60 
61  // Documentation inherited.
62  public: virtual MaterialPtr Material() const override;
63 
64  // Documentation inherited.
65  public: virtual void
66  SetMaterial(MaterialPtr _material, bool _unique) override;
67 
69  private: void Update();
70 
72  private: friend class OgreScene;
73 
75  private: std::unique_ptr<OgreCapsulePrivate> dataPtr;
76  };
77  }
78  }
79 }
80 #endif