HeightFieldOverlayShow Option

 

The HeightFieldOverlayShow option turns on the display of the overlay on the Heightfield. The OptionValue is set to True or False.  True turns the display of the overlay on and False turns the display of the overlay off.

 

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(“HeightFieldOverlayShow”, “OptionValue”)

object.Do() or object.DoOnce()

 

Example

This example changes the HeightField to show a connected overlay.

 

  CommandApi.Construct("ModifyModule")

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

  CommandApi.Option("HeightFieldOverlayShow", "True")

  CommandApi.Do()

 

Used by: HeightField

 

 

See Also

Automation Model