Gazebo Rendering

API Reference

6.6.3
gz/rendering/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 GZ_RENDERING_RENDERTYPES_HH_
18 #define GZ_RENDERING_RENDERTYPES_HH_
19 
20 #include <memory>
21 #include <gz/rendering/config.hh>
22 
23 
26 #define IGN_VISIBILITY_ALL 0x0FFFFFFF
27 
30 #define IGN_VISIBILITY_SELECTION 0x10000000
31 
34 #define IGN_VISIBILITY_GUI 0x00000001
35 
38 #define IGN_VISIBILITY_SELECTABLE 0x00000002
39 
40 namespace ignition
41 {
42  namespace rendering
43  {
44  inline namespace IGNITION_RENDERING_VERSION_NAMESPACE {
45  //
46  template <class T>
48 
49  class ArrowVisual;
50  class AxisVisual;
51  class BoundingBoxCamera;
52  class Camera;
53  class Capsule;
54  class COMVisual;
55  class DepthCamera;
56  class DirectionalLight;
57  class DistortionPass;
58  class GaussianNoisePass;
59  class Geometry;
60  class GizmoVisual;
61  class GpuRays;
62  class Grid;
63  class Heightmap;
64  class Image;
65  class InertiaVisual;
66  class Light;
67  class LightVisual;
68  class JointVisual;
69  class LidarVisual;
70  class Light;
71  class Marker;
72  class Material;
73  class Mesh;
74  class Node;
75  class Object;
76  class ObjectFactory;
77  class ParticleEmitter;
78  class PointLight;
79  class RayQuery;
80  class RenderEngine;
81  class RenderPass;
82  class RenderPassSystem;
83  class RenderTarget;
84  class RenderTexture;
85  class RenderWindow;
86  class Scene;
87  class SegmentationCamera;
88  class Sensor;
89  class ShaderParams;
90  class SpotLight;
91  class SubMesh;
92  class Text;
93  class ThermalCamera;
94  class Visual;
95  class WireBox;
96 
100 
104 
108 
112 
116 
120 
124 
128 
132 
136 
140 
144 
148 
152 
156 
160 
164 
168 
172 
176 
180 
184 
188 
192 
196 
200 
204 
208 
212 
216 
220 
224 
228 
232 
236 
240 
247 
251 
254 
258 
262 
266 
270 
274 
278 
282 
286 
290 
294 
298 
302 
306 
310 
314 
318 
322 
326 
330 
334 
338 
342 
346 
350 
354 
358 
362 
366 
370 
374 
378 
382 
386 
390 
394 
398 
402 
405 
409 
413 
417 
421  }
422  }
423 }
424 #endif
shared_ptr< Object > ObjectPtr
Shared pointer to Object.
Definition: gz/rendering/RenderTypes.hh:207
shared_ptr< const Material > ConstMaterialPtr
Definition: gz/rendering/RenderTypes.hh:345
shared_ptr< const Sensor > ConstSensorPtr
Definition: gz/rendering/RenderTypes.hh:401
Represents a billboard text geometry that is always facing the camera.
Definition: gz/rendering/Text.hh:62
shared_ptr< RayQuery > RayQueryPtr
Shared pointer to RayQuery.
Definition: gz/rendering/RenderTypes.hh:223
shared_ptr< SubMesh > SubMeshPtr
Shared pointer to SubMesh.
Definition: gz/rendering/RenderTypes.hh:261
shared_ptr< const PointLight > ConstPointLightPtr
Definition: gz/rendering/RenderTypes.hh:369
A LidarVisual geometry class. The visual appearance is based on the type specified.
Definition: gz/rendering/LidarVisual.hh:55
shared_ptr< const Image > ConstImagePtr
Definition: gz/rendering/RenderTypes.hh:333
shared_ptr< Geometry > GeometryPtr
Shared pointer to Geometry.
Definition: gz/rendering/RenderTypes.hh:143
Represents a single posable node in the scene graph.
Definition: gz/rendering/Node.hh:51
Represents a scene sensor. The most obvious example is a camera, but it can be anything that generate...
Definition: gz/rendering/Sensor.hh:32
shared_ptr< GpuRays > GpuRaysPtr
Shared pointer to GpuRays.
Definition: gz/rendering/RenderTypes.hh:127
shared_ptr< const BoundingBoxCamera > ConstBoundingBoxCameraPtr
Definition: gz/rendering/RenderTypes.hh:297
STL class.
shared_ptr< const ThermalCamera > ConstThermalCameraPtr
Definition: gz/rendering/RenderTypes.hh:293
shared_ptr< const ObjectFactory > ConstObjectFactoryPtr
Definition: gz/rendering/RenderTypes.hh:361
Represents a off-screen render-texture to which cameras can render images.
Definition: gz/rendering/RenderTarget.hh:103
shared_ptr< const SegmentationCamera > ConstSegmentationCameraPtr
Definition: gz/rendering/RenderTypes.hh:301
shared_ptr< LightVisual > LightVisualPtr
Shared pointer to Light.
Definition: gz/rendering/RenderTypes.hh:183
shared_ptr< const JointVisual > ConstJointVisualPtr
Definition: gz/rendering/RenderTypes.hh:325
Represents a light visual.
Definition: gz/rendering/LightVisual.hh:49
shared_ptr< const AxisVisual > ConstAxisVisualPtr
Definition: gz/rendering/RenderTypes.hh:281
shared_ptr< const Node > ConstNodePtr
Definition: gz/rendering/RenderTypes.hh:353
Definition: gz/rendering/DepthCamera.hh:34
A render pass that applies Gaussian noise to the render target.
Definition: gz/rendering/GaussianNoisePass.hh:35
Represents a spotlight.
Definition: gz/rendering/Light.hh:153
shared_ptr< Light > LightPtr
Shared pointer to Light.
Definition: gz/rendering/RenderTypes.hh:175
Represents a on-screen render-window to which cameras can render images.
Definition: gz/rendering/RenderTarget.hh:119
A terrain defined by a heightfield.
Definition: gz/rendering/Heightmap.hh:32
shared_ptr< ParticleEmitter > ParticleEmitterPtr
Shared pointer to ParticleEmitter.
Definition: gz/rendering/RenderTypes.hh:215
shared_ptr< const Mesh > ConstMeshPtr
Definition: gz/rendering/RenderTypes.hh:349
Encapsulates a raw image buffer and relevant properties.
Definition: gz/rendering/Image.hh:36
shared_ptr< SpotLight > SpotLightPtr
Shared pointer to SpotLight.
Definition: gz/rendering/RenderTypes.hh:257
shared_ptr< const Scene > ConstScenePtr
Definition: gz/rendering/RenderTypes.hh:397
Poseable Segmentation camera used for rendering the scene graph. This camera is designed to produce s...
Definition: gz/rendering/SegmentationCamera.hh:51
shared_ptr< WireBox > WireBoxPtr
Shared pointer to WireBox.
Definition: gz/rendering/RenderTypes.hh:273
Represents a inertia visual.
Definition: gz/rendering/InertiaVisual.hh:35
shared_ptr< const RenderPass > ConstRenderPassPtr
Definition: gz/rendering/RenderTypes.hh:377
shared_ptr< const Geometry > ConstGeometryPtr
Definition: gz/rendering/RenderTypes.hh:317
shared_ptr< JointVisual > JointVisualPtr
Shared pointer to JointVisual.
Definition: gz/rendering/RenderTypes.hh:159
Represents a joint visual.
Definition: gz/rendering/JointVisual.hh:69
Posable camera used for rendering the scene graph.
Definition: gz/rendering/Camera.hh:49
shared_ptr< Grid > GridPtr
Shared pointer to Grid.
Definition: gz/rendering/RenderTypes.hh:155
shared_ptr< const RenderWindow > ConstRenderWindowPtr
Definition: gz/rendering/RenderTypes.hh:393
shared_ptr< const RenderTarget > ConstRenderTargetPtr
Definition: gz/rendering/RenderTypes.hh:385
shared_ptr< Sensor > SensorPtr
Shared pointer to Sensor.
Definition: gz/rendering/RenderTypes.hh:250
shared_ptr< const Heightmap > ConstHeightmapPtr
Definition: gz/rendering/RenderTypes.hh:329
shared_ptr< const LidarVisual > ConstLidarVisualPtr
Definition: gz/rendering/RenderTypes.hh:341
Draws a wireframe box.
Definition: gz/rendering/WireBox.hh:32
Represents a center of mass visual.
Definition: gz/rendering/COMVisual.hh:36
Manages a single scene-graph. This class updates scene-wide properties and holds the root scene node....
Definition: gz/rendering/Scene.hh:49
shared_ptr< GaussianNoisePass > GaussianNoisePassPtr
Shared pointer to GaussianNoisePass.
Definition: gz/rendering/RenderTypes.hh:139
shared_ptr< RenderPassSystem > RenderPassSystemPtr
Shared pointer to RenderPassSystem.
Definition: gz/rendering/RenderTypes.hh:231
a map that holds params to be passed to a shader
Definition: gz/rendering/ShaderParams.hh:38
shared_ptr< const Object > ConstObjectPtr
Definition: gz/rendering/RenderTypes.hh:357
shared_ptr< const GpuRays > ConstGpuRaysPtr
Definition: gz/rendering/RenderTypes.hh:305
shared_ptr< const ShaderParams > ConstShaderParamsPtr
Shared pointer to const ShaderParams.
Definition: gz/rendering/RenderTypes.hh:404
Represents a collection of mesh geometries.
Definition: gz/rendering/Mesh.hh:37
shared_ptr< Mesh > MeshPtr
Shared pointer to Mesh.
Definition: gz/rendering/RenderTypes.hh:199
shared_ptr< BoundingBoxCamera > BoundingBoxCameraPtr
Shared pointer to BoundingBoxCamera.
Definition: gz/rendering/RenderTypes.hh:119
shared_ptr< COMVisual > COMVisualPtr
Shared pointer to COMVisual.
Definition: gz/rendering/RenderTypes.hh:179
shared_ptr< const SpotLight > ConstSpotLightPtr
Definition: gz/rendering/RenderTypes.hh:408
shared_ptr< RenderTexture > RenderTexturePtr
Shared pointer to RenderTexture.
Definition: gz/rendering/RenderTypes.hh:239
shared_ptr< RenderTarget > RenderTargetPtr
Shared pointer to RenderTarget.
Definition: gz/rendering/RenderTypes.hh:235
Poseable BoundingBox camera used for rendering bounding boxes of objects in the scene.
Definition: gz/rendering/BoundingBoxCamera.hh:54
shared_ptr< const GizmoVisual > ConstGizmoVisualPtr
Definition: gz/rendering/RenderTypes.hh:321
shared_ptr< Image > ImagePtr
Shared pointer to Image.
Definition: gz/rendering/RenderTypes.hh:167
Represents a single mesh geometry.
Definition: gz/rendering/Mesh.hh:136
Represents a render-target to which cameras can render images.
Definition: gz/rendering/RenderTarget.hh:37
shared_ptr< LidarVisual > LidarVisualPtr
Shared pointer to LidarVisual.
Definition: gz/rendering/RenderTypes.hh:187
Represents a visual node in a scene graph. A Visual is the only node that can have Geometry and other...
Definition: gz/rendering/Visual.hh:33
shared_ptr< const Camera > ConstCameraPtr
Definition: gz/rendering/RenderTypes.hh:285
shared_ptr< const Text > ConstTextPtr
Definition: gz/rendering/RenderTypes.hh:416
Represents a axis composite visual.
Definition: gz/rendering/AxisVisual.hh:31
shared_ptr< const DirectionalLight > ConstDirectionalLightPtr
Definition: gz/rendering/RenderTypes.hh:309
A Ray Query class used for computing ray object intersections.
Definition: gz/rendering/RayQuery.hh:63
Generate depth ray data.
Definition: gz/rendering/GpuRays.hh:37
Represents a infinite directional light.
Definition: gz/rendering/Light.hh:121
shared_ptr< const ParticleEmitter > ConstParticleEmitterPtr
Definition: gz/rendering/RenderTypes.hh:365
A render pass that applies distortion to the render target.
Definition: gz/rendering/DistortionPass.hh:37
shared_ptr< const RenderPassSystem > ConstRenderPassSystemPtr
Definition: gz/rendering/RenderTypes.hh:381
shared_ptr< const GaussianNoisePass > ConstGaussianNoisePass
Shared pointer to const GaussianNoisePass.
Definition: gz/rendering/RenderTypes.hh:313
shared_ptr< GizmoVisual > GizmoVisualPtr
Shared pointer to GizmoVisual.
Definition: gz/rendering/RenderTypes.hh:147
shared_ptr< const Light > ConstLightPtr
Definition: gz/rendering/RenderTypes.hh:337
shared_ptr< ThermalCamera > ThermalCameraPtr
Shared pointer to ThermalCamera.
Definition: gz/rendering/RenderTypes.hh:115
shared_ptr< Visual > VisualPtr
Shared pointer to Visual.
Definition: gz/rendering/RenderTypes.hh:269
shared_ptr< ArrowVisual > ArrowVisualPtr
Shared pointer to ArrowVisual.
Definition: gz/rendering/RenderTypes.hh:99
Represents a grid geometry drawn along the XY plane. If vertical cell count is specified then the gri...
Definition: gz/rendering/Grid.hh:34
Thermal camera that produces temperature data. An object's temperature can be set through the Visual ...
Definition: gz/rendering/ThermalCamera.hh:40
A render pass can be added to a camera to affect how the scene is rendered. It can be used to add pos...
Definition: gz/rendering/RenderPass.hh:34
A marker geometry class. The marker's visual appearance is based on the marker type specified.
Definition: gz/rendering/Marker.hh:77
Geometry for a capsule shape.
Definition: gz/rendering/Capsule.hh:32
shared_ptr< Camera > CameraPtr
Shared pointer to Camera.
Definition: gz/rendering/RenderTypes.hh:107
Represents a point light.
Definition: gz/rendering/Light.hh:144
Represents an object present in the scene graph. This includes sub-meshes, materials,...
Definition: gz/rendering/Object.hh:34
Represents a light source in the scene graph.
Definition: gz/rendering/Light.hh:32
shared_ptr< Text > TextPtr
Shared pointer to Text.
Definition: gz/rendering/RenderTypes.hh:265
shared_ptr< Node > NodePtr
Shared pointer to Node.
Definition: gz/rendering/RenderTypes.hh:203
shared_ptr< const DepthCamera > ConstDepthCameraPtr
Definition: gz/rendering/RenderTypes.hh:289
shared_ptr< const Visual > ConstVisualPtr
Definition: gz/rendering/RenderTypes.hh:420
shared_ptr< RenderPass > RenderPassPtr
Shared pointer to RenderPass.
Definition: gz/rendering/RenderTypes.hh:227
shared_ptr< RenderWindow > RenderWindowPtr
Shared pointer to RenderWindow.
Definition: gz/rendering/RenderTypes.hh:243
shared_ptr< InertiaVisual > InertiaVisualPtr
Definition: gz/rendering/RenderTypes.hh:171
shared_ptr< PointLight > PointLightPtr
Shared pointer to PointLight.
Definition: gz/rendering/RenderTypes.hh:219
shared_ptr< Scene > ScenePtr
Shared pointer to Scene.
Definition: gz/rendering/RenderTypes.hh:246
An abstract interface to a concrete render-engine. A RenderEngine is responsible for initializing a r...
Definition: gz/rendering/RenderEngine.hh:36
shared_ptr< const SubMesh > ConstSubMeshPtr
Definition: gz/rendering/RenderTypes.hh:412
Class to manage a particle emitter.
Definition: gz/rendering/ParticleEmitter.hh:58
shared_ptr< const RenderTexture > ConstRenderTexturePtr
Definition: gz/rendering/RenderTypes.hh:389
A class for creating and managing render passes.
Definition: gz/rendering/RenderPassSystem.hh:56
shared_ptr< Capsule > CapsulePtr
Shared pointer to Capsule.
Definition: gz/rendering/RenderTypes.hh:151
shared_ptr< ObjectFactory > ObjectFactoryPtr
Shared pointer to ObjectFactory.
Definition: gz/rendering/RenderTypes.hh:211
shared_ptr< Material > MaterialPtr
Shared pointer to Material.
Definition: gz/rendering/RenderTypes.hh:191
Represents a surface material of a Geometry.
Definition: gz/rendering/Material.hh:47
shared_ptr< const RayQuery > ConstRayQueryPtr
Definition: gz/rendering/RenderTypes.hh:373
A gizmo that contains rotate, translate, and scale visuals.
Definition: gz/rendering/GizmoVisual.hh:34
shared_ptr< DirectionalLight > DirectionalLightPtr
Shared pointer to DirectionalLight.
Definition: gz/rendering/RenderTypes.hh:131
shared_ptr< Marker > MarkerPtr
Shared pointer to Marker.
Definition: gz/rendering/RenderTypes.hh:195
shared_ptr< Heightmap > HeightmapPtr
Shared pointer to Heightmap.
Definition: gz/rendering/RenderTypes.hh:163
shared_ptr< DistortionPass > DistortionPassPtr
Shared pointer to DistortionPass.
Definition: gz/rendering/RenderTypes.hh:135
shared_ptr< const ArrowVisual > ConstArrowVisualPtr
Definition: gz/rendering/RenderTypes.hh:277
shared_ptr< DepthCamera > DepthCameraPtr
Shared pointer to DepthCamera.
Definition: gz/rendering/RenderTypes.hh:111
shared_ptr< SegmentationCamera > SegmentationCameraPtr
Shared pointer to Segmentation Camera.
Definition: gz/rendering/RenderTypes.hh:123
Represents a geometric shape to be rendered.
Definition: gz/rendering/Geometry.hh:34
shared_ptr< AxisVisual > AxisVisualPtr
Shared pointer to AxisVisual.
Definition: gz/rendering/RenderTypes.hh:103
shared_ptr< ShaderParams > ShaderParamsPtr
Shared pointer to ShaderParams.
Definition: gz/rendering/RenderTypes.hh:253
Represents a arrow composite visual.
Definition: gz/rendering/ArrowVisual.hh:31