GXSURFACEITEM class¶

class geosoft.gxapi.GXSURFACEITEM¶

The SURFACEITEM allows you to create, read and alter Geosurface files (*.geosoft_surface).
A Geosurface file can contain one or more surface items (see SURFACE class). A surface item can
contains one or more triangular polyhedral meshes.

add_mesh((GXVV)arg1, (GXVV)arg2, (GXVV)arg3, (GXVV)arg4, (GXVV)arg5, (GXVV)arg6) → int:¶

Adds a triangular polyhedral mesh component to the surface item.

Parameters:	arg1 (`geosoft.gxapi.GXVV`) – Vertices X location arg2 (`geosoft.gxapi.GXVV`) – Vertices Y location arg3 (`geosoft.gxapi.GXVV`) – Vertices Z location arg4 (`geosoft.gxapi.GXVV`) – Triangles 1st Vertex arg5 (`geosoft.gxapi.GXVV`) – Triangles 2nd Vertex arg6 (`geosoft.gxapi.GXVV`) – Triangles 3rd Vertex
Returns:	The index of the component added.
Return type:	int

New in version 8.4.0.

compute_extended_info((int_ref)arg1, (int_ref)arg2, (int_ref)arg3, (int_ref)arg4, (int_ref)arg5, (int_ref)arg6, (int_ref)arg7) → None:¶

Compute more information (including validation) about of all mesh components in the surface item.

Parameters:	arg1 (`geosoft.gxapi.int_ref`) – Number of inner components (recomputed) arg2 (`geosoft.gxapi.int_ref`) – Total number of valid vertices arg3 (`geosoft.gxapi.int_ref`) – Total number of valid edges arg4 (`geosoft.gxapi.int_ref`) – Total number of valid triangles arg5 (`geosoft.gxapi.int_ref`) – Number of inconsistent triangles arg6 (`geosoft.gxapi.int_ref`) – Number of invalid triangles arg7 (`geosoft.gxapi.int_ref`) – Number of self intersections
Returns:	Nothing
Return type:	None

New in version 8.5.0.

static create((str)arg1, (str)arg2) → GXSURFACEITEM:¶

Create a SURFACEITEM

Parameters:	arg1 (str) – Type arg2 (str) – Name
Returns:	SURFACEITEM Object
Return type:	`geosoft.gxapi.GXSURFACEITEM`

New in version 8.4.0.

get_default_render_properties((int_ref)arg1, (float_ref)arg2, (int_ref)arg3) → None:¶

Gets default render properties of the surface item.

Parameters:	arg1 (`geosoft.gxapi.int_ref`) – Color arg2 (`geosoft.gxapi.float_ref`) – Transparency arg3 (`geosoft.gxapi.int_ref`) – SURFACERENDER_MODE constants
Returns:	Nothing
Return type:	None

New in version 8.4.0.

See also

geosoft.gxapi.GXMVIEW.color()

get_extents((float_ref)arg1, (float_ref)arg2, (float_ref)arg3, (float_ref)arg4, (float_ref)arg5, (float_ref)arg6) → None:¶

Get the spatial range of the the surface item.

Parameters:	arg1 (`geosoft.gxapi.float_ref`) – Minimum valid data in X. arg2 (`geosoft.gxapi.float_ref`) – Minimum valid data in Y. arg3 (`geosoft.gxapi.float_ref`) – Minimum valid data in Z. arg4 (`geosoft.gxapi.float_ref`) – Maximum valid data in X. arg5 (`geosoft.gxapi.float_ref`) – Maximum valid data in Y. arg6 (`geosoft.gxapi.float_ref`) – Maximum valid data in Z.
Returns:	Nothing
Return type:	None

New in version 8.5.0.

get_geometry_info((int_ref)arg1, (int_ref)arg2) → None:¶

Get the total number of vertices and triangles of all mesh components in item.

Parameters:	arg1 (`geosoft.gxapi.int_ref`) – Total number of vertices arg2 (`geosoft.gxapi.int_ref`) – Total number of triangles
Returns:	Nothing
Return type:	None

New in version 8.5.0.

get_guid((str_ref)arg1) → None:¶

Gets the GUID of the surface item.

Parameters:	arg1 (`geosoft.gxapi.str_ref`) – GUID
Returns:	Nothing
Return type:	None

New in version 8.4.0.

Note:

The value returned by this call will not be valid for newly created items until after a call to geosoft.gxapi.GXSURFACE.add_surface_item().

get_info((bool_ref)arg1, (float_ref)arg2, (float_ref)arg3, (float_ref)arg4) → None:¶

Gets information about the surface item.

Parameters:	arg1 (`geosoft.gxapi.bool_ref`) – bool indicating if all meshes in item is closed arg2 (`geosoft.gxapi.float_ref`) – Area arg3 (`geosoft.gxapi.float_ref`) – Volume arg4 (`geosoft.gxapi.float_ref`) – Volume confidence interval
Returns:	Nothing
Return type:	None

New in version 8.5.0.

get_mesh((int)arg1, (GXVV)arg2, (GXVV)arg3, (GXVV)arg4, (GXVV)arg5, (GXVV)arg6, (GXVV)arg7) → None:¶

Gets a triangular polyhedral mesh of a component in the surface item.

Parameters:	arg1 (int) – Index of the component arg2 (`geosoft.gxapi.GXVV`) – Vertices X arg3 (`geosoft.gxapi.GXVV`) – Vertices Y arg4 (`geosoft.gxapi.GXVV`) – Vertices Z arg5 (`geosoft.gxapi.GXVV`) – Triangles 1st Vertex arg6 (`geosoft.gxapi.GXVV`) – Triangles 2nd Vertex arg7 (`geosoft.gxapi.GXVV`) – Triangles 3rd Vertex
Returns:	Nothing
Return type:	None

New in version 8.4.0.

get_mesh_info((int)arg1, (bool_ref)arg2, (int_ref)arg3, (float_ref)arg4, (float_ref)arg5, (float_ref)arg6) → None:¶

Gets information about a triangular polyhedral mesh component in the surface item.

Parameters:	arg1 (int) – Index of the component arg2 (`geosoft.gxapi.bool_ref`) – bool indicating if mesh is closed arg3 (`geosoft.gxapi.int_ref`) – number of inner components arg4 (`geosoft.gxapi.float_ref`) – Area arg5 (`geosoft.gxapi.float_ref`) – Volume arg6 (`geosoft.gxapi.float_ref`) – Volume confidence interval
Returns:	Nothing
Return type:	None

New in version 8.4.0.

get_properties((str_ref)arg1, (str_ref)arg2, (str_ref)arg3, (str_ref)arg4, (float_ref)arg5, (str_ref)arg6, (str_ref)arg7, (float_ref)arg8) → None:¶

Gets the properties of the surface item.

Parameters:	arg1 (`geosoft.gxapi.str_ref`) – Type arg2 (`geosoft.gxapi.str_ref`) – Name arg3 (`geosoft.gxapi.str_ref`) – SourceGuid arg4 (`geosoft.gxapi.str_ref`) – SourceName arg5 (`geosoft.gxapi.float_ref`) – SourceMeasure arg6 (`geosoft.gxapi.str_ref`) – SecondarySourceGuid arg7 (`geosoft.gxapi.str_ref`) – SecondarySourceName arg8 (`geosoft.gxapi.float_ref`) – SecondarySourceMeasure
Returns:	Nothing
Return type:	None

New in version 8.4.0.

get_properties_ex((str_ref)arg1, (str_ref)arg2, (str_ref)arg3, (str_ref)arg4, (float_ref)arg5, (str_ref)arg6, (str_ref)arg7, (int_ref)arg8, (float_ref)arg9, (float_ref)arg10) → None:¶

Gets the properties of the surface item  (includes new properties introduced in 8.5).

Parameters:	arg1 (`geosoft.gxapi.str_ref`) – Type arg2 (`geosoft.gxapi.str_ref`) – Name arg3 (`geosoft.gxapi.str_ref`) – SourceGuid arg4 (`geosoft.gxapi.str_ref`) – SourceName arg5 (`geosoft.gxapi.float_ref`) – SourceMeasure arg6 (`geosoft.gxapi.str_ref`) – SecondarySourceGuid arg7 (`geosoft.gxapi.str_ref`) – SecondarySourceName arg8 (`geosoft.gxapi.int_ref`) – SecondarySourceOption arg9 (`geosoft.gxapi.float_ref`) – SecondarySourceMeasure arg10 (`geosoft.gxapi.float_ref`) – SecondarySourceMeasure2
Returns:	Nothing
Return type:	None

New in version 8.5.0.

is_null() → bool¶

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

Returns:	True if this is a null instance of `geosoft.gxapi.GXSURFACEITEM`, False otherwise.
Return type:	bool`

static null() → GXSURFACEITEM¶

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

Returns:	A null `geosoft.gxapi.GXSURFACEITEM`
Return type:	`geosoft.gxapi.GXSURFACEITEM`

num_components() → int:¶

Get the number of components in the surface item.

Returns:	Number of components in the surface item.
Return type:	int

New in version 8.4.0.

set_default_render_properties((int)arg1, (float)arg2, (int)arg3) → None:¶

Sets default render properties of the surface item.

Parameters:	arg1 (int) – Color arg2 (float) – Transparency arg3 (int) – SURFACERENDER_MODE constants
Returns:	Nothing
Return type:	None

New in version 8.4.0.

See also

geosoft.gxapi.GXMVIEW.color()

set_properties((str)arg1, (str)arg2, (str)arg3, (str)arg4, (float)arg5, (str)arg6, (str)arg7, (float)arg8) → None:¶

Sets the properties of the surface item.

Parameters:	arg1 (str) – Type arg2 (str) – Name arg3 (str) – SourceGuid arg4 (str) – SourceName arg5 (float) – SourceMeasure arg6 (str) – SecondarySourceGuid arg7 (str) – SecondarySourceName arg8 (float) – SecondarySourceMeasure
Returns:	Nothing
Return type:	None

New in version 8.4.0.

See also

geosoft.gxapi.GXSYS.generate_guid()

set_properties_ex((str)arg1, (str)arg2, (str)arg3, (str)arg4, (float)arg5, (str)arg6, (str)arg7, (int)arg8, (float)arg9, (float)arg10) → None:¶

Sets the properties of the surface item (includes new properties introduced in 8.5).

Parameters:	arg1 (str) – Type arg2 (str) – Name arg3 (str) – SourceGuid arg4 (str) – SourceName arg5 (float) – SourceMeasure arg6 (str) – SecondarySourceGuid arg7 (str) – SecondarySourceName arg8 (int) – SecondarySourceOption arg9 (float) – SecondarySourceMeasure arg10 (float) – SecondarySourceMeasure2
Returns:	Nothing
Return type:	None

New in version 8.5.0.

See also

geosoft.gxapi.GXSYS.generate_guid()

SURFACERENDER_MODE constants¶

Open Modes

gxapi.SURFACERENDER_SMOOTH = 0¶

gxapi.SURFACERENDER_FILL = 1¶

gxapi.SURFACERENDER_EDGES = 2¶

Table Of Contents

Related Topics

Previous Topic

Next Topic

This Page

GXSURFACEITEM class¶

SURFACERENDER_MODE constants¶