Ignition Rendering

API Reference

6.3.1
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 #include <ignition/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< COMVisual > COMVisualPtr
Shared pointer to COMVisual.
Definition: RenderTypes.hh:179
shared_ptr< Marker > MarkerPtr
Shared pointer to Marker.
Definition: RenderTypes.hh:195
shared_ptr< const Sensor > ConstSensorPtr
Definition: RenderTypes.hh:401
shared_ptr< RenderTexture > RenderTexturePtr
Shared pointer to RenderTexture.
Definition: RenderTypes.hh:239
Represents a arrow composite visual.
Definition: ArrowVisual.hh:31
shared_ptr< const LidarVisual > ConstLidarVisualPtr
Definition: RenderTypes.hh:341
shared_ptr< SubMesh > SubMeshPtr
Shared pointer to SubMesh.
Definition: RenderTypes.hh:261
Generate depth ray data.
Definition: GpuRays.hh:37
shared_ptr< Text > TextPtr
Shared pointer to Text.
Definition: RenderTypes.hh:265
shared_ptr< RenderTarget > RenderTargetPtr
Shared pointer to RenderTarget.
Definition: RenderTypes.hh:235
shared_ptr< Scene > ScenePtr
Shared pointer to Scene.
Definition: RenderTypes.hh:246
shared_ptr< const Object > ConstObjectPtr
Definition: RenderTypes.hh:357
shared_ptr< ArrowVisual > ArrowVisualPtr
Shared pointer to ArrowVisual.
Definition: RenderTypes.hh:99
A marker geometry class. The marker&#39;s visual appearance is based on the marker type specified...
Definition: Marker.hh:77
shared_ptr< JointVisual > JointVisualPtr
Shared pointer to JointVisual.
Definition: RenderTypes.hh:159
Represents a light visual.
Definition: LightVisual.hh:49
shared_ptr< const Geometry > ConstGeometryPtr
Definition: RenderTypes.hh:317
shared_ptr< LightVisual > LightVisualPtr
Shared pointer to Light.
Definition: RenderTypes.hh:183
A terrain defined by a heightfield.
Definition: Heightmap.hh:32
Represents a axis composite visual.
Definition: AxisVisual.hh:31
shared_ptr< const SpotLight > ConstSpotLightPtr
Definition: RenderTypes.hh:408
shared_ptr< WireBox > WireBoxPtr
Shared pointer to WireBox.
Definition: RenderTypes.hh:273
shared_ptr< const RenderPassSystem > ConstRenderPassSystemPtr
Definition: RenderTypes.hh:381
Thermal camera that produces temperature data. An object&#39;s temperature can be set through the Visual ...
Definition: ThermalCamera.hh:40
shared_ptr< SpotLight > SpotLightPtr
Shared pointer to SpotLight.
Definition: RenderTypes.hh:257
shared_ptr< const Light > ConstLightPtr
Definition: RenderTypes.hh:337
A class for creating and managing render passes.
Definition: RenderPassSystem.hh:56
shared_ptr< const JointVisual > ConstJointVisualPtr
Definition: RenderTypes.hh:325
shared_ptr< GaussianNoisePass > GaussianNoisePassPtr
Shared pointer to GaussianNoisePass.
Definition: RenderTypes.hh:139
Geometry for a capsule shape.
Definition: Capsule.hh:32
Represents a scene sensor. The most obvious example is a camera, but it can be anything that generate...
Definition: Sensor.hh:32
shared_ptr< const Heightmap > ConstHeightmapPtr
Definition: RenderTypes.hh:329
shared_ptr< const GizmoVisual > ConstGizmoVisualPtr
Definition: RenderTypes.hh:321
shared_ptr< const PointLight > ConstPointLightPtr
Definition: RenderTypes.hh:369
shared_ptr< DirectionalLight > DirectionalLightPtr
Shared pointer to DirectionalLight.
Definition: RenderTypes.hh:131
shared_ptr< ParticleEmitter > ParticleEmitterPtr
Shared pointer to ParticleEmitter.
Definition: RenderTypes.hh:215
A render pass can be added to a camera to affect how the scene is rendered. It can be used to add pos...
Definition: RenderPass.hh:34
Represents a joint visual.
Definition: JointVisual.hh:69
shared_ptr< Image > ImagePtr
Shared pointer to Image.
Definition: RenderTypes.hh:167
A render pass that applies Gaussian noise to the render target.
Definition: GaussianNoisePass.hh:35
shared_ptr< const Camera > ConstCameraPtr
Definition: RenderTypes.hh:285
shared_ptr< DistortionPass > DistortionPassPtr
Shared pointer to DistortionPass.
Definition: RenderTypes.hh:135
shared_ptr< const BoundingBoxCamera > ConstBoundingBoxCameraPtr
Definition: RenderTypes.hh:297
Represents a billboard text geometry that is always facing the camera.
Definition: Text.hh:62
Definition: DepthCamera.hh:34
shared_ptr< AxisVisual > AxisVisualPtr
Shared pointer to AxisVisual.
Definition: RenderTypes.hh:103
Poseable Segmentation camera used for rendering the scene graph. This camera is designed to produce s...
Definition: SegmentationCamera.hh:51
shared_ptr< LidarVisual > LidarVisualPtr
Shared pointer to LidarVisual.
Definition: RenderTypes.hh:187
shared_ptr< Capsule > CapsulePtr
Shared pointer to Capsule.
Definition: RenderTypes.hh:151
Represents a single posable node in the scene graph.
Definition: Node.hh:51
shared_ptr< Geometry > GeometryPtr
Shared pointer to Geometry.
Definition: RenderTypes.hh:143
Represents a render-target to which cameras can render images.
Definition: RenderTarget.hh:37
shared_ptr< RenderPass > RenderPassPtr
Shared pointer to RenderPass.
Definition: RenderTypes.hh:227
shared_ptr< Light > LightPtr
Shared pointer to Light.
Definition: RenderTypes.hh:175
shared_ptr< const RayQuery > ConstRayQueryPtr
Definition: RenderTypes.hh:373
Represents a point light.
Definition: Light.hh:144
shared_ptr< const DepthCamera > ConstDepthCameraPtr
Definition: RenderTypes.hh:289
shared_ptr< ObjectFactory > ObjectFactoryPtr
Shared pointer to ObjectFactory.
Definition: RenderTypes.hh:211
shared_ptr< const RenderTarget > ConstRenderTargetPtr
Definition: RenderTypes.hh:385
shared_ptr< const Node > ConstNodePtr
Definition: RenderTypes.hh:353
shared_ptr< const ArrowVisual > ConstArrowVisualPtr
Definition: RenderTypes.hh:277
shared_ptr< Heightmap > HeightmapPtr
Shared pointer to Heightmap.
Definition: RenderTypes.hh:163
shared_ptr< const GaussianNoisePass > ConstGaussianNoisePass
Shared pointer to const GaussianNoisePass.
Definition: RenderTypes.hh:313
shared_ptr< RenderWindow > RenderWindowPtr
Shared pointer to RenderWindow.
Definition: RenderTypes.hh:243
shared_ptr< RayQuery > RayQueryPtr
Shared pointer to RayQuery.
Definition: RenderTypes.hh:223
shared_ptr< const RenderPass > ConstRenderPassPtr
Definition: RenderTypes.hh:377
shared_ptr< const Mesh > ConstMeshPtr
Definition: RenderTypes.hh:349
Encapsulates a raw image buffer and relevant properties.
Definition: Image.hh:36
shared_ptr< const Material > ConstMaterialPtr
Definition: RenderTypes.hh:345
Represents a center of mass visual.
Definition: COMVisual.hh:36
shared_ptr< const ShaderParams > ConstShaderParamsPtr
Shared pointer to const ShaderParams.
Definition: RenderTypes.hh:404
shared_ptr< const RenderWindow > ConstRenderWindowPtr
Definition: RenderTypes.hh:393
Manages a single scene-graph. This class updates scene-wide properties and holds the root scene node...
Definition: Scene.hh:49
shared_ptr< Grid > GridPtr
Shared pointer to Grid.
Definition: RenderTypes.hh:155
Represents a off-screen render-texture to which cameras can render images.
Definition: RenderTarget.hh:103
Class to manage a particle emitter.
Definition: ParticleEmitter.hh:58
shared_ptr< Object > ObjectPtr
Shared pointer to Object.
Definition: RenderTypes.hh:207
shared_ptr< const Image > ConstImagePtr
Definition: RenderTypes.hh:333
Poseable BoundingBox camera used for rendering bounding boxes of objects in the scene.
Definition: BoundingBoxCamera.hh:54
Posable camera used for rendering the scene graph.
Definition: Camera.hh:49
shared_ptr< const GpuRays > ConstGpuRaysPtr
Definition: RenderTypes.hh:305
A Ray Query class used for computing ray object intersections.
Definition: RayQuery.hh:63
shared_ptr< GpuRays > GpuRaysPtr
Shared pointer to GpuRays.
Definition: RenderTypes.hh:127
Represents a visual node in a scene graph. A Visual is the only node that can have Geometry and other...
Definition: Visual.hh:33
shared_ptr< const Scene > ConstScenePtr
Definition: RenderTypes.hh:397
shared_ptr< Camera > CameraPtr
Shared pointer to Camera.
Definition: RenderTypes.hh:107
shared_ptr< PointLight > PointLightPtr
Shared pointer to PointLight.
Definition: RenderTypes.hh:219
shared_ptr< ShaderParams > ShaderParamsPtr
Shared pointer to ShaderParams.
Definition: RenderTypes.hh:253
shared_ptr< RenderPassSystem > RenderPassSystemPtr
Shared pointer to RenderPassSystem.
Definition: RenderTypes.hh:231
shared_ptr< const ObjectFactory > ConstObjectFactoryPtr
Definition: RenderTypes.hh:361
Represents a light source in the scene graph.
Definition: Light.hh:32
Represents a spotlight.
Definition: Light.hh:153
Represents a on-screen render-window to which cameras can render images.
Definition: RenderTarget.hh:119
Represents a infinite directional light.
Definition: Light.hh:121
a map that holds params to be passed to a shader
Definition: ShaderParams.hh:38
shared_ptr< DepthCamera > DepthCameraPtr
Shared pointer to DepthCamera.
Definition: RenderTypes.hh:111
shared_ptr< Mesh > MeshPtr
Shared pointer to Mesh.
Definition: RenderTypes.hh:199
Represents a inertia visual.
Definition: InertiaVisual.hh:35
Represents a collection of mesh geometries.
Definition: Mesh.hh:37
A render pass that applies distortion to the render target.
Definition: DistortionPass.hh:37
shared_ptr< const ParticleEmitter > ConstParticleEmitterPtr
Definition: RenderTypes.hh:365
shared_ptr< const Text > ConstTextPtr
Definition: RenderTypes.hh:416
Represents a grid geometry drawn along the XY plane. If vertical cell count is specified then the gri...
Definition: Grid.hh:34
shared_ptr< Sensor > SensorPtr
Shared pointer to Sensor.
Definition: RenderTypes.hh:250
shared_ptr< Node > NodePtr
Shared pointer to Node.
Definition: RenderTypes.hh:203
An abstract interface to a concrete render-engine. A RenderEngine is responsible for initializing a r...
Definition: RenderEngine.hh:36
shared_ptr< Visual > VisualPtr
Shared pointer to Visual.
Definition: RenderTypes.hh:269
shared_ptr< SegmentationCamera > SegmentationCameraPtr
Shared pointer to Segmentation Camera.
Definition: RenderTypes.hh:123
shared_ptr< const AxisVisual > ConstAxisVisualPtr
Definition: RenderTypes.hh:281
shared_ptr< const ThermalCamera > ConstThermalCameraPtr
Definition: RenderTypes.hh:293
shared_ptr< const Visual > ConstVisualPtr
Definition: RenderTypes.hh:420
Represents a geometric shape to be rendered.
Definition: Geometry.hh:35
Represents a surface material of a Geometry.
Definition: Material.hh:47
shared_ptr< const SubMesh > ConstSubMeshPtr
Definition: RenderTypes.hh:412
Draws a wireframe box.
Definition: WireBox.hh:32
shared_ptr< Material > MaterialPtr
Shared pointer to Material.
Definition: RenderTypes.hh:191
shared_ptr< BoundingBoxCamera > BoundingBoxCameraPtr
Shared pointer to BoundingBoxCamera.
Definition: RenderTypes.hh:119
Represents an object present in the scene graph. This includes sub-meshes, materials, render targets, as well as posable nodes.
Definition: Object.hh:34
A gizmo that contains rotate, translate, and scale visuals.
Definition: GizmoVisual.hh:34
shared_ptr< GizmoVisual > GizmoVisualPtr
Shared pointer to GizmoVisual.
Definition: RenderTypes.hh:147
shared_ptr< const RenderTexture > ConstRenderTexturePtr
Definition: RenderTypes.hh:389
Represents a single mesh geometry.
Definition: Mesh.hh:135
shared_ptr< const DirectionalLight > ConstDirectionalLightPtr
Definition: RenderTypes.hh:309
shared_ptr< const SegmentationCamera > ConstSegmentationCameraPtr
Definition: RenderTypes.hh:301
shared_ptr< InertiaVisual > InertiaVisualPtr
Definition: RenderTypes.hh:171
A LidarVisual geometry class. The visual appearance is based on the type specified.
Definition: LidarVisual.hh:55
shared_ptr< ThermalCamera > ThermalCameraPtr
Shared pointer to ThermalCamera.
Definition: RenderTypes.hh:115