HeightFieldOverlayFit Option

The HeightFieldOverlayFit option determines how the overlay should be displayed on the Heightfield. The OptionValue is set to 0 or 1. 0 sets the overlay fit to stretch across the entire HeightField. 1 sets the overlay fit to be clipped at the edge of 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(“HeightFieldOverlayFit”, “OptionValue”)

object.Do() or object.DoOnce()

Example

This example changes the HeightField with an overlay to stretch the image appearance.

CommandApi.Construct("ModifyModule")

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

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

CommandApi.Do()

Used by: HeightField