HeightMapSurfaceDataProxy QML Type | Qt Data Visualization | Qt 6.12.0
Description: Base proxy type for Surface3D.
Keywords: qmltype

- Qt 6.12
- Qt Data Visualization
- QML Types
- HeightMapSurfaceDataProxy
- Qt Data Visualization | Commercial or GPLv3

# HeightMapSurfaceDataProxy QML Type

Base proxy type for Surface3D. More...

Import Statement: | `import QtDataVisualization 1.12`
Since: | QtDataVisualization 1.0
In C++: | QHeightMapSurfaceDataProxy
Inherits: | SurfaceDataProxy
Status: | Deprecated

This type is deprecated. We strongly advise against using it in new code.

- List of all members, including inherited members

## Properties

- autoScaleY : real `(since 6.3)`
- heightMapFile : string
- maxXValue : real
- maxYValue : real `(since 6.3)`
- maxZValue : real
- minXValue : real
- minYValue : real `(since 6.3)`
- minZValue : real

## Detailed Description

HeightMapSurfaceDataProxy 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.

For more complete description, see QHeightMapSurfaceDataProxy.

See also Qt Data Visualization Data Handling.

## Property Documentation

### autoScaleY : real `[since 6.3]`

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`.

This property was introduced in Qt 6.3.

### heightMapFile : string

A file with a height map image to be visualized. Setting this property replaces current data with height map data.

There are several formats the image file 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 QImage::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.

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.

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

### maxXValue : real

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.

### maxYValue : real `[since 6.3]`

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.

This property was introduced in Qt 6.3.

### maxZValue : real

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.

### minXValue : real

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.

### minYValue : real `[since 6.3]`

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.

This property was introduced in Qt 6.3.

### minZValue : real

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.