Gazebo Rendering

API Reference

6.6.4
gz/rendering/ogre2/Ogre2Visual.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 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 GZ_RENDERING_OGRE2_OGRE2VISUAL_HH_
18 #define GZ_RENDERING_OGRE2_OGRE2VISUAL_HH_
19 
20 #include <memory>
21 #include <vector>
22 
26 
27 namespace ignition
28 {
29  namespace rendering
30  {
31  inline namespace IGNITION_RENDERING_VERSION_NAMESPACE {
32  //
33  // forward declaration
34  class Ogre2VisualPrivate;
35 
37  class IGNITION_RENDERING_OGRE2_VISIBLE Ogre2Visual :
38  public BaseVisual<Ogre2Node>
39  {
41  protected: Ogre2Visual();
42 
44  public: virtual ~Ogre2Visual();
45 
46  // Documentation inherited
47  public: virtual void SetWireframe(bool _show) override;
48 
49  // Documentation inherited
50  public: virtual bool Wireframe() const override;
51 
52  // Documentation inherited.
53  public: virtual void SetVisible(bool _visible) override;
54 
55  // Documentation inherited.
56  public: virtual void SetVisibilityFlags(uint32_t _flags) override;
57 
58  // Documentation inherited.
60  const override;
61 
62  // Documentation inherited.
64  const override;
65 
72  private: virtual void BoundsHelper(
73  ignition::math::AxisAlignedBox &_box, bool _local,
74  const ignition::math::Pose3d &_pose) const;
75 
81  private: virtual void BoundsHelper(
82  ignition::math::AxisAlignedBox &_box, bool _local) const;
83 
84  // Documentation inherited.
85  protected: virtual GeometryStorePtr Geometries() const override;
86 
87  // Documentation inherited.
88  protected: virtual bool AttachGeometry(GeometryPtr _geometry) override;
89 
90  // Documentation inherited.
91  protected: virtual bool DetachGeometry(GeometryPtr _geometry) override;
92 
94  protected: virtual void Init() override;
95 
98  private: Ogre2VisualPtr SharedThis();
99 
102 
104  private: std::unique_ptr<Ogre2VisualPrivate> dataPtr;
105 
107  private: friend class Ogre2Scene;
108  };
109  }
110  }
111 }
112 #endif
Definition: gz/rendering/base/BaseVisual.hh:40
Ogre2.x implementation of the scene class.
Definition: gz/rendering/ogre2/Ogre2Scene.hh:59
Ogre2.x implementation of the visual class.
Definition: gz/rendering/ogre2/Ogre2Visual.hh:39
virtual bool DetachGeometry(GeometryPtr _geometry) override
Ogre2GeometryStorePtr geometries
Pointer to the attached geometries.
Definition: gz/rendering/ogre2/Ogre2Visual.hh:101
virtual void SetVisibilityFlags(uint32_t _flags) override
Set visibility flags.
virtual void SetVisible(bool _visible) override
Specify if this visual is visible.
virtual ignition::math::AxisAlignedBox BoundingBox() const override
Get the bounding box in world frame coordinates.
virtual GeometryStorePtr Geometries() const override
virtual void SetWireframe(bool _show) override
Enable or disable wireframe.
virtual ~Ogre2Visual()
Destructor.
virtual bool AttachGeometry(GeometryPtr _geometry) override
virtual ignition::math::AxisAlignedBox LocalBoundingBox() const override
Get the local bounding box of the visual.
virtual void Init() override
Initialize the visual.
virtual bool Wireframe() const override
Get whether wireframe is enabled for this visual.