Gazebo Rendering

API Reference

3.7.2

#include <OgreRenderTarget.hh>

Public Member Functions

virtual ~OgreRenderWindow ()
 
virtual void Destroy ()
 
- Public Member Functions inherited from BaseRenderWindow< OgreRenderTarget >
 BaseRenderWindow ()
 
virtual ~BaseRenderWindow ()
 
virtual double DevicePixelRatio () const
 Get the device to pixel ratio. More...
 
virtual std::string Handle () const
 Get the window handle that the render window is attached to. More...
 
virtual void OnMove ()
 Alert the window of a window move event. More...
 
virtual void OnResize (const unsigned int _width, const unsigned int _height)
 Alert the window of a window resize event. More...
 
virtual void SetDevicePixelRatio (const double _ratio)
 Set the device to pixel ratio. More...
 
virtual void SetHandle (const std::string &_handle)
 Set the window handle to attach the render window to. More...
 
- Public Member Functions inherited from RenderWindow
virtual ~RenderWindow ()
 Deconstructor. More...
 
virtual double DevicePixelRatio () const =0
 Get the device to pixel ratio. More...
 
virtual std::string Handle () const =0
 Get the window handle that the render window is attached to. More...
 
- Public Member Functions inherited from RenderTarget
virtual ~RenderTarget ()
 Destructor. More...
 
virtual PixelFormat Format () const =0
 Set the render target image format. More...
 
virtual unsigned int Height () const =0
 Get render target height in pixels. More...
 
virtual unsigned int RenderPassCount () const =0
 Get the number of render passes applied to the render target. More...
 
virtual unsigned int Width () const =0
 Get render target width in pixels. More...
 
- Public Member Functions inherited from Object
virtual ~Object ()
 Destructor. More...
 
virtual unsigned int Id () const =0
 Get the object ID. This ID will be unique across all objects inside a given scene, but necessarily true for objects across different scenes. More...
 
virtual std::string Name () const =0
 Get the object name. This name will be unique across all objects inside a given scene, but necessarily true for objects across different scenes. More...
 
virtual ScenePtr Scene () const =0
 Get the Scene that created this object. More...
 
- Public Member Functions inherited from OgreRenderTarget
virtual ~OgreRenderTarget ()
 
Ogre::Viewport * AddViewport (Ogre::Camera *_viewport)
 
virtual unsigned int AntiAliasing () const
 
virtual math::Color BackgroundColor () const override
 Get the background color of the render target. This should be the same as the scene background color. More...
 
virtual Ogre::Camera * Camera () const
 
virtual void Copy (Image &_image) const override
 Write rendered image to given Image. The RenderTarget will convert the underlying image to the specified format listed in the given Image. However if the given image is not of the correct size no work will be done. Calling this function before an image has been rendered will result in undefined behavior. More...
 
virtual void PostRender () override
 Post process this object and any of its children after rendering. More...
 
virtual void PreRender () override
 Prepare this object and any of its children for rendering. This should be called for each object in a scene just before rendering, which can be achieved by a single call to Scene::PreRender. More...
 
virtual void Render ()
 
virtual void SetAntiAliasing (unsigned int _aa)
 
void SetAutoUpdated (const bool _value)
 
virtual void SetBackgroundColor (math::Color _color)
 
virtual void SetCamera (Ogre::Camera *_camera)
 
void SetMaterial (MaterialPtr _material)
 Set a material to render on every object. This method is used for special cases like the render target of a depth camera. More...
 
void SetUpdate (const bool _value)
 
Ogre::Viewport * Viewport (const int _viewportId) const
 
- Public Member Functions inherited from BaseRenderTarget< OgreObject >
 BaseRenderTarget ()
 
virtual ~BaseRenderTarget ()
 
virtual void AddRenderPass (const RenderPassPtr &_pass) override
 Add a render pass to the render target. More...
 
virtual math::Color BackgroundColor () const override
 Get the background color of the render target. This should be the same as the scene background color. More...
 
virtual PixelFormat Format () const override
 Set the render target image format. More...
 
virtual unsigned int Height () const override
 Get render target height in pixels. More...
 
virtual void RemoveRenderPass (const RenderPassPtr &_pass) override
 Remove a render pass from the render target. More...
 
virtual RenderPassPtr RenderPassByIndex (unsigned int _index) const override
 Get a render pass by index. More...
 
virtual unsigned int RenderPassCount () const override
 Get the number of render passes applied to the render target. More...
 
virtual void SetFormat (PixelFormat _format) override
 Set the render target image format. More...
 
virtual void SetHeight (const unsigned int _height) override
 Set the render target height in pixels. More...
 
virtual void SetWidth (const unsigned int _width) override
 Set the render target width in pixels. More...
 
virtual unsigned int Width () const override
 Get render target width in pixels. More...
 
- Public Member Functions inherited from OgreObject
virtual ~OgreObject ()
 
virtual ScenePtr Scene () const
 
- Public Member Functions inherited from BaseObject
virtual ~BaseObject ()
 
virtual unsigned int Id () const override
 
virtual std::string Name () const override
 

Protected Member Functions

 OgreRenderWindow ()
 
virtual void BuildTarget ()
 
virtual void RebuildTarget ()
 
virtual Ogre::RenderTarget * RenderTarget () const
 
- Protected Member Functions inherited from OgreRenderTarget
 OgreRenderTarget ()
 
virtual void RebuildImpl () override
 
void RebuildMaterial ()
 Re-initializes render target material to apply a material to everything in the scene. Does nothing if no material has been set. More...
 
virtual void RebuildViewport ()
 
virtual void UpdateBackgroundColor ()
 
virtual void UpdateRenderPassChain ()
 Update render pass chain if changes were made. More...
 
- Protected Member Functions inherited from BaseRenderTarget< OgreObject >
virtual void Rebuild ()
 
- Protected Member Functions inherited from OgreObject
 OgreObject ()
 
- Protected Member Functions inherited from BaseObject
 BaseObject ()
 
virtual void Init ()
 
virtual void Load ()
 

Protected Attributes

Ogre::RenderTarget * ogreRenderWindow = nullptr
 
- Protected Attributes inherited from BaseRenderWindow< OgreRenderTarget >
std::string handle
 
double ratio
 
- Protected Attributes inherited from OgreRenderTarget
unsigned int antiAliasing = 4
 
bool colorDirty = true
 
MaterialPtr material
 a material used by for the render target More...
 
OgreRenderTargetMaterialPtr materialApplicator
 Helper class that applies the material to the render target. More...
 
Ogre::ColourValue ogreBackgroundColor
 
Ogre::Camera * ogreCamera = nullptr
 
Ogre::Viewport * ogreViewport = nullptr
 
- Protected Attributes inherited from BaseRenderTarget< OgreObject >
PixelFormat format
 
unsigned int height
 
bool renderPassDirty
 Flag to indicate if render pass need to be rebuilt. More...
 
std::vector< RenderPassPtrrenderPasses
 A chain of render passes applied to the render target. More...
 
bool targetDirty
 
unsigned int width
 
- Protected Attributes inherited from OgreObject
OgreScenePtr scene
 
- Protected Attributes inherited from BaseObject
unsigned int id
 
std::string name
 

Constructor & Destructor Documentation

◆ OgreRenderWindow()

OgreRenderWindow ( )
protected

◆ ~OgreRenderWindow()

virtual ~OgreRenderWindow ( )
virtual

Member Function Documentation

◆ BuildTarget()

virtual void BuildTarget ( )
protectedvirtual

◆ Destroy()

virtual void Destroy ( )
virtual

Implements OgreRenderTarget.

◆ RebuildTarget()

virtual void RebuildTarget ( )
protectedvirtual

Implements OgreRenderTarget.

◆ RenderTarget()

virtual Ogre::RenderTarget* RenderTarget ( ) const
protectedvirtual

Implements OgreRenderTarget.

Member Data Documentation

◆ ogreRenderWindow

Ogre::RenderTarget* ogreRenderWindow = nullptr
protected

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