QHeightMapSurfaceDataProxy#
Base proxy class for Q3DSurface
. More…
Synopsis#
Functions#
def
autoScaleY
()def
heightMap
()def
heightMapFile
()def
maxXValue
()def
maxYValue
()def
maxZValue
()def
minXValue
()def
minYValue
()def
minZValue
()def
setAutoScaleY
(enabled)def
setHeightMap
(image)def
setHeightMapFile
(filename)def
setMaxXValue
(max)def
setMaxYValue
(max)def
setMaxZValue
(max)def
setMinXValue
(min)def
setMinYValue
(min)def
setMinZValue
(min)def
setValueRanges
(minX, maxX, minZ, maxZ)
Signals#
def
autoScaleYChanged
(enabled)def
heightMapChanged
(image)def
heightMapFileChanged
(filename)def
maxXValueChanged
(value)def
maxYValueChanged
(value)def
maxZValueChanged
(value)def
minXValueChanged
(value)def
minYValueChanged
(value)def
minZValueChanged
(value)
Detailed Description#
QHeightMapSurfaceDataProxy
takes care of surface related height map data handling. It provides a way to give a height map to be visualized as a surface plot.
Since height maps do not contain values for X or Z axes, those values need to be given separately using minXValue
, maxXValue
, minZValue
, and maxZValue
properties. X-value corresponds to image horizontal direction and Z-value to the vertical. Setting any of these properties triggers asynchronous re-resolving of any existing height map.
- class PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy([parent=None])#
PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy(image[, parent=None])
PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy(filename[, parent=None])
- Parameters
image –
PySide6.QtGui.QImage
filename – str
parent –
PySide6.QtCore.QObject
Constructs QHeightMapSurfaceDataProxy
with the given parent
.
Constructs QHeightMapSurfaceDataProxy
with the given image
and parent
. Height map is set by calling setHeightMap()
with image
.
See also
Constructs QHeightMapSurfaceDataProxy
from the given image filename
and parent
. Height map is set by calling setHeightMapFile()
with filename
.
See also
- PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.autoScaleY()#
- Return type
bool
This property holds Scale height values to Y-axis..
Defaults to false
.
When this property is set to true
, the height values are scaled to fit on the Y-axis between minYValue
and maxYValue
.
- PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.autoScaleYChanged(enabled)#
- Parameters
enabled – bool
- PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.heightMap()#
- Return type
This property holds The height map image to be visualized..
- PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.heightMapChanged(image)#
- Parameters
image –
PySide6.QtGui.QImage
- PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.heightMapFile()#
- Return type
str
This property holds The name of the file with a height map image to be visualized..
- PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.heightMapFileChanged(filename)#
- Parameters
filename – str
- PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.maxXValue()#
- Return type
float
This property holds The maximum X value for the generated surface points..
Defaults to 10.0
.
When setting this property the corresponding minimum value is adjusted if necessary, to ensure that the range remains valid.
- PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.maxXValueChanged(value)#
- Parameters
value – float
- PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.maxYValue()#
- Return type
float
This property holds The maximum Y value for the generated surface points..
Defaults to 10.0
.
When setting this property the corresponding minimum value is adjusted if necessary, to ensure that the range remains valid.
See also
- PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.maxYValueChanged(value)#
- Parameters
value – float
- PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.maxZValue()#
- Return type
float
This property holds The maximum Z value for the generated surface points..
Defaults to 10.0
.
When setting this property the corresponding minimum value is adjusted if necessary, to ensure that the range remains valid.
- PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.maxZValueChanged(value)#
- Parameters
value – float
- PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.minXValue()#
- Return type
float
This property holds The minimum X value for the generated surface points..
Defaults to 0.0
.
When setting this property the corresponding maximum value is adjusted if necessary, to ensure that the range remains valid.
- PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.minXValueChanged(value)#
- Parameters
value – float
- PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.minYValue()#
- Return type
float
This property holds The minimum Y value for the generated surface points..
Defaults to 0.0
.
When setting this property the corresponding maximum value is adjusted if necessary, to ensure that the range remains valid.
See also
- PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.minYValueChanged(value)#
- Parameters
value – float
- PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.minZValue()#
- Return type
float
This property holds The minimum Z value for the generated surface points..
Defaults to 0.0
.
When setting this property the corresponding maximum value is adjusted if necessary, to ensure that the range remains valid.
- PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.minZValueChanged(value)#
- Parameters
value – float
- PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.setAutoScaleY(enabled)#
- Parameters
enabled – bool
This property holds Scale height values to Y-axis..
Defaults to false
.
When this property is set to true
, the height values are scaled to fit on the Y-axis between minYValue
and maxYValue
.
- PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.setHeightMap(image)#
- Parameters
image –
PySide6.QtGui.QImage
This property holds The height map image to be visualized..
- PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.setHeightMapFile(filename)#
- Parameters
filename – str
This property holds The name of the file with a height map image to be visualized..
- PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.setMaxXValue(max)#
- Parameters
max – float
This property holds The maximum X value for the generated surface points..
Defaults to 10.0
.
When setting this property the corresponding minimum value is adjusted if necessary, to ensure that the range remains valid.
- PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.setMaxYValue(max)#
- Parameters
max – float
This property holds The maximum Y value for the generated surface points..
Defaults to 10.0
.
When setting this property the corresponding minimum value is adjusted if necessary, to ensure that the range remains valid.
See also
- PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.setMaxZValue(max)#
- Parameters
max – float
This property holds The maximum Z value for the generated surface points..
Defaults to 10.0
.
When setting this property the corresponding minimum value is adjusted if necessary, to ensure that the range remains valid.
- PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.setMinXValue(min)#
- Parameters
min – float
This property holds The minimum X value for the generated surface points..
Defaults to 0.0
.
When setting this property the corresponding maximum value is adjusted if necessary, to ensure that the range remains valid.
- PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.setMinYValue(min)#
- Parameters
min – float
This property holds The minimum Y value for the generated surface points..
Defaults to 0.0
.
When setting this property the corresponding maximum value is adjusted if necessary, to ensure that the range remains valid.
See also
- PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.setMinZValue(min)#
- Parameters
min – float
This property holds The minimum Z value for the generated surface points..
Defaults to 0.0
.
When setting this property the corresponding maximum value is adjusted if necessary, to ensure that the range remains valid.
- PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.setValueRanges(minX, maxX, minZ, maxZ)#
- Parameters
minX – float
maxX – float
minZ – float
maxZ – float
A convenience function for setting all minimum (minX
and minZ
) and maximum (maxX
and maxZ
) values at the same time. The minimum values must be smaller than the corresponding maximum value. Otherwise the values get adjusted so that they are valid.