Gazebo Rendering

API Reference

8.2.1
Ogre2NativeWindow Class Reference

Ogre2 implementation of NativeWindow. More...

#include <Ogre2NativeWindow.hh>

Public Member Functions

virtual ~Ogre2NativeWindow ()
 Destructor. More...
 
virtual void Draw (CameraPtr _camera) override
 A native window is not associated with anything. Calling this function will draw whatever is currently the given camera. More...
 
virtual void NotifyFocused (bool _focused) override
 Tells the native window whether it's under focus. More...
 
virtual void NotifyVisible (bool _visible) override
 Tells the native window whether it's visible. More...
 
virtual void NotifyWindowMovedOrResized () override
 Call this when window resolution has changed. More...
 
virtual void RequestResolution (uint32_t _width, uint32_t _height) 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) More...
 
- Public Member Functions inherited from BaseNativeWindow
virtual ~BaseNativeWindow ()
 
- Public Member Functions inherited from NativeWindow
 NativeWindow ()
 Constructor. More...
 
virtual ~NativeWindow ()
 Destructor. More...
 

Additional Inherited Members

- Protected Member Functions inherited from BaseNativeWindow
 BaseNativeWindow ()
 

Detailed Description

Ogre2 implementation of NativeWindow.

Constructor & Destructor Documentation

◆ ~Ogre2NativeWindow()

virtual ~Ogre2NativeWindow ( )
virtual

Destructor.

Member Function Documentation

◆ Draw()

virtual void Draw ( CameraPtr  _camera)
overridevirtual

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

Reimplemented from BaseNativeWindow.

◆ NotifyFocused()

virtual void NotifyFocused ( bool  _focused)
overridevirtual

Tells the native window whether it's under focus.

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

Reimplemented from BaseNativeWindow.

◆ NotifyVisible()

virtual void NotifyVisible ( bool  _visible)
overridevirtual

Tells the native window whether it's visible.

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

Reimplemented from BaseNativeWindow.

◆ NotifyWindowMovedOrResized()

virtual void NotifyWindowMovedOrResized ( )
overridevirtual

Call this when window resolution has changed.

Reimplemented from BaseNativeWindow.

◆ RequestResolution()

virtual void RequestResolution ( uint32_t  _width,
uint32_t  _height 
)
overridevirtual

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

Reimplemented from BaseNativeWindow.


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