A QQUickItem that manages the render window. More...

#include <MinimalScene.hh>

Public Slots
void	Ready ()
	Slot called when thread is ready to be started. More...

void	Ready ()
	Slot called when thread is ready to be started. More...

Public Member Functions
	RenderWindowItem (QQuickItem *_parent=nullptr)
	Constructor. More...

	RenderWindowItem (QQuickItem *_parent=nullptr)
	Constructor. More...

virtual	~RenderWindowItem ()
	Destructor. More...

	~RenderWindowItem ()

void	HandleKeyPress (const common::KeyEvent &_e)
	Handle key press event for snapping. More...

void	HandleKeyPress (QKeyEvent *_e)
	Handle key press event for snapping. More...

void	HandleKeyRelease (const common::KeyEvent &_e)
	Handle key release event for snapping. More...

void	HandleKeyRelease (QKeyEvent *_e)
	Handle key release event for snapping. More...

void	OnDropped (const QString &_drop, const gz::math::Vector2i &_dropPos)
	Callback when receives a drop event. More...

void	OnHovered (const gz::math::Vector2i &_hoverPos)
	Called when the mouse hovers to a new position. More...

void	OnHovered (const gz::math::Vector2i &_hoverPos)
	Called when the mouse hovers to a new position. More...

void	SetAmbientLight (const math::Color &_ambient)
	Set ambient light of render window. More...

void	SetAmbientLight (const math::Color &_ambient)
	Set ambient light of render window. More...

void	SetBackgroundColor (const math::Color &_color)
	Set background color of render window. More...

void	SetBackgroundColor (const math::Color &_color)
	Set background color of render window. More...

void	SetCameraFarClip (double _far)
	Set the render window camera's far clipping plane distance. More...

void	SetCameraHFOV (const math::Angle &_fov)
	Set the Horizontal FOV of the camera. More...

void	SetCameraNearClip (double _near)
	Set the render window camera's near clipping plane distance. More...

void	SetCameraPose (const math::Pose3d &_pose)
	Set the initial pose the render window camera. More...

void	SetCameraPose (const math::Pose3d &_pose)
	Set the initial pose the render window camera. More...

void	SetCameraViewController (const std::string &_view_controller)
	Set the camera view controller. More...

void	SetDeletionTopic (const std::string &_topic)
	Set deletion topic to use for deleting objects from the scene The renderer will subscribe to this topic to get notified when entities in the scene get deleted. More...

void	SetEngineName (const std::string &_name)
	Set engine name used to create the render window. More...

void	SetEngineName (const std::string &_name)
	Set engine name used to create the render window. More...

void	SetErrorCb (std::function< void(const QString &)> _cb)
	Set a callback to be called in case there are errors. More...

void	SetErrorCb (std::function< void(const QString &)> _cb)
	Set a callback to be called in case there are errors. More...

void	SetPoseTopic (const std::string &_topic)
	Set pose topic to use for updating objects in the scene The renderer will subscribe to this topic to get pose messages of visuals in the scene. More...

void	SetSceneName (const std::string &_name)
	Set name of scene created inside the render window. More...

void	SetSceneName (const std::string &_name)
	Set name of scene created inside the render window. More...

void	SetSceneService (const std::string &_service)
	Set scene service to use in this render window A service call will be made using ign-transport to get scene data using this service. More...

void	SetSceneTopic (const std::string &_topic)
	Set the scene topic to use for updating objects in the scene The renderer will subscribe to this topic to get updates scene messages. More...

void	SetSkyEnabled (const bool &_sky)
	Set if sky is enabled. More...

void	StopRendering ()
	Stop rendering and shutdown resources. More...

Protected Member Functions
virtual void	keyPressEvent (QKeyEvent *_e) override

virtual void	keyPressEvent (QKeyEvent *_event) override

virtual void	keyReleaseEvent (QKeyEvent *_e) override

virtual void	keyReleaseEvent (QKeyEvent *_event) override

virtual void	mouseMoveEvent (QMouseEvent *_e) override

virtual void	mouseMoveEvent (QMouseEvent *_e) override

virtual void	mousePressEvent (QMouseEvent *_e) override

virtual void	mousePressEvent (QMouseEvent *_e) override

virtual void	mouseReleaseEvent (QMouseEvent *_e) override

virtual void	mouseReleaseEvent (QMouseEvent *_e) override

virtual void	wheelEvent (QWheelEvent *_e) override

virtual void	wheelEvent (QWheelEvent *_e) override

Detailed Description

A QQUickItem that manages the render window.

Constructor & Destructor Documentation

◆ RenderWindowItem() [1/2]

RenderWindowItem ( QQuickItem * _parent = nullptr )

explicit

Constructor.

Parameters

[in] _parent Parent item

◆ ~RenderWindowItem() [1/2]

~RenderWindowItem ( )

◆ RenderWindowItem() [2/2]

RenderWindowItem ( QQuickItem * _parent = nullptr )

explicit

Constructor.

Parameters

[in] _parent Parent item

◆ ~RenderWindowItem() [2/2]

virtual ~RenderWindowItem ( )

virtual

Destructor.

Member Function Documentation

◆ HandleKeyPress() [1/2]

void HandleKeyPress ( const common::KeyEvent & _e )

Handle key press event for snapping.

Parameters

[in] _e The key event to process.

◆ HandleKeyPress() [2/2]

void HandleKeyPress ( QKeyEvent * _e )

Handle key press event for snapping.

Parameters

[in] _e The key event to process.

◆ HandleKeyRelease() [1/2]

void HandleKeyRelease ( const common::KeyEvent & _e )

Handle key release event for snapping.

Parameters

[in] _e The key event to process.

◆ HandleKeyRelease() [2/2]

void HandleKeyRelease ( QKeyEvent * _e )

Handle key release event for snapping.

Parameters

[in] _e The key event to process.

◆ keyPressEvent() [1/2]

virtual void keyPressEvent ( QKeyEvent * _e )

overrideprotectedvirtual

◆ keyPressEvent() [2/2]

virtual void keyPressEvent ( QKeyEvent * _event )

overrideprotectedvirtual

◆ keyReleaseEvent() [1/2]

virtual void keyReleaseEvent ( QKeyEvent * _e )

overrideprotectedvirtual

◆ keyReleaseEvent() [2/2]

virtual void keyReleaseEvent ( QKeyEvent * _event )

overrideprotectedvirtual

◆ mouseMoveEvent() [1/2]

virtual void mouseMoveEvent ( QMouseEvent * _e )

overrideprotectedvirtual

◆ mouseMoveEvent() [2/2]

virtual void mouseMoveEvent ( QMouseEvent * _e )

overrideprotectedvirtual

◆ mousePressEvent() [1/2]

virtual void mousePressEvent ( QMouseEvent * _e )

overrideprotectedvirtual

◆ mousePressEvent() [2/2]

virtual void mousePressEvent ( QMouseEvent * _e )

overrideprotectedvirtual

◆ mouseReleaseEvent() [1/2]

virtual void mouseReleaseEvent ( QMouseEvent * _e )

overrideprotectedvirtual

◆ mouseReleaseEvent() [2/2]

virtual void mouseReleaseEvent ( QMouseEvent * _e )

overrideprotectedvirtual

◆ OnDropped()

void OnDropped	(	const QString &	_drop,
		const gz::math::Vector2i &	_dropPos
	)

Callback when receives a drop event.

Parameters

[in]	_drop	Dropped string.
[in]	_dropPos	x coordinate of mouse position.

◆ OnHovered() [1/2]

void OnHovered ( const gz::math::Vector2i & _hoverPos )

Called when the mouse hovers to a new position.

Parameters

[in] _hoverPos 2D coordinates of the hovered mouse position on the render window.

◆ OnHovered() [2/2]

void OnHovered ( const gz::math::Vector2i & _hoverPos )

Called when the mouse hovers to a new position.

Parameters

[in] _hoverPos 2D coordinates of the hovered mouse position on the render window.

◆ Ready [1/2]

void Ready ( )

slot

Slot called when thread is ready to be started.

◆ Ready [2/2]

void Ready ( )

slot

Slot called when thread is ready to be started.

◆ SetAmbientLight() [1/2]

void SetAmbientLight ( const math::Color & _ambient )

Set ambient light of render window.

Parameters

[in] _ambient Color of ambient light

◆ SetAmbientLight() [2/2]

void SetAmbientLight ( const math::Color & _ambient )

Set ambient light of render window.

Parameters

[in] _ambient Color of ambient light

◆ SetBackgroundColor() [1/2]

void SetBackgroundColor ( const math::Color & _color )

Set background color of render window.

Parameters

[in] _color Color of render window background

◆ SetBackgroundColor() [2/2]

void SetBackgroundColor ( const math::Color & _color )

Set background color of render window.

Parameters

[in] _color Color of render window background

◆ SetCameraFarClip()

void SetCameraFarClip ( double _far )

Set the render window camera's far clipping plane distance.

Parameters

[in] _far Far clipping plane distance

◆ SetCameraHFOV()

void SetCameraHFOV ( const math::Angle & _fov )

Set the Horizontal FOV of the camera.

Parameters

[in] _fov FOV of the camera in degree

◆ SetCameraNearClip()

void SetCameraNearClip ( double _near )

Set the render window camera's near clipping plane distance.

Parameters

[in] _near Near clipping plane distance

◆ SetCameraPose() [1/2]

void SetCameraPose ( const math::Pose3d & _pose )

Set the initial pose the render window camera.

Parameters

[in] _pose Initical camera pose

◆ SetCameraPose() [2/2]

void SetCameraPose ( const math::Pose3d & _pose )

Set the initial pose the render window camera.

Parameters

[in] _pose Initial camera pose

◆ SetCameraViewController()

void SetCameraViewController ( const std::string & _view_controller )

Set the camera view controller.

Parameters

[in] _view_controller The camera view controller type to set

◆ SetDeletionTopic()

void SetDeletionTopic ( const std::string & _topic )

Set deletion topic to use for deleting objects from the scene The renderer will subscribe to this topic to get notified when entities in the scene get deleted.

Parameters

[in] _topic Deletion topic

◆ SetEngineName() [1/2]

void SetEngineName ( const std::string & _name )

Set engine name used to create the render window.

Parameters

[in] _name Name of render engine

◆ SetEngineName() [2/2]

void SetEngineName ( const std::string & _name )

Set engine name used to create the render window.

Parameters

[in] _name Name of render engine

◆ SetErrorCb() [1/2]

void SetErrorCb ( std::function< void(const QString &)> _cb )

Set a callback to be called in case there are errors.

Parameters

[in] _cb Error callback

◆ SetErrorCb() [2/2]

void SetErrorCb ( std::function< void(const QString &)> _cb )

Set a callback to be called in case there are errors.

Parameters

[in] _cb Error callback

◆ SetPoseTopic()

void SetPoseTopic ( const std::string & _topic )

Set pose topic to use for updating objects in the scene The renderer will subscribe to this topic to get pose messages of visuals in the scene.

Parameters

[in] _topic Pose topic

◆ SetSceneName() [1/2]

void SetSceneName ( const std::string & _name )

Set name of scene created inside the render window.

Parameters

[in] _name Name of scene

◆ SetSceneName() [2/2]

void SetSceneName ( const std::string & _name )

Set name of scene created inside the render window.

Parameters

[in] _name Name of scene

◆ SetSceneService()

void SetSceneService ( const std::string & _service )

Set scene service to use in this render window A service call will be made using ign-transport to get scene data using this service.

Parameters

[in] _service Scene service name

◆ SetSceneTopic()

void SetSceneTopic ( const std::string & _topic )

Set the scene topic to use for updating objects in the scene The renderer will subscribe to this topic to get updates scene messages.

Parameters

[in] _topic Scene topic

◆ SetSkyEnabled()

void SetSkyEnabled ( const bool & _sky )

Set if sky is enabled.

Parameters

[in] _sky True to enable the sky, false otherwise.

◆ StopRendering()

void StopRendering ( )

Stop rendering and shutdown resources.

◆ wheelEvent() [1/2]

virtual void wheelEvent ( QWheelEvent * _e )

overrideprotectedvirtual

◆ wheelEvent() [2/2]

virtual void wheelEvent ( QWheelEvent * _e )

overrideprotectedvirtual

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

Public Slots

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ RenderWindowItem() [1/2]

◆ ~RenderWindowItem() [1/2]

◆ RenderWindowItem() [2/2]

◆ ~RenderWindowItem() [2/2]

Member Function Documentation

◆ HandleKeyPress() [1/2]

◆ HandleKeyPress() [2/2]

◆ HandleKeyRelease() [1/2]

◆ HandleKeyRelease() [2/2]

◆ keyPressEvent() [1/2]

◆ keyPressEvent() [2/2]

◆ keyReleaseEvent() [1/2]

◆ keyReleaseEvent() [2/2]

◆ mouseMoveEvent() [1/2]

◆ mouseMoveEvent() [2/2]

◆ mousePressEvent() [1/2]

◆ mousePressEvent() [2/2]

◆ mouseReleaseEvent() [1/2]

◆ mouseReleaseEvent() [2/2]

◆ OnDropped()

◆ OnHovered() [1/2]

◆ OnHovered() [2/2]

◆ Ready [1/2]

◆ Ready [2/2]

◆ SetAmbientLight() [1/2]

◆ SetAmbientLight() [2/2]

◆ SetBackgroundColor() [1/2]

◆ SetBackgroundColor() [2/2]

◆ SetCameraFarClip()

◆ SetCameraHFOV()

◆ SetCameraNearClip()

◆ SetCameraPose() [1/2]

◆ SetCameraPose() [2/2]

◆ SetCameraViewController()

◆ SetDeletionTopic()

◆ SetEngineName() [1/2]

◆ SetEngineName() [2/2]

◆ SetErrorCb() [1/2]

◆ SetErrorCb() [2/2]

◆ SetPoseTopic()

◆ SetSceneName() [1/2]

◆ SetSceneName() [2/2]

◆ SetSceneService()

◆ SetSceneTopic()

◆ SetSkyEnabled()

◆ StopRendering()

◆ wheelEvent() [1/2]

◆ wheelEvent() [2/2]