Gazebo Rendering

API Reference

6.6.4
gz/rendering/ogre2/Ogre2LightVisual.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 #ifndef IGNITION_RENDERING_OGRE2_OGRE2LIGHTVISUAL_HH_
18 #define IGNITION_RENDERING_OGRE2_OGRE2LIGHTVISUAL_HH_
19 
20 #include <memory>
21 
24 
25 namespace Ogre
26 {
27  class MovableObject;
28 }
29 
30 namespace ignition
31 {
32  namespace rendering
33  {
34  inline namespace IGNITION_RENDERING_VERSION_NAMESPACE {
35 
36  // Forward declaration
37  class Ogre2LightVisualPrivate;
38 
40  class IGNITION_RENDERING_OGRE2_VISIBLE Ogre2LightVisual :
41  public BaseLightVisual<Ogre2Visual>
42  {
44  protected: Ogre2LightVisual();
45 
47  public: virtual ~Ogre2LightVisual();
48 
49  // Documentation inherited.
50  public: virtual void Init() override;
51 
52  // Documentation inherited.
53  public: virtual void PreRender() override;
54 
55  // Documentation inherited.
56  public: Ogre::MovableObject *OgreObject() const;
57 
59  public: void CreateVisual();
60 
61  // Documentation inherited.
62  public: virtual MaterialPtr Material() const override;
63 
64  // Documentation inherited.
65  public: virtual void SetMaterial(
66  MaterialPtr _material, bool _unique) override;
67 
70  protected: virtual void SetMaterialImpl(Ogre2MaterialPtr _material);
71 
73  private: friend class Ogre2Scene;
74 
77  };
78  }
79  }
80 }
81 #endif
Base implementation of a light visual.
Definition: gz/rendering/base/BaseLightVisual.hh:38
Ogre2.x implementation of the light visual class.
Definition: gz/rendering/ogre2/Ogre2LightVisual.hh:42
virtual void SetMaterial(MaterialPtr _material, bool _unique) override
Set the material for all attached visuals and geometries.
virtual void PreRender() override
Prepare this object and any of its children for rendering. This should be called for each object in a...
virtual void SetMaterialImpl(Ogre2MaterialPtr _material)
Set material to grid geometry.
virtual MaterialPtr Material() const override
Get the material assigned to attached visuals and geometries.
virtual ~Ogre2LightVisual()
Destructor.
Ogre::MovableObject * OgreObject() const
void CreateVisual()
Create the Light Visual in Ogre2.
virtual void Init() override
Initialize the visual.
Ogre2.x implementation of the scene class.
Definition: gz/rendering/ogre2/Ogre2Scene.hh:59
Definition: gz/rendering/ogre/OgreCamera.hh:28