QGIS API Documentation 3.99.0-Master (a8f284845db)
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | List of all members
QgsFrameGraph Class Reference
3D library

Container class that holds different objects related to frame graphs of 3D scenes. More...

#include <qgsframegraph.h>

Inheritance diagram for QgsFrameGraph:
Inheritance graph
[legend]

Public Member Functions

 QgsFrameGraph (QSurface *surface, QSize s, Qt3DRender::QCamera *mainCamera, Qt3DCore::QEntity *root)
 Constructor.
void addClipPlanes (int nrClipPlanes)
 Setups nrClipPlanes clip planes in the forward pass to enable OpenGL clipping.
QgsAmbientOcclusionRenderView & ambientOcclusionRenderView ()
 Returns ambient occlusion renderview.
Qt3DRender::QRenderCapture * depthRenderCapture ()
 Returns the render capture object used to take an image of the depth buffer of the scene.
QgsDepthRenderView & depthRenderView ()
 Returns depth renderview.
QString dumpFrameGraph () const
 Dumps frame graph as string.
QString dumpSceneGraph () const
 Dumps scene graph as string.
QgsForwardRenderView & forwardRenderView ()
 Returns forward renderview.
Qt3DRender::QFrameGraphNode * frameGraphRoot ()
 Returns the root of the frame graph object.
QgsHighlightsRenderView & highlightsRenderView ()
 Returns the highlights renderview, used for rendering highlight overlays of identified features.
bool isRenderViewEnabled (const QString &name)
 Returns true if the render view named name is found and enabled.
Qt3DRender::QCamera * mainCamera ()
 Returns the main camera.
QgsOverlayTextureRenderView & overlayTextureRenderView ()
 Returns overlay texture renderview.
QgsPostprocessingEntity * postprocessingEntity ()
 Returns the postprocessing entity.
bool registerRenderView (std::unique_ptr< QgsAbstractRenderView > renderView, const QString &name, Qt3DRender::QFrameGraphNode *topNode=nullptr)
 Registers a new the render view renderView with name name.
void removeClipPlanes ()
 Disables OpenGL clipping.
Qt3DRender::QRenderCapture * renderCapture ()
 Returns the render capture object used to take an image of the scene.
QgsAbstractRenderView * renderView (const QString &name)
 Returns the render view named name, if any.
Qt3DCore::QEntity * rubberBandsRootEntity ()
 Returns entity for all rubber bands (to show them always on top).
void setClearColor (const QColor &clearColor)
 Sets the clear color of the scene (background color).
void setDebugOverlayEnabled (bool enabled)
 Sets whether debug overlay is enabled.
void setFrustumCullingEnabled (bool enabled)
 Sets whether frustum culling is enabled.
void setRenderCaptureEnabled (bool enabled)
 Sets whether it will be possible to render to an image.
void setRenderViewEnabled (const QString &name, bool enable)
 Enables or disables the render view named name according to enable.
void setSize (QSize s)
 Sets the size of the buffers used for rendering.
QgsShadowRenderView & shadowRenderView ()
 Returns shadow renderview.
void unregisterRenderView (const QString &name)
 Unregisters the render view named name, if any.
void updateAmbientOcclusionSettings (const QgsAmbientOcclusionSettings &settings)
 Updates settings for ambient occlusion.
void updateDebugDepthMapSettings (const Qgs3DMapSettings &settings)
 Updates settings for depth debug map.
void updateDebugShadowMapSettings (const Qgs3DMapSettings &settings)
 Updates settings for shadows debug map.
void updateEyeDomeSettings (const Qgs3DMapSettings &settings)
 Updates settings for eye dome lighting.
void updateShadowSettings (const QgsShadowSettings &shadowSettings, const QList< QgsLightSource * > &lightSources)
 Updates shadow bias, light and texture size according to shadowSettings and lightSources.

Static Public Attributes

static const QString AMBIENT_OCCLUSION_RENDERVIEW = "ambient_occlusion"
 Ambient occlusion render view name.
static const QString AXIS3D_RENDERVIEW = "3daxis"
static const QString DEPTH_RENDERVIEW = "depth"
static const QString FORWARD_RENDERVIEW = "forward"
static const QString HIGHLIGHTS_RENDERVIEW = "highlights"
static const QString OVERLAY_RENDERVIEW = "overlay_texture"
static const QString SHADOW_RENDERVIEW = "shadow"

Detailed Description

Container class that holds different objects related to frame graphs of 3D scenes.

A frame graph captures configuration of rendering passes when 3D scene gets rendered.

Note
Not available in Python bindings
Since
QGIS 3.16

Definition at line 71 of file qgsframegraph.h.

Constructor & Destructor Documentation

◆ QgsFrameGraph()

QgsFrameGraph::QgsFrameGraph ( QSurface * surface,
QSize s,
Qt3DRender::QCamera * mainCamera,
Qt3DCore::QEntity * root )

Constructor.

Definition at line 209 of file qgsframegraph.cpp.

Member Function Documentation

◆ addClipPlanes()

void QgsFrameGraph::addClipPlanes ( int nrClipPlanes)

Setups nrClipPlanes clip planes in the forward pass to enable OpenGL clipping.

If nrClipPlanes is equal to 0, the clipping is disabled.

See also
removeClipPlanes()
Since
QGIS 3.40

Definition at line 507 of file qgsframegraph.cpp.

◆ ambientOcclusionRenderView()

QgsAmbientOcclusionRenderView & QgsFrameGraph::ambientOcclusionRenderView ( )

Returns ambient occlusion renderview.

Since
QGIS 3.44

Definition at line 530 of file qgsframegraph.cpp.

◆ depthRenderCapture()

Qt3DRender::QRenderCapture * QgsFrameGraph::depthRenderCapture ( )

Returns the render capture object used to take an image of the depth buffer of the scene.

Definition at line 204 of file qgsframegraph.cpp.

◆ depthRenderView()

QgsDepthRenderView & QgsFrameGraph::depthRenderView ( )

Returns depth renderview.

Since
QGIS 3.44

Definition at line 524 of file qgsframegraph.cpp.

◆ dumpFrameGraph()

QString QgsFrameGraph::dumpFrameGraph ( ) const

Dumps frame graph as string.

Definition at line 441 of file qgsframegraph.cpp.

◆ dumpSceneGraph()

QString QgsFrameGraph::dumpSceneGraph ( ) const

Dumps scene graph as string.

Definition at line 454 of file qgsframegraph.cpp.

◆ forwardRenderView()

QgsForwardRenderView & QgsFrameGraph::forwardRenderView ( )

Returns forward renderview.

Since
QGIS 3.44

Definition at line 512 of file qgsframegraph.cpp.

◆ frameGraphRoot()

Qt3DRender::QFrameGraphNode * QgsFrameGraph::frameGraphRoot ( )
inline

Returns the root of the frame graph object.

Definition at line 80 of file qgsframegraph.h.

◆ highlightsRenderView()

QgsHighlightsRenderView & QgsFrameGraph::highlightsRenderView ( )

Returns the highlights renderview, used for rendering highlight overlays of identified features.

Since
QGIS 4.0

Definition at line 536 of file qgsframegraph.cpp.

◆ isRenderViewEnabled()

bool QgsFrameGraph::isRenderViewEnabled ( const QString & name)

Returns true if the render view named name is found and enabled.

Since
QGIS 3.44

Definition at line 331 of file qgsframegraph.cpp.

◆ mainCamera()

Qt3DRender::QCamera * QgsFrameGraph::mainCamera ( )
inline

Returns the main camera.

Definition at line 83 of file qgsframegraph.h.

◆ overlayTextureRenderView()

QgsOverlayTextureRenderView & QgsFrameGraph::overlayTextureRenderView ( )

Returns overlay texture renderview.

Since
QGIS 4.0

Definition at line 542 of file qgsframegraph.cpp.

◆ postprocessingEntity()

QgsPostprocessingEntity * QgsFrameGraph::postprocessingEntity ( )
inline

Returns the postprocessing entity.

Definition at line 86 of file qgsframegraph.h.

◆ registerRenderView()

bool QgsFrameGraph::registerRenderView ( std::unique_ptr< QgsAbstractRenderView > renderView,
const QString & name,
Qt3DRender::QFrameGraphNode * topNode = nullptr )

Registers a new the render view renderView with name name.

topNode is where the new renderview will be attached to. If nullptr then it will be attached to the main viewport. Will take ownership of the renderView.

Since
QGIS 3.44

Definition at line 298 of file qgsframegraph.cpp.

◆ removeClipPlanes()

void QgsFrameGraph::removeClipPlanes ( )

Disables OpenGL clipping.

See also
addClipPlanes()
Since
QGIS 3.40

Definition at line 502 of file qgsframegraph.cpp.

◆ renderCapture()

Qt3DRender::QRenderCapture * QgsFrameGraph::renderCapture ( )

Returns the render capture object used to take an image of the scene.

Definition at line 484 of file qgsframegraph.cpp.

◆ renderView()

QgsAbstractRenderView * QgsFrameGraph::renderView ( const QString & name)

Returns the render view named name, if any.

Since
QGIS 3.44

Definition at line 322 of file qgsframegraph.cpp.

◆ rubberBandsRootEntity()

Qt3DCore::QEntity * QgsFrameGraph::rubberBandsRootEntity ( )
inline

Returns entity for all rubber bands (to show them always on top).

Definition at line 89 of file qgsframegraph.h.

◆ setClearColor()

void QgsFrameGraph::setClearColor ( const QColor & clearColor)

Sets the clear color of the scene (background color).

Definition at line 460 of file qgsframegraph.cpp.

◆ setDebugOverlayEnabled()

void QgsFrameGraph::setDebugOverlayEnabled ( bool enabled)

Sets whether debug overlay is enabled.

Since
QGIS 3.26

Definition at line 497 of file qgsframegraph.cpp.

◆ setFrustumCullingEnabled()

void QgsFrameGraph::setFrustumCullingEnabled ( bool enabled)

Sets whether frustum culling is enabled.

Definition at line 465 of file qgsframegraph.cpp.

◆ setRenderCaptureEnabled()

void QgsFrameGraph::setRenderCaptureEnabled ( bool enabled)

Sets whether it will be possible to render to an image.

Since
QGIS 3.18

Definition at line 489 of file qgsframegraph.cpp.

◆ setRenderViewEnabled()

void QgsFrameGraph::setRenderViewEnabled ( const QString & name,
bool enable )

Enables or disables the render view named name according to enable.

Since
QGIS 3.44

Definition at line 314 of file qgsframegraph.cpp.

◆ setSize()

void QgsFrameGraph::setSize ( QSize s)

Sets the size of the buffers used for rendering.

Definition at line 470 of file qgsframegraph.cpp.

◆ shadowRenderView()

QgsShadowRenderView & QgsFrameGraph::shadowRenderView ( )

Returns shadow renderview.

Since
QGIS 3.44

Definition at line 518 of file qgsframegraph.cpp.

◆ unregisterRenderView()

void QgsFrameGraph::unregisterRenderView ( const QString & name)

Unregisters the render view named name, if any.

Since
QGIS 3.44

Definition at line 289 of file qgsframegraph.cpp.

◆ updateAmbientOcclusionSettings()

void QgsFrameGraph::updateAmbientOcclusionSettings ( const QgsAmbientOcclusionSettings & settings)

Updates settings for ambient occlusion.

Since
QGIS 3.44

Definition at line 336 of file qgsframegraph.cpp.

◆ updateDebugDepthMapSettings()

void QgsFrameGraph::updateDebugDepthMapSettings ( const Qgs3DMapSettings & settings)

Updates settings for depth debug map.

Since
QGIS 3.44

Definition at line 414 of file qgsframegraph.cpp.

◆ updateDebugShadowMapSettings()

void QgsFrameGraph::updateDebugShadowMapSettings ( const Qgs3DMapSettings & settings)

Updates settings for shadows debug map.

Since
QGIS 3.44

Definition at line 387 of file qgsframegraph.cpp.

◆ updateEyeDomeSettings()

void QgsFrameGraph::updateEyeDomeSettings ( const Qgs3DMapSettings & settings)

Updates settings for eye dome lighting.

Since
QGIS 3.44

Definition at line 348 of file qgsframegraph.cpp.

◆ updateShadowSettings()

void QgsFrameGraph::updateShadowSettings ( const QgsShadowSettings & shadowSettings,
const QList< QgsLightSource * > & lightSources )

Updates shadow bias, light and texture size according to shadowSettings and lightSources.

Since
QGIS 3.44

Definition at line 355 of file qgsframegraph.cpp.

Member Data Documentation

◆ AMBIENT_OCCLUSION_RENDERVIEW

const QString QgsFrameGraph::AMBIENT_OCCLUSION_RENDERVIEW = "ambient_occlusion"
static

Ambient occlusion render view name.

Definition at line 246 of file qgsframegraph.h.

◆ AXIS3D_RENDERVIEW

const QString QgsFrameGraph::AXIS3D_RENDERVIEW = "3daxis"
static

Definition at line 242 of file qgsframegraph.h.

◆ DEPTH_RENDERVIEW

const QString QgsFrameGraph::DEPTH_RENDERVIEW = "depth"
static

Definition at line 243 of file qgsframegraph.h.

◆ FORWARD_RENDERVIEW

const QString QgsFrameGraph::FORWARD_RENDERVIEW = "forward"
static

Definition at line 240 of file qgsframegraph.h.

◆ HIGHLIGHTS_RENDERVIEW

const QString QgsFrameGraph::HIGHLIGHTS_RENDERVIEW = "highlights"
static

Definition at line 247 of file qgsframegraph.h.

◆ OVERLAY_RENDERVIEW

const QString QgsFrameGraph::OVERLAY_RENDERVIEW = "overlay_texture"
static

Definition at line 244 of file qgsframegraph.h.

◆ SHADOW_RENDERVIEW

const QString QgsFrameGraph::SHADOW_RENDERVIEW = "shadow"
static

Definition at line 241 of file qgsframegraph.h.

The documentation for this class was generated from the following files:
Generated on for QGIS API Documentation by doxygen 1.15.0