Gazebo Rendering

API Reference

3.7.2
gz/rendering/Object.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2015 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_OBJECT_HH_
18 #define GZ_RENDERING_OBJECT_HH_
19 
20 #include <string>
21 #include "gz/rendering/config.hh"
23 #include "gz/rendering/Export.hh"
24 
25 namespace ignition
26 {
27  namespace rendering
28  {
29  inline namespace IGNITION_RENDERING_VERSION_NAMESPACE {
30  //
34  class IGNITION_RENDERING_VISIBLE Object
35  {
37  public: virtual ~Object() { }
38 
43  public: virtual unsigned int Id() const = 0;
44 
49  public: virtual std::string Name() const = 0;
50 
53  public: virtual ScenePtr Scene() const = 0;
54 
58  public: virtual void PreRender() = 0;
59 
62  public: virtual void PostRender() = 0;
63 
67  public: virtual void Destroy() = 0;
68  };
69  }
70  }
71 }
72 #endif
STL class.
STL class.
virtual void PostRender()=0
Post process this object and any of its children after rendering.
Manages a single scene-graph. This class updates scene-wide properties and holds the root scene node....
Definition: gz/rendering/Scene.hh:48
virtual void PreRender()=0
Prepare this object and any of its children for rendering. This should be called for each object in a...
virtual unsigned int Id() const =0
Get the object ID. This ID will be unique across all objects inside a given scene,...
virtual ScenePtr Scene() const =0
Get the Scene that created this object.
virtual ~Object()
Destructor.
Definition: gz/rendering/Object.hh:37
Represents an object present in the scene graph. This includes sub-meshes, materials,...
Definition: gz/rendering/Object.hh:34
virtual void Destroy()=0
Destroy any resources associated with this object. Invoking any other functions after destroying an o...
virtual std::string Name() const =0
Get the object name. This name will be unique across all objects inside a given scene,...