A widget allowing users to customize a 3d material. More...

#include <qgsmaterialwidget.h>

Inheritance diagram for QgsMaterialWidget:

[legend]

Public Slots
void	setPreviewVisible (bool visible)
	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 defined by the widget 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
	QgsMaterialWidget (QWidget *parent=nullptr)
	Constructor for QgsMaterialWidget.
	~QgsMaterialWidget () override
bool	filterByTechnique () const
	Returns whether available materials are filtered by technique.
void	setFilterByTechnique (bool enabled)
	Sets whether available materials should be filtered by technique.
void	setSettings (const QgsAbstractMaterialSettings settings, QgsVectorLayer layer)
	Sets the widget state to match material settings.
void	setTechnique (Qgis::MaterialRenderingTechnique technique)
	Sets the required rendering technique which the material must support.
std::unique_ptr< QgsAbstractMaterialSettings >	settings ()
	Returns the current settings defined by the widget.
void	setType (const QString &type)
	Sets the current material type.
Qgis::MaterialRenderingTechnique	technique () const
	Returns the required rendering technique which the material must support.
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
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

A widget allowing users to customize a 3d material.

Note: Not available in Python bindings

Since: QGIS 4.2

Definition at line 45 of file qgsmaterialwidget.h.

Constructor & Destructor Documentation

◆ QgsMaterialWidget()

QgsMaterialWidget::QgsMaterialWidget ( QWidget * parent = nullptr )

explicit

Constructor for QgsMaterialWidget.

Definition at line 38 of file qgsmaterialwidget.cpp.

◆ ~QgsMaterialWidget()

QgsMaterialWidget::~QgsMaterialWidget ( )

overridedefault

Member Function Documentation

◆ changed

void QgsMaterialWidget::changed ( )

signal

Emitted when the material defined by the widget is changed.

◆ filterByTechnique()

bool QgsMaterialWidget::filterByTechnique ( ) const

inline

Returns whether available materials are filtered by technique.

See also: setFilterByTechnique(); setTechnique()

Definition at line 93 of file qgsmaterialwidget.h.

◆ setFilterByTechnique()

void QgsMaterialWidget::setFilterByTechnique ( bool enabled )

Sets whether available materials should be filtered by technique.

See also: filterByTechnique(); setTechnique()

Definition at line 107 of file qgsmaterialwidget.cpp.

◆ setPreviewVisible

void QgsMaterialWidget::setPreviewVisible ( bool visible )

slot

Sets whether the material preview widget should be visible.

Definition at line 132 of file qgsmaterialwidget.cpp.

◆ setSettings()

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

Sets the widget state to match material settings.

Definition at line 113 of file qgsmaterialwidget.cpp.

◆ setTechnique()

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

Sets the required rendering technique which the material must support.

This is used to filter the available material choices in the widget.

Note: This setting is only respected when filterByTechnique() is true.

See also: technique(); filterByTechnique()

Definition at line 61 of file qgsmaterialwidget.cpp.

◆ settings()

std::unique_ptr< QgsAbstractMaterialSettings > QgsMaterialWidget::settings ( )

Returns the current settings defined by the widget.

Definition at line 121 of file qgsmaterialwidget.cpp.

◆ setType()

void QgsMaterialWidget::setType ( const QString & type )

Sets the current material type.

Definition at line 126 of file qgsmaterialwidget.cpp.

◆ technique()

Qgis::MaterialRenderingTechnique QgsMaterialWidget::technique ( ) const

inline

Returns the required rendering technique which the material must support.