Gazebo Rendering

API Reference

7.4.2

#include <OgreRenderTarget.hh>

Public Member Functions

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 Destroy () override=0
 
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 Ogre::RenderTarget * RenderTarget () const =0
 
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)
 
virtual void SetVisibilityMask (uint32_t _mask)
 Set visibility mask for the viewport associated with this render target. More...
 
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 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 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

 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 RebuildTarget ()=0
 
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

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
 
uint32_t visibilityMask = GZ_VISIBILITY_ALL
 visibility mask associated with this render target More...
 
- 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

◆ OgreRenderTarget()

OgreRenderTarget ( )
protected

◆ ~OgreRenderTarget()

virtual ~OgreRenderTarget ( )
virtual

Member Function Documentation

◆ AddViewport()

Ogre::Viewport* AddViewport ( Ogre::Camera *  _viewport)

◆ AntiAliasing()

virtual unsigned int AntiAliasing ( ) const
virtual

◆ BackgroundColor()

virtual math::Color BackgroundColor ( ) const
overridevirtual

Get the background color of the render target. This should be the same as the scene background color.

Returns
Render target background color.

Implements RenderTarget.

◆ Camera()

virtual Ogre::Camera* Camera ( ) const
virtual

◆ Copy()

virtual void Copy ( Image _image) const
overridevirtual

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.

Parameters
[out]_imageImage to which output will be written

Implements RenderTarget.

◆ Destroy()

virtual void Destroy ( )
overridepure virtual

Reimplemented from BaseObject.

Implemented in OgreRenderTexture, and OgreRenderWindow.

◆ PostRender()

virtual void PostRender ( )
overridevirtual

Post process this object and any of its children after rendering.

Reimplemented from BaseRenderTarget< OgreObject >.

Reimplemented in OgreRenderTexture.

◆ PreRender()

virtual void PreRender ( )
overridevirtual

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.

Reimplemented from BaseRenderTarget< OgreObject >.

Reimplemented in OgreRenderTexture.

◆ RebuildImpl()

virtual void RebuildImpl ( )
overrideprotectedvirtual

◆ RebuildMaterial()

void RebuildMaterial ( )
protected

Re-initializes render target material to apply a material to everything in the scene. Does nothing if no material has been set.

See also
OgreRenderTarget::RebuildImpl()
BaseRenderTarget::Rebuild()

◆ RebuildTarget()

virtual void RebuildTarget ( )
protectedpure virtual

Implemented in OgreRenderTexture, and OgreRenderWindow.

◆ RebuildViewport()

virtual void RebuildViewport ( )
protectedvirtual

◆ Render()

virtual void Render ( )
virtual

◆ RenderTarget()

virtual Ogre::RenderTarget* RenderTarget ( ) const
pure virtual

Implemented in OgreRenderTexture, and OgreRenderWindow.

◆ SetAntiAliasing()

virtual void SetAntiAliasing ( unsigned int  _aa)
virtual

◆ SetAutoUpdated()

void SetAutoUpdated ( const bool  _value)

◆ SetBackgroundColor()

virtual void SetBackgroundColor ( math::Color  _color)
virtual

◆ SetCamera()

virtual void SetCamera ( Ogre::Camera *  _camera)
virtual

◆ SetMaterial()

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.

Parameters
[in]_materialThe material to render

◆ SetUpdate()

void SetUpdate ( const bool  _value)

◆ SetVisibilityMask()

virtual void SetVisibilityMask ( uint32_t  _mask)
virtual

Set visibility mask for the viewport associated with this render target.

Parameters
[in]_maskVisibility mask

◆ UpdateBackgroundColor()

virtual void UpdateBackgroundColor ( )
protectedvirtual

◆ UpdateRenderPassChain()

virtual void UpdateRenderPassChain ( )
protectedvirtual

Update render pass chain if changes were made.

◆ Viewport()

Ogre::Viewport* Viewport ( const int  _viewportId) const

Member Data Documentation

◆ antiAliasing

unsigned int antiAliasing = 4
protected

◆ colorDirty

bool colorDirty = true
protected

◆ material

MaterialPtr material
protected

a material used by for the render target

◆ materialApplicator

OgreRenderTargetMaterialPtr materialApplicator
protected

Helper class that applies the material to the render target.

◆ ogreBackgroundColor

Ogre::ColourValue ogreBackgroundColor
protected

◆ ogreCamera

Ogre::Camera* ogreCamera = nullptr
protected

◆ ogreViewport

Ogre::Viewport* ogreViewport = nullptr
protected

◆ visibilityMask

uint32_t visibilityMask = GZ_VISIBILITY_ALL
protected

visibility mask associated with this render target


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