maptek.vulcan_gui module

This module provides an interface to the Vulcan GUI functionality. This allows access to:

  • Panels

  • Gpan Panels

  • On screen data

    • Selections

    • Display

  • Macro functions

class maptek.vulcan_gui.SwigPyIterator(*args, **kwargs)

Bases: object

property thisown

The membership flag

value() → PyObject *
incr(n: size_t = 1) → swig::SwigPyIterator *
decr(n: size_t = 1) → swig::SwigPyIterator *
distance(x: SwigPyIterator) → ptrdiff_t
equal(x: maptek.vulcan_gui.SwigPyIterator) → bool
copy() → swig::SwigPyIterator *
next() → PyObject *
previous() → PyObject *
advance(n: ptrdiff_t) → swig::SwigPyIterator *
class maptek.vulcan_gui.str_list(*args)

Bases: object

property thisown

The membership flag

iterator() → swig::SwigPyIterator *
pop() → std::vector< std::string >::value_type
append(x: std::vector< std::string >::value_type const &) → void
empty() → bool
size() → std::vector< std::string >::size_type
swap(v: str_list) → void
begin() → std::vector< std::string >::iterator
end() → std::vector< std::string >::iterator
rbegin() → std::vector< std::string >::reverse_iterator
rend() → std::vector< std::string >::reverse_iterator
clear() → void
get_allocator() → std::vector< std::string >::allocator_type
pop_back() → void
erase(*args) → std::vector< std::string >::iterator
push_back(x: std::vector< std::string >::value_type const &) → void
front() → std::vector< std::string >::value_type const &
back() → std::vector< std::string >::value_type const &
assign(n: std::vector< std::string >::size_type, x: std::vector< std::string >::value_type const &) → void
resize(*args) → void
insert(*args) → void
reserve(n: std::vector< std::string >::size_type) → void
capacity() → std::vector< std::string >::size_type
class maptek.vulcan_gui.point_list(*args)

Bases: object

property thisown

The membership flag

iterator() → swig::SwigPyIterator *
pop() → std::vector< point >::value_type
append(x: point) → void
empty() → bool
size() → std::vector< point >::size_type
swap(v: point_list) → void
begin() → std::vector< point >::iterator
end() → std::vector< point >::iterator
rbegin() → std::vector< point >::reverse_iterator
rend() → std::vector< point >::reverse_iterator
clear() → void
get_allocator() → std::vector< point >::allocator_type
pop_back() → void
erase(*args) → std::vector< point >::iterator
push_back(x: point) → void
front() → std::vector< point >::value_type const &
back() → std::vector< point >::value_type const &
assign(n: std::vector< point >::size_type, x: point) → void
resize(*args) → void
insert(*args) → void
reserve(n: std::vector< point >::size_type) → void
capacity() → std::vector< point >::size_type
maptek.vulcan_gui.message(msg)
Parameters

  • msg (std::string const &) –

  • a message box in Vulcan. (Displays) –

maptek.vulcan_gui.error(msg)
Parameters

  • msg (std::string const &) –

  • an error message in Vulcan. (Displays) –

maptek.vulcan_gui.start_busy_message(msg, time=- 1)
Parameters

  • msg (std::string const &) –

  • time (int) –

  • a busy message (small non-interactive message) (Starts) –

maptek.vulcan_gui.end_busy_message()

Ends any running busy message.

maptek.vulcan_gui.globals() → MVariant

Access to current data items in Vulcan such as layer list, current dgd, etc.

maptek.vulcan_gui.save()

Issues a save command to Vulcan.

maptek.vulcan_gui.pick_triangulation(prompt) → std::string
Parameters

  • prompt (std::string const &) –

  • a triangulation in Vulcan. (Picks) –

maptek.vulcan_gui.get_layer(layerName) → layer
Parameters

  • layerName (std::string const &) –

  • a layer from Vulcan by name. (Loads) –

maptek.vulcan_gui.add_layer(lyr, loadMethod='LOAD_IF_EXISTS') → bool
Parameters

  • lyr (layer const &) –

  • loadMethod (std::string const &) –

  • a layer to Vulcan. (Adds) –

  • options defined in gui_options.layer_load (Load) –

maptek.vulcan_gui.load_triangulation(file, interactive=False) → bool
Parameters

  • file (std::string const &) –

  • interactive (bool) –

  • triangulation into Vulcan. (Load) –

maptek.vulcan_gui.reload_triangulation(file)
Parameters

  • file (std::string const &) –

  • a triangulation in Vulcan. (Reloads) –

maptek.vulcan_gui.load_triangulations(files) → bool
Parameters

  • files (std::vector< std::string,std::allocator< std::string > > const &) –

  • a list of triangulations into Vulcan. (Load) –

maptek.vulcan_gui.remove_triangulations(files) → bool
Parameters

files (std::vector< std::string,std::allocator< std::string > > const &) –

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

Bases: object

Proxy of C++ gui_options class.

property thisown

The membership flag

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

List of the available GUI display options

label = ('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')

List of the available GUI label options

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

List of the available GUI load options

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

List of the available GUI type options

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

List of the available GUI criteria options

class maptek.vulcan_gui.panel(*args, **kwargs)

Bases: object

Interface for building basic Vulcan panels.

property thisown

The membership flag

begin_block(self, border=False, title='')
Parameters

  • border (bool) –

  • title (std::string const &) –

  • a new area on the panel with optional border and title. (Creates) –

end_block(self)
pan_if(self)

Makes the next element conditional on the previous element.

pan_else(self)
pan_endif(self)
staticline(self)

Line drawn across panel.

begin_indent(self, indent=1)
Parameters

  • indent (int) –

  • or increases indent used for fields. (Sets) –

end_indent(self)
begin_same_line(self)
end_same_line(self)
skip_line(self)
statictext(self, prompt, bold=False)
Parameters

  • prompt (std::string const &) –

  • bold (bool) –

  • placed on the panel. (Text) –

editbox(self, tag, prompt, defaultVal=None, width=None)
Parameters

  • tag (std::string const &) –

  • prompt (std::string const &) –

  • defaultVal (std::string const *) –

  • width (int const *) –

numberbox(self, tag, prompt, defaultVal=None, width=None)
Parameters

  • tag (std::string const &) –

  • prompt (std::string const &) –

  • defaultVal (double const *) –

  • width (int const *) –

integerbox(self, tag, prompt, defaultVal=None, width=None)
Parameters

  • tag (std::string const &) –

  • prompt (std::string const &) –

  • defaultVal (int const *) –

  • width (int const *) –

fileselector(self, tag, prompt, filter, width=None)
Parameters

  • tag (std::string const &) –

  • prompt (std::string const &) –

  • filter (std::string const &) –

  • width (int const *) –

  • with a built in file filter using wildcard matching. (Combobox) –

:param : :type : Example: :param >>> # .bmf would return any files ending in .bmf: :param >>> pan.fileselector(‘file’: :param ‘Select a block model’: :param ‘.bmf’):

combobox(self, tag, prompt, options, width=None)
Parameters

  • tag (std::string const &) –

  • prompt (std::string const &) –

  • options (std::vector< std::string,std::allocator< std::string > > const &) –

  • width (int const *) –

filterbox(self, tag, prompt, filter, width=None)
Parameters

  • tag (std::string const &) –

  • prompt (std::string const &) –

  • filter (std::string const &) –

  • width (int const *) –

  • with a built in filter (Combobox) –

  • gpan filter strings. (using) –

checkbox(self, tag, prompt, checked=False)
Parameters

  • tag (std::string const &) –

  • prompt (std::string const &) –

  • checked (bool) –

radiobutton(self, tag, prompt, initial=False, bank=0)
Parameters

  • tag (std::string const &) –

  • prompt (std::string const &) –

  • initial (bool) –

  • bank (int const) –

  • to pick one of several options. Only one tag per bank will return '1'. (Radiobutton) –

colour(self, tag, prompt, defaultVal=None)
Parameters

  • tag (std::string const &) –

  • prompt (std::string const &) –

  • defaultVal (int *) –

  • for colour using Vulcan colour palette. (Selector) –

linestyle(self, tag, prompt, style=None, thickness=None)
Parameters

  • tag (std::string const &) –

  • prompt (std::string const &) –

  • style (int *) –

  • thickness (int *) –

  • for linestyle using Vulcan linestyles. (Selector) –

  • Returns – list : [line style, line thickness]

pattern(self, tag, prompt, defaultVal=None)
Parameters

  • tag (std::string const &) –

  • prompt (std::string const &) –

  • defaultVal (int *) –

  • for pattern using Vulcan patterns. (Selector) –

display(self, values=None) → bool
Parameters

  • values (MVariant *) –

  • the panel. Stores to optional input dictionary. (Displays) –

get_values(self) → MVariant

Gets the values from the panel (after it has run).

set_values(self, values)
Parameters

  • values (MVariant &) –

  • panel key values with input dictionary values. (Preloads) –

load_spec(self, specName)
Parameters

  • specName (std::string const &) –

  • a specification file into the panel. (Loads) –

save_spec(self, specName)
Parameters

  • specName (std::string const &) –

  • the panel data to a specification file. (Saves) –

property values

Get/Set for panel values (dict)

class maptek.vulcan_gui.gpan(*args)

Bases: object

Display Vulcan gpan panels

property thisown

The membership flag

display(self, cgpFile, panelName, values=None, on_change=None, user_button=None) → std::string
Parameters

  • cgpFile (std::string const &) –

  • panelName (std::string const &) –

  • values (MVariant *) –

  • on_change (swig_callback *) –

  • user_button (swig_callback *) –

  • the specified panel file/name. Stores to optional input dictionary. (Displays) –

  • should be a function name to call (Callbacks) –

  • a dictionary as input and (taking) –

  • a dictionary to the panel. (returning) –

get_values(self) → MVariant

Gets the values from the panel (after it has run).

set_values(self, values)
Parameters

  • values (MVariant &) –

  • panel key values with input dictionary values. (Preloads) –

load_spec(self, specName)
Parameters

  • specName (std::string const &) –

  • a specification file into the panel. (Loads) –

save_spec(self, specName)
Parameters

  • specName (std::string const &) –

  • the panel data to a specification file. (Saves) –

property values

Get/Set for panel values (dict)

class maptek.vulcan_gui.temp_object(object: obj)

Bases: object

Class for displaying temporary objects in the GUI.

property thisown

The membership flag

set_display_mode(self, mode)
Parameters

  • mode (std::string const &) –

  • the display mode for the temporary object (visible (Sets) –

  • shadow –

  • etc) –

  • listed in gui_options.display (Options) –

set_label_mode(self, mode)
Parameters

  • mode (std::string const &) –

  • the label mode for the temporary object. (Sets) –

  • listed in gui_options.label (Options) –

remove(self)

Removes the temporary object from screen.

class maptek.vulcan_gui.pick_point

Bases: object

Pick points inside of Vulcan.

property thisown

The membership flag

set_single_point(self, single=True)
Parameters

single (bool) –

get_single_point(self) → bool
set_rubberband(self, rubberband=True)
Parameters

rubberband (bool) –

get_rubberband(self) → bool
pick(self, firstPrompt, secondPrompt='') → point_list
Parameters

  • firstPrompt (std::string const &) –

  • secondPrompt (std::string const &) –

property rubberband

Get/Set for rubberband.

property single_point

Get/Set for single_point.

class maptek.vulcan_gui.selection(prompt: std::string const &)

Bases: object

Class for creating object selections inside of Vulcan.

property thisown

The membership flag

set_criteria(self, types)
Parameters

  • types (std::vector< std::string,std::allocator< std::string > > const &) –

  • the allowed types to be picked from a list of options. (Sets) –

get_criteria(self) → str_list

Returns the list of allowed selection types.

set_single_object(self, singleObj=True)
Parameters

  • singleObj (bool) –

  • the selection to single object mode. (Sets) –

get_single_object(self) → bool

Returns the single object mode setting.

set_selection_type(self, type)
Parameters

  • type (std::string const &) –

  • the selection type (BY_LAYER (Sets) –

  • BY_GROUP –

  • etc) –

get_selection_type(self) → std::string

Gets the selection type (Default=ALL).

set_display_mode(self, type)
Parameters

  • type (std::string const &) –

  • the display mode of selected data. (Sets) –

get_display_mode(self) → std::string

Gets the display mode of selected data.

set_ignore_preselected(self, ignore=True)
Parameters

  • ignore (bool) –

  • the flag to ignore preselected data. (Sets) –

get_ignore_preselected(self) → bool

Returns the option for allowing preselected data.

pick(self, layername=None, group=None, feature=None)
Parameters

  • layername (std::string const *) –

  • group (std::string const *) –

  • feature (std::string const *) –

get_object(self, index) → VulcanObj
Parameters

  • index (int) –

  • an object from the selection by index. (Gets) –

num_obj(self) → int

Returns the number of objects in the selection.

replace(self, object) → bool
Parameters

  • object (obj &) –

  • an object (If it originated from Vulcan) (Replaces) –

next()
property objects
type_options = ('NOTYPE', 'BYLAYER', 'BYOBJECT', 'BYNAME', 'BYGROUP', 'BYFEATURE', 'BYALL')
criteria_options = ('ALL', 'LINE', 'POLYGON', 'TEXT', '3DTEXT', 'ARROW', 'DIMENSIONLINE', 'DIMENSIONRADIUS', 'DIMENSIONARC', 'DIMENSIONANGLE', 'IMPLIEDPOLYGON')
property criteria

Get/Set for selection criteria

property single_object

Get/Set for single object mode

property selection_type

Get/Set for selection type

property display_mode

Get/Set for selection display mode

property ignore_preselected

Get/Set for ignore preselected

class maptek.vulcan_gui.run_menu(menu_tag, mode, err=None)

Bases: object

maptek.vulcan_gui.get_report_window() → str_list

Gets any messages from the report window that were saved during a macro run.

maptek.vulcan_gui.set_view(title, data) → bool
Parameters

  • title (std::string const &) –

  • data (MVariant const &) –

maptek.vulcan_gui.set_window(title) → bool
Parameters

title (std::string const &) –

maptek.vulcan_gui.workbench_macro(macro_content) → bool
Parameters

macro_content (std::string const &) –

class maptek.vulcan_gui.macro

Bases: object

Macro class for interacting with Vulcan.

property thisown

The membership flag

command(self, cmd)
Parameters

cmd (std::string const &) –

set_view(self, title, data)
Parameters

  • title (std::string const &) –

  • data (MVariant const &) –

set_window(self, title)
Parameters

title (std::string const &) –

panel_results(self, title, pan_data)
Parameters

  • title (std::string const &) –

  • pan_data (MVariant const &) –

select_by_attr(self, layer='*', object='*', group='*', feature='*')
Parameters

  • layer (std::string const &) –

  • object (std::string const &) –

  • group (std::string const &) –

  • feature (std::string const &) –

select_interactive(self, prompt='', do_layer=0, do_name=0, do_group=0, do_feature=0)
Parameters

  • prompt (std::string const &) –

  • do_layer (int) –

  • do_name (int) –

  • do_group (int) –

  • do_feature (int) –

triangulation(name: std::string const &) → void

Interface for Vulcan triangulations.

point_absolute(self, x, y, z)
Parameters

  • x (double) –

  • y (double) –

  • z (double) –

point_relative(self, x, y, z)
Parameters

  • x (double) –

  • y (double) –

  • z (double) –

workbench_macro(self, macro_content)
Parameters

macro_content (std::string const &) –

begin_menu_command(self, menuTag, mismatch)
Parameters

  • menuTag (std::string const &) –

  • mismatch (std::string const &) –

end_menu_command(self)
run(self) → bool