Complete Python Module List


maptek.vulcan module
variant isisdb block_model mapio
python_datetime triangulation tri_attributes VGD_grid_cell_t
VGD_grid_t grid dgd layer
obj point polyline text
text3d arrow dimension dim_angle
dim_arc dim_line dim_radius swig_callback
callback attributes metadata section_widths
compare_isis compare_tris compare_grids compare_dgds
compare_blockmodels      
maptek.drillholes
       
collar_scheme desurvey_interval drillhole_database table_information
drillhole drillhole_table interval  
maptek.vulcan_gui module
gui gui_options panel gpan
macro temp_object pick_point selection
run_menu      
maptek.vulcan_gui.gfx module
gui.gfx clip_mode cursor_snap_mode grid_effects
intersection_draw section_settings viewport_effects  

variant

Class to access Vulcan specification files from Variant formats. This implementation behaves like a dictionary with the additional ability to load and save the specfile to the original specification file type.

variant.load()
variant.save()
variant.save_as()

python_datetime

Translation utility class for Maptek DateTime class.

python_datetime.as_datetime()
python_datetime.convert()

isisdb

Interface for Vulcan isis databases.

isisdb.__iter__()
isisdb.append()
isisdb.append_buffer()
isisdb.close()
isisdb.delete_key()
isisdb.delete_record()
isisdb.field_index()
isisdb.field_list()
isisdb.field_list_numbers()
isisdb.field_list_strings()
isisdb.field_size()
isisdb.find_key()
isisdb.get()
isisdb.get_buffer()
isisdb.get_coordinate()
isisdb.get_default()
isisdb.get_default_string()
isisdb.get_field_index()
isisdb.get_key()
isisdb.get_position()
isisdb.get_raw_header()
isisdb.get_raw_layer()
isisdb.get_string()
isisdb.get_subtype()
isisdb.get_table_index()
isisdb.get_table_name()
isisdb.goto_table()
isisdb.has_dsr()
isisdb.insert_after()
isisdb.insert_before()
isisdb.is_field()
isisdb.is_number()
isisdb.is_string()
isisdb.key()
isisdb.key_list()
isisdb.keys
isisdb.next()
isisdb.next_key()
isisdb.next_same_key()
isisdb.open()
isisdb.put()
isisdb.put_string()
isisdb.put_table_name()
isisdb.rewind()
isisdb.set_position()
isisdb.synonym()
isisdb.table_list()
isisdb.this_key
isisdb.this_table()
isisdb.write()

block_model

Interface for Vulcan block models.

block_model.add_block()
block_model.add_variable()
block_model.block_extent()
block_model.close()
block_model.create_irregular()
block_model.create_regular()
block_model.create_strat()
block_model.creation_date()
block_model.delete_variable()
block_model.description()
block_model.field_default()
block_model.field_default_string()
block_model.field_description()
block_model.field_index()
block_model.field_list()
block_model.field_list_numbers()
block_model.field_list_strings()
block_model.field_predefined()
block_model.field_type()
block_model.find_world_xyz()
block_model.find_world_xyz_seam()
block_model.find_xy_seam()
block_model.find_xyz()
block_model.get()
block_model.get_data()
block_model.get_grid()
block_model.get_matches()
block_model.get_matches_extent()
block_model.get_pandas()
block_model.get_pandas_extent()
block_model.get_position()
block_model.get_regular_indices()
block_model.get_string()
block_model.get_translation_values()
block_model.get_variable_index()
block_model.index_model()
block_model.is_field()
block_model.is_indexed()
block_model.is_number()
block_model.is_regular()
block_model.is_string()
block_model.is_tb_model()
block_model.match_extent()
block_model.match_volume()
block_model.model_extent()
block_model.model_n_schemas()
block_model.model_orientation()
block_model.model_origin()
block_model.model_schema_dimensions()
block_model.model_schema_extent()
block_model.model_schema_size()
block_model.modified_date()
block_model.move_block()
block_model.n_blocks()
block_model.next()
block_model.pop_select()
block_model.put()
block_model.put_data()
block_model.put_data_double()
block_model.put_data_float()
block_model.put_data_string()
block_model.put_data_string_list()
block_model.put_grid()
block_model.put_pandas()
block_model.put_string()
block_model.rewind()
block_model.rotate()
block_model.scale()
block_model.select()
block_model.select_xy_seam()
block_model.set_model_orientation()
block_model.set_model_origin()
block_model.set_position()
block_model.to_model()
block_model.to_world()
block_model.translate()
block_model.write()

mapio

Proxy of C++ mapio class.

mapio.__iter__()
mapio.append()
mapio.close()
mapio.field_index()
mapio.field_list()
mapio.field_list_numbers()
mapio.field_list_strings()
mapio.field_size()
mapio.find_key()
mapio.get()
mapio.get_position()
mapio.get_string()
mapio.is_field()
mapio.is_number()
mapio.is_string()
mapio.next()
mapio.next_key()
mapio.open()
mapio.put()
mapio.put_string()
mapio.rewind()
mapio.set_position()
mapio.write()

triangulation

Interface for Vulcan triangulations.

triangulation_class_faces()
trinagulation_class_nodes()
triangulation.add_face()
triangulation.add_node()
triangulation.append_faces()
triangulation.append_vertices()
triangulation.centroid()
triangulation.clean()
triangulation.clear()
triangulation.clear_triangles()
triangulation.close()
triangulation.contour()
triangulation.delete_face()
triangulation.delete_node()
triangulation.extent()
triangulation.extent_pts()
triangulation.face_direction()
triangulation.face_neighborhood()
triangulation.get_colour_index()
triangulation.get_elevation()
triangulation.get_elevations()
triangulation.get_face()
triangulation.get_faces()
triangulation.get_node()
triangulation.get_properties()
triangulation.get_rgb()
triangulation.get_translucency()
triangulation.get_vertices()
triangulation.is_closed()
triangulation.is_consistent()
triangulation.is_crossing()
triangulation.is_ok()
triangulation.is_rgb()
triangulation.load_grid()
triangulation.n_faces()
triangulation.n_nodes()
triangulation.neighbors()
triangulation.node_neighborhood()
triangulation.normalise()
triangulation.point_inside()
triangulation.put_faces()
triangulation.put_vertices()
triangulation.save()
triangulation.scale()
triangulation.segment_intersections()
triangulation.segment_intersections_pt()
triangulation.set_colour()
triangulation.set_colour_index()
triangulation.set_face()
triangulation.set_node()
triangulation.set_properties()
triangulation.set_rgb()
triangulation.set_translucency()
triangulation.shortest_path()
triangulation.solid_from_polygon()
triangulation.surface_area()
triangulation.translate()
triangulation.update_grid()
triangulation.volume()

tri_attributes

Interface for Vulcan triangulation attributes.

tri_attributes.clear()
tri_attributes.delete_key()
tri_attributes.exists()
tri_attributes.get_hash()
tri_attributes.get_keys()
tri_attributes.get_last_error()
tri_attributes.get_string()
tri_attributes.get_type()
tri_attributes.get_types()
tri_attributes.get_values()
tri_attributes.is_ok()
tri_attributes.put()
tri_attributes.save()

VGD_grid_cell_t

Proxy of C++ VGD_grid_cell_t class.

VGD_grid_cell_t.copy()
VGD_grid_cell_t.get_mask()
VGD_grid_cell_t.get_w()
VGD_grid_cell_t.get_w_and_mask()
VGD_grid_cell_t.put_mask()
VGD_grid_cell_t.put_w()
VGD_grid_cell_t.set_mask()
VGD_grid_cell_t.set_w()

VGD_grid_t

Proxy of C++ VGD_grid_t class.

VGD_grid_t.__call__()
VGD_grid_t.basic_stats()
VGD_grid_t.clear()
VGD_grid_t.copy()
VGD_grid_t.get_dx()
VGD_grid_t.get_dy()
VGD_grid_t.get_elevation()
VGD_grid_t.get_elevation_mask()
VGD_grid_t.get_elevation_missing()
VGD_grid_t.get_elevation_missing_mask()
VGD_grid_t.get_grid()
VGD_grid_t.get_grid_mask()
VGD_grid_t.get_grid_x()
VGD_grid_t.get_grid_y()
VGD_grid_t.get_mask()
VGD_grid_t.get_nx()
VGD_grid_t.get_ny()
VGD_grid_t.get_pandas()
VGD_grid_t.get_values()
VGD_grid_t.get_values_mask()
VGD_grid_t.get_w()
VGD_grid_t.get_w_missing()
VGD_grid_t.get_x()
VGD_grid_t.get_x0()
VGD_grid_t.get_x_coordinates()
VGD_grid_t.get_y()
VGD_grid_t.get_y0()
VGD_grid_t.get_y_coordinates()
VGD_grid_t.get_z()
VGD_grid_t.ij_to_pos()
VGD_grid_t.load()
VGD_grid_t.load_esri()
VGD_grid_t.n_data()
VGD_grid_t.ok
VGD_grid_t.pandas
VGD_grid_t.put_grid()
VGD_grid_t.put_grid_mask()
VGD_grid_t.put_mask()
VGD_grid_t.put_pandas()
VGD_grid_t.put_values()
VGD_grid_t.put_values_mask()
VGD_grid_t.put_w()
VGD_grid_t.save()
VGD_grid_t.save_esri_ascii()
VGD_grid_t.set_dx()
VGD_grid_t.set_dy()
VGD_grid_t.set_size()
VGD_grid_t.set_x0()
VGD_grid_t.set_y0()
check_python_auth()
get_spec_type()

grid

Interface for Vulcan grids.

load_spec()
python_authorise()
save_formatted_spec()
save_spec()
shutdown_python_auth()

dgd

Interface for Vulcan design databases.

dgd.append()
dgd.close()
dgd.delete_layer()
dgd.get_layer()
dgd.is_layer()
dgd.is_locked()
dgd.is_open()
dgd.list_layers()
dgd.num_layers()
dgd.save_layer()
dgd.save_layer_as()
dgd.layers
dgd.locked
dgd.open

layer

Interface for Vulcan layers.

layer.append()
layer.clear_objects()
layer.delete_object()
layer.find_object()
layer.get_description()
layer.get_name()
layer.get_object()
layer.get_objects()
layer.get_objects_enumerate()
layer.num_objects()
layer.set_description()
layer.set_name()
layer.set_object()

obj

Base class for shared methods in design object datatypes.

obj.__eq__()
obj.__ne__()
obj.clear()
obj.get_attributes()
obj.get_colour()
obj.get_description()
obj.get_feature()
obj.get_group()
obj.get_layer()
obj.get_link()
obj.get_linkdata()
obj.get_linktype()
obj.get_metadata()
obj.get_name()
obj.get_primitive()
obj.get_section_widths()
obj.get_type()
obj.get_value()
obj.num_links()
obj.object_details()
obj.set_attributes()
obj.set_colour()
obj.set_description()
obj.set_feature()
obj.set_feature_with_file()
obj.set_group()
obj.set_link()
obj.set_linkdata()
obj.set_metadata()
obj.set_name()
obj.set_primitive()
obj.set_section_widths()
obj.set_value()
obj.attributes
obj.colour
obj.description
obj.feature
obj.group
obj.layer
obj.linkdata
obj.metadata
obj.name
obj.section_widths
obj.type
obj.value

point

Interface for Vulcan design points.

point.distance()
point.xyz
point.x
point.y
point.z
point.w
point.t
point.name

polyline

Interface for Vulcan design polylines.

polyline.append()
polyline.center_average()
polyline.centroid()
polyline.change_xyz()
polyline.delete_point()
polyline.filter()
polyline.get_coordinates()
polyline.get_linetype()
polyline.get_pattern()
polyline.is_clockwise()
polyline.is_closed()
polyline.length()
polyline.make_clockwise()
polyline.make_counter_clockwise()
polyline.num_points()
polyline.planar_area()
polyline.point_inside()
polyline.scale()
polyline.set_closed()
polyline.set_connected()
polyline.set_coordinates()
polyline.set_direction()
polyline.set_linetype()
polyline.set_pattern()
polyline.shift()
polyline.clockwise
polyline.closed
polyline.coordinates
polyline.linetype
polyline.pattern

text

Interface for Vulcan design text (2D).

text.append()
text.delete_all_lines()
text.delete_line()
text.get_angle()
text.get_font()
text.get_height()
text.get_line()
text.get_origin()
text.get_scale()
text.get_width()
text.is_framed()
text.num_lines()
text.set_angle()
text.set_font()
text.set_framed()
text.set_height()
text.set_line()
text.set_origin()
text.set_scale()
text.set_width()
text.angle
text.font
text.framed
text.height
text.origin
text.scale
text.width

text3d

Interface for Vulcan design text (3D)

text3d.append()
text3d.delete_all_lines()
text3d.delete_line()
text3d.get_direction()
text3d.get_font()
text3d.get_height()
text3d.get_horizontal_align()
text3d.get_line()
text3d.get_normal()
text3d.get_origin()
text3d.get_scale()
text3d.get_vertical_align()
text3d.get_width()
text3d.is_italic()
text3d.is_mirrored_horizontal()
text3d.is_mirrored_vertical()
text3d.num_lines()
text3d.set_direction()
text3d.set_font()
text3d.set_height()
text3d.set_horizontal_align()
text3d.set_italic()
text3d.set_line()
text3d.set_mirrored_horizontal()
text3d.set_mirrored_vertical()
text3d.set_normal()
text3d.set_origin()
text3d.set_scale()
text3d.set_vertical_align()
text3d.set_width()
text3d.direction
text3d.font
text3d.height
text3d.horizontal_align
text3d.italic
text3d.mirrored_horizontal
text3d.mirrored_vertical
text3d.normal
text3d.origin
text3d.scale
text3d.vertical_align
text3d.width

arrow

Interface for Vulcan design arrows.

arrow.get_arrow_type()
arrow.get_end()
arrow.get_head_length()
arrow.get_head_width()
arrow.get_normal()
arrow.get_num_facets()
arrow.get_relative_head_length()
arrow.get_relative_head_width()
arrow.get_scale()
arrow.get_scaled_head_length()
arrow.get_scaled_head_width()
arrow.get_start()
arrow.is_auto_scale()
arrow.is_filled()
arrow.set_arrow_type()
arrow.set_auto_scale()
arrow.set_end()
arrow.set_filled()
arrow.set_head_length()
arrow.set_head_width()
arrow.set_normal()
arrow.set_num_facets()
arrow.set_relative_head_length()
arrow.set_relative_head_width()
arrow.set_scale()
arrow.set_start()
arrow.arrow_type
arrow.auto_scale
arrow.end
arrow.filled
arrow.head_length
arrow.head_width
arrow.normal
arrow.num_facets
arrow.relative_head_length
arrow.relative_head_width
arrow.scale
arrow.start

dimension

Base class for Vulcan design dimensions.

dimension.get_arrow_length()
dimension.get_arrow_width()
dimension.get_font()
dimension.get_label()
dimension.get_scale()
dimension.get_scale_factor()
dimension.get_scaled_text_height()
dimension.get_text_height()
dimension.get_text_map_size()
dimension.get_tick_extent_size()
dimension.get_tick_gap()
dimension.get_tick_offset()
dimension.is_mirrored_horizontally()
dimension.is_mirrored_vertically()
dimension.set_arrow_length()
dimension.set_arrow_width()
dimension.set_font()
dimension.set_label()
dimension.set_mirrored_horizontally()
dimension.set_mirrored_vertically()
dimension.set_scale()
dimension.set_text_height()
dimension.set_text_map_size()
dimension.set_tick_extent_size()
dimension.set_tick_gap()
dimension.set_tick_offset()
dimension.arrow_length
dimension.arrow_width
dimension.font
dimension.label
dimension.mirrored_horizontally
dimension.mirrored_vertically
dimension.scale
dimension.text_height
dimension.text_map_size
dimension.tick_extent_size
dimension.tick_gap
dimension.tick_offset

dim_angle

Interface for Vulcan design dimension angles.

dim_angle.get_origin()
dim_angle.get_radius()
dim_angle.get_sweep()
dim_angle.set_origin()
dim_angle.set_radius()
dim_angle.set_sweep()
dim_angle.swap_points()
dim_angle.origin
dim_angle.radius
dim_angle.sweep

dim_arc

Interface for Vulcan design dimension arcs.

dim_arc.get_origin()
dim_arc.set_origin()
dim_arc.get_radius()
dim_arc.set_radius()
dim_arc.get_sweep()
dim_arc.set_sweep()
dim_arc.swap_points()
dim_arc.origin
dim_arc.radius
dim_arc.sweep

dim_line

Interface for Vulcan design dimension lines.

dim_line.get_start()
dim_line.set_start()
dim_line.get_end()
dim_line.set_end()
dim_line.midpoint()
dim_line.get_normal()
dim_line.set_normal()
dim_line.swap_points()
dim_line.start
dim_line.end
dim_line.normal

dim_radius

Interface for Vulcan design dimension radii.

dim_radius.get_start()
dim_radius.set_start()
dim_radius.get_end()
dim_radius.set_end()
dim_radius.get_normal()
dim_radius.set_normal()
dim_radius.swap_points()
dim_radius.start
dim_radius.end
dim_radius.normal

swig_callback

C++ underlying callback handler. Use class ‘callback’ to create callbacks.

swig_callback.__call__()

callback

Callback creator for Vulcan utilities. Create a callback and pass it to a function that uses it.

callback.set_callback()
callback.__call__()

attributes

Class for accessing object attribute data.

attributes.as_dict()
attributes.attribute_list()
attributes.from_dict()
attributes.get_attribute()
attributes.get_date_attribute()
attributes.get_template()
attributes.set_attribute()
attributes.set_template()
attributes.template_list()

metadata

Class for manipulating object metadata.

metadata.as_dict()
metadata.field_list()
metadata.from_dict()
metadata.get_timestamp()
metadata.get_value()
metadata.has_field()
metadata.num_fields()
metadata.remove_field()
metadata.set_field()

section_widths

Controls section widths of an object.

section_widths.__str__()
section_widths.enable_section_width()
section_widths.get_back_width()
section_widths.get_cross_sections()
section_widths.get_front_width()
section_widths.set_back_width()
section_widths.set_cross_sections()
section_widths.set_front_width()
section_widths.use_section_width()
section_widths.back_width
section_widths.cross_points
section_widths.cross_sections
section_widths.enable
section_widths.front_width

compare_isis

Proxy of C++ compare_isis class.

compare_isis.add_field_to_test()
compare_isis.clear()
compare_isis.compare()
compare_isis.get_check_design()
compare_isis.get_check_fields()
compare_isis.get_check_fields_tolerance()
compare_isis.get_check_key()
compare_isis.get_check_key_match()
compare_isis.get_number_of_fields_to_test()
compare_isis.get_test_field()
compare_isis.get_test_field_table()
compare_isis.get_verbose_level()
compare_isis.set_check_design()
compare_isis.set_check_fields()
compare_isis.set_check_key()
compare_isis.set_isis()
compare_isis.set_verbose_level()

compare_tris

Proxy of C++ compare_tris class.

compare_tris.clear()
compare_tris.compare()
compare_tris.get_check_extents()
compare_tris.get_check_properties()
compare_tris.get_check_surface_area()
compare_tris.get_check_triangles()
compare_tris.get_check_volume()
compare_tris.get_extents_tolerance()
compare_tris.get_surface_area_tolerance()
compare_tris.get_verbose_level()
compare_tris.get_volume_tolerance()
compare_tris.set_check_extents()
compare_tris.set_check_properties()
compare_tris.set_check_surface_area()
compare_tris.set_check_triangles()
compare_tris.set_check_volume()
compare_tris.set_tris()
compare_tris.set_verbose_level()

compare_grids

Proxy of C++ compare_grids class.

compare_grids.clear()
compare_grids.compare()
compare_grids.get_cell_spacing_tolerance()
compare_grids.get_check_cell_spacing()
compare_grids.get_check_extents()
compare_grids.get_check_mask()
compare_grids.get_check_origin()
compare_grids.get_check_value()
compare_grids.get_extents_tolerance()
compare_grids.get_origin_tolerance()
compare_grids.get_value_tolerance()
compare_grids.get_verbose_level()
compare_grids.set_check_cell_spacing()
compare_grids.set_check_extents()
compare_grids.set_check_mask()
compare_grids.set_check_origin()
compare_grids.set_check_value()
compare_grids.set_grids()
compare_grids.set_verbose_level()

compare_dgds

Proxy of C++ compare_dgds class.

compare_dgds.clear()
compare_dgds.compare()
compare_dgds.get_check_colours()
compare_dgds.get_check_object_description()
compare_dgds.get_check_object_name()
compare_dgds.get_tolerance()
compare_dgds.get_verbose_level()
compare_dgds.set_check_colours()
compare_dgds.set_check_object_description()
compare_dgds.set_check_object_name()
compare_dgds.set_dgds()
compare_dgds.set_tolerance()
compare_dgds.set_verbose_level()

compare_blockmodels

Proxy of C++ compare_blockmodels class.

compare_blockmodels.clear()
compare_blockmodels.compare()
compare_blockmodels.get_check_extent()
compare_blockmodels.get_check_nblocks()
compare_blockmodels.get_check_origin()
compare_blockmodels.get_check_rotation()
compare_blockmodels.get_check_schema()
compare_blockmodels.get_check_variable_list()
compare_blockmodels.get_check_variable_value()
compare_blockmodels.get_extent_tolerance()
compare_blockmodels.get_origin_tolerance()
compare_blockmodels.get_rotation_tolerance()
compare_blockmodels.get_schema_tolerance()
compare_blockmodels.get_specific_check_variable()
compare_blockmodels.get_variable_value_tolerance()
compare_blockmodels.get_verbose_level()
compare_blockmodels.set_blockmodels()
compare_blockmodels.set_check_extent()
compare_blockmodels.set_check_nblocks()
compare_blockmodels.set_check_origin()
compare_blockmodels.set_check_rotation()
compare_blockmodels.set_check_schema()
compare_blockmodels.set_check_variable_list()
compare_blockmodels.set_check_variable_value()
compare_blockmodels.set_specific_variable_check()
compare_blockmodels.set_verbose_level()

maptek.drillholes

An interface to create and edit data within drillhole tables. This includes classes for managing the database itself, the holes within the database, as well as tables, fields and intervals associated with individual drillholes.

collar_scheme

Class containing information about the collar scheme, including the database table name of the collar table, as well as the names of the HoleId, Easting, Northing, Elevation and Total Depth fields.

db_table_name
holeid_field
easting_field
northing_field
elevation_field
total_depth_field

desurvey_interval

Class containing depth, bearing and inclination information for a desurvey measurement.

depth
bearing
inclination

drillhole_database

An interface to create and edit data within drillhole databases.

read()
edit()
create()
is_read_only()
add_drillhole()
delete_drillhole()
drillhole_ids()
get_drillhole()
database_table_names()
list_fields()
interval_table_names()
tables()
add_assay_table()
add_geology_table()
add_analytical_table()
add_text_field_to_table()
add_float_field_to_table()
add_int_field_to_table()
save_drillhole()
def __enter__()
def collar_fields()
def collar_scheme()
def collar_scheme()
def drillhole_count()

table_information

Class representing the mapping of fields to tables in the database.

fields()
name()

drillhole

Class representing a single drillhole object within a database. All drillholes that originate from the same database will have the same tables and fields, but have no restrictions on containing the same intervals.

get_interval_table()
raw_collar()
raw_collar()
point_at_depth()
get_dsr()
total_depth()
total_depth()
interval_count()
set_collar_field()
add_dsr()
add_dsr()
get_collar_field()
get_interval_value()
dsr_entry_count()

drillhole_table

Class representing a table in a drillhole database which contains interval data.

name()
get_interval()
append_interval()
remove_interval()
get_field_values()
intervals()
field_names()
interval_count()

interval

def has_field()
is_field_numeric()
is_field_empty()
set_field()
set_name()
__getitem__()
__setitem__()
get_field()
from_depth()
to_depth()

maptek.vulcan_gui module

This module provides an interface to the Vulcan GUI functionality.

This provides access to:

  • Panels

  • Gpan Panels

  • On screen data

  • Selections

  • Display

  • Macro functions

gui_options

Proxy of C++ gui_options class.

gui_options.display
gui_options.label
gui_options.layer_load
gui_options.selection_type
gui_options.selection_criteria

panel

Interface for building basic Vulcan panels.

panel.begin_block()
panel.begin_indent()
panel.begin_same_line()
panel.checkbox()
panel.colour()
panel.combobox()
panel.display()
panel.editbox()
panel.end_block()
panel.end_indent()
panel.end_same_line()
panel.fileselector()
panel.filterbox()
panel.get_values()
panel.integerbox()
panel.linestyle()
panel.load_spec()
panel.numberbox()
panel.pan_else()
panel.pan_endif()
panel.pan_if()
panel.pattern()
panel.radiobutton()
panel.save_spec()
panel.set_values()
panel.skip_line()
panel.staticline()
panel.statictext()

gpan

Display Vulcan gpan panels.

gpan.display()
gpan.get_values()
gpan.load_spec()
gpan.save_spec()
gpan.set_values()
gpan.values

temp_object

Class for displaying temporary objects in the GUI.

temp_object.remove()
temp_object.set_display_mode()
temp_object.set_label_mode()

pick_point

Pick points inside of Vulcan.

pick_point.pick()
pick_point.get_rubberband
pick_point.set_rubberband
pick_point.get_single_point
pick_point.set_single_point

selection

Class for creating object selections inside of Vulcan.

selection.get_criteria()
selection.get_display_mode()
selection.get_ignore_preselected()
selection.get_object()
selection.get_selection_type()
selection.get_single_object()
selection.num_obj()
selection.pick()
selection.replace()
selection.set_criteria()
selection.set_display_mode()
selection.set_ignore_preselected()
selection.set_selection_type()
selection.set_single_object()
selection.criteria
selection.display_mode
selection.ignore_preselected
selection.selection_type
selection.single_object

run_menu

Class used for running recorded macros.

get_report_window()
set_view()
set_window()
workbench_macro()

macro

Macro class for interacting with Vulcan.

macro.begin_menu_command()
macro.command()
macro.end_menu_command()
macro.panel_results()
macro.point_absolute()
macro.point_relative()
macro.run()
macro.select_by_attr()
macro.select_interactive()
macro.set_view()
macro.set_window()
macro.triangulation()
macro.workbench_macro()

maptek.vulcan_gui.gfx module

This module provides an interface to the Vulcan GUI GFX functionality.

Functionality includes:

  • Window listing/setting

  • View control

  • View feature control

load_window_from_definition()
set_current_window()
view_fit_to_world()
view_pan()
view_reset()
view_reset_and_fit_to_world()
view_rotate_relative()
view_screen_dump()
window_info()
zoom_to_object_list()
zoom_to_selection()

clip_mode

Section clipping modes for section_settings.clip property.

clip_mode.BACKWARDS
clip_mode.BY_WIDTH
clip_mode.FORWARDS
clip_mode.NO_CLIPPING

intersection_draw

Section intersection drawing modes for section_settings.draw property.

intersection_draw.HIGHLIGHT
intersection_draw.NONE
intersection_draw.PATTERN

section_settings

Settings for section display.

move_section_plane()
section_by_plane_equation()
section_by_strike_dip()
section_by_three_points()
section_settings.back_width
section_settings.clip
section_settings.draw
section_settings.front_width
section_settings.reverse_view
section_settings.step
step_section_plane()

cursor_snap_mode

Class to set cursor mode.

cursor_snap_mode.DRAW
cursor_snap_mode.ELEVATION
cursor_snap_mode.GRID
cursor_snap_mode.INDICATE
cursor_snap_mode.OBJECT
cursor_snap_mode.POINT
cursor_snap_mode.SMART
set_cursor_snap_mode()

grid_effects

Struct for the state of grid effects for a window.

get_grid_effects()
set_grid_effects()
grid_effects.annotate
grid_effects.brightness
grid_effects.colour
grid_effects.font_size
grid_effects.label_frequency
grid_effects.label_plane
grid_effects.origin
grid_effects.show
grid_effects.snap_mode
grid_effects.step
grid_effects.type
grid_effects.visible

viewport_effects

Struct for the state of viewport effects for a window.

get_viewport_effects()
set_viewport_effects()
viewport_effects.anti_alias
viewport_effects.daylight_enable
viewport_effects.direction_dials
viewport_effects.draw_object_extents
viewport_effects.mark_end_on_lines
viewport_effects.refresh_timer
viewport_effects.show_annotations