HeightFieldOverlayModulation Option

The HeightFieldOverlayModulation option determines how the overlay should be displayed on the Heightfield. The OptionValue is set to 0 or 1. 0 sets the overlay modulation to show the blended HeightField colormap and image. 1 sets the overlay modulation to show only the heightfield. 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(“HeightFieldOverlayModulation”, “OptionValue”)

object.Do() or object.DoOnce()

Example

This example changes the HeightField with an overlay to blend the image and HeightField colormap.

CommandApi.Construct("ModifyModule")

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

CommandApi.Option("HeightFieldOverlayModulation", "0")

CommandApi.Do()

Used by: HeightField