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 = c1ffun(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 Brown's 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	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 sonar data. More...

Enumerations
enum	HorizAlign { H_LEFT, H_CENTER }
	Horizontal alignment. More...

enum	LightingModel { SSLM_PerVertexLighting, SSLM_PerPixelLighting, SSLM_NormalMapLightingTangentSpace, SSLM_NormalMapLightingObjectSpace }

enum	Mode { NONE = 0, FORCE = 1, TORQUE = 2 }

enum	RenderPathType { NONE = 0, VERTEX = 1, FORWARD = 2, DEFERRED = 3, RENDER_PATH_COUNT }
	The type of rendering path used by the rendering engine. More...

enum	SelectionMode { SELECTION_NONE = 0, TRANS, ROT, SCALE, TRANS_X, TRANS_Y, TRANS_Z, ROT_X, ROT_Y, ROT_Z, SCALE_X, SCALE_Y, SCALE_Z }

enum	SkyXMode { GZ_SKYX_ALL = 0x0FFFFFFF, GZ_SKYX_CLOUDS = 0x0000001, GZ_SKYX_MOON = 0x0000002, GZ_SKYX_NONE = 0 }

enum	VertAlign { V_BELOW, V_ABOVE }
	vertical alignment More...

enum	VisualType { VT_ENTITY, VT_MODEL, VT_LINK, VT_VISUAL, VT_COLLISION, VT_SENSOR, VT_GUI, VT_PHYSICS }
	Type of visual. 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.

Enumeration Type Documentation

enum HorizAlign

Horizontal alignment.

Enumerator
H_LEFT	Left alignment.
H_CENTER	Center alignment.

enum LightingModel

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.

enum Mode

Enumerator
NONE	None.
FORCE	Force.
TORQUE	Torque.

enum RenderPathType

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.

enum SelectionMode

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.

enum SkyXMode

Enumerator
GZ_SKYX_ALL
GZ_SKYX_CLOUDS
GZ_SKYX_MOON
GZ_SKYX_NONE

enum VertAlign

vertical alignment

Enumerator
V_BELOW	Align below.
V_ABOVE	Align above.

enum VisualType

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

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.

bool gazebo::rendering::fini ( )

teardown rendering engine.

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.

bool gazebo::rendering::init ( )

init rendering engine.

bool gazebo::rendering::load ( )

load rendering engine.

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.

Namespaces

Classes

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

Function Documentation