MinimalScene Class Reference

Creates a Gazebo rendering scene and user camera. It is possible to orbit the camera around the scene with the mouse. Use other plugins to manage objects in the scene. More...

#include <MinimalScene.hh>

Public Slots
void	OnDropped (const QString &_drop, int _mouseX, int _mouseY)
	Callback when receives a drop event.
void	OnFocusWindow ()
	Callback when the mouse enters the render window to focus the window for mouse/key events.
void	OnHovered (int _mouseX, int _mouseY)
	Callback when the mouse hovers to a new position.

Signals
void	LoadingErrorChanged ()
	Notify that loading error has changed.

Public Member Functions
	MinimalScene ()
	Constructor.
virtual void	LoadConfig (const tinyxml2::XMLElement *_pluginElem) override
Q_INVOKABLE QString	LoadingError () const
	Get the loading error string.
Q_INVOKABLE void	SetLoadingError (const QString &_loadingError)
	Set the loading error message.

Properties
QString	loadingError
	Loading error message.

Detailed Description

Creates a Gazebo rendering scene and user camera. It is possible to orbit the camera around the scene with the mouse. Use other plugins to manage objects in the scene.

Only one plugin displaying a Gazebo Rendering scene can be used at a time.

Configuration

• <engine> : Optional render engine name, defaults to 'ogre'. If another engine is already loaded, that will be used, because only one engine is supported at a time currently.
• <scene> : Optional scene name, defaults to 'scene'. The plugin will create a scene with this name if there isn't one yet. If there is already one, a new camera is added to it.
• <ambient_light> : Optional color for ambient light, defaults to (0.3, 0.3, 0.3, 1.0)
• <background_color> : Optional background color, defaults to (0.3, 0.3, 0.3, 1.0)
• <camera_pose> : Optional starting pose for the camera, defaults to (0, 0, 5, 0, 0, 0)
• <camera_clip> : Optional near/far clipping distance for camera
  • <near> : Camera's near clipping plane distance, defaults to 0.01
  • <far> : Camera's far clipping plane distance, defaults to 1000.0
• <sky> : If present, sky is enabled.
• <horizontal_fov> : Horizontal FOV of the user camera in degrees, defaults to 90
• <graphics_api> : Optional graphics API name. Valid choices are: 'opengl', 'metal'. Defaults to 'opengl'.
• <view_controller> : Set the view controller (InteractiveViewControl currently supports types: ortho or orbit).

Constructor & Destructor Documentation

MinimalScene()

MinimalScene

(

)

Constructor.

Member Function Documentation

LoadConfig()

virtual void LoadConfig ( const tinyxml2::XMLElement *  _pluginElem )

overridevirtual

LoadingError()

Q_INVOKABLE QString LoadingError

(

)

const

Get the loading error string.

Returns

String explaining the loading error. If empty, there's no error.

LoadingErrorChanged

void LoadingErrorChanged ( )

signal

Notify that loading error has changed.

OnDropped

void OnDropped ( const QString &  _drop, int  _mouseX, int  _mouseY  )

slot

Callback when receives a drop event.

Parameters

[in]	_drop	Dropped string.
[in]	_mouseX	x coordinate of mouse position.
[in]	_mouseY	y coordinate of mouse position.

OnFocusWindow

void OnFocusWindow ( )

slot

Callback when the mouse enters the render window to focus the window for mouse/key events.

OnHovered

void OnHovered ( int  _mouseX, int  _mouseY  )

slot

Callback when the mouse hovers to a new position.

Parameters

[in]	_mouseX	x coordinate of the hovered mouse position.
[in]	_mouseY	y coordinate of the hovered mouse position.

SetLoadingError()

Q_INVOKABLE void SetLoadingError

(

const QString &

_loadingError

)

Set the loading error message.

Parameters

[in]

_loadingError

Error message.

Property Documentation

loadingError

QString loadingError

readwrite

Loading error message.

---

The documentation for this class was generated from the following file:

• MinimalScene.hh