QHeightMapSurfaceDataProxy#

Base proxy class for Q3DSurface . More…

Synopsis#

Properties#

autoScaleY - Scale height values to Y-axis
heightMap - Height map image to be visualized
heightMapFile - Name of the file with a height map image to be visualized
maxXValue - Maximum X value for the generated surface points
maxYValue - Maximum Y value for the generated surface points
maxZValue - Maximum Z value for the generated surface points
minXValue - Minimum X value for the generated surface points
minYValue - Minimum Y value for the generated surface points
minZValue - Minimum Z value for the generated surface points

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)

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

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.

See also

QSurfaceDataProxy Qt Data Visualization Data Handling

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

heightMap

Constructs QHeightMapSurfaceDataProxy from the given image filename and parent. Height map is set by calling setHeightMapFile() with filename.

See also

heightMapFile

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property PᅟySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.autoScaleY: 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 .

See also

minYValue maxYValue

Access functions:

autoScaleY ()
setAutoScaleY (enabled)
Signal autoScaleYChanged (enabled)

property PᅟySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.heightMap: PySide6.QtGui.QImage#

This property holds The height map image to be visualized..

Access functions:

heightMap ()
setHeightMap (image)
Signal heightMapChanged (image)

property PᅟySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.heightMapFile: str#

This property holds The name of the file with a height map image to be visualized..

Access functions:

heightMapFile ()
setHeightMapFile (filename)
Signal heightMapFileChanged (filename)

property PᅟySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.maxXValue: 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.

Access functions:

maxXValue ()
setMaxXValue (max)
Signal maxXValueChanged (value)

property PᅟySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.maxYValue: 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

autoScaleY

Access functions:

maxYValue ()
setMaxYValue (max)
Signal maxYValueChanged (value)

property PᅟySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.maxZValue: 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.

Access functions:

maxZValue ()
setMaxZValue (max)
Signal maxZValueChanged (value)

property PᅟySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.minXValue: 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.

Access functions:

minXValue ()
setMinXValue (min)
Signal minXValueChanged (value)

property PᅟySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.minYValue: 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

autoScaleY

Access functions:

minYValue ()
setMinYValue (min)
Signal minYValueChanged (value)

property PᅟySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.minZValue: 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.

Access functions:

minZValue ()
setMinZValue (min)
Signal minZValueChanged (value)

PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.autoScaleY()#

Return type:: bool

See also

setAutoScaleY()

Getter of property autoScaleY .

PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.autoScaleYChanged(enabled)#

Parameters:: enabled – bool

Notification signal of property autoScaleY .

PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.heightMap()#

Return type:: PySide6.QtGui.QImage

See also

setHeightMap()

Getter of property heightMap .

PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.heightMapChanged(image)#

Parameters:: image – PySide6.QtGui.QImage

Notification signal of property heightMap .

PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.heightMapFile()#

Return type:: str

See also

setHeightMapFile()

Getter of property heightMapFile .

PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.heightMapFileChanged(filename)#

Parameters:: filename – str

Notification signal of property heightMapFile .

PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.maxXValue()#

Return type:: float

See also

setMaxXValue()

Getter of property maxXValue .

PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.maxXValueChanged(value)#

Parameters:: value – float

Notification signal of property maxXValue .

PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.maxYValue()#

Return type:: float

See also

setMaxYValue()

Getter of property maxYValue .

PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.maxYValueChanged(value)#

Parameters:: value – float

Notification signal of property maxYValue .

PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.maxZValue()#

Return type:: float

See also

setMaxZValue()

Getter of property maxZValue .

PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.maxZValueChanged(value)#

Parameters:: value – float

Notification signal of property maxZValue .

PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.minXValue()#

Return type:: float

See also

setMinXValue()

Getter of property minXValue .

PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.minXValueChanged(value)#

Parameters:: value – float

Notification signal of property minXValue .

PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.minYValue()#

Return type:: float

See also

setMinYValue()

Getter of property minYValue .

PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.minYValueChanged(value)#

Parameters:: value – float

Notification signal of property minYValue .

PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.minZValue()#

Return type:: float

See also

setMinZValue()

Getter of property minZValue .

PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.minZValueChanged(value)#

Parameters:: value – float

Notification signal of property minZValue .

PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.setAutoScaleY(enabled)#

Parameters:: enabled – bool

See also

autoScaleY()

Setter of property autoScaleY .

PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.setHeightMap(image)#

Parameters:: image – PySide6.QtGui.QImage

Replaces current data with the height map data specified by image.

There are several formats the image can be given in, but if it is not in a directly usable format, a conversion is made.

Note

If the result seems wrong, the automatic conversion failed and you should try converting the image yourself before setting it. Preferred format is Format_RGB32 in grayscale.

The height of the image is read from the red component of the pixels if the image is in grayscale, otherwise it is an average calculated from red, green, and blue components of the pixels. Using grayscale images may improve data conversion speed for large images.

Not recommended formats: all mono formats (for example Format_Mono ).

The height map is resolved asynchronously. arrayReset() is emitted when the data has been resolved.

See also

heightMap()

Setter of property heightMap .

PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.setHeightMapFile(filename)#

Parameters:: filename – str

Replaces current data with height map data from the file specified by filename.

See also

heightMapFile() heightMap

Setter of property heightMapFile .

PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.setMaxXValue(max)#

Parameters:: max – float

See also

maxXValue()

Setter of property maxXValue .

PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.setMaxYValue(max)#

Parameters:: max – float

See also

maxYValue()

Setter of property maxYValue .

PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.setMaxZValue(max)#

Parameters:: max – float

See also

maxZValue()

Setter of property maxZValue .

PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.setMinXValue(min)#

Parameters:: min – float

See also

minXValue()

Setter of property minXValue .

PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.setMinYValue(min)#

Parameters:: min – float

See also

minYValue()

Setter of property minYValue .

PySide6.QtDataVisualization.QHeightMapSurfaceDataProxy.setMinZValue(min)#

Parameters:: min – float

See also

minZValue()

Setter of property minZValue .

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.