Skip to main content

SetPointFeatureDrawStyle

Updated
globalmapper.SetPointFeatureDrawStyle(GM_LayerHandle_t32 aLayer, uint32 aPointIndex, GM_PointStyle_t aPointStyle) → GM_Error_t32

Sets the symbol and font to use for drawing the given point feature. Pass None for the point style to reset the drawing style to the default style for the classification of the point.

Typically, when modifying the drawing style of a point you will want to call GetPointFeature to get the current drawing style, then copy the mPointStyle member of the GM_PointFeature_t and just change what you need, then pass your copy in to this function. You can add new symbols using the AddCustomSymbol function.

There are some custom symbols built in and you can use a string with the following form: ShapeName + “_CUSTOM_” + size_R_G_B.

Example: you if you wanted a red Diamond with a scale of 5 pixels. You would use the string: “DIAMOND_CUSTOM_5_255_0_0”

The built in custom shapes include: DOT, SQUARE, DOT_EMPTY, VERT_BAR, CROSS, DIAG_CROSS, STAR, STAR_EMPTY, TRIANGLE, TRIANGLE_EMPTY, DIAMOND, DIAMOND_EMPTY, SQUARE_EMPTY, HALF_PIE and HALF_PIE_EMPTY.

Parameters:

  • aLayer (GM_LayerHandle_t32) – Layer the point is in

  • aPointIndex (uint32) – Index of point in layer

  • aPointStyle (GM_PointStyle_t) – New style to use for point

Returns:

Error Code

Return type:

GM_Error_t32

Example

The following is an example of SetPointFeatureDrawStyle.

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, "point.shp"),
    gm.GM_LoadFlags_HideAllPrompts,
)

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
point_feature = gm.GetPointFeature(layers_list[0], 0)
point_feature.mPointStyle.mSymbolName = "STAR_CUSTOM_10_255_219_89"
err_SetPointFeatureDrawStyle = gm.SetPointFeatureDrawStyle(
    layers_list[0], 0, point_feature.mPointStyle
)
gm.FreePointFeature(point_feature)

### END SAMPLE

# Resets the changes made in this sample
err_SetPointFeatureDrawStyle1 = gm.SetPointFeatureDrawStyle(layers_list[0], 0, None)

assert (
    gm.GM_Error_None == err_SetPointFeatureDrawStyle
), f"SetPointFeatureDrawStyle: Expected {gm.GM_Error_None}, got {err_SetPointFeatureDrawStyle}"

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

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