GX3DV class¶

class GX3DV(handle=0)[source]¶

GX3DV class.

TODO…

__init__(handle=0)[source]¶: Initialize self. See help(type(self)) for accurate signature.

copy_to_map(map, mview, min_x, min_y, max_x, max_y, force_overwrite, new_view, problem_files)[source]¶

Copy the GX3DV’s 3D GXMVIEW into a map.

Parameters

map (GXMAP) – GXMAP Object
mview (str) – Desired new view name
min_x (float) – X minimum in mm
min_y (float) – Y minimun in mm
max_x (float) – X maximum in mm
max_y (float) – Y maximum in mm
force_overwrite (int) – (0 - Produce errors for conflicting unpacked files, 1 - Force overwrites of conflicting unpacked files)
new_view (str_ref) – New view name created
problem_files (str_ref) – List of files that are problematic returned

New in version 8.0.

License: Geosoft Open License

Note: A GX3DV packs all source files. This functions creates an unpacked map and unpacks the packed files in the same way that UnPackFilesEx in the GXMAP class does.

crc_3dv(crc, file)[source]¶

Generate an XML CRC of a GX3DV

Parameters

crc (int_ref) – CRC returned
file (str) – Name of xml to generate (.zip added)

New in version 8.0.

License: Geosoft Open License

classmethod create_new(file_name, mview)[source]¶

Create a new GX3DV.

Parameters

file_name (str) – GX3DV file name
mview (GXMVIEW) – 3D GXMVIEW to create new GX3DV from

Returns

GX3DV Object

Return type

New in version 8.0.

License: Geosoft Open License

classmethod from_map(map)[source]¶

Get an GX3DV from GXMAP handle (e.g. from GXEMAP.lock on open geosoft_3dv document in project)

Parameters: map (GXMAP) – GXMAP Object
Returns: GX3DV Object
Return type: GX3DV

New in version 9.2.

License: Geosoft Open License

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 GX3DV

Returns: A null GX3DV
Return type: GX3DV

classmethod open(file_name)[source]¶

Open an existing GX3DV.

Parameters: file_name (str) – GX3DV file name
Returns: GX3DV Object
Return type: GX3DV

New in version 8.0.

License: Geosoft Open License

open_mview(mode)[source]¶

Open GX3DV’s 3D GXMVIEW

Parameters: mode (int) – GEO3DV_OPEN constants
Returns: GXMVIEW, aborts on failure
Return type: GXMVIEW

New in version 8.0.

License: Geosoft Open License

GEO3DV_OPEN constants¶

Open Modes

GEO3DV_MVIEW_READ¶

Geo3dv mview read

gxapi.GEO3DV_MVIEW_READ = 0¶

GEO3DV_MVIEW_WRITEOLD¶

Geo3dv mview writeold

gxapi.GEO3DV_MVIEW_WRITEOLD = 2¶