RenderEvents.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2012 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 _RENDER_EVENTS_HH_
18 #define _RENDER_EVENTS_HH_
19 
20 #include <string>
21 #include "gazebo/common/Event.hh"
22 #include "gazebo/msgs/msgs.hh"
23 #include "gazebo/util/system.hh"
24 
25 namespace gazebo
26 {
27  namespace rendering
28  {
31 
34  class GZ_RENDERING_VISIBLE Events
35  {
39  public: template<typename T>
41  { return createScene.Connect(_subscriber); }
42 
46  public: static void DisconnectCreateScene(
47  event::ConnectionPtr _connection)
49  { createScene.Disconnect(_connection->Id()); }
50 
54  public: template<typename T>
56  {return removeScene.Connect(_subscriber);}
57 
61  public: static void DisconnectRemoveScene(
62  event::ConnectionPtr _connection)
64  {removeScene.Disconnect(_connection->Id());}
65 
69  public: template<typename T>
71  {return toggleLayer.Connect(_subscriber);}
72 
76  public: static void DisconnectToggleLayer(
77  event::ConnectionPtr _connection)
79  {toggleLayer.Disconnect(_connection->Id());}
80 
84  public: template<typename T>
85  static event::ConnectionPtr ConnectNewLayer(T _subscriber)
86  {return newLayer.Connect(_subscriber);}
87 
91  public: static void DisconnectNewLayer(
92  event::ConnectionPtr _connection)
94  {newLayer.Disconnect(_connection->Id());}
95 
98 
101 
104 
107  };
109  }
110 }
111 #endif
static void DisconnectCreateScene(event::ConnectionPtr _connection) GAZEBO_DEPRECATED(8.0)
Disconnect from a scene created event.
Definition: RenderEvents.hh:46
static void DisconnectRemoveScene(event::ConnectionPtr _connection) GAZEBO_DEPRECATED(8.0)
Disconnect from a scene removed event.
Definition: RenderEvents.hh:61
Forward declarations for the common classes.
Definition: Animation.hh:33
static void DisconnectToggleLayer(event::ConnectionPtr _connection) GAZEBO_DEPRECATED(8.0)
Disconnect from a layer toggle event.
Definition: RenderEvents.hh:76
static event::EventT< void(const int32_t)> toggleLayer
The event used to turn on/off a layer.
Definition: RenderEvents.hh:103
Base class for rendering events.
Definition: RenderEvents.hh:34
static event::ConnectionPtr ConnectCreateScene(T _subscriber)
Connect to a scene created event.
Definition: RenderEvents.hh:40
static event::EventT< void(const std::string &)> removeScene
The event used to trigger a remove scene event.
Definition: RenderEvents.hh:100
static event::ConnectionPtr ConnectToggleLayer(T _subscriber)
Connect to a layer toggle event.
Definition: RenderEvents.hh:70
static event::EventT< void(const std::string &)> createScene
The event used to trigger a create scene event.
Definition: RenderEvents.hh:97
boost::shared_ptr< Connection > ConnectionPtr
Definition: CommonTypes.hh:134
static event::ConnectionPtr ConnectNewLayer(T _subscriber)
Connect to a new layer event.
Definition: RenderEvents.hh:85
static event::EventT< void(const int32_t)> newLayer
The event used to indicate that a new layer is present.
Definition: RenderEvents.hh:106
#define GAZEBO_DEPRECATED(version)
Definition: system.hh:302
static event::ConnectionPtr ConnectRemoveScene(T _subscriber)
Connect to a scene removed event.
Definition: RenderEvents.hh:55
static void DisconnectNewLayer(event::ConnectionPtr _connection) GAZEBO_DEPRECATED(8.0)
Disconnect from a new layer event.
Definition: RenderEvents.hh:91