GXVOXD class¶

class geosoft.gx.GXVOXD¶

VOX Display object.

static create((GXContext)ctx, (GXVOX)arg1, (str)arg2, (int)arg3, (float)arg4) → GXVOXD:¶

Create a new VOXD

Parameters:	ctx (`geosoft.gx.GXContext`) – The GX execution context arg1 (`geosoft.gx.GXVOX`) – VOX Object arg2 (str) – colour table name, “” for default arg3 (int) – ITR_ZONE constants arg4 (float) – colour contour interval or rDUMMY
Returns:	VOXD handle, terminates if creation fails
Return type:	`geosoft.gx.GXVOXD`

New in version 6.2.0.

Note:

Fails if the VOX object is NOT thematic.
(See the geosoft.gx.GXVOXD.create_thematic() function.)

static create_itr((GXContext)ctx, (GXVOX)arg1, (GXITR)arg2) → GXVOXD:¶

Create a new VOXD with our own ITR

Parameters:	ctx (`geosoft.gx.GXContext`) – The GX execution context arg1 (`geosoft.gx.GXVOX`) – VOX Object arg2 (`geosoft.gx.GXITR`) – ITR Object
Returns:	VOXD handle, terminates if creation fails
Return type:	`geosoft.gx.GXVOXD`

New in version 6.2.0.

Note:

Fails if the VOX object is thematic.
(See the geosoft.gx.GXVOXD.create_thematic() function.)

static create_thematic((GXContext)ctx, (GXVOX)arg1) → GXVOXD:¶

Create a new VOXD for a thematic VOX object.

Parameters:	ctx (`geosoft.gx.GXContext`) – The GX execution context arg1 (`geosoft.gx.GXVOX`) – VOX Object
Returns:	VOXD handle, terminates if creation fails
Return type:	`geosoft.gx.GXVOXD`

New in version 7.0.0.

Note:

A thematic voxel is one where the stored integer values
represent indices into an internally stored TPAT object.
Thematic voxels contain their own color definitions, and
normal numerical operations, such as applying ITRs for display,
are not valid.

To determine if a VOX object is thematic, use the
geosoft.gx.GXVOX.is_thematic() function.

Fails if the VOX object is NOT thematic.

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

Get the draw controls

Parameters:	arg1 (`geosoft.gx.int_ref`) – Draw Bounding Box arg2 (`geosoft.gx.float_ref`) – Transparency arg3 (`geosoft.gx.float_ref`) – Min X arg4 (`geosoft.gx.float_ref`) – Min Y arg5 (`geosoft.gx.float_ref`) – Min Z arg6 (`geosoft.gx.float_ref`) – Max X arg7 (`geosoft.gx.float_ref`) – Max Y arg8 (`geosoft.gx.float_ref`) – Max Z
Returns:	Nothing
Return type:	None

New in version 6.2.0.

get_itr((GXITR)arg1) → None:¶

Get the ITR of the VOXD

Parameters:	arg1 (`geosoft.gx.GXITR`) – ITR object
Returns:	Nothing
Return type:	None

New in version 6.2.0.

get_name((str_ref)arg1) → None:¶

Gets the file name of the voxel.

Parameters:	arg1 (`geosoft.gx.str_ref`) – file name returned
Returns:	Nothing
Return type:	None

New in version 8.2.0.

get_shell_controls((float_ref)arg1, (float_ref)arg2) → None:¶

Get the shell controls

Parameters:	arg1 (`geosoft.gx.float_ref`) – Min Value (rDUMMY for no limit) arg2 (`geosoft.gx.float_ref`) – Max Value (rDUMMY for no limit)
Returns:	Nothing
Return type:	None

New in version 6.2.0.

is_null() → bool¶

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

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

static null() → GXVOXD¶

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

Returns:	A null `geosoft.gx.GXVOXD`
Return type:	`geosoft.gx.GXVOXD`

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

Set the draw controls

Parameters:	arg1 (int) – Draw Bounding Box arg2 (float) – Transparency arg3 (float) – Min X arg4 (float) – Min Y arg5 (float) – Min Z arg6 (float) – Max X arg7 (float) – Max Y arg8 (float) – Max Z
Returns:	Nothing
Return type:	None

New in version 6.2.0.

set_itr((GXITR)arg1) → None:¶

Set the ITR of the VOXD

Parameters:	arg1 (`geosoft.gx.GXITR`) – ITR object
Returns:	Nothing
Return type:	None

New in version 6.2.0.

set_shell_controls((float)arg1, (float)arg2) → None:¶

Set the shell controls

Parameters:	arg1 (float) – Min Value (rDUMMY for no limit) arg2 (float) – Max Value (rDUMMY for no limit)
Returns:	Nothing
Return type:	None

New in version 6.2.0.