Open Inventor Release 2024.2.0
 
Loading...
Searching...
No Matches
openinventor::inventor::viewercomponents::qt::qml::RenderArea Class Reference

(Preview feature) More...

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

+ Inheritance diagram for openinventor::inventor::viewercomponents::qt::qml::RenderArea:

Public Slots

void onWindowChanged (QQuickWindow *window)
 
void onScreenChanged ()
 

Public Member Functions

 RenderArea ()
 
virtual ~RenderArea ()
 
void setSceneGraph (SoNode *sceneGraph) override
 Sets the scene graph to render.
 
SoNodegetSceneGraph () const override
 Gets the scene graph to render.
 
void setClearPolicy (ClearPolicy policy) override
 Defines the color buffer and depth buffer clear policy.
 
ClearPolicy getClearPolicy () const override
 Gets the color buffer and depth buffer clear policy.
 
void setClearColor (const SbColorRGBA &color) override
 Defines the RGBA value used when the color buffer is cleared.
 
SbColorRGBA getClearColor () const override
 Gets the RGBA value used when the color buffer is cleared.
 
void setClearDepth (float depth) override
 Defines the depth value used when the depth buffer is cleared.
 
float getClearDepth () const override
 Gets the depth value used when the depth buffer is cleared.
 
void setSize (const SbVec2i32 &size) override
 Defines the size used for rendering.
 
SbVec2i32 getSize () const override
 Gets the size used for rendering.
 
virtual void setGLRenderAction (SoGLRenderAction *glAction)
 Defines the render action used for rendering.
 
SoGLRenderActiongetGLRenderAction () const
 Returns the render action used for rendering.
 
virtual void setTransparencyType (SoGLRenderAction::TransparencyType type)
 Sets the global transparency algorithm to use when rendering.
 
virtual SoGLRenderAction::TransparencyType getTransparencyType () const
 Gets the global transparency algorithm to use when rendering.
 
void setAntialiasingMode (SoSceneManager::AntialiasingMode mode)
 Defines the antialiasing mode.
 
SoSceneManager::AntialiasingMode getAntialiasingMode () const
 
void setAntialiasingQuality (float quality)
 Defines the antialiasing quality value.
 
float getAntialiasingQuality () const
 
void setStillSuperSamplingQuality (float quality)
 Sets quality for supersampling when "still" (not interacting).
 
float getStillSuperSamplingQuality () const
 
void setStillSuperSamplingDelay (unsigned int delay)
 Sets delay for supersampling when "still" (not interacting).
 
unsigned int getStillSuperSamplingDelay () const
 
void activateStereo (bool activated)
 Activate/Deactivate stereo.
 
bool isStereoActivated () const
 Always returns false.
 
void setStereoParameters (SoStereoParameters *parameters)
 Defines the stereo parameters.
 
SoStereoParametersgetStereoParameters () const
 Returns nullptr.
 
bool isRawStereoAvailable ()
 Always returns false.
 

Friends

class QmlRenderer
 

Additional Inherited Members

- Public Types inherited from SiRenderArea
enum  ClearPolicy {
  NONE ,
  COLORBUFFER ,
  DEPTHBUFFER ,
  COLORBUFFER_AND_DEPTHBUFFER
}
 Policy values to clear color and depth buffers beforing rendering. More...
 
enum  RenderStatus {
  ABORTED ,
  INTERACTIVE ,
  STILL
}
 Returned by the render method. More...
 

Detailed Description

(Preview feature)

Class to render an OpenInventor scene in a QML item.

RenderArea creates a 3D rendering item. Use the setSceneGraph() method to specify the scene graph to be rendered.

SEE ALSO

RenderAreaInteractive, RenderAreaOrbiter

Definition at line 45 of file RenderArea.h.

Constructor & Destructor Documentation

◆ RenderArea()

openinventor::inventor::viewercomponents::qt::qml::RenderArea::RenderArea ( )

◆ ~RenderArea()

virtual openinventor::inventor::viewercomponents::qt::qml::RenderArea::~RenderArea ( )
virtual

Member Function Documentation

◆ activateStereo()

void openinventor::inventor::viewercomponents::qt::qml::RenderArea::activateStereo ( bool  activated)

Activate/Deactivate stereo.

NOTES

    Do nothing. QML does not allow having raw stereo.

◆ getAntialiasingMode()

SoSceneManager::AntialiasingMode openinventor::inventor::viewercomponents::qt::qml::RenderArea::getAntialiasingMode ( ) const

◆ getAntialiasingQuality()

float openinventor::inventor::viewercomponents::qt::qml::RenderArea::getAntialiasingQuality ( ) const

◆ getClearColor()

SbColorRGBA openinventor::inventor::viewercomponents::qt::qml::RenderArea::getClearColor ( ) const
overridevirtual

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

Implements SiRenderArea.

◆ getClearDepth()

float openinventor::inventor::viewercomponents::qt::qml::RenderArea::getClearDepth ( ) const
overridevirtual

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

Implements SiRenderArea.

◆ getClearPolicy()

ClearPolicy openinventor::inventor::viewercomponents::qt::qml::RenderArea::getClearPolicy ( ) const
overridevirtual

Gets the color buffer and depth buffer clear policy.

Implements SiRenderArea.

◆ getGLRenderAction()

SoGLRenderAction * openinventor::inventor::viewercomponents::qt::qml::RenderArea::getGLRenderAction ( ) const

Returns the render action used for rendering.

This method returns nullptr if the show() of the main window is not done.

◆ getSceneGraph()

SoNode * openinventor::inventor::viewercomponents::qt::qml::RenderArea::getSceneGraph ( ) const
overridevirtual

Gets the scene graph to render.

Implements SiRenderArea.

◆ getSize()

SbVec2i32 openinventor::inventor::viewercomponents::qt::qml::RenderArea::getSize ( ) const
overridevirtual

Gets the size used for rendering.

Implements SiRenderArea.

◆ getStereoParameters()

SoStereoParameters * openinventor::inventor::viewercomponents::qt::qml::RenderArea::getStereoParameters ( ) const

Returns nullptr.

See also
setStereoParameters().

◆ getStillSuperSamplingDelay()

unsigned int openinventor::inventor::viewercomponents::qt::qml::RenderArea::getStillSuperSamplingDelay ( ) const

◆ getStillSuperSamplingQuality()

float openinventor::inventor::viewercomponents::qt::qml::RenderArea::getStillSuperSamplingQuality ( ) const

◆ getTransparencyType()

virtual SoGLRenderAction::TransparencyType openinventor::inventor::viewercomponents::qt::qml::RenderArea::getTransparencyType ( ) const
virtual

Gets the global transparency algorithm to use when rendering.

◆ isRawStereoAvailable()

bool openinventor::inventor::viewercomponents::qt::qml::RenderArea::isRawStereoAvailable ( )

Always returns false.

NOTES

    QML does not allow having raw stereo.

◆ isStereoActivated()

bool openinventor::inventor::viewercomponents::qt::qml::RenderArea::isStereoActivated ( ) const

Always returns false.

NOTES

    Stereo status can only be retrieved once rendering area is initialized. QML does not allow having raw stereo.

◆ onScreenChanged

void openinventor::inventor::viewercomponents::qt::qml::RenderArea::onScreenChanged ( )
slot

◆ onWindowChanged

void openinventor::inventor::viewercomponents::qt::qml::RenderArea::onWindowChanged ( QQuickWindow *  window)
slot

◆ setAntialiasingMode()

void openinventor::inventor::viewercomponents::qt::qml::RenderArea::setAntialiasingMode ( SoSceneManager::AntialiasingMode  mode)

Defines the antialiasing mode.

Parameters
modeThe antialiasing algorithm. Default is NO_ANTIALIASING which turns off antialiasing.

◆ setAntialiasingQuality()

void openinventor::inventor::viewercomponents::qt::qml::RenderArea::setAntialiasingQuality ( float  quality)

Defines the antialiasing quality value.

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

◆ setClearColor()

void openinventor::inventor::viewercomponents::qt::qml::RenderArea::setClearColor ( const SbColorRGBA color)
overridevirtual

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

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

Implements SiRenderArea.

◆ setClearDepth()

void openinventor::inventor::viewercomponents::qt::qml::RenderArea::setClearDepth ( float  depth)
overridevirtual

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

Default is 1. Range is 0..1.

Implements SiRenderArea.

◆ setClearPolicy()

void openinventor::inventor::viewercomponents::qt::qml::RenderArea::setClearPolicy ( ClearPolicy  policy)
overridevirtual

Defines the color buffer and depth buffer clear policy.

Use enum ClearPolicy Default is COLORBUFFER_AND_DEPTHBUFFER.

Implements SiRenderArea.

◆ setGLRenderAction()

virtual void openinventor::inventor::viewercomponents::qt::qml::RenderArea::setGLRenderAction ( SoGLRenderAction glAction)
virtual

Defines the render action used for rendering.

◆ setSceneGraph()

void openinventor::inventor::viewercomponents::qt::qml::RenderArea::setSceneGraph ( SoNode sceneGraph)
overridevirtual

Sets the scene graph to render.

Implements SiRenderArea.

Reimplemented in openinventor::inventor::viewercomponents::qt::qml::RenderAreaInteractive.

◆ setSize()

void openinventor::inventor::viewercomponents::qt::qml::RenderArea::setSize ( const SbVec2i32 size)
overridevirtual

Defines the size used for rendering.

Implements SiRenderArea.

◆ setStereoParameters()

void openinventor::inventor::viewercomponents::qt::qml::RenderArea::setStereoParameters ( SoStereoParameters parameters)

Defines the stereo parameters.

NOTES

    Stereo parameters can only be set once rendering area is initialized. Do nothing. QML does not allow having raw stereo.

◆ setStillSuperSamplingDelay()

void openinventor::inventor::viewercomponents::qt::qml::RenderArea::setStillSuperSamplingDelay ( unsigned int  delay)

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

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

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

◆ setStillSuperSamplingQuality()

void openinventor::inventor::viewercomponents::qt::qml::RenderArea::setStillSuperSamplingQuality ( float  quality)

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

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

Parameters
qualityThe 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.

◆ setTransparencyType()

virtual void openinventor::inventor::viewercomponents::qt::qml::RenderArea::setTransparencyType ( SoGLRenderAction::TransparencyType  type)
virtual

Sets the global transparency algorithm to use when rendering.

Parameters
typeThe global transparency algorithm

Friends And Related Symbol Documentation

◆ QmlRenderer

friend class QmlRenderer
friend

Definition at line 296 of file RenderArea.h.


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