##

Rendering

A set of rendering related class, functions, and definitions. More...

## Namespaces

| gazebo::rendering
| Rendering namespace.

## Classes

class | ApplyWrenchVisual
| Visualization for the apply wrench GUI. More...
class | ArrowVisual
| Basic arrow visualization. More...
class | AxisVisual
| Basic axis visualization. More...
class | Camera
| Basic camera sensor. More...
class | CameraLens
| Describes a lens of a camera as amapping function of type r = c1*f*fun(theta/c2+c3) More...
class | CameraVisual
| Basic camera visualization. More...
class | COMVisual
| Basic Center of Mass visualization. More...
class | ContactVisual
| Contact visualization. More...
class | Conversions
| Conversions Conversions.hh rendering/Conversions.hh. More...
class | DepthCamera
| Depth camera used to render depth data into an image buffer. More...
class | Distortion
| Camera distortion based on the Brown-Conrady model. More...
class | DynamicLines
| Class for drawing lines that can change. More...
class | DynamicRenderable
| Abstract base class providing mechanisms for dynamically growing hardware buffers. More...
class | Events
| Base class for rendering events. More...
class | FPSViewController
| First Person Shooter style view controller. More...
class | GpuLaser
| GPU based laser distance sensor. More...
class | Grid
| Displays a grid of cells, drawn with lines. More...
class | Heightmap
| Rendering a terrain using heightmap information. More...
class | InertiaVisual
| Basic Inertia visualization. More...
class | JointVisual
| Visualization for joints. More...
class | LaserVisual
| Visualization for laser data. More...
class | LensFlare
| Camera lens flare compositor. This lens flare effect does not perform any depth checking so if the directional light is occluded by an object in the scene, lens flare will pass through the object. The lens flare's color is set by the shaders and not exposed through an API in this class. More...
class | Light
| A light source. More...
class | LinkFrameVisual
| Visualization for link frames. More...
class | LogicalCameraVisual
| Logical camera visualization. More...
class | MovableText
| Movable text. More...
class | OculusCamera
| A camera used for user visualization of a scene. More...
class | OrbitViewController
| Orbit view controller. More...
class | OriginVisual
| Basic world origin visualization. More...
class | OrthoViewController
| Orthographic view controller. More...
class | Projector
| Projects a material onto surface, light a light projector. More...
class | RayQuery
| A Ray Query class used for retrieving mesh data of a visual, adapted from Ogre3D wiki. More...
class | RenderEngine
| Adaptor to Ogre3d. More...
class | RFIDTagVisual
| Visualization for RFID tags sensor. More...
class | RFIDVisual
| Visualization for RFID sensor. More...
class | Road
| Used to render a strip of road. More...
class | Road2d
class | RTShaderSystem
| Implements Ogre's Run-Time Shader system. More...
class | Scene
| Representation of an entire scene graph. More...
class | SelectionObj
| Interactive selection object for models and links. More...
class | SonarVisual
| Visualization for sonar data. More...
class | TransmitterVisual
| Visualization for the wireless propagation data. More...
class | UserCamera
| A camera used for user visualization of a scene. More...
class | VideoVisual
| A visual element that displays a video as a texture. More...
class | ViewController
| Base class for view controllers. More...
class | Visual
| A renderable object. More...
class | WideAngleCamera
| Camera with variable mapping function. More...
class | WindowManager
| Class to mangage render windows. More...
class | WireBox
| Draws a wireframe box. More...
class | WrenchVisual
| Visualization for wrench data. It consists of a purple line pointing at the force direction and 3 RGB cones representing the torque about the XYZ directions. More...

## Functions

rendering::ScenePtr | create_scene (const std::string &_name, bool _enableVisualizations, bool _isServer=false)
| create rendering::Scene by name. More...
bool | fini ()
| teardown rendering engine. More...
rendering::ScenePtr | get_scene (const std::string &_name="")
| get pointer to rendering::Scene by name. More...
bool | init ()
| init rendering engine. More...
bool | load ()
| load rendering engine. More...
void | remove_scene (const std::string &_name)
| remove a rendering::Scene by name More...

## Detailed Description

A set of rendering related class, functions, and definitions.

## Function Documentation

## create_scene()

rendering::ScenePtr gazebo::rendering::create_scene | ( | const std::string & | _name,
|  | bool | _enableVisualizations,
|  | bool | _isServer = `false`
| ) |  |

create rendering::Scene by name.

Parameters

  [in] | _name | Name of the scene to create.
  [in] | _enableVisualizations | True enables visualization elements such as laser lines.

## fini()

bool gazebo::rendering::fini | ( |  | ) |

teardown rendering engine.

## get_scene()

rendering::ScenePtr gazebo::rendering::get_scene | ( | const std::string & | _name = `""` | ) |

get pointer to rendering::Scene by name.

Parameters

  [in] | _name | Name of the scene to retreive.

## init()

bool gazebo::rendering::init | ( |  | ) |

init rendering engine.

## load()

bool gazebo::rendering::load | ( |  | ) |

load rendering engine.

## remove_scene()

void gazebo::rendering::remove_scene | ( | const std::string & | _name | ) |

remove a rendering::Scene by name

Parameters

  [in] | _name | The name of the scene to remove.