Gazebo Gui

API Reference

7.2.2
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 123]
 Nevents
 CBlockOrbitEvent that block the Interactive View control when some of the other plugins require it. For example: When the transform control is active we should block the movements of the camera
 CDragOnSceneEvent which is called to broadcast information about mouse drags on the scene
 CDropdownMenuEnabledEvent which is called to enable or disable the dropdown menu. This is primarily used by plugins which also use the right click mouse event to cancel any actions currently in progress
 CDropOnSceneEvent called to clone a resource, given its name as a string
 CHoverOnSceneEvent which is called to broadcast the 2D coordinates of a user's mouse hover within the scene
 CHoverToSceneEvent which is called to broadcast the 3D coordinates of a user's mouse hover within the scene
 CKeyPressOnSceneEvent which is called to broadcast the key press within the scene
 CKeyReleaseOnSceneEvent which is called to broadcast the key release within the scene
 CLeftClickOnSceneEvent which is called to broadcast information about left mouse releases on the scene. For the 3D coordinates of that point on the scene, see LeftClickToScene
 CLeftClickToSceneEvent which is called to broadcast the 3D coordinates of a user's releasing the left button within the scene
 CMousePressOnSceneEvent which is called to broadcast information about mouse presses on the scene, with right, left or middle buttons
 CPreRenderEvent called in the render thread of a 3D scene, before the user camera is rendered. It's safe to make rendering calls in this event's callback
 CRenderEvent called in the render thread of a 3D scene after the user camera has rendered. It's safe to make rendering calls in this event's callback
 CRightClickOnSceneEvent which is called to broadcast information about right mouse releases on the scene. For the 3D coordinates of that point on the scene, see RightClickToScene
 CRightClickToSceneEvent which is called to broadcast the 3D coordinates of a user's releasing the right button within the scene
 CScrollOnSceneEvent which is called to broadcast information about mouse scrolls on the scene
 CSnapIntervalsThe class for sending and receiving custom snap value events. This event is used in the Transform Control plugin tool when the user manually alters their snapping values
 CSpawnCloneFromNameEvent called to clone a resource, given its name as a string
 CSpawnFromDescriptionEvent called to spawn a resource, given its description as a string
 CSpawnFromPathEvent called to spawn a resource, which takes the path to its file
 CWorldControlEvent which is called to share WorldControl information
 Ngz
 Ngui
 CApplicationA Gazebo GUI application loads a QML engine and provides an API to load plugins and configuration files. The application supports either running a single main window or several plugins as standalone dialogs
 CDialogGui plugin
 CDragDropModelCustomized item model so that we can pass along an URI query as MIME information during a drag-drop
 CGridConfigManages grids in a Gazebo Rendering scene. This plugin can be used for:
 CKeyPublisherPublish keyboard stokes to "keyboard/keypress" topic
 CMainWindowThe main window class creates a QQuickWindow and acts as an interface which provides properties and functions which can be called from Main.qml
 CPlotDataPlot Data containter to hold value and registered charts Can be a Field or a PlotComponent Used by PlottingInterface and Gazebo Plotting
 CPlottingInterfacePlotting Interface Responsible for plotting transport msgs-fields Used by TransportPlotting Plugin & GazeboPlotting Plugin Accepts dragged items from TopicViewer Plugin & ComponentInspector Plugin
 CPluginBase class for Gazebo GUI plugins
 CSearchModelCustomize the proxy model to display search results
 CTapeMeasureProvides buttons for the tape measure tool
 CTopicPlotting Topic to handle published topics & their registered fields
 CTransportHandle transport topics subscribing for one object (Chart)
 CWindowConfigHolds configurations related to a MainWindow
 CWorldControlEventListenerHelper class for testing listening to events emitted by the WorldControl plugin. This is used for testing the event behavior of the WorldControl plugin
 Nplugins
 CCameraFpsThis plugin displays the GUI camera's Framerate Per Second (FPS)
 CCameraTrackingThis plugin provides camera tracking capabilities such as "move to" and "follow"
 CGzCameraTextureRhiRender interface class to handle OpenGL / Metal compatibility of camera textures in GzRenderer
 CGzCameraTextureRhiMetalImplementation of GzCameraTextureRhi for the Metal graphics API
 CGzCameraTextureRhiOpenGLImplementation of GzCameraTextureRhi for the OpenGL graphics API
 CGzRendererGz-rendering renderer. All gz-rendering calls should be performed inside this class as it makes sure that opengl calls in the underlying render engine do not interfere with QtQuick's opengl render operations. The main Render function will render to an offscreen texture and notify via signal and slots when it's ready to be displayed
 CImageDisplayDisplay images coming through a Gazebo Transport topic
 CImageProvider
 CInteractiveViewControlThis Plugin allows to control a user camera with the mouse:
 CMarkerManagerThis plugin will be in charge of handling the markers in the scene. It will allow to add, modify or remove markers
 CMinimalSceneCreates 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
 CNavSatMapDisplay NavSat messages coming through a Gazebo Transport topic on top of a map
 CPointCloudVisualize gz::msgs::PointCloudPacked messages in a 3D scene
 CPublisherWidget which publishes a custom Gazebo Transport message
 CRenderThreadRendering thread
 CRenderThreadRhiRender interface class to handle OpenGL / Metal compatibility in RenderThread
 CRenderThreadRhiMetalImplementation of RenderThreadRhi for the Metal graphics API
 CRenderThreadRhiOpenGLImplementation of RenderThreadRhi for the OpenGL graphics API
 CRenderWindowItemA QQUickItem that manages the render window
 CScreenshotProvides a button and a transport service for taking a screenshot of current 3D scene
 CShutdownButtonThis plugin provides a shutdown button
 CTeleopPublish teleop stokes to a user selected topic, or to '/cmd_vel' if no topic is selected. Buttons, the keyboard or sliders can be used to move a vehicle in the world
 CTextureNodeTexture node for displaying the render texture from gz-renderer
 CTextureNodeRhiRender interface class to handle OpenGL / Metal compatibility in TextureNode
 CTextureNodeRhiMetalImplementation of TextureNodeRhi for the Metal graphics API
 CTextureNodeRhiOpenGLImplementation of TextureNodeRhi for the OpenGL graphics API
 CTopicEchoEcho messages coming through a Gazebo Transport topic
 CTopicViewerPlugin to view the topics and their msgs & fields Field's informations can be passed by dragging them via the UI
 CTransportPlottingPlots fields from Gazebo Transport topics. Fields can be dragged from the Topic Viewer or the Component Inspector
 CTransportSceneManagerProvides a Gazebo Transport interface to plugins::MinimalScene
 CWorldControlThis plugin provides a world control panel which may have a play / pause and step buttons
 CWorldStatsThis plugin provides a time panel which may display: