Base class for 3D material settings widgets. More...

#include <qgsmaterialsettingswidget.h>

Inheritance diagram for QgsMaterialSettingsWidget:

[legend]

Public Slots
virtual void	setPreviewVisible (bool visible)=0
	Sets whether the material preview widget should be visible.
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.

Signals
void	changed ()
	Emitted when the material definition 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
	QgsMaterialSettingsWidget (QWidget *parent)
	Constructor for QgsMaterialSettingsWidget with the specified parent widget.
virtual void	setSettings (const QgsAbstractMaterialSettings settings, QgsVectorLayer layer)=0
	Sets the material settings to show in the widget.
virtual void	setTechnique (Qgis::MaterialRenderingTechnique technique)
	Sets the rendering technique which will be used for the symbol.
virtual std::unique_ptr< QgsAbstractMaterialSettings >	settings ()=0
	Returns a new instance of the material settings defined 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.

Protected Attributes
QgsPropertyCollection	mPropertyCollection

Additional Inherited Members
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 material settings widgets.

Note: Not available in Python bindings

Since: QGIS 3.16

Definition at line 37 of file qgsmaterialsettingswidget.h.

Constructor & Destructor Documentation

◆ QgsMaterialSettingsWidget()

QgsMaterialSettingsWidget::QgsMaterialSettingsWidget ( QWidget * parent )

Constructor for QgsMaterialSettingsWidget with the specified parent widget.

Definition at line 20 of file qgsmaterialsettingswidget.cpp.

Member Function Documentation

◆ changed

void QgsMaterialSettingsWidget::changed ( )

signal

Emitted when the material definition is changed.

◆ setPreviewVisible

virtual void QgsMaterialSettingsWidget::setPreviewVisible ( bool visible )

pure virtualslot

Sets whether the material preview widget should be visible.

◆ setSettings()

virtual void QgsMaterialSettingsWidget::setSettings	(	const QgsAbstractMaterialSettings *	settings,
		QgsVectorLayer *	layer )

pure virtual

Sets the material settings to show in the widget.

◆ setTechnique()

void QgsMaterialSettingsWidget::setTechnique ( Qgis::MaterialRenderingTechnique technique )

virtual

Sets the rendering technique which will be used for the symbol.

Allows the widget to adapt available settings for the specified technique.

Definition at line 24 of file qgsmaterialsettingswidget.cpp.

◆ settings()

virtual std::unique_ptr< QgsAbstractMaterialSettings > QgsMaterialSettingsWidget::settings ( )

pure virtual

Returns a new instance of the material settings defined by the widget.

Caller takes ownership of the returned settings.

Member Data Documentation

◆ mPropertyCollection

QgsPropertyCollection QgsMaterialSettingsWidget::mPropertyCollection

protected

Definition at line 80 of file qgsmaterialsettingswidget.h.

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

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

Public Slots

Signals

Public Member Functions

Protected Attributes

Additional Inherited Members