QGIS API Documentation 3.41.0-Master (fda2aa46e9a)
Loading...
Searching...
No Matches
Public Slots | Signals | Public Member Functions | List of all members
QgsElevationControllerWidget Class Reference

A widget for configuring vertical elevation slicing behavior for maps. More...

#include <qgselevationcontrollerwidget.h>

Inheritance diagram for QgsElevationControllerWidget:
Inheritance graph
[legend]

Public Slots

void setFixedRangeSize (double size)
 Sets the fixed range size.
 
void setInverted (bool inverted)
 Sets whether the elevation slider should be inverted.
 
void setRange (const QgsDoubleRange &range)
 Sets the current visible range for the widget.
 
void setRangeLimits (const QgsDoubleRange &limits)
 Sets the limits of the elevation range which can be selected by the widget.
 
void setSignificantElevations (const QList< double > &elevations)
 Sets a list of significant elevations to highlight in the widget.
 

Signals

void fixedRangeSizeChanged (double size)
 Emitted when the fixed range size is changed from the widget.
 
void invertedChanged (bool inverted)
 Emitted when the elevation filter slider is inverted.
 
void rangeChanged (const QgsDoubleRange &range)
 Emitted when the visible range from the widget is changed.
 

Public Member Functions

 QgsElevationControllerWidget (QWidget *parent=nullptr)
 Constructor for QgsElevationControllerWidget, with the specified parent widget.
 
double fixedRangeSize () const
 Returns the fixed range size, or -1 if no fixed size is set.
 
QMenu * menu ()
 Returns a reference to the widget's configuration menu, which can be used to add actions to the menu.
 
QgsDoubleRange range () const
 Returns the current visible range from the widget.
 
QgsDoubleRange rangeLimits () const
 Returns the limits of the elevation range which can be selected by the widget.
 
void resizeEvent (QResizeEvent *event) override
 
QgsRangeSliderslider ()
 Returns a reference to the slider component of the widget.
 

Detailed Description

A widget for configuring vertical elevation slicing behavior for maps.

Since
QGIS 3.38

Definition at line 82 of file qgselevationcontrollerwidget.h.

Constructor & Destructor Documentation

◆ QgsElevationControllerWidget()

QgsElevationControllerWidget::QgsElevationControllerWidget ( QWidget *  parent = nullptr)

Constructor for QgsElevationControllerWidget, with the specified parent widget.

Definition at line 36 of file qgselevationcontrollerwidget.cpp.

Member Function Documentation

◆ fixedRangeSize()

double QgsElevationControllerWidget::fixedRangeSize ( ) const

Returns the fixed range size, or -1 if no fixed size is set.

A fixed size forces the selected elevation range to have a matching difference between the upper and lower elevation.

See also
setFixedRangeSize()

Definition at line 221 of file qgselevationcontrollerwidget.cpp.

◆ fixedRangeSizeChanged

void QgsElevationControllerWidget::fixedRangeSizeChanged ( double  size)
signal

Emitted when the fixed range size is changed from the widget.

See also
fixedRangeSize()
setFixedRangeSize()

◆ invertedChanged

void QgsElevationControllerWidget::invertedChanged ( bool  inverted)
signal

Emitted when the elevation filter slider is inverted.

See also
setInverted()

◆ menu()

QMenu * QgsElevationControllerWidget::menu ( )

Returns a reference to the widget's configuration menu, which can be used to add actions to the menu.

Definition at line 156 of file qgselevationcontrollerwidget.cpp.

◆ range()

QgsDoubleRange QgsElevationControllerWidget::range ( ) const

Returns the current visible range from the widget.

See also
setRange()
rangeChanged()

Definition at line 122 of file qgselevationcontrollerwidget.cpp.

◆ rangeChanged

void QgsElevationControllerWidget::rangeChanged ( const QgsDoubleRange range)
signal

Emitted when the visible range from the widget is changed.

See also
setRange()
range()

◆ rangeLimits()

QgsDoubleRange QgsElevationControllerWidget::rangeLimits ( ) const

Returns the limits of the elevation range which can be selected by the widget.

See also
rangeLimits()

Definition at line 146 of file qgselevationcontrollerwidget.cpp.

◆ resizeEvent()

void QgsElevationControllerWidget::resizeEvent ( QResizeEvent *  event)
override

Definition at line 116 of file qgselevationcontrollerwidget.cpp.

◆ setFixedRangeSize

void QgsElevationControllerWidget::setFixedRangeSize ( double  size)
slot

Sets the fixed range size.

Set to -1 if no fixed size is desired.

A fixed size forces the selected elevation range to have a matching difference between the upper and lower elevation.

See also
fixedRangeSize()
fixedRangeSizeChanged()

Definition at line 226 of file qgselevationcontrollerwidget.cpp.

◆ setInverted

void QgsElevationControllerWidget::setInverted ( bool  inverted)
slot

Sets whether the elevation slider should be inverted.

See also
invertedChanged()

Definition at line 245 of file qgselevationcontrollerwidget.cpp.

◆ setRange

void QgsElevationControllerWidget::setRange ( const QgsDoubleRange range)
slot

Sets the current visible range for the widget.

See also
range()
rangeChanged()

Definition at line 161 of file qgselevationcontrollerwidget.cpp.

◆ setRangeLimits

void QgsElevationControllerWidget::setRangeLimits ( const QgsDoubleRange limits)
slot

Sets the limits of the elevation range which can be selected by the widget.

See also
rangeLimits()

Definition at line 176 of file qgselevationcontrollerwidget.cpp.

◆ setSignificantElevations

void QgsElevationControllerWidget::setSignificantElevations ( const QList< double > &  elevations)
slot

Sets a list of significant elevations to highlight in the widget.

Definition at line 250 of file qgselevationcontrollerwidget.cpp.

◆ slider()

QgsRangeSlider * QgsElevationControllerWidget::slider ( )

Returns a reference to the slider component of the widget.

Definition at line 151 of file qgselevationcontrollerwidget.cpp.


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