GXKML class

class GXKML(handle=0)[source]

GXKML class.

GXKML functions provide an interface KML (Keyhole markup language) files.

Note:

None.

__init__(handle=0)[source]

Initialize self. See help(type(self)) for accurate signature.

classmethod import_3d_line_path(mview, name, vv_vx, vv_vy, vv_vz, color, extruded)[source]

Imports a KML 3D LinePath into a provided view.

Parameters

  • mview (GXMVIEW) – GXMVIEW object - the (3d) view to import the LinePath into.

  • name (str) – The name of the resulting LinePath group.

  • vv_vx (GXVV) – X Vertex Components - VV of GS_REAL

  • vv_vy (GXVV) – Y Vertex Components - VV of GS_REAL

  • vv_vz (GXVV) – Z Vertex Components - VV of GS_REAL

  • color (int) – The colour of the resulting surface - COL_ANY.

  • extruded (bool) – Extrude the LinePath to the base - BOOL.

Return type

int

New in version 9.10.

License: Geosoft Open License

Note: Requirements – The MVIEW must be 3D and valid (see GXMVIEW.is_view_3d);- The group name must not be null/empty;- The three VV for vector components must contain vertices, and be of equal length.

classmethod import_3d_polygon(mview, name, vv_vx, vv_vy, vv_vz, color, extruded)[source]

Imports a KML 3D polygon into a provided view.

Parameters

  • mview (GXMVIEW) – GXMVIEW object - the (3d) view to import the polygon into.

  • name (str) – The name of the resulting polygon group.

  • vv_vx (GXVV) – X Vertex Components - VV of GS_REAL

  • vv_vy (GXVV) – Y Vertex Components - VV of GS_REAL

  • vv_vz (GXVV) – Z Vertex Components - VV of GS_REAL

  • color (int) – The colour of the resulting surface - COL_ANY.

  • extruded (bool) – Extrude the polygon to the base - BOOL.

Return type

int

New in version 9.10.

License: Geosoft Open License

Note: Requirements – The MVIEW must be 3D and valid (see GXMVIEW.is_view_3d);- The group name must not be null/empty;- The three VV for vector components must contain vertices, and be of equal length.

is_null()[source]

Check if this is a null (undefined) instance

Returns

True if this is a null (undefined) instance, False otherwise.

Return type

bool

classmethod null()[source]

A null (undefined) instance of GXKML

Returns

A null GXKML

Return type

GXKML

KML_ALT constants

KML Altitude values.

KML_ALT_CLAMPTOGROUND

Clamptoground

gxapi.KML_ALT_CLAMPTOGROUND = 0
KML_ALT_RELATIVETOGROUND

Relativetoground

gxapi.KML_ALT_RELATIVETOGROUND = 1
KML_ALT_ABSOLUTE

Absolute

gxapi.KML_ALT_ABSOLUTE = 2