Gazebo Rendering

API Reference

6.6.4
gz/rendering/ogre/OgreWireBox.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2020 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_OGREWIREBOX_HH_
19 #define IGNITION_RENDERING_OGRE_OGREWIREBOX_HH_
20 
21 #include <memory>
25 
26 namespace Ogre
27 {
28  class MovableObject;
29 }
30 
31 namespace ignition
32 {
33  namespace rendering
34  {
35  inline namespace IGNITION_RENDERING_VERSION_NAMESPACE {
36  //
37  // Forward declaration
38  class OgreWireBoxPrivate;
39 
41  class IGNITION_RENDERING_OGRE_VISIBLE OgreWireBox
42  : public BaseWireBox<OgreGeometry>
43  {
45  protected: OgreWireBox();
46 
48  public: virtual ~OgreWireBox();
49 
50  // Documentation inherited.
51  public: virtual void Init() override;
52 
53  // Documentation inherited.
54  public: virtual Ogre::MovableObject *OgreObject() const override;
55 
56  // Documentation inherited.
57  public: virtual void PreRender() override;
58 
59  // Documentation inherited.
60  public: virtual MaterialPtr Material() const override;
61 
62  // Documentation inherited.
63  public: virtual void SetMaterial(MaterialPtr _material, bool _unique)
64  override;
65 
68  protected: virtual void SetMaterialImpl(OgreMaterialPtr _material);
69 
71  private: void Create();
72 
74  private: friend class OgreScene;
75 
77  private: std::unique_ptr<OgreWireBoxPrivate> dataPtr;
78  };
79  }
80  }
81 }
82 #endif
Base implementation of a wireframe box.
Definition: gz/rendering/base/BaseWireBox.hh:34
Definition: gz/rendering/ogre/OgreScene.hh:41
Ogre implementation of a wire box geometry.
Definition: gz/rendering/ogre/OgreWireBox.hh:43
virtual ~OgreWireBox()
Destructor.
virtual Ogre::MovableObject * OgreObject() const override
virtual void SetMaterial(MaterialPtr _material, bool _unique) override
Set the materials of this Geometry.
virtual void PreRender() override
Prepare this object and any of its children for rendering. This should be called for each object in a...
virtual MaterialPtr Material() const override
Get the material of this geometry.
virtual void SetMaterialImpl(OgreMaterialPtr _material)
Set material to wire box geometry.
virtual void Init() override
Definition: gz/rendering/ogre/OgreCamera.hh:28