RenderArea Class Reference
[Qt ViewerComponents]

Class to render an OpenInventor scene in a Qt OpenGL window. More...

#include <Inventor/ViewerComponents/Qt/RenderArea.h>

Inheritance diagram for RenderArea:
SiRenderArea SiRenderAreaStereo SiRenderAreaAntialiasing SiRenderAreaStillSuperSampling RenderAreaInteractive RenderAreaExaminer RenderAreaOrbiter

List of all members.

Classes

struct  RenderAreaSaveRestore
 Store FBO information to provide save/restore mechanism.

Public Member Functions

 RenderArea (QWidget *parent)
virtual ~RenderArea ()
virtual void setSceneGraph (SoNode *sceneGraph)
virtual SoNodegetSceneGraph () const
virtual void setClearPolicy (ClearPolicy policy)
virtual ClearPolicy getClearPolicy () const
virtual void setClearColor (const SbColorRGBA &color)
virtual SbColorRGBA getClearColor () const
virtual void setClearDepth (float depth)
virtual float getClearDepth () const
virtual void setSize (const SbVec2i32 &size)
virtual SbVec2i32 getSize () const
virtual void setGLRenderAction (SoGLRenderAction *glAction)
virtual SoGLRenderActiongetGLRenderAction () const
virtual void setAntialiasingMode (SoSceneManager::AntialiasingMode mode) override
virtual
SoSceneManager::AntialiasingMode 
getAntialiasingMode () const override
virtual void setAntialiasingQuality (float quality) override
virtual float getAntialiasingQuality () const override
virtual void setStillSuperSamplingQuality (float quality) override
virtual float getStillSuperSamplingQuality () const override
virtual void setStillSuperSamplingDelay (unsigned int delay) override
virtual unsigned int getStillSuperSamplingDelay () const override
virtual SbEventHandler
< RenderEventArg & > & 
onStartRender ()
virtual void activateStereo (bool activated)
virtual bool isStereoActivated () const
virtual void setStereoParameters (SoStereoParameters *parameters)
virtual SoStereoParametersgetStereoParameters () const
bool isRawStereoAvailable ()
QWidget * getContainerWidget ()

Detailed Description

Class to render an OpenInventor scene in a Qt OpenGL window.

RenderArea creates a 3D rendering window as a child of another widget. Use the setSceneGraph() method to specify the scene graph to be rendered.

A SceneExaminer node is typically used to allow the user to manipulate the scene camera.

SEE ALSO

RenderAreaInteractive, RenderAreaExaminer, SceneInteractor, SceneExaminer


Constructor & Destructor Documentation

RenderArea::RenderArea ( QWidget *  parent  ) 

This constructor initializes the QOpenGLWidget using the default QSurfaceFormat.

virtual RenderArea::~RenderArea (  )  [virtual]

Destructor.


Member Function Documentation

virtual void RenderArea::activateStereo ( bool  activated  )  [virtual]

Activate/Deactivate stereo.

Implements SiRenderAreaStereo.

Reimplemented in RenderAreaInteractive.

virtual SoSceneManager::AntialiasingMode RenderArea::getAntialiasingMode (  )  const [override, virtual]
virtual float RenderArea::getAntialiasingQuality (  )  const [override, virtual]
virtual SbColorRGBA RenderArea::getClearColor (  )  const [virtual]

Gets the RGBA value used when the color buffer is cleared.

Implements SiRenderArea.

virtual float RenderArea::getClearDepth (  )  const [virtual]

Gets the depth value used when the depth buffer is cleared.

Implements SiRenderArea.

virtual ClearPolicy RenderArea::getClearPolicy (  )  const [virtual]

Gets the color buffer and depth buffer clear policy.

Implements SiRenderArea.

QWidget* RenderArea::getContainerWidget (  )  [inline]
virtual SoGLRenderAction* RenderArea::getGLRenderAction (  )  const [virtual]

Returns the render action used for rendering.

virtual SoNode* RenderArea::getSceneGraph (  )  const [virtual]

Gets the scene graph to render.

Implements SiRenderArea.

virtual SbVec2i32 RenderArea::getSize (  )  const [virtual]

Gets the size used for rendering.

Implements SiRenderArea.

virtual SoStereoParameters* RenderArea::getStereoParameters (  )  const [virtual]
virtual unsigned int RenderArea::getStillSuperSamplingDelay (  )  const [override, virtual]
virtual float RenderArea::getStillSuperSamplingQuality (  )  const [override, virtual]
bool RenderArea::isRawStereoAvailable (  ) 

Returns true if stereo buffering is enabled.

virtual bool RenderArea::isStereoActivated (  )  const [virtual]

Returns true if stereo rendering is currently activated.

NOTES

    Stereo status can only be retrieved once rendering area is initialized.

    Implements SiRenderAreaStereo.

virtual SbEventHandler<RenderEventArg&>& RenderArea::onStartRender (  )  [virtual]

Returns the event handler that raises when a new render starts.

Implements SiRenderArea.

virtual void RenderArea::setAntialiasingMode ( SoSceneManager::AntialiasingMode  mode  )  [override, virtual]

Define the antialiasing mode.

Parameters:
mode The antialiasing algorithm. Default is NO_ANTIALIASING which turns off antialiasing.

Implements SiRenderAreaAntialiasing.

virtual void RenderArea::setAntialiasingQuality ( float  quality  )  [override, virtual]

Define the antialiasing quality value.

Parameters:
quality The quality is a factor in the range [0.0,1.0].
Default is 0.0. The value 0.0 turns off antialiasing.

Implements SiRenderAreaAntialiasing.

virtual void RenderArea::setClearColor ( const SbColorRGBA color  )  [virtual]

Defines the RGBA value used when the color buffer is cleared.

Default is transparent black (0,0,0,0).

Implements SiRenderArea.

virtual void RenderArea::setClearDepth ( float  depth  )  [virtual]

Defines the depth value used when the depth buffer is cleared.

Default is 1. Range is 0..1.

Implements SiRenderArea.

virtual void RenderArea::setClearPolicy ( ClearPolicy  policy  )  [virtual]

Defines the color buffer and depth buffer clear policy.

Use enum ClearPolicy Default is COLORBUFFER_AND_DEPTHBUFFER.

Implements SiRenderArea.

virtual void RenderArea::setGLRenderAction ( SoGLRenderAction glAction  )  [virtual]

Defines the render action used for rendering.

virtual void RenderArea::setSceneGraph ( SoNode sceneGraph  )  [virtual]

Sets the scene graph to render.

Implements SiRenderArea.

Reimplemented in RenderAreaInteractive.

virtual void RenderArea::setSize ( const SbVec2i32 size  )  [virtual]

Defines the size used for rendering.

Implements SiRenderArea.

virtual void RenderArea::setStereoParameters ( SoStereoParameters parameters  )  [virtual]

Defines the stereo parameters.

NOTES

    Stereo parameters can only be set once rendering area is initialized.

    Implements SiRenderAreaStereo.

virtual void RenderArea::setStillSuperSamplingDelay ( unsigned int  delay  )  [override, virtual]

Set delay for supersampling when "still" (not interacting).

If greater than 0, images will be supersampled after the specified delay.

Parameters:
delay The delay is in milliseconds.
If greater than 0, images will be supersampled after the specified delay See also setStillSuperSamplingQuality.

Implements SiRenderAreaStillSuperSampling.

virtual void RenderArea::setStillSuperSamplingQuality ( float  quality  )  [override, virtual]

Set quality for supersampling when "still" (not interacting).

When quality is greater than 0, still images will be automatically supersampled.

Parameters:
quality The quality is a factor in the range [0.0,1.0].
Default value is 0.0. Use the value 0.0 to turn off still supersampling. 0.5 is a typical value. See also setStillSuperSamplingDelay.

Implements SiRenderAreaStillSuperSampling.


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

Open Inventor Toolkit reference manual, generated on 30 May 2021
Copyright © Thermo Fisher Scientific All rights reserved.
http://www.openinventor.com/