Ignition Rendering

API Reference

0.1.0
RenderTypes.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 IGNITION_RENDERING_RENDERTYPES_HH_
18 #define IGNITION_RENDERING_RENDERTYPES_HH_
19 
20 #include <memory>
21 
22 namespace ignition
23 {
24  namespace rendering
25  {
26  template <class T>
28 
29  class ArrowVisual;
30  class AxisVisual;
31  class Camera;
32  class DirectionalLight;
33  class Geometry;
34  class Grid;
35  class JointVisual;
36  class Image;
37  class Light;
38  class Material;
39  class Mesh;
40  class Node;
41  class Object;
42  class ObjectFactory;
43  class PointLight;
44  class RayQuery;
45  class RenderEngine;
46  class RenderTarget;
47  class RenderTexture;
48  class RenderWindow;
49  class Scene;
50  class Sensor;
51  class SpotLight;
52  class SubMesh;
53  class Visual;
54 
58 
62 
66 
70 
74 
78 
82 
86 
90 
94 
98 
102 
106 
110 
114 
118 
122 
126 
133 
137 
141 
145 
149 
153 
157 
161 
165 
169 
173 
177 
181 
185 
189 
193 
197 
201 
205 
209 
213 
217 
221 
225 
229 
233 
237 
241  }
242 }
243 #endif
shared_ptr< const Sensor > ConstSensorPtr
Definition: RenderTypes.hh:228
Represents a arrow composite visual.
Definition: ArrowVisual.hh:28
shared_ptr< const Object > ConstObjectPtr
Definition: RenderTypes.hh:196
shared_ptr< const Geometry > ConstGeometryPtr
Definition: RenderTypes.hh:168
shared_ptr< ArrowVisual > ArrowVisualPtr
Definition: RenderTypes.hh:57
Represents a axis composite visual.
Definition: AxisVisual.hh:28
shared_ptr< const SpotLight > ConstSpotLightPtr
Definition: RenderTypes.hh:232
shared_ptr< const Light > ConstLightPtr
Definition: RenderTypes.hh:180
shared_ptr< const JointVisual > ConstJointVisualPtr
Definition: RenderTypes.hh:172
shared_ptr< Mesh > MeshPtr
Definition: RenderTypes.hh:97
Represents a scene sensor. The most obvious example is a camera, but it can be anything that generate...
Definition: Sensor.hh:29
shared_ptr< const PointLight > ConstPointLightPtr
Definition: RenderTypes.hh:204
shared_ptr< Image > ImagePtr
Definition: RenderTypes.hh:85
shared_ptr< DirectionalLight > DirectionalLightPtr
Definition: RenderTypes.hh:69
shared_ptr< RenderWindow > RenderWindowPtr
Definition: RenderTypes.hh:129
shared_ptr< const Camera > ConstCameraPtr
Definition: RenderTypes.hh:160
shared_ptr< Geometry > GeometryPtr
Definition: RenderTypes.hh:73
shared_ptr< AxisVisual > AxisVisualPtr
Definition: RenderTypes.hh:61
Represents a single posable node in the scene graph.
Definition: Node.hh:34
shared_ptr< Visual > VisualPtr
Definition: RenderTypes.hh:148
Represents a render-target to which cameras can render images.
Definition: RenderTarget.hh:34
shared_ptr< RenderTarget > RenderTargetPtr
Definition: RenderTypes.hh:121
Represents a point light.
Definition: Light.hh:133
shared_ptr< const RenderTarget > ConstRenderTargetPtr
Definition: RenderTypes.hh:212
shared_ptr< Object > ObjectPtr
Definition: RenderTypes.hh:105
shared_ptr< const Node > ConstNodePtr
Definition: RenderTypes.hh:192
shared_ptr< const ArrowVisual > ConstArrowVisualPtr
Definition: RenderTypes.hh:152
shared_ptr< Sensor > SensorPtr
Definition: RenderTypes.hh:136
shared_ptr< const Mesh > ConstMeshPtr
Definition: RenderTypes.hh:188
Encapsulates a raw image buffer and relevant properties.
Definition: Image.hh:30
shared_ptr< Node > NodePtr
Definition: RenderTypes.hh:101
shared_ptr< const Material > ConstMaterialPtr
Definition: RenderTypes.hh:184
shared_ptr< const RenderWindow > ConstRenderWindowPtr
Definition: RenderTypes.hh:220
Manages a single scene-graph. This class updates scene-wide properties and holds the root scene node...
Definition: Scene.hh:44
Represents a off-screen render-texture to which cameras can render images.
Definition: RenderTarget.hh:82
shared_ptr< Camera > CameraPtr
Definition: RenderTypes.hh:65
shared_ptr< SpotLight > SpotLightPtr
Definition: RenderTypes.hh:140
shared_ptr< const Image > ConstImagePtr
Definition: RenderTypes.hh:176
shared_ptr< RayQuery > RayQueryPtr
Definition: RenderTypes.hh:117
Posable camera used for rendering the scene graph.
Definition: Camera.hh:35
A Ray Query class used for computing ray object intersections.
Definition: RayQuery.hh:51
Represents a visual node in a scene graph. A Visual is the only node that can have Geometry and other...
Definition: Visual.hh:30
shared_ptr< const Scene > ConstScenePtr
Definition: RenderTypes.hh:224
shared_ptr< const ObjectFactory > ConstObjectFactoryPtr
Definition: RenderTypes.hh:200
Represents a light source in the scene graph.
Definition: Light.hh:29
Represents a spotlight.
Definition: Light.hh:142
shared_ptr< SubMesh > SubMeshPtr
Definition: RenderTypes.hh:144
Represents a on-screen render-window to which cameras can render images.
Definition: RenderTarget.hh:93
Represents a infinite directional light.
Definition: Light.hh:110
shared_ptr< Material > MaterialPtr
Definition: RenderTypes.hh:93
Represents a collection of mesh geometries.
Definition: Mesh.hh:30
Represents a grid geometry drawn along the XY plane. If vertical cell count is specified then the gri...
Definition: Grid.hh:31
shared_ptr< RenderTexture > RenderTexturePtr
Definition: RenderTypes.hh:125
An abstract interface to a concrete render-engine. A RenderEngine is responsible for initializing a r...
Definition: RenderEngine.hh:32
shared_ptr< const RayQuery > ConstRayQuery
Definition: RenderTypes.hh:208
shared_ptr< const AxisVisual > ConstAxisVisualPtr
Definition: RenderTypes.hh:156
shared_ptr< JointVisual > JointVisualPtr
Definition: RenderTypes.hh:81
Definition: ArrowVisual.hh:22
shared_ptr< const Visual > ConstVisualPtr
Definition: RenderTypes.hh:240
shared_ptr< Scene > ScenePtr
Definition: RenderTypes.hh:132
shared_ptr< Grid > GridPtr
Definition: RenderTypes.hh:77
Represents a geometric shape to be rendered.
Definition: Geometry.hh:31
Represents a surface material of a Geometry.
Definition: Material.hh:34
shared_ptr< ObjectFactory > ObjectFactoryPtr
Definition: RenderTypes.hh:109
shared_ptr< const SubMesh > ConstSubMeshPtr
Definition: RenderTypes.hh:236
Represents an object present in the scene graph. This includes sub-meshes, materials, render targets, as well as posable nodes.
Definition: Object.hh:31
shared_ptr< PointLight > PointLightPtr
Definition: RenderTypes.hh:113
shared_ptr< const RenderTexture > ConstRenderTexturePtr
Definition: RenderTypes.hh:216
Represents a single mesh geometry.
Definition: Mesh.hh:65
shared_ptr< const DirectionalLight > ConstDirectionalLightPtr
Definition: RenderTypes.hh:164
shared_ptr< Light > LightPtr
Definition: RenderTypes.hh:89