HeightFieldOverlayQuality Option

The HeightFieldOverlayQuality option determines how much detail the overlay should show on the Heightfield. The OptionValue is a value between zero and one. 0 sets the overlay quality to the lowest setting. This decreases redraw time, but reduces the quality of the image. 1 sets the overlay quality to the highest setting. This makes the image as crisp as possible, but increases redraw time. Turn on the display of the overlay with the HeightFieldOverlayShow option.

Note that the image needs to be imported and connected to the HeightField in the TargetPort position 1.

Syntax

object.Construct(“CreateModule”)

object.Option(“SourceModule”, “data file name”)

object.Option(“Type”, “HeightField”)

object.Do() or object.DoOnce()

object.Construct(“ConnectModules”)

object.Option(“SourceModule”, “image name”)

object.Option(“TargetModule”, “HeightField”)

object.Option(“TargetPort”, “1”)

object.Do() or object.DoOnce()

object.Construct(“ModifyModule”)

object.Option(“Module”, “HeightField”)

object.Option(“HeightFieldOverlayQuality”, “OptionValue”)

object.Do() or object.DoOnce()

Example

This example changes the HeightField with an overlay to a moderate image quality.

CommandApi.Construct("ModifyModule")

CommandApi.Option("Module","HeightField")

CommandApi.Option("HeightFieldOverlayQuality", "0.5")

CommandApi.Do()

Used by: HeightField