maptek.vulcan_gui_options

Provides an interface to the Vulcan Graphical User Interface functionality.

To download all the example scripts on this page, click Python GUI Option Example Scripts.

Note

To use any of the method calls from this class, be sure to import the library at the top of your Python script, like this:

from maptek import vulcan_gui

maptek.vulcan_gui.gui_options(*args, **kwargs)

These are used as a method of validation, not for assigning parameters.

gui_options.display

Types = ('VISIBLE', 'INVISIBLE', 'SHADOW', 'HIGHLIGHT', 'VISIBLE_AND_POINTS', 'SHADOW_AND_POINTS', 'HIGHLIGHT_AND_POINTS', 'MARKERS', 'CONTRAST', 'CONTRAST_AND_POINTS', 'FREEZE')

# Filename: gui_options_display.py
# Purpose: Validation check for option selected.
# Returns: Void.

from maptek import vulcan_gui

sel = vulcan_gui.selection('Select object')
display_mode = 'SHADOW'

assert display_mode in vulcan_gui.gui_options.display, \
      'ValueError: Invalid display mode requested'

prop = vulcan_gui.gui_options.property_values()
print(prop)

gui_options.label

Types = ('OFF', 'POINT_NAME', 'POINT_Z', 'POINT_W', 'POINT_LOCATION', 'POINT_SEQUENCE', 'POINT_SEQUENCE_FIRST_LAST', 'POINT_GRADIENT_ANGLE', 'POINT_GRADIENT_RATIO', 'POINT_GRADIENT_PERCENTAGE', 'OBJECT_VALUE', 'OBJECT_GROUP', 'OBJECT_CLASS', 'OBJECT_NAME_FIRST_CENTER_LAST', 'OBJECT_NAME_FIRST_CENTER', 'OBJECT_NAME_CENTER_LAST', 'OBJECT_NAME_CENTER', 'OBJECT_NAME_FIRST_LAST', 'OBJECT_NAME_FIRST', 'OBJECT_NAME_LAST', 'OBJECT_DYNAMIC', 'OBJECT_DESCRIPTION')

# Filename: gui_options_label.py
# Purpose: Validation check for option selected.
# Returns: Void.

from maptek import vulcan_gui

sel = vulcan_gui.selection('Select object')
label_mode = 'POINT_NAME'

assert label_mode in vulcan_gui.gui_options.label, \
      'ValueError: Invalid label mode requested'

prop = vulcan_gui.gui_options.property_values()
print(prop)

gui_options.layer_load

Types = ('LOAD_IF_EXISTS', 'CLEAR_IF_EXISTS', 'PROMPT_IF_EXISTS', 'PROMPT_IF_NOT_LOADED', 'ACTIVE_IF_EXISTS', 'ACTIVE_PROMPT_IF_NOT_SET', 'PROMPT_NEW_ACTIVE')

# Filename: gui_options_layer.py
# Purpose: Validation check for option selected.
# Returns: Void.

from maptek import vulcan_gui

sel = vulcan_gui.selection('Select object')
layer_load_mode = 'LOAD_IF_EXISTS'

assert layer_load_mode in vulcan_gui.gui_options.layer_load, \
      'ValueError: Invalid layer_load mode requested'

prop = vulcan_gui.gui_options.property_values()
print(prop)

gui_options.selection_type

Types = ('NOTYPE', 'BYLAYER', 'BYOBJECT', 'BYNAME', 'BYGROUP', 'BYFEATURE', 'BYALL')

# Filename: gui_options_selection_type.py
# Purpose: Validation check for option selected.
# Returns: Void.

from maptek import vulcan_gui

sel = vulcan_gui.selection('Select object')
selection_type_mode = 'BYLAYER'

assert selection_type_mode in vulcan_gui.gui_options.selection_type, \
      'ValueError: Invalid selection_type mode requested'

prop = vulcan_gui.gui_options.property_values()
print(prop)

gui_options.selection_criteria

Types = ('ALL', 'LINE', 'POLYGON', 'TEXT', '3DTEXT', 'ARROW', 'DIMENSIONLINE', 'DIMENSIONRADIUS', 'DIMENSIONARC', 'DIMENSIONANGLE', 'IMPLIEDPOLYGON')

# Filename: gui_options_selection_criteria.py
# Purpose: Validation check for option selected.
# Returns: Void.

from maptek import vulcan_gui

sel = vulcan_gui.selection('Select object')
selection_criteria_mode = 'POLYGON'

assert selection_criteria_mode in vulcan_gui.gui_options.selection_criteria, \
      'ValueError: Invalid selection_criteria mode requested'

prop = vulcan_gui.gui_options.property_values()
print(prop)