GXMVIEW class

class geosoft.gxapi.GXMVIEW
A view (MVIEW class) has a 2-D/3-D translation matrix, a map
projection and a clip region.  A view contains any number of
"groups", and each "group" contains one or more graphics
elements (entities).  Different types of groups will contain
different types of entities:

Note:

CSYMB groups (colour symbols) contain data and rules for
presenting the data as colour symbols.  See geosoft.gxapi.GXMVIEW.col_symbol()
and the CSYMB class.

AGG groups (aggregates) contain images.  See geosoft.gxapi.GXMVIEW.aggregate()
and the AGG class.

PAGG groups (poly-aggregates) contain images with multiple
frames that make up an animation.  See geosoft.gxapi.GXMVIEW.poly_aggregate()
and the PAGG class.

Standard groups contain symbols, lines, polylines, and polygons.
See geosoft.gxapi.GXMVIEW.start_group().
aggregate((GXAGG)arg1, (str)arg2) → None:
Add an aggregate to a view.
Parameters:
  • arg1 (geosoft.gxapi.GXAGG) – Aggregate
  • arg2 (str) – Aggregate name Maximum length is MVIEW_NAME_LENGTH
Returns:

Nothing
Return type:

None

New in version 5.0.0.

arc((float)arg1, (float)arg2, (float)arg3, (float)arg4, (float)arg5, (float)arg6, (float)arg7) → None:
Draw an arc.
Parameters:
  • arg1 (float) – center x
  • arg2 (float) – center y
  • arg3 (float) – radius
  • arg4 (float) – ratio x/y
  • arg5 (float) – angle
  • arg6 (float) – start angle
  • arg7 (float) – end angle
Returns:

Nothing
Return type:

None

New in version 5.0.0.

axis_x((float)arg1, (float)arg2, (float)arg3, (float)arg4, (float)arg5, (float)arg6) → None:
Draw an X axis
Parameters:
  • arg1 (float) – Y location in view units
  • arg2 (float) – left X
  • arg3 (float) – right X
  • arg4 (float) – major tick interval
  • arg5 (float) – minor tick interval (half size of major)
  • arg6 (float) – tick size in view units (negative for down ticks)
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

All coordinates are in view units.

See also

rOptimumTick_MVIEW

axis_y((float)arg1, (float)arg2, (float)arg3, (float)arg4, (float)arg5, (float)arg6) → None:
Draw a  Y axis
Parameters:
  • arg1 (float) – X location in view units
  • arg2 (float) – bottom Y
  • arg3 (float) – top Y
  • arg4 (float) – major tick interval
  • arg5 (float) – minor tick interval (half size of major)
  • arg6 (float) – tick size in view units (negative for left ticks)
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

All coordinates are in view units.

See also

rOptimumTick_MVIEW

best_fit_window((float_ref)arg1, (float_ref)arg2, (float_ref)arg3, (float_ref)arg4, (float_ref)arg5, (float_ref)arg6, (float_ref)arg7, (float_ref)arg8, (int)arg9) → None:
Fit an area in ground coordinates centered to an area in mm on map or vise versa
keeping X and Y scales the same.
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.1.8.

Note:

X and Y scales will be redefined and units will remain unchanged.
The final X and Y ranges (if changed) are returned.

See also

geosoft.gxapi.GXMVIEW.fit_window()

box_3d((float)arg1, (float)arg2, (float)arg3, (float)arg4, (float)arg5, (float)arg6) → None:
Draw a 3D box
Parameters:
  • arg1 (float) – Min X
  • arg2 (float) – Min Y
  • arg3 (float) – Min Z
  • arg4 (float) – Max X
  • arg5 (float) – Max Y
  • arg6 (float) – Max Z
Returns:

Nothing
Return type:

None

New in version 5.1.6.

Note:

The Fill color is used to color the box.
change_line_message((str)arg1) → None:
Change the specified line in a view.
Parameters:arg1 (str) – Change to this line
Returns:Nothing
Return type:None

New in version 5.0.0.

Note:

The line name can be created by calling LineLabel_DB using
DB_LINE_LABEL_FORMAT_LINK. This insures that the label is
created is the same way as used in the database.
chord((float)arg1, (float)arg2, (float)arg3, (float)arg4, (float)arg5, (float)arg6, (float)arg7) → None:
Draw a filled arc.
Parameters:
  • arg1 (float) – center x
  • arg2 (float) – center y
  • arg3 (float) – radius
  • arg4 (float) – ratio x/y
  • arg5 (float) – angle
  • arg6 (float) – start angle
  • arg7 (float) – end angle
Returns:

Nothing
Return type:

None

New in version 5.0.0.

classified_symbols((GXVV)arg1, (GXVV)arg2, (GXVV)arg3, (float)arg4, (float)arg5, (str)arg6, (str)arg7, (str)arg8) → None:
Plot classified symbols
Parameters:
  • arg1 (geosoft.gxapi.GXVV) – X VV
  • arg2 (geosoft.gxapi.GXVV) – Y VV
  • arg3 (geosoft.gxapi.GXVV) – Data VV
  • arg4 (float) – scale factor to convert mm to view units
  • arg5 (float) – Classified minimum Z to plot
  • arg6 (str) – comma delimited list of Z maximums
  • arg7 (str) – comma delimited list of sizes in mm
  • arg8 (str) – comma delimited list of colour strings
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

For example, to plot three levels <95, 95-100 and
100-120, three string arguments would be:

"95,100,120"      maximums of each class
"2.0,2.5,3.0"     sizes in mm
"y,g,r"           fill colours
clear_esrild_ts() → None:
Clear ESRI local datum transformations currently in use.
Returns:Nothing
Return type:None

New in version 7.1.0.

clip_clear() → None:
Remove/clear the view clip region.
Returns:Nothing
Return type:None

New in version 5.0.0.

clip_groups((int)arg1) → None:
Set the Clipping mode on/off for all groups.
Parameters:arg1 (int) – MVIEW_CLIP constants
Returns:Nothing
Return type:None

New in version 5.0.0.

clip_marked_groups((int)arg1) → None:
Set the Clipping mode on/off for marked groups.
Parameters:arg1 (int) – MVIEW_CLIP constants
Returns:Nothing
Return type:None

New in version 5.0.0.

clip_mode((int)arg1) → None:
Set the view clipping mode on or off.
Parameters:arg1 (int) – MVIEW_CLIP constants
Returns:Nothing
Return type:None

New in version 5.0.0.

Note:

Entitles that follow in this group will be clipped
or not clipped depending on this mode.

The montaj editor cannot change the clip mode of
embedded clipped/unclipped enties that are controlled
by this call.  Use the Group clipping functions
instead.

It is highly recommended that you use the geosoft.gxapi.GXMVIEW.group_clip_mode()
function to control clipping on a group-by-group basis, instead
of using geosoft.gxapi.GXMVIEW.clip_mode() when inside a group, as it is impossible
to determine the  true visible extents of a group. In such cases, the
"zoom to full map extents" command may give incorrect results.
clip_poly((GXVV)arg1, (GXVV)arg2, (int)arg3) → None:
Add a polygon to the clip region.
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

The polygon will be added to the current clip region.
The VV's cannot have any dummy elements.
clip_poly_ex((GXVV)arg1, (GXVV)arg2, (int)arg3, (int)arg4) → None:
Add a polygon to the clip region.
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

The polygon will be added to the current clip region.
The VV's cannot have any dummy elements.
clip_rect((float)arg1, (float)arg2, (float)arg3, (float)arg4, (int)arg5) → None:
Add a rectangle to the clip region.
Parameters:
  • arg1 (float) – X minimum
  • arg2 (float) – Y minimum
  • arg3 (float) – X maximum
  • arg4 (float) – Y maximum
  • arg5 (int) – MVIEW_UNIT constants
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

The rectangle will be added to the current clip region.
clip_rect_ex((float)arg1, (float)arg2, (float)arg3, (float)arg4, (int)arg5, (int)arg6) → None:
Add a rectangle to the clip region.
Parameters:
  • arg1 (float) – X minimum
  • arg2 (float) – Y minimum
  • arg3 (float) – X maximum
  • arg4 (float) – Y maximum
  • arg5 (int) – MVIEW_UNIT constants
  • arg6 (int) – Exclude
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

The rectangle will be added to the current clip region.
col_symbol((str)arg1, (GXCSYMB)arg2) → None:
Add a colored symbol object to a view.
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

static color((str)arg1) → int:
Get a color from a colour string label
Parameters:arg1 (str) – colour name string
Returns:colour int
Return type:int

New in version 5.0.0.

Note:

Colour strings may be "R","G","B","C","M","Y",
"H","S","V", or "K" or a combination of these
characters, each followed by up to three digits
specifying a number between 0 and 255.
An empty string produce C_ANY_NONE.

You must stay in the same colour model, RGB, CMY,
HSV or K.

For example "R", "R127G22", "H255S127V32"

Characters are not case sensitive.

See also

iColorXXX_MVIEW macros

static color2_rgb((int)arg1, (int_ref)arg2, (int_ref)arg3, (int_ref)arg4) → None:
Convert to RGB values.
Parameters:
Returns:

Nothing
Return type:

None

New in version 6.3.0.

Note:

Color component intensities will be in the range 0-255.

See also

geosoft.gxapi.GXMVIEW.color()

static color_cmy((int)arg1, (int)arg2, (int)arg3) → int:
Return CMY color.
Parameters:
  • arg1 (int) – Cyan
  • arg2 (int) – Magenta
  • arg3 (int) – Yellow
Returns:

colour int based on color model.
Return type:

int

New in version 5.0.0.

Note:

Color component intensities must be in the range 0-255.

See also

geosoft.gxapi.GXMVIEW.color()

static color_descr((int)arg1, (str_ref)arg2) → None:
Convert a colour to a colour string label
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

See geosoft.gxapi.GXMVIEW.color().
static color_hsv((int)arg1, (int)arg2, (int)arg3) → int:
Return HSV color.
Parameters:
  • arg1 (int) – Hue
  • arg2 (int) – Saturation
  • arg3 (int) – Color
Returns:

colour int based on color model.
Return type:

int

New in version 5.0.0.

Note:

Color component intensities must be in the range 0-255.

See also

geosoft.gxapi.GXMVIEW.color()

static color_rgb((int)arg1, (int)arg2, (int)arg3) → int:
Return RGB color.
Parameters:
  • arg1 (int) – Red
  • arg2 (int) – Green
  • arg3 (int) – Blue
Returns:

colour int based on color model.
Return type:

int

New in version 5.0.0.

Note:

Color component intensities must be in the range 0-255.

See also

geosoft.gxapi.GXMVIEW.color()

complex_polygon((GXVV)arg1, (GXVV)arg2, (GXVV)arg3) → None:
Draw a polygon with holes in it.
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

You pass a VV with polygon sizes and 2 point vvs.
copy_marked_groups((GXMVIEW)arg1) → None:
Copies all marked groups from one view into another view
Parameters:arg1 (geosoft.gxapi.GXMVIEW) – Destination MVIEW
Returns:Nothing
Return type:None

New in version 5.0.0.

Note:

Projections in source and destination views are used to copy the
entities. Entities are clipped by the destination view's clipping
region.
copy_raw_marked_groups((GXMVIEW)arg1) → None:
Copies all marked groups raw from one view into another
Parameters:arg1 (geosoft.gxapi.GXMVIEW) – Destination MVIEW
Returns:Nothing
Return type:None

New in version 5.1.2.

Note:

The projections, and clipping is completly ignored.
crc_group((str)arg1, (int)arg2) → int:
Compute CRC for a group.
Parameters:
Returns:

CRC
Return type:

int

New in version 5.0.0.

crc_view((int_ref)arg1, (str)arg2) → None:
Generate an XML CRC of a View
Parameters:
Returns:

Nothing
Return type:

None

New in version 6.0.0.

crc_view_group((str)arg1, (int_ref)arg2, (str)arg3) → None:
Generate an XML CRC of a Group
Parameters:
  • arg1 (str) – Name of Group
  • arg2 (geosoft.gxapi.int_ref) – CRC returned
  • arg3 (str) – Name of xml to generate (.zip added)
Returns:

Nothing
Return type:

None

New in version 6.0.0.

static create((GXMAP)arg1, (str)arg2, (int)arg3) → GXMVIEW:
Create MVIEW.
Parameters:
Returns:

MVIEW, aborts if creation fails
Return type:

geosoft.gxapi.GXMVIEW

New in version 5.0.0.

Note:

View scaling is set to mm on the map and the view
origin is set to the map origin.
static create_crooked_section((GXMAP)arg1, (GXIPJ)arg2, (str)arg3, (float)arg4, (float)arg5, (float)arg6, (float)arg7, (float)arg8, (float)arg9, (float)arg10, (float)arg11, (GXVV)arg12, (GXVV)arg13, (GXVV)arg14) → GXMVIEW:
Creates a new crooked section view.
Parameters:
  • arg1 (geosoft.gxapi.GXMAP) – MAP Object
  • arg2 (geosoft.gxapi.GXIPJ) – Geographic projection of input X, Y locations below (without orientation)
  • arg3 (str) – View Name
  • arg4 (float) – Base view bottom left corner X (mm)
  • arg5 (float) – Base view bottom left corner Y (mm)
  • arg6 (float) – Base view size in X (mm)
  • arg7 (float) – Base view size in Y (mm)
  • arg8 (float) – Map horizontal scale (X-axis)
  • arg9 (float) – Vertical exaggeration (1.0 is normal, must be >0.0)
  • arg10 (float) – Starting distance at the left side of the view.
  • arg11 (float) – Elevation at TOP of the view
  • arg12 (geosoft.gxapi.GXVV) – Cumulative distances along the secton
  • arg13 (geosoft.gxapi.GXVV) – True X locations along the section
  • arg14 (geosoft.gxapi.GXVV) – True Y locations along the section
Returns:

MVIEW, aborts if creation fails
Return type:

geosoft.gxapi.GXMVIEW

New in version 7.2.0.

Note:

A crooked section is a section running vertically beneath
a path of (X, Y) locations, like a river. This view supports
linking to other plan, section, or 3D views.
The data view coordinates are set up so that vertical coordinate
corresponds to elevation, and the X coordinate is the distance along
the crooked feature, beginning at zero on the left, but the
status bar will show the true (X, Y, Z) location.

If the scale is set to rDUMMY, then it will be calculated so that
the points will all fit horizontally.
static create_crooked_section_data_profile((GXMAP)arg1, (GXIPJ)arg2, (str)arg3, (float)arg4, (float)arg5, (float)arg6, (float)arg7, (float)arg8, (float)arg9, (float)arg10, (float)arg11, (int)arg12, (GXVV)arg13, (GXVV)arg14, (GXVV)arg15) → GXMVIEW:
Creates a new crooked section data profile view.
Parameters:
  • arg1 (geosoft.gxapi.GXMAP) – MAP Object
  • arg2 (geosoft.gxapi.GXIPJ) – Geographic projection of input X, Y locations below (without orientation)
  • arg3 (str) – View Name
  • arg4 (float) – Base view bottom left corner X (mm)
  • arg5 (float) – Base view bottom left corner Y (mm)
  • arg6 (float) – Base view size in X (mm)
  • arg7 (float) – Base view size in Y (mm)
  • arg8 (float) – Map horizontal scale (X-axis)
  • arg9 (float) – Starting distance at the left side of the view.
  • arg10 (float) – Data value at bottom of the view
  • arg11 (float) – Data value at top of the view
  • arg12 (int) – Make logarithmic Y-axis (0:No, 1:Yes)?
  • arg13 (geosoft.gxapi.GXVV) – Cumulative distances along the secton
  • arg14 (geosoft.gxapi.GXVV) – True X locations along the section
  • arg15 (geosoft.gxapi.GXVV) – True Y locations along the section
Returns:

MVIEW, aborts if creation fails
Return type:

geosoft.gxapi.GXMVIEW

New in version 7.2.0.

Note:

This is the same as geosoft.gxapi.GXMVIEW.create_crooked_section(), except that the
vertical axis plots a data value, not elevation, and allows for
logarithmic scaling.

See Also: geosoft.gxapi.GXMVIEW.create_crooked_section().
create_plane((str)arg1) → int:
Create a 3D Plane for 2D Groups
Parameters:arg1 (str) – Name of Plane
Returns:x - Index of plane
Return type:int

New in version 5.1.2.

cylinder_3d((float)arg1, (float)arg2, (float)arg3, (float)arg4, (float)arg5, (float)arg6, (float)arg7, (float)arg8, (int)arg9) → None:
Draw a 3D cylinder
Parameters:
  • arg1 (float) – Start X
  • arg2 (float) – Start Y
  • arg3 (float) – Start Z
  • arg4 (float) – End X
  • arg5 (float) – End Y
  • arg6 (float) – End Z
  • arg7 (float) – Start Radius (can be zero)
  • arg8 (float) – End Radius (can be zero)
  • arg9 (int) – MVIEW_CYLINDER3D constants
Returns:

Nothing
Return type:

None

New in version 5.1.6.

Note:

The Fill color is used to color the cylinder.
The flags determine if the cylinder is open and what
end are closed. Note that you can create cones by
specifying a 0 radius for one of the ends.
datalinkd((GXDATALINKD)arg1, (str)arg2) → None:
Add a Data Link Display (DATALINKD) object to the view.
Parameters:
Returns:

Nothing
Return type:

None

New in version 6.4.0.

define_plane_3d((float)arg1, (float)arg2, (float)arg3, (float)arg4, (float)arg5, (float)arg6, (float)arg7, (float)arg8, (float)arg9) → None:
Define a 2D drawing plane based on point and normal
Parameters:
  • arg1 (float) – Center point X
  • arg2 (float) – Center point Y
  • arg3 (float) – Center point Z
  • arg4 (float) – X Vector X
  • arg5 (float) – X Vector Y
  • arg6 (float) – X Vector Z
  • arg7 (float) – Y Vector X
  • arg8 (float) – Y Vector Y
  • arg9 (float) – Y Vector Z
Returns:

Nothing
Return type:

None

New in version 5.1.6.

Note:

2D rendering commands are translated to 3D commands
based on the plane.
define_viewer_axis_3d((float)arg1, (float)arg2, (float)arg3, (float)arg4, (float)arg5, (float)arg6) → None:
Define a 2D drawing plane based on the user's view that
oriented around the vector.
Parameters:
  • arg1 (float) – Center point X
  • arg2 (float) – Center point Y
  • arg3 (float) – Center point Z
  • arg4 (float) – Directional Point X
  • arg5 (float) – Directional Point Y
  • arg6 (float) – Directional Point Z
Returns:

Nothing
Return type:

None

New in version 5.1.6.

define_viewer_plane_3d((float)arg1, (float)arg2, (float)arg3) → None:
Define a 2D drawing plane based on the user's view.
Parameters:
  • arg1 (float) – Center point X
  • arg2 (float) – Center point Y
  • arg3 (float) – Center point Z
Returns:

Nothing
Return type:

None

New in version 5.1.6.

Note:

The plane is always facing the viewer. Otherwise the
this is identical to the previous
del_marked_groups() → None:
Delete marked groups.
Returns:Nothing
Return type:None

New in version 5.0.0.

delete_ext_clip_ply((int)arg1) → None:
Deletes an extended clip PLY object used by this view.
Parameters:arg1 (int) – Extended ClipPLY number
Returns:Nothing
Return type:None

New in version 6.0.0.

delete_group((str)arg1) → None:
Delete a group.
Parameters:arg1 (str) – Group name
Returns:Nothing
Return type:None

New in version 5.1.8.

Note:

Does nothing if the group does not already exist.
delete_plane((int)arg1, (int)arg2) → None:
Delete a plane in a view
Parameters:
  • arg1 (int) – plane number to delete
  • arg2 (int) – TRUE to delete all groups on the plane
Returns:

Nothing
Return type:

None

New in version 5.1.2.

Note:

If the groups on the plane are not deleted, they will remain in the
3D view as "New" groups but will be unassigned to a plane.  The
SetAllNewGroupsToPlane  function can be used to assign these groups
to a different plane.
draw_object_3d((int)arg1, (int)arg2, (int)arg3, (int)arg4, (GXVV)arg5, (GXVV)arg6, (GXVV)arg7, (GXVV)arg8, (GXVV)arg9, (GXVV)arg10, (GXVV)arg11, (GXVV)arg12, (GXVV)arg13) → None:
Draw a 3D object optimized for rendering
Parameters:
Returns:

Nothing
Return type:

None

New in version 6.2.0.

draw_surface_3d_ex((str)arg1, (GXVV)arg2, (GXVV)arg3, (GXVV)arg4, (GXVV)arg5, (GXVV)arg6, (GXVV)arg7, (GXVV)arg8, (int)arg9, (GXVV)arg10, (GXVV)arg11, (GXVV)arg12, (GXIPJ)arg13) → None:
Draw a 3D object built from triangles
Parameters:
Returns:

Nothing
Return type:

None

New in version 7.0.0.

Note:

Provide one normal per vertex.
Triangles are defined by indices into the set of vertices.
draw_surface_3d_from_file((str)arg1, (str)arg2) → None:
Draw a 3D object from a surface file
Parameters:
  • arg1 (str) – Group name
  • arg2 (str) – Surface file
Returns:

Nothing
Return type:

None

New in version 7.0.0.

draw_vector_voxel_vectors((GXVOX)arg1, (str)arg2, (GXITR)arg3, (float)arg4, (float)arg5, (float)arg6, (float)arg7, (int)arg8) → None:
Display vectors from a vector voxel in the view.
Parameters:
  • arg1 (geosoft.gxapi.GXVOX) – VOX
  • arg2 (str) – view group name Maximum length is MVIEW_NAME_LENGTH
  • arg3 (geosoft.gxapi.GXITR) – Image transform - must contain zones
  • arg4 (float) – Vector length scale factor - w.r.t. the voxel minimum horizontal cell size (default 1)
  • arg5 (float) – Ratio of the vector cone height to its base (default 4)
  • arg6 (float) – Ratio of maximum base size to minimum horizontal cell size (default 0.25)
  • arg7 (float) – Cutoff value - do not plot vectors with amplitudes less than this value (rDUMMY or 0 to plot all)
  • arg8 (int) – Maximum number of vectors - decimate as required to reduce (iDUMMY to plot all)
Returns:

Each data value in a vector voxel contains X, Y and Z components of a vector. The amplitudes do NOT necessarily correspond to the spatial size of the voxel.
Return type:

None

New in version 7.6.0.

draw_vectors_3d((str)arg1, (GXVV)arg2, (GXVV)arg3, (GXVV)arg4, (GXVV)arg5, (GXVV)arg6, (GXVV)arg7, (GXITR)arg8, (float)arg9, (float)arg10, (float)arg11) → None:
Display vectors in the view.
Parameters:
  • arg1 (str) – view group name Maximum length is MVIEW_NAME_LENGTH
  • arg2 (geosoft.gxapi.GXVV) – X locations
  • arg3 (geosoft.gxapi.GXVV) – Y locations
  • arg4 (geosoft.gxapi.GXVV) – Z locations
  • arg5 (geosoft.gxapi.GXVV) – Vector X component
  • arg6 (geosoft.gxapi.GXVV) – Vector Y component
  • arg7 (geosoft.gxapi.GXVV) – Vector Z component
  • arg8 (geosoft.gxapi.GXITR) – Image transform - must contain zones
  • arg9 (float) – Scale factor for the longest vector in map units / vector units. Vector lengths for the rest of the vectors scale by the square root of the vector amplitudes. This results in the apparent (viewed) area of the vector being proportional to the amplitude.
  • arg10 (float) – Ratio of the vector cone height to its base (default 4)
  • arg11 (float) – Maximum base size in view units. Leave blank (dummy) for no limit. If applied this can make larger vectors skinnier, but does not reduce the length, so they don’t obscure other vectors as much.
Returns:

Plot vectors as cones scaled in area to the maximum amplitude
Return type:

None

New in version 8.0.1.

easy_maker((str)arg1, (str)arg2) → None:
Used for GX makers which use both maps and databases.
Parameters:
  • arg1 (str) – Maker name, used in menu prompt
  • arg2 (str) – INI groups (terminate each with a ”;”)
Returns:

Nothing
Return type:

None

New in version 5.0.0.

ellipse((float)arg1, (float)arg2, (float)arg3, (float)arg4, (float)arg5) → None:
Draw an ellipse
Parameters:
  • arg1 (float) – center x
  • arg2 (float) – center y
  • arg3 (float) – radius
  • arg4 (float) – ratio x/y
  • arg5 (float) – angle
Returns:

Nothing
Return type:

None

New in version 5.0.0.

emf_object((float)arg1, (float)arg2, (float)arg3, (float)arg4, (str)arg5) → None:
Add an EMF file data object to the view.
Parameters:
  • arg1 (float) – Min X
  • arg2 (float) – Min Y
  • arg3 (float) – Max X
  • arg4 (float) – Max Y
  • arg5 (str) – EMF File holding data
Returns:

Nothing
Return type:

None

New in version 6.4.0.

exist_group((str)arg1) → int:
Checks to see if a group exists.
Parameters:arg1 (str) – Group name
Returns:0 - group does not exist. 1 - group exists.
Return type:int

New in version 5.0.0.

ext_clip_ply_list((GXLST)arg1) → None:
Get the names of existing extended clip PLY objects in this view as list.
Parameters:arg1 (geosoft.gxapi.GXLST) – LST
Returns:Nothing
Return type:None

New in version 6.0.0.

extent((int)arg1, (int)arg2, (float_ref)arg3, (float_ref)arg4, (float_ref)arg5, (float_ref)arg6) → None:
Get the view extents
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

The CLIP region is the current view window or the limits
of the current clip polygon.

If MVIEW_EXTENT_ALL is requested and the view has no groups, the
clip extents are returned.

If clip extents are requested and there are no clip extents, an
area 0.0,0.0 1.0,1.0 is returned.

The MVIEW_EXTENT_VISIBLE flag will return the union of the MVIEW_EXTENT_CLIP area and the
extents of all non-masked visible groups in the view.
external_string_object((float)arg1, (float)arg2, (float)arg3, (float)arg4, (str)arg5, (str)arg6, (str)arg7) → None:
Add an external string data object to the view.
Parameters:
  • arg1 (float) – Min X
  • arg2 (float) – Min Y
  • arg3 (float) – Max X
  • arg4 (float) – Max Y
  • arg5 (str) – name of external object
  • arg6 (str) – class of external object
  • arg7 (str) – string data of external object
Returns:

Nothing
Return type:

None

New in version 5.0.0.

fill_color((int)arg1) → None:
Set the fill color.
Parameters:arg1 (int) – color
Returns:Nothing
Return type:None

New in version 5.0.0.

find_group((str)arg1) → int:
Find a Group by name.
Parameters:arg1 (str) – Group name
Returns:Group Number.
Return type:int

New in version 7.2.0.

find_plane((str)arg1) → int:
Find a plane in a view
Parameters:arg1 (str) – name of the plane
Returns:Plane number, -1 if not found
Return type:int

New in version 5.1.2.

fit_map_window_3d((float)arg1, (float)arg2, (float)arg3, (float)arg4, (float)arg5, (float)arg6, (float)arg7, (float)arg8) → None:
Set the 2D view window for a 3D view.
Parameters:
  • arg1 (float) – X minimum (mm) of the area in map relative to map origin
  • arg2 (float) – Y minimum ..
  • arg3 (float) – X maximum ..
  • arg4 (float) – Y maximum ..
  • arg5 (float) – min X in ground coordinate to fit to the area defined above
  • arg6 (float) – min Y in ground coordinate ..
  • arg7 (float) – max X in ground coordinate ..
  • arg8 (float) – max Y in ground coordinate ..
Returns:

Nothing
Return type:

None

New in version 5.1.2.

Note:

3D views are placed in 2D maps within a 2D mapping window
that is analgous to a 2D View.  This allows all 2D functions
(such as changing a view location and size) to treat a 3D
view just like a 2D view.

The geosoft.gxapi.GXMVIEW.fit_map_window_3d() function allows you to
locate and set the "apparent" 2D mapping of a 3D view on
the map. An intial map window is established
as specified on the map, and the view scaling is
established to fit the specified area within that
map area.
fit_window((float)arg1, (float)arg2, (float)arg3, (float)arg4, (float)arg5, (float)arg6, (float)arg7, (float)arg8) → None:
Fit an area in ground coordinates to an area in mm on map.
Parameters:
  • arg1 (float) – X minimum (mm) of the area in map relative to map origin
  • arg2 (float) – Y minimum ..
  • arg3 (float) – X maximum ..
  • arg4 (float) – Y maximum ..
  • arg5 (float) – min X in ground coordinate to fit to the area defined above
  • arg6 (float) – min Y in ground coordinate ..
  • arg7 (float) – max X in ground coordinate ..
  • arg8 (float) – max Y in ground coordinate ..
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

X and Y scales will be redefined and the units will be set to <unknown>.
Coordinate ranges must be greater than 0.0.

See also

geosoft.gxapi.GXMVIEW.set_window()

static font_weight_lst((GXLST)arg1) → None:
Fill a LST with the different font weights.
Parameters:arg1 (geosoft.gxapi.GXLST) – LST object
Returns:Nothing
Return type:None

New in version 5.1.0.

gen_new_group_name((str)arg1, (str_ref)arg2) → None:
Generate the name of a group from a base name that
is new. (always unique and won't overwrite existing
objects).
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.8.

get_3d_group_flags((int)arg1) → int:
Get a 3D geometry group's 3D rendering flags.
Parameters:arg1 (int) – Group number
Returns:Combination of MVIEW_3D_RENDER constants flags or 0
Return type:int

New in version 9.1.0.

get_3d_point_of_view((float_ref)arg1, (float_ref)arg2, (float_ref)arg3, (float_ref)arg4, (float_ref)arg5, (float_ref)arg6) → None:
Get 3D point of view (values are will be rDUMMY if view for 2D views)
Parameters:
Returns:

Nothing
Return type:

None

New in version 9.2.0.

get_agg_file_names((str)arg1, (GXVV)arg2) → None:
Get the names of grid files stored in an AGG.
Parameters:
  • arg1 (str) – group name
  • arg2 (geosoft.gxapi.GXVV) – returned string VV of type -STR_FILE
Returns:

Nothing
Return type:

None

New in version 5.1.5.

Note:

The group must be an AGG group. Check this using
geosoft.gxapi.GXMVIEW.is_group()(View, sGroup, MVIEW_IS_AGG).
get_aggregate((int)arg1) → GXAGG:
Get an existing Aggregate object from the view.
Parameters:arg1 (int) – group number
Returns:AGG object
Return type:geosoft.gxapi.GXAGG

New in version 9.2.0.

Note:

This method returns a cached object owned by the MVIEW and will be destroyed automatically when the MVIEW is disposed
get_class_name((str)arg1, (str_ref)arg2) → None:
Get a class name.
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.1.2.

Note:

MVIEW class names are intended to be used to record the
names of certain classes in the view, such as "Plane"
for the default drawing plane.
get_clip_ply((GXPLY)arg1) → None:
Get clipping polygons, in the user projection
Parameters:arg1 (geosoft.gxapi.GXPLY) – Poly
Returns:Nothing
Return type:None

New in version 5.0.0.

Note:

The returned PLY is recast into the User projection.
For oriented views (especially sections), use
geosoft.gxapi.GXMVIEW.get_ply(), which returns the Clip PLY in the view's native
projection (e.g. the one set using geosoft.gxapi.GXMVIEW.set_ipj()).
get_col_symbol((int)arg1) → GXCSYMB:
Get an existing colored symbol object from the view.
Parameters:arg1 (int) – group number
Returns:CSYMB object
Return type:geosoft.gxapi.GXCSYMB

New in version 9.2.0.

Note:

This method returns a cached object owned by the MVIEW and will be destroyed automatically when the MVIEW is disposed
get_datalinkd((int)arg1) → GXDATALINKD:
Get an existing Data Link Display (DATALINKD) object from the view.
Parameters:arg1 (int) – group number
Returns:DATALINKD object
Return type:geosoft.gxapi.GXDATALINKD

New in version 9.2.0.

Note:

This method returns a cached object owned by the MVIEW and will be destroyed automatically when the MVIEW is disposed
get_def_plane((str_ref)arg1) → None:
Get the default drawing plane.
Parameters:arg1 (geosoft.gxapi.str_ref) – name
Returns:Nothing
Return type:None

New in version 5.1.2.

Note:

2D drawing to a 3D View will always be placed on the
default drawing plane.  If no default drawing plane
has been set, the first valid plane in the view is
used as the default drawing plane.
get_ext_clip_ply((int)arg1, (GXPLY)arg2) → None:
Get an extended clip PLY object used by this view.
Parameters:
Returns:

Nothing
Return type:

None

New in version 6.0.0.

get_group_ext_clip_ply((str)arg1, (int_ref)arg2) → None:
Gets extended clip information for group in view.
Parameters:
  • arg1 (str) – Group Name
  • arg2 (geosoft.gxapi.int_ref) – Extended PLY number (returned, -1 if not set)
Returns:

Nothing
Return type:

None

New in version 6.0.0.

get_group_extent((str)arg1, (float_ref)arg2, (float_ref)arg3, (float_ref)arg4, (float_ref)arg5, (int)arg6) → None:
Get extent of a group in a view
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

get_group_freeze_scale((int)arg1, (float_ref)arg2) → None:
Get a scale freezing value for the group (rDUMMY for disabled).
Parameters:
Returns:

Nothing
Return type:

None

New in version 7.2.0.

get_group_transparency((str)arg1, (float_ref)arg2) → None:
Gets the transparency value of group
Parameters:
Returns:

Nothing
Return type:

None

New in version 6.0.0.

get_ipj((GXIPJ)arg1) → None:
Get the projection of the view.
Parameters:arg1 (geosoft.gxapi.GXIPJ) – IPJ in which to place the view IPJ
Returns:Nothing
Return type:None

New in version 5.0.0.

get_map() → GXMAP:
Get the MAP of the view.
Returns:The MAP of the View.
Return type:geosoft.gxapi.GXMAP

New in version 7.2.0.

get_map_scale() → float:
Get the current map scale of the view
Returns:The current map scale to 6 significant digits
Return type:float

New in version 5.0.0.

get_meta((str)arg1, (str_ref)arg2) → GXMETA:
Retrieves Metadata from a group
Parameters:
Returns:

META Object
Return type:

geosoft.gxapi.GXMETA

New in version 5.1.6.

get_name((str_ref)arg1) → None:
Gets the name of a view.
Parameters:arg1 (geosoft.gxapi.str_ref) – view name returned
Returns:Nothing
Return type:None

New in version 5.0.0.

get_name_ext_clip_ply((int)arg1, (str_ref)arg2) → None:
Get the name of the extended clip PLY object in this view.
Parameters:
Returns:

Nothing
Return type:

None

New in version 6.0.0.

get_plane_clip_ply((int)arg1, (GXPLY)arg2) → None:
Get the Plane Clip Region
Parameters:
Returns:

Nothing
Return type:

None

New in version 6.0.0.

Note:

By default it is the View's Clip Region
get_plane_equation((int)arg1, (float_ref)arg2, (float_ref)arg3, (float_ref)arg4, (float_ref)arg5, (float_ref)arg6, (float_ref)arg7, (float_ref)arg8, (float_ref)arg9, (float_ref)arg10) → None:
Get the equation of a plane
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.1.2.

get_ply((GXPLY)arg1) → None:
Get clipping polygons, in the base projection
Parameters:arg1 (geosoft.gxapi.GXPLY) – Poly
Returns:Nothing
Return type:None

New in version 6.0.0.

Note:

This should be used to get the clipping polygon for
oriented views (especially sections).
get_reg() → GXREG:
Get the REG of the view.
Returns:The REG of the View.
Return type:geosoft.gxapi.GXREG

New in version 5.0.5.

get_user_ipj((GXIPJ)arg1) → None:
Get the user projection of the view.
Parameters:arg1 (geosoft.gxapi.GXIPJ) – IPJ in which to place the view IPJ
Returns:Nothing
Return type:None

New in version 5.0.0.

get_view_plane_equation((float_ref)arg1, (float_ref)arg2, (float_ref)arg3, (float_ref)arg4, (float_ref)arg5, (float_ref)arg6, (float_ref)arg7, (float_ref)arg8, (float_ref)arg9) → None:
Get the View's Plane Equation
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.1.2.

get_voxd((int)arg1) → GXVOXD:
Get an existing VOXD object from the view.
Parameters:arg1 (int) – group number
Returns:VOXD object
Return type:geosoft.gxapi.GXVOXD

New in version 8.2.0.

Note:

This method returns a cached object owned by the MVIEW and will be destroyed automatically when the MVIEW is disposed
grid((float)arg1, (float)arg2, (float)arg3, (float)arg4, (int)arg5) → None:
Draw a grid in the current window
Parameters:
  • arg1 (float) – X grid increment
  • arg2 (float) – Y grid increment
  • arg3 (float) – dX dot increment/cross X size
  • arg4 (float) – dY dot increment/cross Y size
  • arg5 (int) – MVIEW_GRID constants
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

The grid will be drawn in the current window specified
by the last SetWindow call.

See also

geosoft.gxapi.GXMVIEW.axis_x(), geosoft.gxapi.GXMVIEW.axis_y(), geosoft.gxapi.GXMVIEW.optimum_tick()

group_clip_mode((int)arg1) → None:
Set the Clipping mode on or off for new groups.
Parameters:arg1 (int) – MVIEW_CLIP constants
Returns:Nothing
Return type:None

New in version 5.0.0.

Note:

All new groups will be clipped.
group_name((int)arg1, (str_ref)arg2) → None:
Get a group name
Parameters:
Returns:

Nothing
Return type:

None

New in version 7.2.0.

group_to_ply((str)arg1, (GXPLY)arg2) → None:
Save all polygons in group into PLY obj.
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

The coordinates will be in the working coordinate system
of the view.  The SetWorkingIPJ_MVIEW method can be used
to change the working coordinate system. This function will
return an empty PLY if the group is hidden.
hide_marked_groups((int)arg1) → None:
Hide/Show marked groups.
Parameters:arg1 (int) – MVIEW_HIDE constants
Returns:Nothing
Return type:None

New in version 5.0.0.

hide_shadow2_d_interpretations((int)arg1) → None:
Hide/Show 2d shadow interpretations.
Parameters:arg1 (int) – MVIEW_HIDE constants
Returns:Nothing
Return type:None

New in version 8.5.0.

is_group((str)arg1, (int)arg2) → int:
Query a status or characteristic of a group
Parameters:
Returns:

TRUE or FALSE (1 or 0)
Return type:

int

New in version 5.0.5.

is_group_empty((str)arg1) → int:
Is the group empty?
Parameters:arg1 (str) – group name
Returns:TRUE or FALSE (1 or 0)
Return type:int

New in version 6.3.0.

is_movable() → bool:
Is this view movable?
Returns:bool
Return type:bool

New in version 6.4.0.

Note:

Views are always physically movable in the API, this
flag is for preventing accidental moving in the GUI.
By default views are not movable.
is_null() → bool

Check if the instance of geosoft.gxapi.GXMVIEW is null (undefined)

Returns:True if this is a null instance of geosoft.gxapi.GXMVIEW, False otherwise.
Return type:bool`
is_projection_empty() → int:
Returns 1 if the view projection and view user projection are both empty (undefined).
Returns:1 if the view projection and view user projection are both empty.
Return type:int

New in version 9.0.0.

Note:

Use, for instance, to see if the map view contains projection information. The first time you add data that
                             has projection information you should set up an empty view projection so that subsequent data added with a different
                        projection is properly displayed in relation to the initial data.
is_section() → int:
Is the view a section view?
Returns:TRUE if view is a section view.
Return type:int

New in version 8.2.0.

Note:

Section views are recognized because their projection contains one of the following orientations:

IPJ_ORIENT_SECTION - Target-type sections with Z projection horizontally
IPJ_ORIENT_SECTION_NORMAL - Like IPJ_ORIENT_SECTION, but Z projects
perpendicular to the secton plane.
IPJ_ORIENT_SECTION_CROOKED - Crooked sections
IPJ_ORIENT_3D - Some Sections extracted from a voxel - e.g. VoxelToGrids,
as the voxel can have any orientation in 3D.
is_view_3d() → int:
Is the view 3D?
Returns:TRUE if view is 3D
Return type:int

New in version 5.1.2.

is_visible() → bool:
Is this view visible?
Returns:bool
Return type:bool

New in version 6.3.0.

label_fid((GXVV)arg1, (float)arg2, (float)arg3, (float)arg4, (float)arg5, (float)arg6) → None:
Label fiducials on a profile
Parameters:
  • arg1 (geosoft.gxapi.GXVV) – X VV
  • arg2 (float) – fiducial start
  • arg3 (float) – fiducial increment
  • arg4 (float) – fiducial label interval, default 100.0
  • arg5 (float) – Y location in view unit
  • arg6 (float) – Y scale
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

A 1mm long vertical tick is drawn at the place
where a label is present. The label is drawn
below the tick.

The incoming X VV is used to define the place for
label.
label_x((float)arg1, (float)arg2, (float)arg3, (float)arg4, (int)arg5, (int)arg6, (int)arg7) → None:
Label annotations on the X axis
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

Label bounding will justify edge labels to be inside
the bar limits. But bounding does not apply if
labels are drawn vertically (top right or top left)

See also

geosoft.gxapi.GXMVIEW.axis_x(), geosoft.gxapi.GXMVIEW.axis_y(), geosoft.gxapi.GXMVIEW.optimum_tick()

label_y((float)arg1, (float)arg2, (float)arg3, (float)arg4, (int)arg5, (int)arg6, (int)arg7) → None:
Label annotations on the Y axis
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

Label bounding will justify edge labels to be inside
the bar limits. But bounding does not apply if
labels are drawn vertically (top right or top left)

See also

geosoft.gxapi.GXMVIEW.axis_x(), geosoft.gxapi.GXMVIEW.axis_y(), geosoft.gxapi.GXMVIEW.optimum_tick()

line((float)arg1, (float)arg2, (float)arg3, (float)arg4) → None:
Draw a line.
Parameters:
  • arg1 (float) – x0
  • arg2 (float) – y0
  • arg3 (float) – x1
  • arg4 (float) – y1
Returns:

Nothing
Return type:

None

New in version 5.0.0.

line_color((int)arg1) → None:
Set the line color.
Parameters:arg1 (int) – Color
Returns:Nothing
Return type:None

New in version 5.0.0.

line_smooth((int)arg1) → None:
Set the line edge smoothing.
Parameters:arg1 (int) – MVIEW_SMOOTH constants
Returns:Nothing
Return type:None

New in version 6.3.0.

line_style((int)arg1, (float)arg2) → None:
Set the style of a line.
Parameters:
  • arg1 (int) – Line Style #, see default.lpt
  • arg2 (float) – Pitch in view units
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

Line styles are selected by ordinal value (line style #)
from those defined in default.lpt.  If default.lpt does
not have a the style specified, the file user.lpt is
searched.  If this file does not contain the line style
solid is assumed.

Note that line styles from default.lpt and user.lpt are
read into the map at the time the map is created, not
at display time.
line_thick((float)arg1) → None:
Set the line thickness.
Parameters:arg1 (float) – line thickness in view space units
Returns:Nothing
Return type:None

New in version 5.0.0.

line_vv((GXVV)arg1) → None:
Draw line segments stored in a GS_D2LINE VV.
Parameters:arg1 (geosoft.gxapi.GXVV) – VV for GS_D2LINE
Returns:Nothing
Return type:None

New in version 5.0.0.

Make a link to a database.
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

list_groups((GXLST)arg1, (int)arg2) → int:
Get a list of the groups in a view.
Parameters:
Returns:

Number of groups in the list
Return type:

int

New in version 5.0.0.

list_plane_groups((int)arg1, (GXLST)arg2) → None:
List all groups in a specific plane of a 3D view
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.1.2.

Note:

The group names are placed in the list names, group
numbers are placed in the list values.

Groups are added to the end of the LST.
list_planes((GXLST)arg1) → None:
List all planes in a 3D view
Parameters:arg1 (geosoft.gxapi.GXLST) – List of plane names and numbers
Returns:Nothing
Return type:None

New in version 5.1.2.

Note:

The plane names are placed in the list names, plane
numbers are placed in the list values.

Planes are added to the end of the LST.
maker((int)arg1, (int)arg2, (str)arg3, (int)arg4, (str)arg5, (str)arg6) → None:
Generates a Maker for the database and/or map.
Parameters:
  • arg1 (int) – Database required? (0 = No, 1 = Yes)
  • arg2 (int) – Map required? (0 = No, 1 = Yes)
  • arg3 (str) – Program name
  • arg4 (int) – MAKER constants
  • arg5 (str) – Maker name, used in menu prompt
  • arg6 (str) – INI groups (terminate each with a ”;”)
Returns:

Nothing
Return type:

None

New in version 5.0.0.

map_origin((float_ref)arg1, (float_ref)arg2) → None:
Get the map origin from a view
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

mark_all_groups((int)arg1) → None:
Mark or unmark all groups.
Parameters:arg1 (int) – 0 - unmark, 1 - mark
Returns:Nothing
Return type:None

New in version 5.0.0.

mark_empty_groups((int)arg1) → None:
Mark/unmark all empty groups.
Parameters:arg1 (int) – 0 - unmark, 1 - mark
Returns:Nothing
Return type:None

New in version 6.3.0.

mark_group((str)arg1, (int)arg2) → None:
Mark or unmark a specific group
Parameters:
  • arg1 (str) – group name
  • arg2 (int) – 0 - unmark, 1 - mark
Returns:

Nothing
Return type:

None

New in version 5.0.0.

measure_text((str)arg1, (float_ref)arg2, (float_ref)arg3, (float_ref)arg4, (float_ref)arg5) → None:
Compute the bounding rectangle in view units of the text using the current attributes.
Parameters:
Returns:

Nothing
Return type:

None

New in version 6.0.0.

Note:

Area will be 0 if error occured (does not fail).
This will return the bounding rectangle as if the text was placed at 0,0 and adjusted according to
the current text alignment and angle set for the view. Also see notes for geosoft.gxapi.GXMVIEW.text_size().
meta((GXMETA)arg1, (str)arg2) → None:
Store Metadata in a group
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.1.3.

mode_pj((int)arg1) → None:
Set the working projection mode
Parameters:arg1 (int) – MVIEW_PJ constants
Returns:Nothing
Return type:None

New in version 5.0.0.

Note:

This controls how your coordinates and attributes will be interpreted.
A working projection must be set useing SetWorkingIPJ_MVIEW for this
method to have any effect.

See also

SetWorkingIPJ

move_group_backward((str)arg1) → None:
Move the group backward one position (render sooner).
Parameters:arg1 (str) – Group name
Returns:Nothing
Return type:None

New in version 5.1.1.

move_group_forward((str)arg1) → None:
Move the group forward one position (render later).
Parameters:arg1 (str) – Group name
Returns:Nothing
Return type:None

New in version 5.1.1.

move_group_to_back((str)arg1) → None:
Move the group to the back (render first).
Parameters:arg1 (str) – Group name
Returns:Nothing
Return type:None

New in version 5.1.1.

move_group_to_front((str)arg1) → None:
Move the group to the front (render last).
Parameters:arg1 (str) – Group name
Returns:Nothing
Return type:None

New in version 5.1.1.

north() → float:
Returns North direction at center of view.
Returns:North direction id deg. azimuth relative to view Y.
Return type:float

New in version 5.0.0.

Note:

North is calculated from the IPJ North direction.
It will be rDUMMY if IPJ is unknown.
static null() → GXMVIEW

A null (undefined) instance of geosoft.gxapi.GXMVIEW

Returns:A null geosoft.gxapi.GXMVIEW
Return type:geosoft.gxapi.GXMVIEW
num_ext_clip_ply() → int:
Get the number of extended clip PLY objects in this view.
Returns:Number of PLYs
Return type:int

New in version 6.0.0.

static optimum_tick((float)arg1, (float)arg2, (float_ref)arg3) → None:
Return a default optimum tick interval
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

pat_angle((float)arg1) → None:
Sets the pattern angle
Parameters:arg1 (float) – Angle
Returns:Nothing
Return type:None

New in version 5.0.0.

Note:

Allows the user to apply a rotation to the basic
pattern. Care should be taken to ensure that the
tiling remains continuous; i.e. if the pattern
consists of horizontal lines, only angles of
-90, 0, 90, 180 (etc.) would give seamless tiling.
However, simple, closed figure, such as a star,
could be given any angle.
Rotations about the center point (0.5, 0.5) of the
unit cell are performed prior to applying PatSize.
The default value is 0.0.
Setting an angle of -999 inititates the random angle
feature, and each pattern tile is rotated to a different
angle. Using this along with PatStyle(View, MVIEW_TILE_RANDOM)
can give a "hand-drawn" effect to geological fills.

See the IMPORTANT note for sPatNumber_MVIEW().
pat_density((float)arg1) → None:
Sets the tiling density.
Parameters:arg1 (float) – Relative density (default = 1).
Returns:Nothing
Return type:None

New in version 5.0.0.

Note:

This number is the ratio between the plotted unit cell size and the
distance between the plotted tile centers. The default value is 1.
A value larger than 1 increases the density of the pattern, while
values less than 1 make the pattern more "spread out".
This can be used along with sPatStyleMethod to create more complicated
fills from simple patterns.

See the IMPORTANT note for sPatNumber_MVIEW().
pat_number((int)arg1) → None:
Sets the pattern number
Parameters:arg1 (int) – Pattern number
Returns:Nothing
Return type:None

New in version 5.0.0.

Note:

Pattern 0 is solid fill.(default)
Set the pattern colour using geosoft.gxapi.GXMVIEW.fill_color().

Patterns are selected by ordinal value (pattern number)
from those defined in default.pat.  If default.pat does
not have a the pattern specified, the file user.pat is
searched.  If this file does not contain the pattern
solid is assumed.

Note that patterns from default.pat and user.pat are
read into the map at the time the map is created, not
at display time.

IMPORTANT: A call to this function resets all the various
pattern attributes to those defined for the selected pattern.
If you want to modify any attributes, call that function (e.g.
sPatSize_MVIEW(), AFTER you call sPatNumber_MVIEW().
pat_size((float)arg1) → None:
Sets the pattern unit cell size (X)
Parameters:arg1 (float) – Pattern size in view units
Returns:Nothing
Return type:None

New in version 5.0.0.

Note:

See the IMPORTANT note for sPatNumber_MVIEW().
pat_style((int)arg1) → None:
Sets the tiling method (i.e. rectangle, triangle)
Parameters:arg1 (int) – MVIEW_TILE constants
Returns:Nothing
Return type:None

New in version 5.0.0.

Note:

Normally, the unit cell is duplicated across the fill area
like floor tiles (MVIEW_TILE_RECTANGULAR).
DIAGONAL tiling rotates the tiling positions (but not the tiles)
by 45 degrees.
TRIANGULAR tiling
Offsets each succeeding row by half the unit cell size, and
lessens the vertical offset, so that the unit cell centers
form a triangular grid pattern.
RANDOM tiling adds small random offsets in both directions to give
the diffuse effect seen on many geological maps.

NOTE: Some patterns are designed to be interlocking and may only
work "correctly" with one tiling method.

See the IMPORTANT note for sPatNumber_MVIEW().
pat_thick((float)arg1) → None:
Sets the pattern line thickness
Parameters:arg1 (float) – Line thickness as fraction of pattern size (ie. 0.05)
Returns:Nothing
Return type:None

New in version 5.0.0.

Note:

See the IMPORTANT note for sPatNumber_MVIEW().
plot_to_view((float_ref)arg1, (float_ref)arg2) → None:
Convert a plot coordinate in mm to a VIEW coordinate.
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

point_3d((float)arg1, (float)arg2, (float)arg3) → None:
Draw a 3D point.
Parameters:
  • arg1 (float) – X
  • arg2 (float) – Y
  • arg3 (float) – Z
Returns:

Nothing
Return type:

None

New in version 5.1.6.

Note:

The Line color and line thickness will affect rendering.
poly_line((int)arg1, (GXVV)arg2, (GXVV)arg3) → None:
Draw a polyline or polygon (dummies deleted).
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

Dummies in X and/or Y VV are deleted and it results
in 'solid' line. Using geosoft.gxapi.GXMVIEW.poly_line_dm() (below) function
if gaps from dummies are to be kept.
poly_line_3d((GXVV)arg1, (GXVV)arg2, (GXVV)arg3) → None:
Draw a 3D polyline.
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.1.6.

Note:

Dummies are not allowed in the line.
Line Color, Thickness is supported on rendering
poly_line_dm((GXVV)arg1, (GXVV)arg2) → None:
Draw a polyline with gaps defined by dummies in X/Y VVs
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

poly_wrap((GXVV)arg1, (GXVV)arg2) → None:
Draw wrapped polylines from X and Y VV's.
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

Convert a given VVy into a wrapped VVy using
the current view window as the wrap region.
Then draw polylines from it.

See also

geosoft.gxapi.GXMVIEW.poly_line()

polygon_dm((GXVV)arg1, (GXVV)arg2) → None:
Like PolyLineDm, but draw polygons.
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.6.

polygon_ply((GXPLY)arg1) → None:
Draw a complex polygon from PLY.
Parameters:arg1 (geosoft.gxapi.GXPLY) – PLY
Returns:Nothing
Return type:None

New in version 5.1.0.

re_scale((float)arg1) → None:
Change the scale of a view.
Parameters:arg1 (float) – scale factor (> 0.0)
Returns:Nothing
Return type:None

New in version 5.0.0.

Note:

The view size is multiplied by the scale factor.
The view location will move relative to the map origin
by the scale factor.
rectangle((float)arg1, (float)arg2, (float)arg3, (float)arg4) → None:
Draw a rectangle.
Parameters:
  • arg1 (float) – x0
  • arg2 (float) – y0
  • arg3 (float) – x1
  • arg4 (float) – y1
Returns:

Nothing
Return type:

None

New in version 5.0.0.

relocate_group((str)arg1, (float)arg2, (float)arg3, (float)arg4, (float)arg5, (int)arg6) → None:
Re-locate a group in a view.
Parameters:
  • arg1 (str) – group name
  • arg2 (float) – area X minimum
  • arg3 (float) – area Y minimum
  • arg4 (float) – area X maximum
  • arg5 (float) – area Y maximum
  • arg6 (int) – MVIEW_RELOCATE constants
Returns:

Nothing
Return type:

None

New in version 5.0.0.

rename_group((str)arg1, (str)arg2) → None:
Rename a group.
Parameters:
  • arg1 (str) – Old group name
  • arg2 (str) – New group name
Returns:

Nothing
Return type:

None

New in version 5.1.1.

Note:

Does nothing if the group does not already exist.
render((HDC)arg1, (int)arg2, (int)arg3, (int)arg4, (int)arg5, (float)arg6, (float)arg7, (float)arg8, (float)arg9) → None:
Render a specified area of view onto a Windows DC handle
Parameters:
  • arg1 (geosoft.gxapi.HDC) – DC Handle
  • arg2 (int) – left value of the render rect in Windows coordinates (bottom>top)
  • arg3 (int) – bottom value
  • arg4 (int) – right value
  • arg5 (int) – top value
  • arg6 (float) – area X minimum
  • arg7 (float) – area Y minimum
  • arg8 (float) – area X maximum
  • arg9 (float) – area Y maximum
Returns:

Nothing
Return type:

None

New in version 6.4.0.

render_order() → int:
Query the view render order
Returns:Render order
Return type:int

New in version 6.3.0.

Note:

Views with lower numbers should render first, iDUMMY is undefined
scale_all_group((float)arg1, (float)arg2) → None:
Scale all groups (except for GRID) in a view
Parameters:
  • arg1 (float) – X scale
  • arg2 (float) – Y scale
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

X (and Y) scale is the ratio of the new dimension over
the old dimension of a reference object. For example, if a horizontal
straight line of 10m long becomes 20m, X scale should be 2.

The view is then scaled back so that the view occupies the same
area size as before.  The view's clip area is updated as well.
scale_mm() → float:
Get the horizontal scale in view X units/mm
Returns:Returns horizontal scale in view X units/mm
Return type:float

New in version 5.0.0.

Note:

The scale factor is intended to be used by methods
that would like to specify sizes in mm.  Examples
would be text sizes, line thicknesses and line
pitch.
scale_pj_mm() → float:
Get horizontal scale in projected user units/mm
Returns:Returns horizontal scale in projected user units/mm
Return type:float

New in version 5.0.0.

Note:

The scale factor is intended to be used by methods
that would like to specify sizes in mm.  Examples
would be text sizes, line thicknesses and line
pitch.
Same as rScaleMM if working projection not defined
scale_window((float)arg1, (float)arg2, (float)arg3, (float)arg4, (float)arg5, (float)arg6, (float)arg7, (float)arg8) → None:
Assign view coordinates to define a window.
Parameters:
  • arg1 (float) – X minimum in view coordinates
  • arg2 (float) – Y minimum
  • arg3 (float) – X maximum
  • arg4 (float) – Y maximum
  • arg5 (float) – X minimum in plot coordinates
  • arg6 (float) – Y minimum
  • arg7 (float) – horizontal scale (view unit/plot unit in mm)
  • arg8 (float) – vertical scale
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

The provided coordinates are converted to map mm
using the current view translation and scaling.
SetWindow is effectively called.

See also

geosoft.gxapi.GXMVIEW.set_window(), geosoft.gxapi.GXMVIEW.scale_window(), geosoft.gxapi.GXMVIEW.tran_scale()

scale_ymm() → float:
Get the vertical scale in Y units/mm
Returns:Returns vertical scale in view Y units/mm
Return type:float

New in version 5.0.0.

Note:

The scale factor is intended to be used by methods
that would like to specify sizes in mm.  Examples
would be text sizes, line thicknesses and line
pitch.
segment((float)arg1, (float)arg2, (float)arg3, (float)arg4, (float)arg5, (float)arg6, (float)arg7) → None:
Draw a filled segment of an ellipse.
Parameters:
  • arg1 (float) – center x
  • arg2 (float) – center y
  • arg3 (float) – radius
  • arg4 (float) – ratio x/y
  • arg5 (float) – angle
  • arg6 (float) – start angle
  • arg7 (float) – end angle
Returns:

Nothing
Return type:

None

New in version 5.0.7.

set_3d_group_flags((int)arg1, (int)arg2) → None:
Set a 3D geometry group's 3D rendering flags.
Parameters:
Returns:

Nothing
Return type:

None

New in version 9.1.0.

set_3d_point_of_view((float)arg1, (float)arg2, (float)arg3, (float)arg4, (float)arg5, (float)arg6) → None:
Set 3D point of view (no effect on 2D views)
Parameters:
  • arg1 (float) – X center
  • arg2 (float) – Y center
  • arg3 (float) – Z center
  • arg4 (float) – Distance from center
  • arg5 (float) – Declination, 0 to 360 CW from Y
  • arg6 (float) – Inclination, -90 to +90
Returns:

Nothing
Return type:

None

New in version 9.2.0.

set_all_groups_to_plane((int)arg1) → None:
Set all groups to be within one plane
Parameters:arg1 (int) – Plane Index to set all groups to
Returns:Nothing
Return type:None

New in version 5.1.2.

set_all_new_groups_to_plane((int)arg1) → None:
Set all groups that are not in any plane to this plane
Parameters:arg1 (int) – Plane Index to set all groups to
Returns:Nothing
Return type:None

New in version 5.1.2.

set_class_name((str)arg1, (str)arg2) → None:
Set a class name.
Parameters:
  • arg1 (str) – class
  • arg2 (str) – name
Returns:

Nothing
Return type:

None

New in version 5.1.2.

Note:

MVIEW class names are intended to be used to record the
names of certain classes in the view, such as "Plane"
for the default drawing plane.
set_clip_ply((GXPLY)arg1) → None:
Set clipping region to a PLY
Parameters:arg1 (geosoft.gxapi.GXPLY) – Poly
Returns:Nothing
Return type:None

New in version 5.0.0.

set_def_plane((str)arg1) → None:
Set the default drawing plane.
Parameters:arg1 (str) – name
Returns:Nothing
Return type:None

New in version 5.1.2.

Note:

2D drawing to a 3D View will always be placed on the
default drawing plane.  If no default drawing plane
has been set, the first valid plane in the view is
used as the default drawing plane.
set_ext_clip_ply((int)arg1, (str)arg2, (GXPLY)arg3) → int:
Set an extended clip PLY object used by this view.
Parameters:
  • arg1 (int) – Extended ClipPLY number, If >= iNumExtClipPLY_MVIEW(View) it will be added to the end of the current list
  • arg2 (str) – Name (Has to be unique, otherwise error will be returned)
  • arg3 (geosoft.gxapi.GXPLY) – PLY object to set, use (PLY)0 to rename an existing object
Returns:

Index of new or changed PLY, -1 on error
Return type:

int

New in version 6.0.0.

set_freeze_scale((float)arg1) → None:
Set a scale freezing value into stream (rDUMMY for disabled).
Parameters:arg1 (float) – Freeze Scale value
Returns:Nothing
Return type:None

New in version 7.2.0.

Note:

Objects written after this will override any scale freezing set for the group
set_group_ext_clip_ply((str)arg1, (int)arg2) → None:
Sets extended clip information for group in view.
Parameters:
  • arg1 (str) – Group Name
  • arg2 (int) – Extended PLY number (-1 to clear)
Returns:

Nothing
Return type:

None

New in version 6.0.0.

set_group_freeze_scale((int)arg1, (float)arg2) → None:
Set a scale freezing value for the group (rDUMMY for disabled).
Parameters:
  • arg1 (int) – Group number
  • arg2 (float) – Variable to fill with freeze scale
Returns:

Nothing
Return type:

None

New in version 7.2.0.

set_group_moveable((str)arg1, (int)arg2) → None:
Set the movable attribute of a group.
Parameters:
  • arg1 (str) – group name
  • arg2 (int) – 0 - not movable, 1 - movable
Returns:

Nothing
Return type:

None

New in version 5.0.5.

set_group_to_plane((int)arg1, (str)arg2) → None:
Set a group to a plane
Parameters:
  • arg1 (int) – Plane Index to set all groups to
  • arg2 (str) – Name of group to set
Returns:

Nothing
Return type:

None

New in version 5.1.2.

set_group_transparency((str)arg1, (float)arg2) → None:
Sets the transparency value of group
Parameters:
  • arg1 (str) – Group name
  • arg2 (float) – Transparency (1.0 - Opaque, 0.0 - Transparent)
Returns:

Nothing
Return type:

None

New in version 6.0.0.

set_h_3dn((GX3DN)arg1) → None:
Set the 3DN object for this view
Parameters:arg1 (geosoft.gxapi.GX3DN) – 3DN to set (NULL for 2D view)
Returns:Nothing
Return type:None

New in version 5.1.2.

Note:

To make the view a 2D view, set a 3DN of NULL.
set_ipj((GXIPJ)arg1) → None:
Set the projection of the view.
Parameters:arg1 (geosoft.gxapi.GXIPJ) – IPJ to place in the view
Returns:Nothing
Return type:None

New in version 5.0.0.

Note:

As of v5.1.8, this function also sets the User IPJ,
and automatically clears the WARP before doing so, so
that instead of the following construction:

geosoft.gxapi.GXMVIEW.set_ipj()(View,hIPJ);
ClearWarp_IPJ(hIPJ);
geosoft.gxapi.GXMVIEW.set_user_ipj()(View,hIPJ);

you can simply use:

geosoft.gxapi.GXMVIEW.set_ipj()(View,hIPJ);
set_mark_moveable((int)arg1) → None:
Set the movable attribute of marked groups.
Parameters:arg1 (int) – 0 - not movable, 1 - movable
Returns:Nothing
Return type:None

New in version 5.0.5.

set_meta((str)arg1, (GXMETA)arg2, (str)arg3) → None:
Update the META in this group with the new meta object.
Parameters:
  • arg1 (str) – Group Name
  • arg2 (geosoft.gxapi.GXMETA) – META object
  • arg3 (str) – Meta name of Object
Returns:

Nothing
Return type:

None

New in version 5.1.6.

set_movability((bool)arg1) → None:
Set the view movability
Parameters:arg1 (bool) – bool
Returns:Nothing
Return type:None

New in version 6.4.0.

Note:

Views are always physically movable in the API, this
flag is for preventing accidental moving in the GUI.
By default views are not movable.
set_plane_clip_ply((int)arg1, (GXPLY)arg2) → None:
Set the Plane Clip Region
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.1.4.

Note:

By default it is the View's Clip Region
set_plane_equation((int)arg1, (float)arg2, (float)arg3, (float)arg4, (float)arg5, (float)arg6, (float)arg7, (float)arg8, (float)arg9, (float)arg10) → None:
Set the equation of a plane
Parameters:
  • arg1 (int) – Plane index
  • arg2 (float) – Rotation about X (Z toward Y +ve, between -360 and 360)
  • arg3 (float) – Rotation about Y (Z toward X +ve, between -360 and 360)
  • arg4 (float) – Rotation about Z (Y toward X +ve, between -360 and 360)
  • arg5 (float) – X offset of plane
  • arg6 (float) – Y offset of plane
  • arg7 (float) – Z offset of plane
  • arg8 (float) – X scale
  • arg9 (float) – Y scale
  • arg10 (float) – Z scale
Returns:

Nothing
Return type:

None

New in version 5.1.2.

Note:

For a grid with the "Y" axis giving elevation:
use rotations = (-90, 0, 0) for a section with azimuth 90 (E-W)
use rotations = (-90, 0, -90) for a section with azimuth 0 (N-S)
set_plane_surf_info((int)arg1, (int)arg2, (float)arg3, (float)arg4, (float)arg5, (float)arg6) → None:
Set the surface information
Parameters:
  • arg1 (int) – Plane index
  • arg2 (int) – Sample rate (>=1)
  • arg3 (float) – Base
  • arg4 (float) – Scale
  • arg5 (float) – Min
  • arg6 (float) – Max
Returns:

Nothing
Return type:

None

New in version 5.1.2.

set_plane_surface((int)arg1, (str)arg2) → None:
Set the surface image of a plane
Parameters:
  • arg1 (int) – Plane index
  • arg2 (str) – Optional surface image/grid name, can be NULL
Returns:

Nothing
Return type:

None

New in version 5.1.2.

set_render_order((int)arg1) → None:
Set the view render order
Parameters:arg1 (int) – Render order
Returns:Nothing
Return type:None

New in version 6.3.0.

Note:

Views with lower numbers should render first, iDUMMY is undefined
set_thin_res((float)arg1) → None:
Set polyline/polygon thinning resolution
Parameters:arg1 (float) – Thinning resolution in mm, -1.0 to turn off.
Returns:Nothing
Return type:None

New in version 5.0.0.

Note:

The thinning resolution controls the removal of
redundant points from polylines and polygons.  Points
that deviate from a straight line by less than the
thinning resolution are removed.  This can significantly
reduce the size of a MAP file.
We recommend that you set the thinning resolution to
0.02 mm.

By default, the thinning resolution is set to 0.05mm.

Set resolution to 0.0 to remove colinear points only.

To turn off thinning after turning it on, call
SetThinRes_MVIEW with a resolution of -1.
set_u_fac((float)arg1) → None:
Set the unit conversion of a view.
Parameters:arg1 (float) – New UFac value
Returns:Nothing
Return type:None

New in version 5.0.0.

set_user_ipj((GXIPJ)arg1) → None:
Set the user projection of the view.
Parameters:arg1 (geosoft.gxapi.GXIPJ) – IPJ to place in the view
Returns:Nothing
Return type:None

New in version 5.0.0.

set_visibility((bool)arg1) → None:
Set the view visibility
Parameters:arg1 (bool) – bool
Returns:Nothing
Return type:None

New in version 6.3.0.

set_window((float)arg1, (float)arg2, (float)arg3, (float)arg4, (int)arg5) → None:
Set the view window
Parameters:
  • arg1 (float) – X minimum
  • arg2 (float) – Y minimum
  • arg3 (float) – X maximum
  • arg4 (float) – Y maximum
  • arg5 (int) – MVIEW_UNIT constants
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

The current clip region will be set to the clip
window.

See also

geosoft.gxapi.GXMVIEW.fit_window(), geosoft.gxapi.GXMVIEW.scale_window(), geosoft.gxapi.GXMVIEW.extent().

set_working_ipj((GXIPJ)arg1) → None:
Set the working projection of the view.
Parameters:arg1 (geosoft.gxapi.GXIPJ) – The input projection
Returns:Nothing
Return type:None

New in version 5.0.0.

Note:

The working projection is the coordinate system of coordinates drawn to
the view.  The working coordinate system can be different than the view
coordinate system, in which case the coordinates are re-projected to the
view coordinate system before they are placed in the view.

See also

geosoft.gxapi.GXMVIEW.mode_pj() to control use of the working projection.

size_symbols((GXVV)arg1, (GXVV)arg2, (GXVV)arg3) → None:
Plot sized symbols
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

sphere_3d((float)arg1, (float)arg2, (float)arg3, (float)arg4) → None:
Draw a 3D sphere
Parameters:
  • arg1 (float) – Center X
  • arg2 (float) – Center Y
  • arg3 (float) – Center Z
  • arg4 (float) – Radius
Returns:

Nothing
Return type:

None

New in version 5.1.6.

Note:

The Fill color is used to color the sphere.
start_group((str)arg1, (int)arg2) → None:
Start a group.
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

Line and fill colours and thickness must be set
before drawing to a group.

If the group name is NULL, output will be sent to
the primary group stream and the MVIEW_GROUP constants is
ignored.

Group names must be different from view names.
symb_angle((float)arg1) → None:
Set the Symb angle.
Parameters:arg1 (float) – angle in degrees CCW from +X
Returns:Nothing
Return type:None

New in version 5.0.0.

symb_color((int)arg1) → None:
Set the Symbol color.
Parameters:arg1 (int) – color
Returns:Nothing
Return type:None

New in version 5.0.0.

symb_fill_color((int)arg1) → None:
Set the Symbol color fill.
Parameters:arg1 (int) – Color
Returns:Nothing
Return type:None

New in version 5.0.0.

symb_font((str)arg1, (bool)arg2, (int)arg3, (bool)arg4) → None:
Set the symbol font and style.
Parameters:
  • arg1 (str) – face name
  • arg2 (bool) – Geosoft font? bool
  • arg3 (int) – MVIEW_FONT_WEIGHT constants
  • arg4 (bool) – Italic font? bool
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

If the font cannot be found, the DEFAULT_SYMBOL_FONT
specified in the [MONTAJ] section of GEOSOFT.INI
will be used.

See geosoft.gxapi.GXMVIEW.text_font() for the font name syntax.
symb_number((int)arg1) → None:
Set the Symbol number.
Parameters:arg1 (int) – symbol number
Returns:Nothing
Return type:None

New in version 5.0.0.

Note:

The lower 16 bits of the number is interpreted as UTF-16 with a valid Unicode character
code point. GFN fonts wil produce valid symbols depending on the font for 0x01-0x7f and the degree,
plus-minus and diameter symbol(latin small letter o with stroke) for 0xB0, 0xB1 and 0xF8 respectively.

It is possible to check if a character is valid using geosoft.gxapi.GXUNC.is_valid_utf16_char(). The high 16-bits are reserved
for future use. Also see: geosoft.gxapi.GXUNC.valid_symbol() and geosoft.gxapi.GXUNC.validate_symbols().
symb_size((float)arg1) → None:
Set the Symb size.
Parameters:arg1 (float) – size in view units
Returns:Nothing
Return type:None

New in version 5.0.0.

symbol((float)arg1, (float)arg2) → None:
Plot a symbol
Parameters:
  • arg1 (float) – X
  • arg2 (float) – Y
Returns:

Nothing
Return type:

None

New in version 5.0.0.

symbols((GXVV)arg1, (GXVV)arg2) → None:
Plot symbols
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

symbols_itr((str)arg1, (GXVV)arg2, (GXVV)arg3, (GXVV)arg4) → None:
Plot symbols using an ITR
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

text((str)arg1, (float)arg2, (float)arg3) → None:
Draw text.
Parameters:
  • arg1 (str) – text to plot
  • arg2 (float) – x location of text
  • arg3 (float) – y location of text
Returns:

Nothing
Return type:

None

New in version 5.0.0.

text_angle((float)arg1) → None:
Set the text angle.
Parameters:arg1 (float) – angle in degrees CCW from +X
Returns:Nothing
Return type:None

New in version 5.0.0.

text_color((int)arg1) → None:
Set the Text color.
Parameters:arg1 (int) – color
Returns:Nothing
Return type:None

New in version 5.0.0.

text_font((str)arg1, (int)arg2, (int)arg3, (int)arg4) → None:
Set the text font.
Parameters:
  • arg1 (str) – Font face name
  • arg2 (int) – Geosoft font? (TRUE or FALSE)
  • arg3 (int) – MVIEW_FONT_WEIGHT constants
  • arg4 (int) – Italic font? (TRUE or FALSE)
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

Font characteristics can be defined using the function parameters,
or may be defined as decorations in the font name.  A decorated font
name has the following format:

font_name(type,weight,italics,charset)

where
type     - "TT" or "GFN"
weight   - last word from MVIEW_FONT_WEIGHT_ (ie. "LIGHT")
italics  - "ITALICS" for for italics
charset  - Before version 6.2. this decoration was honoured and it affected the display
of characters above ASCII 127. 6.2. introduced Unicode in the core
montaj engine that eliminated the need for such a setting. All strings
on the GX API level are encoded in UTF8 during runtime which makes it possible
to represent all possible characters without using character sets. This decoration
will now be ignored.

Qualifiers take precidence over passed parameters.
The order of qualifiers is not relevant.

examples:

"sr(GFN,ITALICS)"  - geosoft GFN font, normal weight, italics
"Arial(TT,XBOLD)"  - TrueType font, bold
"Times(TT,ITALICS,_EastEurope)"
- TrueType font, italics, Eastern Europe charcters

Decorated name qualifiers take precedence over passed parameters.

If the font cannot be found, or if "Default" is used, the DEFAULT_MAP_FONT
specified in the [MONTAJ] section of GEOSOFT.INI
will be used.
text_ref((int)arg1) → None:
Set the text plot reference point.
Parameters:arg1 (int) – TEXT_REF constants
Returns:Nothing
Return type:None

New in version 5.0.0.

text_size((float)arg1) → None:
Set the text size.
Parameters:arg1 (float) – size in view units
Returns:Nothing
Return type:None

New in version 5.0.0.

Note:

Because views may have differing X and Y scales this size can only make sense in one of these directions
otherwise text would appear warped on these kinds of views. The X direction was chosen to represent the
font size. For instance if the X scale is 1 unit/mm and my Y scale is 2 units/mm a font size of 3.0 view
units will result in un-rotated text that appears 6 view units or 3mm high in the Y direction.

Another important thing to keep in mind that this size represents what is known as the "ascent" height
of the font. The full height of the text may be higher if characters with accents or lower extension
(e.g. the lowercase y) appear in the text. For TrueType fonts the mapping system will do a best effort
positioning and sizing of the text using the alignment set and information about the font that it queries
from the operating system. For instance; if Arial text "Blog" is placed at (0,0) and the alignment
setting is Left-Bottom the left side of the B should be aligned at 0 in the X direction and the
bottom of all the letters except y will be at 0 in the Y direction. The lower part of the y will extend
below 0 in the Y (this is known as the "descent" height of the font at this size). The letters B and l
should be very close to the size set here (this may differ slightly for different fonts).
tran_scale((float)arg1, (float)arg2, (float)arg3, (float)arg4) → None:
Set the view translation and scaling
Parameters:
  • arg1 (float) – X origin (user X to be placed at map 0)
  • arg2 (float) – Y origin (user Y to be placed at map 0)
  • arg3 (float) – X mm/user unit
  • arg4 (float) – Y mm/user unit
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

Warning. For reasons unknown (and maybe a bug), this
function resets the view IPJ units. It is a good idea
to call the SetUnits_IPJ function after calling this
function in order to restore them. This will be addressed
in v6.4.
transparency((float)arg1) → None:
Sets the transparency for new objects.
Parameters:arg1 (float) – Transparency (1.0 - Opaque, 0.0 - Transparent)
Returns:Nothing
Return type:None

New in version 6.0.0.

Note:

1.0 Renders completely opaque objects while 0.0 will be transparent.
Objects written after this will have a combined transparency value with the
group transparency if it is set (e.g. 0.5 for group and 0.8 stream will result in 0.4).
update_met_afrom_group((str)arg1, (GXMETA)arg2) → None:
Fill the META with group dataset information
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.1.6.

user_to_view((float_ref)arg1, (float_ref)arg2) → None:
Convert a USERplot in mm to a VIEW coordinate
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

See also

geosoft.gxapi.GXMVIEW.set_user_ipj() geosoft.gxapi.GXMVIEW.get_user_ipj()

view_to_plot((float_ref)arg1, (float_ref)arg2) → None:
Convert a VIEW coordinate to a plot coordinate in mm.
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

view_to_user((float_ref)arg1, (float_ref)arg2) → None:
Convert a VIEW coordinate to a USER coordinate.
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

See also

geosoft.gxapi.GXMVIEW.set_user_ipj() geosoft.gxapi.GXMVIEW.get_user_ipj()

voxd((GXVOXD)arg1, (str)arg2) → None:
Add a Voxel Display (VOXD) object to the view.
Parameters:
Returns:

Nothing
Return type:

None

New in version 6.2.0.

z_value((float)arg1) → None:
Sets Z-value info.
Parameters:arg1 (float) – Z-Value
Returns:Nothing
Return type:None

New in version 6.0.0.

Note:

This number is stored in map mainly for exports to other vector formats (e.g ShapeFiles)
A contour map that's exported to a shape file will use this value as a Z-value attributes for its shapes.

MAKER constants

Maker defines
gxapi.MAKER_GX = 0
GX

MVIEW_CLIP constants

Boolean clipping defines
gxapi.CLIP_ON = 1
Turn ON clipping
gxapi.CLIP_OFF = 0
Turn OFF clipping

MVIEW_COLOR constants

24-bit color defines
The \ :func:`geosoft.gxapi.GXMVIEW.color`\  function can be used to create a color int from a
color string description.
The iColorXXX_MVIEW macros can be used to create colors from component
intensities.
gxapi.C_BLACK = 33554432
Black
gxapi.C_RED = 33554687
Red
gxapi.C_GREEN = 33619712
Green
gxapi.C_BLUE = 50266112
Blue
gxapi.C_CYAN = 50331903
Cyan
gxapi.C_MAGENTA = 50396928
Magenta
gxapi.C_YELLOW = 67043328
Yellow
gxapi.C_GREY = 41975936
Grey
gxapi.C_LT_RED = 54542336
Light Red
gxapi.C_LT_GREEN = 54526016
Light Green
gxapi.C_LT_BLUE = 50348096
Light Blue
gxapi.C_LT_CYAN = 50331712
Light Cyan
gxapi.C_LT_MAGENTA = 50348032
Light Magenta
gxapi.C_LT_YELLOW = 54525952
Light Yellow
gxapi.C_LT_GREY = 54542400
Light Grey
gxapi.C_GREY10 = 51910680
Grey 10%
gxapi.C_GREY25 = 54542400
Grey 25%
gxapi.C_GREY50 = 41975936
Grey 50%
gxapi.C_WHITE = 50331648
White
gxapi.C_TRANSPARENT = 0
Transparent or no-draw

MVIEW_CYLINDER3D constants

What parts of the cylinder are closed
gxapi.MVIEW_CYLINDER3D_OPEN = 0
gxapi.MVIEW_CYLINDER3D_CLOSESTART = 1
gxapi.MVIEW_CYLINDER3D_CLOSEEND = 2
gxapi.MVIEW_CYLINDER3D_CLOSEALL = 3

MVIEW_DRAW constants

Polygon drawing defines
gxapi.MVIEW_DRAW_POLYLINE = 0
Draw Polylines
gxapi.MVIEW_DRAW_POLYGON = 1
Draw Polygons

MVIEW_DRAWOBJ3D_ENTITY constants

What types of entities to draw
gxapi.MVIEW_DRAWOBJ3D_ENTITY_POINTS = 0
Draw 3D Points (no normals) [1 verticies per object]
gxapi.MVIEW_DRAWOBJ3D_ENTITY_LINES = 1
Draw 3D Lines (no normals) [2 verticies per object]
gxapi.MVIEW_DRAWOBJ3D_ENTITY_LINE_STRIPS = 2
Draw 3D Line strip (no normals) [2+x verticies per object]
gxapi.MVIEW_DRAWOBJ3D_ENTITY_LINE_LOOPS = 3
Draw 3D Line loop (no normals, closes loop with first point) [2+x verticies per object]
gxapi.MVIEW_DRAWOBJ3D_ENTITY_TRIANGLES = 4
Draw 3D Triangles [3 verticies per object]
gxapi.MVIEW_DRAWOBJ3D_ENTITY_TRIANGLE_STRIPS = 5
Draw 3D Triangle strips [3+x verticies per object]
gxapi.MVIEW_DRAWOBJ3D_ENTITY_TRIANGLE_FANS = 6
Draw 3D Triangle fans [3+x verticies per object]
gxapi.MVIEW_DRAWOBJ3D_ENTITY_QUADS = 7
Draw 3D Quads (Must be in the same plane) [4 verticies per object]
gxapi.MVIEW_DRAWOBJ3D_ENTITY_QUADS_STRIPS = 8
Draw 3D Quad Strips (Must be in the same plane) [4+2x verticies per object]
gxapi.MVIEW_DRAWOBJ3D_ENTITY_POLYGONS = 9
Draw 3D Quad Polygones (Must be in the same plane, must be convex and cannot intersect itself)

MVIEW_DRAWOBJ3D_MODE constants

What types of entities to draw
gxapi.MVIEW_DRAWOBJ3D_MODE_FLAT = 0
Draw flat shaded faces (one normal and color per object)
gxapi.MVIEW_DRAWOBJ3D_MODE_SMOOTH = 1
Draw smooth shaded faces (one normal and color per vertex)

MVIEW_EXTENT constants

Types of extents defines
gxapi.MVIEW_EXTENT_ALL = 0
All objects
gxapi.MVIEW_EXTENT_CLIP = 1
Clipping regions
gxapi.MVIEW_EXTENT_MAP = 2
Map extents
gxapi.MVIEW_EXTENT_VISIBLE = 3
Visible objects

MVIEW_FIT constants

Fit area defines
gxapi.MVIEW_FIT_MAP = 0
Fit it to the map area
gxapi.MVIEW_FIT_VIEW = 1
Fit it to the view area

MVIEW_FONT_WEIGHT constants

Font weight defines
gxapi.MVIEW_FONT_WEIGHT_NORMAL = 0
gxapi.MVIEW_FONT_WEIGHT_ULTRALIGHT = 1
gxapi.MVIEW_FONT_WEIGHT_LIGHT = 2
gxapi.MVIEW_FONT_WEIGHT_MEDIUM = 3
gxapi.MVIEW_FONT_WEIGHT_BOLD = 4
gxapi.MVIEW_FONT_WEIGHT_XBOLD = 5
gxapi.MVIEW_FONT_WEIGHT_XXBOLD = 6

MVIEW_GRID constants

Grid Drawing defines
gxapi.MVIEW_GRID_DOT = 0
gxapi.MVIEW_GRID_LINE = 1
gxapi.MVIEW_GRID_CROSS = 2

MVIEW_GROUP constants

Open Group defines
gxapi.MVIEW_GROUP_NEW = 1
New Group (destroy any existing group)
gxapi.MVIEW_GROUP_APPEND = 0
Append to an existing Group

MVIEW_GROUP_LIST constants

What groups to list
gxapi.MVIEW_GROUP_LIST_ALL = 0
All the groups.
gxapi.MVIEW_GROUP_LIST_MARKED = 1
Those groups marked using the various mark functions.
gxapi.MVIEW_GROUP_LIST_VISIBLE = 2
Those groups checked as visible in the view/group manager.

MVIEW_HIDE constants

Boolean hidding defines
gxapi.HIDE_ON = 1
Turn ON hidding
gxapi.HIDE_OFF = 0
Turn OFF hidding

MVIEW_IS constants

Defines for mview types
gxapi.MVIEW_IS_AGG = 0
gxapi.MVIEW_IS_MOVABLE = 3
gxapi.MVIEW_IS_CSYMB = 4
gxapi.MVIEW_IS_LINKED = 5
gxapi.MVIEW_IS_MADE = 6
gxapi.MVIEW_IS_HIDDEN = 7
gxapi.MVIEW_IS_CLIPPED = 8
gxapi.MVIEW_IS_META = 9
gxapi.MVIEW_IS_VOXD = 10

MVIEW_LABEL_BOUND constants

Label Binding Defines
gxapi.MVIEW_LABEL_BOUND_NO = 0
Label Not Bound
gxapi.MVIEW_LABEL_BOUND_YES = 1
Label Bound

MVIEW_LABEL_JUST constants

Label Justification Defines
gxapi.MVIEW_LABEL_JUST_TOP = 0
gxapi.MVIEW_LABEL_JUST_BOTTOM = 1
gxapi.MVIEW_LABEL_JUST_LEFT = 2
gxapi.MVIEW_LABEL_JUST_RIGHT = 3

MVIEW_LABEL_ORIENT constants

Label Orientation Defines
gxapi.MVIEW_LABEL_ORIENT_HORIZONTAL = 0
gxapi.MVIEW_LABEL_ORIENT_TOP_RIGHT = 1
gxapi.MVIEW_LABEL_ORIENT_TOP_LEFT = 2

MVIEW_NAME_LENGTH constant

gxapi.MVIEW_NAME_LENGTH = 1040
maximum length for view and group names

MVIEW_OPEN constants

Open MVIEW define
gxapi.MVIEW_READ = 0
Read Only - No changes
gxapi.MVIEW_WRITENEW = 1
Create new MVIEW - destroys any existing MVIEW
gxapi.MVIEW_WRITEOLD = 2
Open existing MVIEW for read/write (must exist)

MVIEW_PJ constants

Projection modes
gxapi.MVIEW_PJ_OFF = 0
No reprojection is used and all locations and
attributes are assumed to be in the view coordinate
system.
gxapi.MVIEW_PJ_LOCATION = 1
Only locations will be transformed to the view
coordinate system.
gxapi.MVIEW_PJ_ALL = 2
Locations and attributes (sizes, thicknesses, angles)
will be transformed to the view coordinate system.
gxapi.MVIEW_PJ_ON = 3
mode before the last MVIEW_PJ_OFF.

MVIEW_RELOCATE constants

Relocation Defines
gxapi.MVIEW_RELOCATE_FIT = 0
Will fit the image to fill the specified area
gxapi.MVIEW_RELOCATE_ASPECT = 1
Will maintain aspect ratio
gxapi.MVIEW_RELOCATE_ASPECT_CENTER = 2
Will maintain aspect ratio and center in specified area

MVIEW_SMOOTH constants

Interpolation method to use for drawing line and polygon edges
gxapi.MVIEW_SMOOTH_NEAREST = 0
Nearest neighbour
gxapi.MVIEW_SMOOTH_CUBIC = 1
Cubic Spline
gxapi.MVIEW_SMOOTH_AKIMA = 2
Akima

MVIEW_TILE constants

Tiling defines
gxapi.MVIEW_TILE_RECTANGULAR = 0
gxapi.MVIEW_TILE_DIAGONAL = 1
gxapi.MVIEW_TILE_TRIANGULAR = 2
gxapi.MVIEW_TILE_RANDOM = 3

MVIEW_UNIT constants

Coordinate systems defines
gxapi.MVIEW_UNIT_VIEW = 0
view coordinates
gxapi.MVIEW_UNIT_PLOT = 1
plot hi-metric (mm\ `*`\ 100) on the map.
gxapi.MVIEW_UNIT_MM = 2
plot mm on the map.
gxapi.MVIEW_UNIT_VIEW_UNWARPED = 3
view coordinates without a warp if there is one

MVIEW_EXTENT_UNIT constants

Types of units for extents (these map to the
MVIEW_UNIT defines directly)
gxapi.MVIEW_EXTENT_UNIT_VIEW = 0
MVIEW_UNIT_VIEW
gxapi.MVIEW_EXTENT_UNIT_PLOT = 1
MVIEW_UNIT_PLOT
gxapi.MVIEW_EXTENT_UNIT_MM = 2
MVIEW_UNIT_MM
gxapi.MVIEW_EXTENT_UNIT_VIEW_UNWARPED = 3
MVIEW_UNIT_VIEW_UNWARPED

TEXT_REF constants

Text reference locations
gxapi.TEXT_REF_BOTTOM_LEFT = 0
gxapi.TEXT_REF_BOTTOM_CENTER = 1
gxapi.TEXT_REF_BOTTOM_RIGHT = 2
gxapi.TEXT_REF_MIDDLE_LEFT = 3
gxapi.TEXT_REF_MIDDLE_CENTER = 4
gxapi.TEXT_REF_MIDDLE_RIGHT = 5
gxapi.TEXT_REF_TOP_LEFT = 6
gxapi.TEXT_REF_TOP_CENTER = 7
gxapi.TEXT_REF_TOP_RIGHT = 8

MVIEW_3D_RENDER constants

3D Geometry rendering defines. These flags only affect mixed geometry groups and not the data
specific groups (e.g. voxels, vector voxels surfaces etc.). Each of those groups
has predefined optimum behaviour and any changes to these flags are ignored.
gxapi.MVIEW_3D_RENDER_BACKFACES = 1
This flag is enabled if the backfaces of geometry should be rendered
gxapi.MVIEW_3D_DONT_SCALE_GEOMETRY = 2
If the exaggeration scales of the 3D view in X, Y and/or Z is set to anything other than 1.0
any geometric objects (spheres, cubes etc.) for 3D groups with the following flags
will render untransformed while only the centers of the objects are changed.
This ensures the objects appear in the correct place with respect to other data being rendered (and scaled).