Open Inventor Release 2024.1.0
 
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
openinventor::inventor::viewercomponents::qt::qml::RenderAreaInteractive Class Reference
Inventor » Viewer Components » Qt ViewerComponents

(Preview feature) More...

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

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

Public Types

enum  ClippingPlanesAdjustMode {
  AUTO ,
  MANUAL
}
 Camera clipping planes adjustment mode. More...
 
- 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...
 

Public Member Functions

 RenderAreaInteractive ()
 Constructor.
 
virtual ~RenderAreaInteractive ()
 Destructor.
 
void setSceneGraph (SoNode *sceneGraph) override
 Sets the scene graph to render.
 
void setClippingPlanesAdjustMode (ClippingPlanesAdjustMode mode)
 Sets the camera clipping planes adjustment mode.
 
ClippingPlanesAdjustMode getClippingPlanesAdjustMode ()
 Get the camera clipping planes adjustment mode.
 
virtual SceneInteractor * getSceneInteractor () const
 Return the root of the scene graph.
 
virtual void viewAll (const SbViewportRegion &viewport)
 Moves the camera to view the scene defined by the given path.
 
virtual void viewAxis (const SbVec3f &direction, const SbVec3f &up)
 Moves the camera to be aligned with the given direction vector while keeping the "up" direction of the camera parallel to the specified up vector.
 
virtual void activateStereo (bool activated)
 Activate/Deactivate stereo.
 
virtual bool isStereoSupported () const
 Returns true if stereo can be activated.
 
void setStereoCameraOffset (float offset)
 Set the stereo offset.
 
void setStereoCameraBalance (float balance)
 Set the stereo balance.
 
SbBool processEvent (const SoEvent *event)
 Processes the passed event to the scene graph managed here.
 
SbBool processEvents (const std::vector< const SoEvent * > &eventList)
 Processes the passed event to the scene graph managed here.
 
- Public Member Functions inherited from openinventor::inventor::viewercomponents::qt::qml::RenderArea
 RenderArea ()
 
virtual ~RenderArea ()
 
SoNode * getSceneGraph () 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.
 
SoGLRenderAction * getGLRenderAction () 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.
 
SoStereoParameters * getStereoParameters () const
 Returns nullptr.
 
bool isRawStereoAvailable ()
 Always returns false.
 

Additional Inherited Members

- Public Slots inherited from openinventor::inventor::viewercomponents::qt::qml::RenderArea
void onWindowChanged (QQuickWindow *window)
 
void onScreenChanged ()
 

Detailed Description

(Preview feature)

Class to render an OpenInventor scene in a QML item. This class extends RenderArea to add mouse and keyboard interactions.

SEE ALSO

RenderArea, RenderAreaOrbiter

Definition at line 26 of file RenderAreaInteractive.h.

Member Enumeration Documentation

◆ ClippingPlanesAdjustMode

enum openinventor::inventor::viewercomponents::qt::qml::RenderAreaInteractive::ClippingPlanesAdjustMode

Camera clipping planes adjustment mode.

When adjustment mode is set to AUTO, the camera near and far planes are dynamically adjusted to be as tight as possible (least amount of stuff is clipped) before each render traversal. When adjustment mode is set to MANUAL, the user is expected to manually set the camera near and far planes.

Enumerator
AUTO 
MANUAL 

Definition at line 38 of file RenderAreaInteractive.h.

Constructor & Destructor Documentation

◆ RenderAreaInteractive()

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

Constructor.

◆ ~RenderAreaInteractive()

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

Destructor.

Member Function Documentation

◆ activateStereo()

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

Activate/Deactivate stereo.

◆ getClippingPlanesAdjustMode()

ClippingPlanesAdjustMode openinventor::inventor::viewercomponents::qt::qml::RenderAreaInteractive::getClippingPlanesAdjustMode ( )

Get the camera clipping planes adjustment mode.

◆ getSceneInteractor()

virtual SceneInteractor * openinventor::inventor::viewercomponents::qt::qml::RenderAreaInteractive::getSceneInteractor ( ) const
virtual

Return the root of the scene graph.

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

◆ isStereoSupported()

virtual bool openinventor::inventor::viewercomponents::qt::qml::RenderAreaInteractive::isStereoSupported ( ) const
virtual

Returns true if stereo can be activated.

◆ processEvent()

SbBool openinventor::inventor::viewercomponents::qt::qml::RenderAreaInteractive::processEvent ( const SoEvent *  event)

Processes the passed event to the scene graph managed here.

Returns TRUE if the event was handled by a node.

NOTES

    Events can only be processed once rendering area is initialized.

◆ processEvents()

SbBool openinventor::inventor::viewercomponents::qt::qml::RenderAreaInteractive::processEvents ( const std::vector< const SoEvent * > &  eventList)

Processes the passed event to the scene graph managed here.

Returns TRUE if at least one event was handled by a node.

NOTES

    Events can only be processed once rendering area is initialized.

◆ setClippingPlanesAdjustMode()

void openinventor::inventor::viewercomponents::qt::qml::RenderAreaInteractive::setClippingPlanesAdjustMode ( ClippingPlanesAdjustMode  mode)

Sets the camera clipping planes adjustment mode.

When adjustment mode is set to AUTO, the camera near and far planes are dynamically adjusted to be as tight as possible (least amount of stuff is clipped) before each render traversal. When adjustment mode is set to MANUAL, the user is expected to manually set those planes. Updating clipping planes after a camera move is not enough; if a dragger or a rendered shape is moved, they can disappear or become partially clipped. Default is AUTO.

◆ setSceneGraph()

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

Sets the scene graph to render.

Reimplemented from openinventor::inventor::viewercomponents::qt::qml::RenderArea.

◆ setStereoCameraBalance()

void openinventor::inventor::viewercomponents::qt::qml::RenderAreaInteractive::setStereoCameraBalance ( float  balance)

Set the stereo balance.

◆ setStereoCameraOffset()

void openinventor::inventor::viewercomponents::qt::qml::RenderAreaInteractive::setStereoCameraOffset ( float  offset)

Set the stereo offset.

◆ viewAll()

virtual void openinventor::inventor::viewercomponents::qt::qml::RenderAreaInteractive::viewAll ( const SbViewportRegion &  viewport)
virtual

Moves the camera to view the scene defined by the given path.

Equivalent to calling the SoCamera method viewAll(). Camera position is changed, but not orientation.

◆ viewAxis()

virtual void openinventor::inventor::viewercomponents::qt::qml::RenderAreaInteractive::viewAxis ( const SbVec3f &  direction,
const SbVec3f &  up 
)
virtual

Moves the camera to be aligned with the given direction vector while keeping the "up" direction of the camera parallel to the specified up vector.

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