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

#include <qgsframegraph.h>

Inheritance diagram for QgsFrameGraph:

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.

QgsPreviewQuad *	addTexturePreviewOverlay (Qt3DRender::QTexture2D texture, const QPointF &centerNDC, const QSizeF &size, QVector< Qt3DRender::QParameter > additionalShaderParameters=QVector< Qt3DRender::QParameter * >())
	Adds an preview entity that shows a texture in real time for debugging purposes.

bool	ambientOcclusionEnabled () const
	Returns whether Screen Space Ambient Occlusion is enabled.

float	ambientOcclusionIntensity () const
	Returns the ambient occlusion intensity.

float	ambientOcclusionRadius () const
	Returns the ambient occlusion radius.

float	ambientOcclusionThreshold () const
	Returns the ambient occlusion threshold.

Qt3DRender::QTexture2D *	blurredAmbientOcclusionFactorMap ()
	Returns blurred ambient occlusion factor values texture.

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.

bool	isRenderViewEnabled (const QString &name)
	Returns true if the render view named name is found and enabled.

Qt3DRender::QCamera *	mainCamera ()
	Returns the main camera.

QgsPostprocessingEntity *	postprocessingEntity ()
	Returns the postprocessing entity.

Qt3DRender::QLayer *	previewLayer ()
	Returns a layer object used to indicate that an entity is to be rendered during the preview textures rendering pass.

bool	registerRenderView (std::unique_ptr< QgsAbstractRenderView > renderView, const QString &name)
	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.

bool	renderCaptureEnabled () const
	Returns whether it will be possible to render to an image.

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	setAmbientOcclusionEnabled (bool enabled)
	Sets whether Screen Space Ambient Occlusion will be enabled.

void	setAmbientOcclusionIntensity (float intensity)
	Sets the ambient occlusion intensity.

void	setAmbientOcclusionRadius (float radius)
	Sets the ambient occlusion radius.

void	setAmbientOcclusionThreshold (float threshold)
	Sets the ambient occlusion threshold.

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.

void	setupDepthMapDebugging (bool enabled, Qt::Corner corner, double size)
	Sets the depth map debugging view port.

void	setupEyeDomeLighting (bool enabled, double strength, int distance)
	Sets eye dome lighting shading related settings.

void	setupShadowMapDebugging (bool enabled, Qt::Corner corner, double size)
	Sets the shadow map debugging view port.

QgsShadowRenderView &	shadowRenderView ()
	Returns shadow renderview.

void	unregisterRenderView (const QString &name)
	Unregisters the render view named name, if any.

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	AXIS3D_RENDERVIEW = "3daxis"

static const QString	DEPTH_RENDERVIEW = "depth"

static const QString	FORWARD_RENDERVIEW = "forward"

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 67 of file qgsframegraph.h.

Constructor & Destructor Documentation

◆ QgsFrameGraph()

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

Constructor.

Definition at line 321 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 652 of file qgsframegraph.cpp.

◆ addTexturePreviewOverlay()

QgsPreviewQuad * QgsFrameGraph::addTexturePreviewOverlay	(	Qt3DRender::QTexture2D *	texture,
		const QPointF &	centerNDC,
		const QSizeF &	size,
		QVector< Qt3DRender::QParameter * >	additionalShaderParameters = `QVector<Qt3DRender::QParameter *>()`
	)

Adds an preview entity that shows a texture in real time for debugging purposes.

Definition at line 465 of file qgsframegraph.cpp.

◆ ambientOcclusionEnabled()

bool QgsFrameGraph::ambientOcclusionEnabled ( ) const

inline

Returns whether Screen Space Ambient Occlusion is enabled.

Since: QGIS 3.28

Definition at line 114 of file qgsframegraph.h.

◆ ambientOcclusionIntensity()

float QgsFrameGraph::ambientOcclusionIntensity ( ) const

inline

Returns the ambient occlusion intensity.

Since: QGIS 3.28

Definition at line 126 of file qgsframegraph.h.

◆ ambientOcclusionRadius()

float QgsFrameGraph::ambientOcclusionRadius ( ) const

inline

Returns the ambient occlusion radius.

Since: QGIS 3.28

Definition at line 138 of file qgsframegraph.h.

◆ ambientOcclusionThreshold()

float QgsFrameGraph::ambientOcclusionThreshold ( ) const

inline

Returns the ambient occlusion threshold.

Since: QGIS 3.28

Definition at line 150 of file qgsframegraph.h.

◆ blurredAmbientOcclusionFactorMap()

Qt3DRender::QTexture2D * QgsFrameGraph::blurredAmbientOcclusionFactorMap ( )

inline

Returns blurred ambient occlusion factor values texture.

Since: QGIS 3.28

Definition at line 82 of file qgsframegraph.h.

◆ 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 316 of file qgsframegraph.cpp.

◆ depthRenderView()

QgsDepthRenderView & QgsFrameGraph::depthRenderView ( )

Returns depth renderview.

Since: QGIS 3.44

Definition at line 669 of file qgsframegraph.cpp.

◆ dumpFrameGraph()

QString QgsFrameGraph::dumpFrameGraph ( ) const

Dumps frame graph as string.

Definition at line 506 of file qgsframegraph.cpp.

◆ dumpSceneGraph()

QString QgsFrameGraph::dumpSceneGraph ( ) const

Dumps scene graph as string.

Definition at line 519 of file qgsframegraph.cpp.

◆ forwardRenderView()

QgsForwardRenderView & QgsFrameGraph::forwardRenderView ( )

Returns forward renderview.

Since: QGIS 3.44

Definition at line 657 of file qgsframegraph.cpp.

◆ frameGraphRoot()

Qt3DRender::QFrameGraphNode * QgsFrameGraph::frameGraphRoot ( )

inline

Returns the root of the frame graph object.

Definition at line 76 of file qgsframegraph.h.

◆ 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 460 of file qgsframegraph.cpp.

◆ mainCamera()

Qt3DRender::QCamera * QgsFrameGraph::mainCamera ( )

inline

Returns the main camera.

Definition at line 88 of file qgsframegraph.h.

◆ postprocessingEntity()

QgsPostprocessingEntity * QgsFrameGraph::postprocessingEntity ( )

inline

Returns the postprocessing entity.

Definition at line 90 of file qgsframegraph.h.

◆ previewLayer()

Qt3DRender::QLayer * QgsFrameGraph::previewLayer ( )

inline

Returns a layer object used to indicate that an entity is to be rendered during the preview textures rendering pass.

Definition at line 85 of file qgsframegraph.h.

◆ registerRenderView()

bool QgsFrameGraph::registerRenderView	(	std::unique_ptr< QgsAbstractRenderView >	renderView,
		const QString &	name
	)

Registers a new the render view renderView with name name.

Will take ownership of the renderView.

Since: QGIS 3.44

Definition at line 427 of file qgsframegraph.cpp.

◆ removeClipPlanes()

void QgsFrameGraph::removeClipPlanes ( )

Disables OpenGL clipping.

See also: addClipPlanes()

Since: QGIS 3.40

Definition at line 647 of file qgsframegraph.cpp.

◆ renderCapture()

Qt3DRender::QRenderCapture * QgsFrameGraph::renderCapture ( )

inline

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

Definition at line 96 of file qgsframegraph.h.

◆ renderCaptureEnabled()

bool QgsFrameGraph::renderCaptureEnabled ( ) const

inline

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

Since: QGIS 3.18

Definition at line 176 of file qgsframegraph.h.

◆ renderView()

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

Returns the render view named name, if any.

Since: QGIS 3.44

Definition at line 451 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 93 of file qgsframegraph.h.

◆ setAmbientOcclusionEnabled()

void QgsFrameGraph::setAmbientOcclusionEnabled ( bool enabled )

Sets whether Screen Space Ambient Occlusion will be enabled.

Since: QGIS 3.28

Definition at line 530 of file qgsframegraph.cpp.

◆ setAmbientOcclusionIntensity()

void QgsFrameGraph::setAmbientOcclusionIntensity ( float intensity )

Sets the ambient occlusion intensity.

Since: QGIS 3.28

Definition at line 537 of file qgsframegraph.cpp.

◆ setAmbientOcclusionRadius()

void QgsFrameGraph::setAmbientOcclusionRadius ( float radius )

Sets the ambient occlusion radius.

Since: QGIS 3.28

Definition at line 543 of file qgsframegraph.cpp.

◆ setAmbientOcclusionThreshold()

void QgsFrameGraph::setAmbientOcclusionThreshold ( float threshold )

Sets the ambient occlusion threshold.

Since: QGIS 3.28

Definition at line 549 of file qgsframegraph.cpp.

◆ setClearColor()

void QgsFrameGraph::setClearColor ( const QColor & clearColor )

Sets the clear color of the scene (background color)

Definition at line 525 of file qgsframegraph.cpp.

◆ setDebugOverlayEnabled()

void QgsFrameGraph::setDebugOverlayEnabled ( bool enabled )

Sets whether debug overlay is enabled.

Since: QGIS 3.26

Definition at line 642 of file qgsframegraph.cpp.

◆ setFrustumCullingEnabled()

void QgsFrameGraph::setFrustumCullingEnabled ( bool enabled )

Sets whether frustum culling is enabled.

Definition at line 555 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 634 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 443 of file qgsframegraph.cpp.

◆ setSize()

void QgsFrameGraph::setSize ( QSize s )

Sets the size of the buffers used for rendering.

Definition at line 617 of file qgsframegraph.cpp.

◆ setupDepthMapDebugging()

void QgsFrameGraph::setupDepthMapDebugging	(	bool	enabled,
		Qt::Corner	corner,
		double	size
	)

Sets the depth map debugging view port.

Definition at line 593 of file qgsframegraph.cpp.

◆ setupEyeDomeLighting()

void QgsFrameGraph::setupEyeDomeLighting	(	bool	enabled,
		double	strength,
		int	distance
	)

Sets eye dome lighting shading related settings.

Definition at line 560 of file qgsframegraph.cpp.

◆ setupShadowMapDebugging()

void QgsFrameGraph::setupShadowMapDebugging	(	bool	enabled,
		Qt::Corner	corner,
		double	size
	)

Sets the shadow map debugging view port.

Definition at line 570 of file qgsframegraph.cpp.

◆ shadowRenderView()

QgsShadowRenderView & QgsFrameGraph::shadowRenderView ( )

Returns shadow renderview.

Since: QGIS 3.44

Definition at line 663 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 418 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 474 of file qgsframegraph.cpp.

Member Data Documentation

◆ AXIS3D_RENDERVIEW

const QString QgsFrameGraph::AXIS3D_RENDERVIEW = "3daxis"

static

Definition at line 265 of file qgsframegraph.h.

◆ DEPTH_RENDERVIEW

const QString QgsFrameGraph::DEPTH_RENDERVIEW = "depth"

static

Definition at line 266 of file qgsframegraph.h.

◆ FORWARD_RENDERVIEW

const QString QgsFrameGraph::FORWARD_RENDERVIEW = "forward"

static

Definition at line 263 of file qgsframegraph.h.

◆ SHADOW_RENDERVIEW

const QString QgsFrameGraph::SHADOW_RENDERVIEW = "shadow"

static

Definition at line 264 of file qgsframegraph.h.

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

/build/qgis-3.43.0+git20250406+b60ef06885e+99sid/src/3d/framegraph/qgsframegraph.h
/build/qgis-3.43.0+git20250406+b60ef06885e+99sid/src/3d/framegraph/qgsframegraph.cpp

Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ QgsFrameGraph()

Member Function Documentation

◆ addClipPlanes()

◆ addTexturePreviewOverlay()

◆ ambientOcclusionEnabled()

◆ ambientOcclusionIntensity()

◆ ambientOcclusionRadius()

◆ ambientOcclusionThreshold()

◆ blurredAmbientOcclusionFactorMap()

◆ depthRenderCapture()

◆ depthRenderView()

◆ dumpFrameGraph()

◆ dumpSceneGraph()

◆ forwardRenderView()

◆ frameGraphRoot()

◆ isRenderViewEnabled()

◆ mainCamera()

◆ postprocessingEntity()

◆ previewLayer()

◆ registerRenderView()

◆ removeClipPlanes()

◆ renderCapture()

◆ renderCaptureEnabled()

◆ renderView()

◆ rubberBandsRootEntity()

◆ setAmbientOcclusionEnabled()

◆ setAmbientOcclusionIntensity()

◆ setAmbientOcclusionRadius()

◆ setAmbientOcclusionThreshold()

◆ setClearColor()

◆ setDebugOverlayEnabled()

◆ setFrustumCullingEnabled()

◆ setRenderCaptureEnabled()

◆ setRenderViewEnabled()

◆ setSize()

◆ setupDepthMapDebugging()

◆ setupEyeDomeLighting()

◆ setupShadowMapDebugging()

◆ shadowRenderView()

◆ unregisterRenderView()

◆ updateShadowSettings()

Member Data Documentation

◆ AXIS3D_RENDERVIEW

◆ DEPTH_RENDERVIEW

◆ FORWARD_RENDERVIEW

◆ SHADOW_RENDERVIEW