Qgs3DSymbolWidget Class Reference

Base class for 3D symbol configuration widgets. More...

#include <qgs3dsymbolwidget.h>

Inheritance diagram for Qgs3DSymbolWidget:

Signals
void	changed ()
	Emitted when the symbol is changed.
void	renderingTechniqueChanged ()
	Emitted when the rendering technique associated with the symbol is changed.
Signals inherited from QgsPanelWidget
void	panelAccepted (QgsPanelWidget *panel)
	Emitted when the panel is accepted by the user.
void	showPanel (QgsPanelWidget *panel)
	Emit when you require a panel to be show in the interface.
void	widgetChanged ()
	Emitted when the widget state changes.

Public Member Functions
	Qgs3DSymbolWidget (QWidget *parent)
	Constructor for Qgs3DSymbolWidget with the specified parent widget.
virtual Qgis::MaterialRenderingTechnique	renderingTechnique () const =0
	Returns associated rendering technique.
virtual void	setSymbol (const QgsAbstract3DSymbol *symbol, QgsVectorLayer *layer)=0
	Sets the symbol to show in the widget.
virtual QgsAbstract3DSymbol *	symbol ()=0
	Returns a new instance of the symbol defined by the widget.
virtual QString	symbolType () const =0
	Returns the symbol type handled by the widget.
Public Member Functions inherited from QgsPanelWidget
	QgsPanelWidget (QWidget *parent=nullptr)
	Base class for any widget that can be shown as an inline panel.
virtual bool	applySizeConstraintsToStack () const
	Returns true if the size constraints and hints for the panel widget should be applied to the parent QgsPanelWidgetStack which this panel is shown in.
bool	autoDelete () const
	The the auto delete property on the widget.
void	connectChildPanel (QgsPanelWidget *panel)
	Connect the given sub panel widgets showPanel signals to this current panels main showPanel event to bubble up to the user.
void	connectChildPanels (const QList< QgsPanelWidget * > &panels)
	Connect the given sub panel widgets showPanel signals to this current panels main showPanel event to bubble up to the user.
bool	dockMode () const
	Returns the dock mode state.
virtual QMenu *	menuButtonMenu ()
	Returns the menu to use for the menu button for this panel, or nullptr if no menu button is required.
virtual QString	menuButtonTooltip () const
	Returns the (translated) tooltip text to use for the menu button for this panel.
QString	panelTitle () const
	The title of the panel.
void	setAutoDelete (bool autoDelete)
	The the auto delete property on the widget.
virtual void	setDockMode (bool dockMode)
	Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs.
void	setPanelTitle (const QString &panelTitle)
	Set the title of the panel when shown in the interface.

Additional Inherited Members
Public Slots inherited from QgsPanelWidget
void	acceptPanel ()
	Accept the panel.
void	openPanel (QgsPanelWidget *panel)
	Open a panel or dialog depending on dock mode setting If dock mode is true this method will emit the showPanel signal for connected slots to handle the open event.
Static Public Member Functions inherited from QgsPanelWidget
static QgsPanelWidget *	findParentPanel (QWidget *widget)
	Traces through the parents of a widget to find if it is contained within a QgsPanelWidget widget.
Protected Member Functions inherited from QgsPanelWidget
void	keyPressEvent (QKeyEvent *event) override
	Overridden key press event to handle the esc event on the widget.

Detailed Description

Base class for 3D symbol configuration widgets.

Since

QGIS 3.16

Definition at line 37 of file qgs3dsymbolwidget.h.

Constructor & Destructor Documentation

Qgs3DSymbolWidget()

Qgs3DSymbolWidget::Qgs3DSymbolWidget

(

QWidget *

parent

)

Constructor for Qgs3DSymbolWidget with the specified parent widget.

Definition at line 32 of file qgs3dsymbolwidget.cpp.

Member Function Documentation

changed

void Qgs3DSymbolWidget::changed ( )

signal

Emitted when the symbol is changed.

renderingTechnique()

virtual Qgis::MaterialRenderingTechnique Qgs3DSymbolWidget::renderingTechnique ( ) const

pure virtual

Returns associated rendering technique.

Warning

This is not considered stable API, and may change in future QGIS releases. It is exposed to the Python bindings as a tech preview only.

Since

QGIS 4.2

renderingTechniqueChanged

void Qgs3DSymbolWidget::renderingTechniqueChanged ( )

signal

Emitted when the rendering technique associated with the symbol is changed.

Warning

This is not considered stable API, and may change in future QGIS releases. It is exposed to the Python bindings as a tech preview only.

Since

QGIS 4.2

setSymbol()

virtual void Qgs3DSymbolWidget::setSymbol ( const QgsAbstract3DSymbol * symbol, QgsVectorLayer * layer )

pure virtual

Sets the symbol to show in the widget.

symbol()

virtual QgsAbstract3DSymbol * Qgs3DSymbolWidget::symbol ( )

pure virtual

Returns a new instance of the symbol defined by the widget.

Caller takes ownership of the returned symbol.

symbolType()

virtual QString Qgs3DSymbolWidget::symbolType ( ) const

pure virtual

Returns the symbol type handled by the widget.

---

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

• /build/qgis-4.1.0+git20260701+0cdd3ae6384+99sid/src/gui/qgs3dsymbolwidget.h
• /build/qgis-4.1.0+git20260701+0cdd3ae6384+99sid/src/gui/qgs3dsymbolwidget.cpp