Namespaces | Classes | Enumerations | Functions
Rendering

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

Namespaces

 gazebo::rendering
 Rendering namespace.
 

Classes

class  gazebo::rendering::ApplyWrenchVisual
 Visualization for the apply wrench GUI. More...
 
class  gazebo::rendering::ArrowVisual
 Basic arrow visualization. More...
 
class  gazebo::rendering::AxisVisual
 Basic axis visualization. More...
 
class  gazebo::rendering::Camera
 Basic camera sensor. More...
 
class  gazebo::rendering::CameraVisual
 Basic camera visualization. More...
 
class  gazebo::rendering::COMVisual
 Basic Center of Mass visualization. More...
 
class  gazebo::rendering::ContactVisual
 Contact visualization. More...
 
class  gazebo::rendering::Conversions
 Conversions Conversions.hh rendering/Conversions.hh. More...
 
class  gazebo::rendering::DepthCamera
 Depth camera used to render depth data into an image buffer. More...
 
class  gazebo::rendering::Distortion
 Camera distortion based on Brown's model. More...
 
class  gazebo::rendering::DynamicLines
 Class for drawing lines that can change. More...
 
class  gazebo::rendering::DynamicRenderable
 Abstract base class providing mechanisms for dynamically growing hardware buffers. More...
 
class  gazebo::rendering::Events
 Base class for rendering events. More...
 
class  gazebo::rendering::FPSViewController
 First Person Shooter style view controller. More...
 
class  gazebo::rendering::GpuLaser
 GPU based laser distance sensor. More...
 
class  gazebo::rendering::Grid
 Displays a grid of cells, drawn with lines. More...
 
class  gazebo::rendering::Heightmap
 Rendering a terrain using heightmap information. More...
 
class  gazebo::rendering::InertiaVisual
 Basic Inertia visualization. More...
 
class  gazebo::rendering::JointVisual
 Visualization for joints. More...
 
class  gazebo::rendering::LaserVisual
 Visualization for laser data. More...
 
class  gazebo::rendering::Light
 A light source. More...
 
class  gazebo::rendering::LinkFrameVisual
 Visualization for link frames. More...
 
class  gazebo::rendering::LogicalCameraVisual
 Logical camera visualization. More...
 
class  gazebo::rendering::MovableText
 Movable text. More...
 
class  gazebo::rendering::OculusCamera
 A camera used for user visualization of a scene. More...
 
class  gazebo::rendering::OrbitViewController
 Orbit view controller. More...
 
class  gazebo::rendering::OriginVisual
 Basic world origin visualization. More...
 
class  gazebo::rendering::OrthoViewController
 Orthographic view controller. More...
 
class  gazebo::rendering::Projector
 Projects a material onto surface, light a light projector. More...
 
class  gazebo::rendering::RayQuery
 A Ray Query class used for retrieving mesh data of a visual, adapted from Ogre3D wiki. More...
 
class  gazebo::rendering::RenderEngine
 Adaptor to Ogre3d. More...
 
class  gazebo::rendering::RFIDTagVisual
 Visualization for RFID tags sensor. More...
 
class  gazebo::rendering::RFIDVisual
 Visualization for RFID sensor. More...
 
class  Road
 Used to render a strip of road. More...
 
class  gazebo::rendering::Road2d
 
class  gazebo::rendering::RTShaderSystem
 Implements Ogre's Run-Time Shader system. More...
 
class  gazebo::rendering::Scene
 Representation of an entire scene graph. More...
 
class  gazebo::rendering::SelectionObj
 Interactive selection object for models and links. More...
 
class  gazebo::rendering::SonarVisual
 Visualization for sonar data. More...
 
class  gazebo::rendering::TransmitterVisual
 Visualization for the wireless propagation data. More...
 
class  gazebo::rendering::UserCamera
 A camera used for user visualization of a scene. More...
 
class  gazebo::rendering::VideoVisual
 A visual element that displays a video as a texture. More...
 
class  gazebo::rendering::ViewController
 Base class for view controllers. More...
 
class  gazebo::rendering::Visual
 A renderable object. More...
 
class  gazebo::rendering::WindowManager
 Class to mangage render windows. More...
 
class  gazebo::rendering::WireBox
 Draws a wireframe box. More...
 
class  gazebo::rendering::WrenchVisual
 Visualization for sonar data. More...
 

Enumerations

enum  gazebo::rendering::MovableText::HorizAlign { gazebo::rendering::MovableText::H_LEFT, gazebo::rendering::MovableText::H_CENTER }
 Horizontal alignment. More...
 
enum  gazebo::rendering::RTShaderSystem::LightingModel { gazebo::rendering::RTShaderSystem::SSLM_PerVertexLighting, gazebo::rendering::RTShaderSystem::SSLM_PerPixelLighting, gazebo::rendering::RTShaderSystem::SSLM_NormalMapLightingTangentSpace, gazebo::rendering::RTShaderSystem::SSLM_NormalMapLightingObjectSpace }
 
enum  gazebo::rendering::ApplyWrenchVisual::Mode { gazebo::rendering::ApplyWrenchVisual::NONE = 0, gazebo::rendering::ApplyWrenchVisual::FORCE = 1, gazebo::rendering::ApplyWrenchVisual::TORQUE = 2 }
 
enum  gazebo::rendering::RenderEngine::RenderPathType {
  gazebo::rendering::RenderEngine::NONE = 0, gazebo::rendering::RenderEngine::VERTEX = 1, gazebo::rendering::RenderEngine::FORWARD = 2, gazebo::rendering::RenderEngine::DEFERRED = 3,
  gazebo::rendering::RenderEngine::RENDER_PATH_COUNT
}
 The type of rendering path used by the rendering engine. More...
 
enum  gazebo::rendering::SelectionObj::SelectionMode {
  gazebo::rendering::SelectionObj::SELECTION_NONE = 0, gazebo::rendering::SelectionObj::TRANS, gazebo::rendering::SelectionObj::ROT, gazebo::rendering::SelectionObj::SCALE,
  gazebo::rendering::SelectionObj::TRANS_X, gazebo::rendering::SelectionObj::TRANS_Y, gazebo::rendering::SelectionObj::TRANS_Z, gazebo::rendering::SelectionObj::ROT_X,
  gazebo::rendering::SelectionObj::ROT_Y, gazebo::rendering::SelectionObj::ROT_Z, gazebo::rendering::SelectionObj::SCALE_X, gazebo::rendering::SelectionObj::SCALE_Y,
  gazebo::rendering::SelectionObj::SCALE_Z
}
 
enum  gazebo::rendering::Scene::SkyXMode { gazebo::rendering::Scene::GZ_SKYX_ALL = 0x0FFFFFFF, gazebo::rendering::Scene::GZ_SKYX_CLOUDS = 0x0000001, gazebo::rendering::Scene::GZ_SKYX_MOON = 0x0000002, gazebo::rendering::Scene::GZ_SKYX_NONE = 0 }
 
enum  gazebo::rendering::MovableText::VertAlign { gazebo::rendering::MovableText::V_BELOW, gazebo::rendering::MovableText::V_ABOVE }
 vertical alignment More...
 
enum  gazebo::rendering::Visual::VisualType {
  gazebo::rendering::Visual::VT_ENTITY, gazebo::rendering::Visual::VT_MODEL, gazebo::rendering::Visual::VT_LINK, gazebo::rendering::Visual::VT_VISUAL,
  gazebo::rendering::Visual::VT_COLLISION, gazebo::rendering::Visual::VT_SENSOR, gazebo::rendering::Visual::VT_GUI, gazebo::rendering::Visual::VT_PHYSICS
}
 Type of visual. More...
 

Functions

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

Detailed Description

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

Enumeration Type Documentation

Horizontal alignment.

Enumerator
H_LEFT 

Left alignment.

H_CENTER 

Center alignment.

The type of lighting.

Enumerator
SSLM_PerVertexLighting 

Per-Vertex lighting: best performance.

SSLM_PerPixelLighting 

Per-Pixel lighting: best look.

SSLM_NormalMapLightingTangentSpace 

Normal Map lighting: lighting calculations have been stored in a light map (texture) using tangent space.

SSLM_NormalMapLightingObjectSpace 

Normal Map lighting: lighting calculations have been stored in a light map (texture) using object space.

Enumerator
NONE 

None.

FORCE 

Force.

TORQUE 

Torque.

The type of rendering path used by the rendering engine.

Enumerator
NONE 

No rendering is done.

VERTEX 

Most basic rendering, with least fidelity.

FORWARD 

Utilizes the RTT shader system.

DEFERRED 

Utilizes deferred rendering. Best fidelity.

RENDER_PATH_COUNT 

Count of the rendering path enums.

Enumerator
SELECTION_NONE 

Translation in x.

TRANS 

Translation mode.

ROT 

Rotation mode.

SCALE 

Scale mode.

TRANS_X 

Translation in x.

TRANS_Y 

Translation in y.

TRANS_Z 

Translation in z.

ROT_X 

Rotation in x.

ROT_Y 

Rotation in y.

ROT_Z 

Rotation in z.

SCALE_X 

Scale in x.

SCALE_Y 

Scale in y.

SCALE_Z 

Scale in z.

Enumerator
GZ_SKYX_ALL 
GZ_SKYX_CLOUDS 
GZ_SKYX_MOON 
GZ_SKYX_NONE 

vertical alignment

Enumerator
V_BELOW 

Align below.

V_ABOVE 

Align above.

Type of visual.

Enumerator
VT_ENTITY 

Entity visual.

VT_MODEL 

Model visual.

VT_LINK 

Link visual.

VT_VISUAL 

Visual visual.

VT_COLLISION 

Collision visual.

VT_SENSOR 

Sensor visual.

VT_GUI 

GUI visual.

VT_PHYSICS 

Physics data visual.

Function Documentation

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

create rendering::Scene by name.

Parameters
[in]_nameName of the scene to create.
[in]_enableVisualizationsTrue enables visualization elements such as laser lines.
GZ_RENDERING_VISIBLE bool gazebo::rendering::fini ( )

teardown rendering engine.

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

get pointer to rendering::Scene by name.

Parameters
[in]_nameName of the scene to retreive.
GZ_RENDERING_VISIBLE bool gazebo::rendering::init ( )

init rendering engine.

GZ_RENDERING_VISIBLE bool gazebo::rendering::load ( )

load rendering engine.

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

remove a rendering::Scene by name

Parameters
[in]_nameThe name of the scene to remove.