Ignition Gazebo

API Reference

6.6.0
ShaderParam.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2022 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_GAZEBO_SYSTEMS_SHADER_PARAM_HH_
19 #define IGNITION_GAZEBO_SYSTEMS_SHADER_PARAM_HH_
20 
21 #include <memory>
22 
24 
25 namespace ignition
26 {
27 namespace gazebo
28 {
29 // Inline bracket to help doxygen filtering.
30 inline namespace IGNITION_GAZEBO_VERSION_NAMESPACE {
31 namespace systems
32 {
33  // Forward declaration
34  class ShaderParamPrivate;
35 
75  : public System,
76  public ISystemConfigure,
77  public ISystemPreUpdate
78  {
80  public: ShaderParam();
81 
83  public: ~ShaderParam() override;
84 
85  // Documentation inherited
86  public: void Configure(const Entity &_entity,
89  EventManager &_eventMgr) final;
90 
92  public: void PreUpdate(
93  const ignition::gazebo::UpdateInfo &_info,
95 
97  private: std::unique_ptr<ShaderParamPrivate> dataPtr;
98  };
99  }
100 }
101 }
102 }
103 
104 #endif
Information passed to systems on the update callback.
Definition: include/ignition/gazebo/Types.hh:38
The EntityComponentManager constructs, deletes, and returns components and entities. A component can be of any class which inherits from components::BaseComponent.
Definition: EntityComponentManager.hh:66
A plugin for setting shaders to a visual and its params.
Definition: ShaderParam.hh:74
The EventManager is used to send/receive notifications of simulator events.
Definition: EventManager.hh:54
Interface for a system that implements optional configuration.
Definition: System.hh:88
This library is part of the Ignition Robotics project.
uint64_t Entity
An Entity identifies a single object in simulation such as a model, link, or light. At its core, an Entity is just an identifier.
Definition: Entity.hh:59
Interface for a system that uses the PreUpdate phase.
Definition: System.hh:105
Base class for a System.
Definition: System.hh:73