GXDMPPLY class

class geosoft.gx.GXDMPPLY
Datamine Multiple polygon object
clear() → None:
Clear/remove all polygons from the DMPPLY.
Returns:Nothing
Return type:None

New in version 6.0.0.

copy((GXDMPPLY)arg1) → None:
Copy
Parameters:arg1 (geosoft.gx.GXDMPPLY) – source
Returns:Nothing
Return type:None

New in version 6.0.0.

static create((GXContext)ctx) → GXDMPPLY:
Creates a DMPPLY object.
Parameters:ctx (geosoft.gx.GXContext) – The GX execution context
Returns:DMPLY Object
Return type:geosoft.gx.GXDMPPLY

New in version 6.0.0.

get_azimuth((int)arg1, (float_ref)arg2) → None:
Get the azimuth of a given polygon.
Parameters:
Returns:

Nothing
Return type:

None

New in version 6.0.0.

Note:

The azimuth is the equivalent section azimuth,
equal to the azimuth of the normal vector plus
90 degrees.
get_extents((int)arg1, (float_ref)arg2, (float_ref)arg3, (float_ref)arg4, (float_ref)arg5, (float_ref)arg6) → None:
Get the center, width and height of a given polygon.
Parameters:
Returns:

Nothing
Return type:

None

New in version 6.0.0.

get_joins((int)arg1, (GXVV)arg2) → None:
Get join lines for each vertex in a specific polygon.
Parameters:
  • arg1 (int) – polygon number (1 to N)
  • arg2 (geosoft.gx.GXVV) – INT VV of join indices (1 to NJoins).
Returns:

Nothing
Return type:

None

New in version 6.0.0.

Note:

If a specific vertex is not joined, the returned value is 0.
If the vertex is joined, then the index of the join line (1 to NJoins)
is returned.
get_normal_vectors((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 normal vectors of a given polygon.
Parameters:
Returns:

Nothing
Return type:

None

New in version 6.0.0.

Note:

Three normalized vectors are returned.
The first is horizontal, in the plane of the polygon.
The second is in the vertical plane, corresponding to the
"down-dip" direction.
The third is the normal vector to the polygon plane.
get_poly((int)arg1, (GXVV)arg2, (GXVV)arg3, (GXVV)arg4) → None:
Get a specific polygon from a DMPPLY object.
Parameters:
Returns:

Nothing
Return type:

None

New in version 6.0.0.

Note:

Get the number of points from the VV length.
get_swing((int)arg1, (float_ref)arg2) → None:
Get the swing of a given polygon.
Parameters:
Returns:

Nothing
Return type:

None

New in version 6.0.0.

Note:

The swing is the equivalent section swing,
equal to zero for vertical plates, and increasing
as the normal vector goes from horizontal upward.
get_vertex((int)arg1, (int)arg2, (float_ref)arg3, (float_ref)arg4, (float_ref)arg5) → None:
Get a vertex location from a DMPPLY object.
Parameters:
Returns:

Nothing
Return type:

None

New in version 6.0.0.

is_null() → bool

Check if the instance of geosoft.gx.GXDMPPLY is null (undefined)

Returns:True if this is a null instance of geosoft.gx.GXDMPPLY, False otherwise.
Return type:bool`
load((str)arg1) → None:
Loads a Datamine polygon file.
Parameters:arg1 (str) – Name of the file to load
Returns:Nothing
Return type:None

New in version 6.0.0.

move_vertex((int)arg1, (int)arg2, (float)arg3, (float)arg4, (float)arg5) → None:
Moves a vertex and any associated lines.
Parameters:
  • arg1 (int) – polygon number (1 to NP)
  • arg2 (int) – vertex number (1 to NV)
  • arg3 (float) – new location X
  • arg4 (float) – new location Y
  • arg5 (float) – new location Z
Returns:

Nothing
Return type:

None

New in version 6.0.0.

static null() → GXDMPPLY

A null (undefined) instance of geosoft.gx.GXDMPPLY

Returns:A null geosoft.gx.GXDMPPLY
Return type:geosoft.gx.GXDMPPLY
num_joins() → int:
Get the number of joining lines in a DMPPLY object.
Returns:Number of joining lines
Return type:int

New in version 6.0.0.

num_polys() → int:
Get the number of polygons in a DMPPLY object.
Returns:Number of polygons
Return type:int

New in version 6.0.0.

Note:

The value returned is the "NP" used in function descriptions
below.
num_vertices((int)arg1) → int:
Get the number of vertices in a polygon.
Parameters:arg1 (int) – polygon number (1 to NP)
Returns:Number of vertices in a polygon
Return type:int

New in version 6.0.0.

Note:

The value returned is the "NV" used in function descriptions
below.
project_poly((int)arg1, (float)arg2, (float)arg3, (float)arg4, (float)arg5, (float)arg6, (GXVV)arg7, (GXVV)arg8, (GXVV)arg9) → None:
Project a polygon onto a vertical plane.
Parameters:
  • arg1 (int) – polygon number (1 to NP)
  • arg2 (float) – X location of plane origin in 3D
  • arg3 (float) – Y location of plane origin in 3D
  • arg4 (float) – Z location of plane origin in 3D
  • arg5 (float) – azimuth of the plane in degrees
  • arg6 (float) – swing of the plane in degrees
  • arg7 (geosoft.gx.GXVV) – X (horizontal along-section locations on vertical plane (o)
  • arg8 (geosoft.gx.GXVV) – Y (vertical locations on vertical plane (o)
  • arg9 (geosoft.gx.GXVV) – Z (horizontal distances perpendicular to the plane (o)
Returns:

Nothing
Return type:

None

New in version 6.0.0.

Note:

Gives the location in plane coordinates of a selected polygon,
after it has been projected perpendicularly onto the plane.

Plane coodinates: X - horizontal in plane
                  Y - "vertical" in plane (can be a swing)
                  Z - horizontal, "perpendicular" to plane (RH)
re_project_poly((int)arg1, (float)arg2, (float)arg3, (float)arg4, (float)arg5, (GXVV)arg6, (GXVV)arg7, (GXVV)arg8, (GXVV)arg9, (GXVV)arg10) → None:
Recover polygon locations from 2D locations on vertical plane.
Parameters:
  • arg1 (int) – polygon number (1 to lNP) (i)
  • arg2 (float) – X location of plane origin in 3D (i)
  • arg3 (float) – Y location of plane origin in 3D (i)
  • arg4 (float) – Z location of plane origin in 3D (i)
  • arg5 (float) – azimuth of the plane in degrees (i)
  • arg6 (geosoft.gx.GXVV) – X locations on vertical plane (i)
  • arg7 (geosoft.gx.GXVV) – Y (actually Z) locations on vertical plane (i)
  • arg8 (geosoft.gx.GXVV) – X Locations of polygon (o)
  • arg9 (geosoft.gx.GXVV) – Y Locations of polygon (o)
  • arg10 (geosoft.gx.GXVV) – Z Locations of polygon (o)
Returns:

Nothing
Return type:

None

New in version 6.0.0.

Note:

This is the inverse operation of geosoft.gx.GXDMPPLY.project_poly().

Input the 2D locations on the projected vertical plane. These locations
are projected back onto the original polygon plane.
save((str)arg1) → None:
Save to a Datamine polygon file
Parameters:arg1 (str) – Name of the file to save to
Returns:Nothing
Return type:None

New in version 6.0.0.

set_poly((int)arg1, (GXVV)arg2, (GXVV)arg3, (GXVV)arg4) → None:
Set a specific polygon into a DMPPLY object.
Parameters:
Returns:

Nothing
Return type:

None

New in version 6.0.0.

Note:

Get the number of points from the VV length.