Gazebo Rendering

API Reference

9.0.0

#include <BaseNativeWindow.hh>

Public Member Functions

virtual ~BaseNativeWindow ()
 
virtual void Draw (CameraPtr) override
 A native window is not associated with anything. Calling this function will draw whatever is currently the given camera.
 
virtual void NotifyFocused (bool) override
 Tells the native window whether it's under focus.
 
virtual void NotifyVisible (bool) override
 Tells the native window whether it's visible.
 
virtual void NotifyWindowMovedOrResized () override
 Call this when window resolution has changed.
 
virtual void RequestResolution (uint32_t, uint32_t) override
 Requests a particular resolution. It may not be possible to satisfy it though and the new resolution may be different from current and requested (e.g. if you request 1920x1080 when that's the max monitor resolution after evaluating window borders, the title, and the start menu the OS may shrink the window so the whole thing is visible)
 
- Public Member Functions inherited from NativeWindow
 NativeWindow ()
 Constructor.
 
virtual ~NativeWindow ()
 Destructor.
 

Protected Member Functions

 BaseNativeWindow ()
 

Constructor & Destructor Documentation

◆ BaseNativeWindow()

BaseNativeWindow ( )
protected

◆ ~BaseNativeWindow()

virtual ~BaseNativeWindow ( )
virtual

Member Function Documentation

◆ Draw()

virtual void Draw ( CameraPtr  _camera)
inlineoverridevirtual

A native window is not associated with anything. Calling this function will draw whatever is currently the given camera.

Remarks
Assumes _camera->Render() has already been called If the camera resolution doesn't match, the contents will be stretched.
Parameters
[in]_cameraCamera to draw

Implements NativeWindow.

Reimplemented in Ogre2NativeWindow.

◆ NotifyFocused()

virtual void NotifyFocused ( bool  _focused)
inlineoverridevirtual

Tells the native window whether it's under focus.

Parameters
[in]_focusedTrue if we acquired focus. False if we lost it

Implements NativeWindow.

Reimplemented in Ogre2NativeWindow.

◆ NotifyVisible()

virtual void NotifyVisible ( bool  _visible)
inlineoverridevirtual

Tells the native window whether it's visible.

Parameters
[in]_visibleTrue if we are at least partially visible. False otherwise

Implements NativeWindow.

Reimplemented in Ogre2NativeWindow.

◆ NotifyWindowMovedOrResized()

virtual void NotifyWindowMovedOrResized ( )
inlineoverridevirtual

Call this when window resolution has changed.

Implements NativeWindow.

Reimplemented in Ogre2NativeWindow.

◆ RequestResolution()

virtual void RequestResolution ( uint32_t  _width,
uint32_t  _height 
)
inlineoverridevirtual

Requests a particular resolution. It may not be possible to satisfy it though and the new resolution may be different from current and requested (e.g. if you request 1920x1080 when that's the max monitor resolution after evaluating window borders, the title, and the start menu the OS may shrink the window so the whole thing is visible)

Parameters
[in]_widthNew width of the window being requested
[in]_heightNew height of the window being requested

Implements NativeWindow.

Reimplemented in Ogre2NativeWindow.


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