QGIS API Documentation  3.21.0-Master (af9a72eda6)
Public Member Functions | Protected Attributes | List of all members
QgsPointCloudRendererWidget Class Referenceabstract

Base class for point cloud 2D renderer settings widgets. More...

#include <qgspointcloudrendererwidget.h>

Inheritance diagram for QgsPointCloudRendererWidget:
Inheritance graph
[legend]

Public Member Functions

 QgsPointCloudRendererWidget (QgsPointCloudLayer *layer, QgsStyle *style)
 Constructor for QgsPointCloudRendererWidget, associated with the specified layer and style database. More...
 
QgsSymbolWidgetContext context () const
 Returns the context in which the renderer widget is shown, e.g., the associated map canvas and expression contexts. More...
 
const QgsPointCloudLayerlayer () const
 Returns the point cloud layer associated with the widget. More...
 
virtual QgsPointCloudRendererrenderer ()=0
 Returns a new instance of a renderer as defined by the settings in the widget. More...
 
virtual void setContext (const QgsSymbolWidgetContext &context)
 Sets the context in which the renderer widget is shown, e.g., the associated map canvas and expression contexts. More...
 
- Public Member Functions inherited from QgsPanelWidget
 QgsPanelWidget (QWidget *parent=nullptr)
 Base class for any widget that can be shown as a inline panel. More...
 
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. More...
 
bool autoDelete ()
 The the auto delete property on the widget. More...
 
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. More...
 
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. More...
 
bool dockMode ()
 Returns the dock mode state. More...
 
virtual QMenu * menuButtonMenu ()
 Returns the menu to use for the menu button for this panel, or nullptr if no menu button is required. More...
 
virtual QString menuButtonTooltip () const
 Returns the (translated) tooltip text to use for the menu button for this panel. More...
 
QString panelTitle ()
 The title of the panel. More...
 
void setAutoDelete (bool autoDelete)
 The the auto delete property on the widget. More...
 
virtual void setDockMode (bool dockMode)
 Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs. More...
 
void setPanelTitle (const QString &panelTitle)
 Set the title of the panel when shown in the interface. More...
 

Protected Attributes

QgsSymbolWidgetContext mContext
 Context in which widget is shown. More...
 
QgsPointCloudLayermLayer = nullptr
 
QgsStylemStyle = nullptr
 

Additional Inherited Members

- Public Slots inherited from QgsPanelWidget
void acceptPanel ()
 Accept the panel. More...
 
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. More...
 
- Signals inherited from QgsPanelWidget
void panelAccepted (QgsPanelWidget *panel)
 Emitted when the panel is accepted by the user. More...
 
void showPanel (QgsPanelWidget *panel)
 Emit when you require a panel to be show in the interface. More...
 
void widgetChanged ()
 Emitted when the widget state changes. More...
 
- Static Public Member Functions inherited from QgsPanelWidget
static QgsPanelWidgetfindParentPanel (QWidget *widget)
 Traces through the parents of a widget to find if it is contained within a QgsPanelWidget widget. More...
 
- Protected Member Functions inherited from QgsPanelWidget
void keyPressEvent (QKeyEvent *event) override
 Overridden key press event to handle the esc event on the widget. More...
 

Detailed Description

Base class for point cloud 2D renderer settings widgets.

Since
QGIS 3.18

Definition at line 36 of file qgspointcloudrendererwidget.h.

Constructor & Destructor Documentation

◆ QgsPointCloudRendererWidget()

QgsPointCloudRendererWidget::QgsPointCloudRendererWidget ( QgsPointCloudLayer layer,
QgsStyle style 
)

Constructor for QgsPointCloudRendererWidget, associated with the specified layer and style database.

Definition at line 17 of file qgspointcloudrendererwidget.cpp.

Member Function Documentation

◆ context()

QgsSymbolWidgetContext QgsPointCloudRendererWidget::context ( ) const

Returns the context in which the renderer widget is shown, e.g., the associated map canvas and expression contexts.

See also
setContext()

Definition at line 28 of file qgspointcloudrendererwidget.cpp.

◆ layer()

const QgsPointCloudLayer* QgsPointCloudRendererWidget::layer ( ) const
inline

Returns the point cloud layer associated with the widget.

Definition at line 69 of file qgspointcloudrendererwidget.h.

◆ renderer()

virtual QgsPointCloudRenderer* QgsPointCloudRendererWidget::renderer ( )
pure virtual

Returns a new instance of a renderer as defined by the settings in the widget.

Caller takes ownership of the returned object.

◆ setContext()

void QgsPointCloudRendererWidget::setContext ( const QgsSymbolWidgetContext context)
virtual

Sets the context in which the renderer widget is shown, e.g., the associated map canvas and expression contexts.

See also
context()

Definition at line 23 of file qgspointcloudrendererwidget.cpp.

Member Data Documentation

◆ mContext

QgsSymbolWidgetContext QgsPointCloudRendererWidget::mContext
protected

Context in which widget is shown.

Definition at line 78 of file qgspointcloudrendererwidget.h.

◆ mLayer

QgsPointCloudLayer* QgsPointCloudRendererWidget::mLayer = nullptr
protected

Definition at line 74 of file qgspointcloudrendererwidget.h.

◆ mStyle

QgsStyle* QgsPointCloudRendererWidget::mStyle = nullptr
protected

Definition at line 75 of file qgspointcloudrendererwidget.h.


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