##

gazebo::rendering Namespace Reference
Rendering

Rendering namespace. More...

## 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 | CustomGLSLProgramWriter
| This overrides ogre's default GLSLProgramWriter to fix a bug in ogre versions <= 1.8 where 'sampler2DShadow' sampler type is missing. More...
class | CustomGLSLProgramWriterFactory
| A factory to create our own CustomGLSLProgramWriter. More...
class | CustomPSSM3
| Custom PSSM shadow receiver that overrides one deficient method in IntegratedPSSM3. More...
class | CustomPSSM3Factory
| A factory that enables creation of CustomPSSM3 instances. More...
class | CustomPSSMShadowCameraSetup
| Parallel Split Shadow Map (PSSM) shadow camera setup. 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...
struct | GpuLaserData
| struct containing info about a single ray measurement More...
class | GpuLaserDataIterator
| const Bidirectional iterator for laser data 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 | 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...

## Typedefs

typedef std::shared_ptr< ApplyWrenchVisual > | ApplyWrenchVisualPtr
typedef std::shared_ptr< ArrowVisual > | ArrowVisualPtr
typedef std::shared_ptr< AxisVisual > | AxisVisualPtr
typedef boost::shared_ptr< Camera > | CameraPtr
typedef std::shared_ptr< CameraVisual > | CameraVisualPtr
typedef std::shared_ptr< COMVisual > | COMVisualPtr
typedef std::shared_ptr< ContactVisual > | ContactVisualPtr
typedef boost::shared_ptr< DepthCamera > | DepthCameraPtr
typedef boost::shared_ptr< Distortion > | DistortionPtr
typedef boost::shared_ptr< DynamicLines > | DynamicLinesPtr
typedef boost::shared_ptr< GpuLaser > | GpuLaserPtr
typedef std::shared_ptr< InertiaVisual > | InertiaVisualPtr
typedef std::shared_ptr< JointVisual > | JointVisualPtr
typedef std::shared_ptr< LaserVisual > | LaserVisualPtr
typedef std::shared_ptr< LensFlare > | LensFlarePtr
typedef boost::shared_ptr< Light > | LightPtr
typedef std::shared_ptr< LinkFrameVisual > | LinkFrameVisualPtr
typedef std::shared_ptr< LogicalCameraVisual > | LogicalCameraVisualPtr
typedef std::shared_ptr< OriginVisual > | OriginVisualPtr
typedef boost::shared_ptr< RayQuery > | RayQueryPtr
typedef std::shared_ptr< RFIDTagVisual > | RFIDTagVisualPtr
typedef std::shared_ptr< RFIDVisual > | RFIDVisualPtr
typedef std::shared_ptr< Road2d > | Road2dPtr
typedef boost::shared_ptr< Scene > | ScenePtr
typedef std::shared_ptr< SelectionObj > | SelectionObjPtr
typedef std::shared_ptr< SonarVisual > | SonarVisualPtr
typedef boost::shared_ptr< UserCamera > | UserCameraPtr
typedef std::shared_ptr< Visual > | VisualPtr
typedef std::weak_ptr< Visual > | VisualWeakPtr
typedef boost::shared_ptr< WideAngleCamera > | WideAngleCameraPtr
typedef boost::shared_ptr< WindowManager > | WindowManagerPtr
typedef std::shared_ptr< WrenchVisual > | WrenchVisualPtr

## Enumerations

enum | ReferenceFrame { RF_LOCAL, RF_PARENT, RF_WORLD }
| Frame of reference. More...
enum | RenderOpType { RENDERING_POINT_LIST = 0, RENDERING_LINE_LIST = 1, RENDERING_LINE_STRIP = 2, RENDERING_TRIANGLE_LIST = 3, RENDERING_TRIANGLE_STRIP = 4, RENDERING_TRIANGLE_FAN = 5, RENDERING_MESH_RESOURCE = 6 }
| Type of render operation for a drawable. 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

Rendering namespace.

## Typedef Documentation

## ApplyWrenchVisualPtr

typedef std::shared_ptr<ApplyWrenchVisual> ApplyWrenchVisualPtr

## ArrowVisualPtr

typedef std::shared_ptr<ArrowVisual> ArrowVisualPtr

## AxisVisualPtr

typedef std::shared_ptr<AxisVisual> AxisVisualPtr

## CameraPtr

typedef boost::shared_ptr<Camera> CameraPtr

## CameraVisualPtr

typedef std::shared_ptr<CameraVisual> CameraVisualPtr

## COMVisualPtr

typedef std::shared_ptr<COMVisual> COMVisualPtr

## ContactVisualPtr

typedef std::shared_ptr<ContactVisual> ContactVisualPtr

## DepthCameraPtr

typedef boost::shared_ptr<DepthCamera> DepthCameraPtr

## DistortionPtr

typedef boost::shared_ptr<Distortion> DistortionPtr

## DynamicLinesPtr

typedef boost::shared_ptr<DynamicLines> DynamicLinesPtr

## GpuLaserPtr

typedef boost::shared_ptr<GpuLaser> GpuLaserPtr

## InertiaVisualPtr

typedef std::shared_ptr<InertiaVisual> InertiaVisualPtr

## JointVisualPtr

typedef std::shared_ptr<JointVisual> JointVisualPtr

## LaserVisualPtr

typedef std::shared_ptr<LaserVisual> LaserVisualPtr

## LensFlarePtr

typedef std::shared_ptr<LensFlare> LensFlarePtr

## LightPtr

typedef boost::shared_ptr<Light> LightPtr

## LinkFrameVisualPtr

typedef std::shared_ptr<LinkFrameVisual> LinkFrameVisualPtr

## LogicalCameraVisualPtr

typedef std::shared_ptr<LogicalCameraVisual> LogicalCameraVisualPtr

## OriginVisualPtr

typedef std::shared_ptr<OriginVisual> OriginVisualPtr

## RayQueryPtr

typedef boost::shared_ptr<RayQuery> RayQueryPtr

## RFIDTagVisualPtr

typedef std::shared_ptr<RFIDTagVisual> RFIDTagVisualPtr

## RFIDVisualPtr

typedef std::shared_ptr<RFIDVisual> RFIDVisualPtr

## Road2dPtr

typedef std::shared_ptr<Road2d> Road2dPtr

## ScenePtr

typedef boost::shared_ptr<Scene> ScenePtr

## SelectionObjPtr

typedef std::shared_ptr<SelectionObj> SelectionObjPtr

## SonarVisualPtr

typedef std::shared_ptr<SonarVisual> SonarVisualPtr

## UserCameraPtr

typedef boost::shared_ptr<UserCamera> UserCameraPtr

## VisualPtr

typedef std::shared_ptr<Visual> VisualPtr

## VisualWeakPtr

typedef std::weak_ptr<Visual> VisualWeakPtr

## WideAngleCameraPtr

typedef boost::shared_ptr<WideAngleCamera> WideAngleCameraPtr

## WindowManagerPtr

typedef boost::shared_ptr<WindowManager> WindowManagerPtr

## WrenchVisualPtr

typedef std::shared_ptr<WrenchVisual> WrenchVisualPtr

## Enumeration Type Documentation

## ReferenceFrame

enum ReferenceFrame

Frame of reference.

Enumerator
RF_LOCAL | Local frame.
RF_PARENT | Parent frame.
RF_WORLD | World frame.

## RenderOpType

enum RenderOpType

Type of render operation for a drawable.

Enumerator
RENDERING_POINT_LIST | A list of points, 1 vertex per point.
RENDERING_LINE_LIST | A list of lines, 2 vertices per line.
RENDERING_LINE_STRIP | A strip of connected lines, 1 vertex per line plus 1 start vertex.
RENDERING_TRIANGLE_LIST | A list of triangles, 3 vertices per triangle.
RENDERING_TRIANGLE_STRIP | A strip of triangles, 3 vertices for the first triangle, and 1 per triangle after that.
RENDERING_TRIANGLE_FAN | A fan of triangles, 3 vertices for the first triangle, and 1 per triangle after that.
RENDERING_MESH_RESOURCE | N/A.