Skip to main content

SetLayerEnabled

Updated
globalmapper.SetLayerEnabled(GM_LayerHandle_t32 aLayer, bool aEnable) → GM_Error_t32

Sets whether or not a given layer is enabled for display. If disabled, the layer will never be drawn or used as input for other translucent or texture-mapped layers.

All layers are enabled by default when initially loaded.

Parameters:

  • aLayer (GM_LayerHandle_t32) – layer to enable or disable

  • aEnable (bool) – enable or disable the layer?

Returns:

Error Code

Return type:

GM_Error_t32

Example

The following is an example of SetLayerEnabled.

import os
import globalmapper as gm

import_dir = "Z:/GM-20069/single_function_sample_data/"
# Close all layers that may be open
layers_are_open = gm.GetLoadedLayerList()
if layers_are_open:
    arr_ptr, arr_size = layers_are_open
    initial_layers = gm.GM_LayerHandle_array_frompointer(arr_ptr)
    for i in range(arr_size):
        gm.CloseLayer(initial_layers[i])

err_LoadLayerList, array_pointer, array_size_param = gm.LoadLayerList(
    os.path.join(import_dir, "Augusta.jpg"),
    gm.GM_LoadFlags_UseDefaultLoadOpts,
)

# Get handle for the loaded layers
arr_ptr, arr_size = gm.GetLoadedLayerList()
layers_array = gm.GM_LayerHandle_array_frompointer(arr_ptr)
layers_list = gm.carray_to_list(layers_array, arr_size)

### START SAMPLE
err_SetLayerEnabled = gm.SetLayerEnabled(layers_list[0], 0)

### END SAMPLE

assert (
    gm.GM_Error_None == err_LoadLayerList
), f"LoadLayerList: Expected {gm.GM_Error_None}, got {err_LoadLayerList}"
assert (
    gm.GM_Error_None == err_SetLayerEnabled
), f"SetLayerEnabled: Expected {gm.GM_Error_None}, got {err_SetLayerEnabled}"

assert os.path.isdir(import_dir), f"Import directory doesn't exist: {import_dir}"

assert os.path.exists(
    os.path.join(import_dir, "Augusta.jpg")
), "Sample data doesn't exist"