QgsAbstractRenderView Class Reference

Base class for 3D render view. More...

#include <qgsabstractrenderview.h>

Inheritance diagram for QgsAbstractRenderView:

Public Member Functions
	QgsAbstractRenderView (const QgsAbstractRenderView &other)=delete
	Disabled copy constructor.
	QgsAbstractRenderView (const QString &viewName)
	Constructor for QgsAbstractRenderView with the specified parent object.
virtual	~QgsAbstractRenderView ()
	Default destructor.
virtual bool	isEnabled () const
	Returns true if render view is enabled.
QgsAbstractRenderView &	operator= (const QgsAbstractRenderView &other)=delete
	Disabled operator=.
virtual void	setEnabled (bool enable)
	Enable or disable via enable the render view sub tree.
QPointer< Qt3DRender::QFrameGraphNode >	topGraphNode () const
	Returns the top node of this render view branch. Will be used to register the render view.
virtual void	updateWindowResize (int width, int height)
	Called when 3D window is resized.

Protected Attributes
Qt3DRender::QSubtreeEnabler *	mRendererEnabler = nullptr
QPointer< Qt3DRender::QFrameGraphNode >	mRoot
QString	mViewName

Detailed Description

Base class for 3D render view.

An instance of QgsAbstractRenderView is a branch (ie. a render pass, ie. a render view) of the framegraph. It may contains multiple render passes.

Will be used with QgsFrameGraph::registerRenderView.

Note

Not available in Python bindings

Since

QGIS 3.44

Definition at line 44 of file qgsabstractrenderview.h.

Constructor & Destructor Documentation

QgsAbstractRenderView() [1/2]

QgsAbstractRenderView::QgsAbstractRenderView

(

const QString &

viewName

)

Constructor for QgsAbstractRenderView with the specified parent object.

Definition at line 20 of file qgsabstractrenderview.cpp.

QgsAbstractRenderView() [2/2]

QgsAbstractRenderView::QgsAbstractRenderView ( const QgsAbstractRenderView &  other )

delete

Disabled copy constructor.

~QgsAbstractRenderView()

QgsAbstractRenderView::~QgsAbstractRenderView ( )

virtual

Default destructor.

Definition at line 34 of file qgsabstractrenderview.cpp.

Member Function Documentation

isEnabled()

bool QgsAbstractRenderView::isEnabled ( ) const

virtual

Returns true if render view is enabled.

Definition at line 60 of file qgsabstractrenderview.cpp.

operator=()

QgsAbstractRenderView & QgsAbstractRenderView::operator= ( const QgsAbstractRenderView &  other )

delete

Disabled operator=.

setEnabled()

void QgsAbstractRenderView::setEnabled ( bool  enable )

virtual

Enable or disable via enable the render view sub tree.

Reimplemented in QgsAmbientOcclusionRenderView, and QgsShadowRenderView.

Definition at line 54 of file qgsabstractrenderview.cpp.

topGraphNode()

QPointer< Qt3DRender::QFrameGraphNode > QgsAbstractRenderView::topGraphNode

(

)

const

Returns the top node of this render view branch. Will be used to register the render view.

Definition at line 49 of file qgsabstractrenderview.cpp.

updateWindowResize()

void QgsAbstractRenderView::updateWindowResize ( int  width, int  height  )

virtual

Called when 3D window is resized.

Render views may update their textures accordingly. Default implementation does nothing.

Reimplemented in Qgs3DAxisRenderView, QgsAmbientOcclusionRenderView, QgsDepthRenderView, and QgsForwardRenderView.

Definition at line 44 of file qgsabstractrenderview.cpp.

Member Data Documentation

mRendererEnabler

Qt3DRender::QSubtreeEnabler* QgsAbstractRenderView::mRendererEnabler = nullptr

protected

Definition at line 78 of file qgsabstractrenderview.h.

mRoot

QPointer<Qt3DRender::QFrameGraphNode> QgsAbstractRenderView::mRoot

protected

Definition at line 77 of file qgsabstractrenderview.h.

mViewName

QString QgsAbstractRenderView::mViewName

protected

Definition at line 76 of file qgsabstractrenderview.h.

---

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

• /build/qgis-3.43.0+git20250520+e01d6d7c4c0+99sid/src/3d/framegraph/qgsabstractrenderview.h
• /build/qgis-3.43.0+git20250520+e01d6d7c4c0+99sid/src/3d/framegraph/qgsabstractrenderview.cpp