### extends 'class_empty.py'
### block ClassImports
# NOTICE: Do not edit anything here, it is generated code
from . import gxapi_cy
from geosoft.gxapi import GXContext, float_ref, int_ref, str_ref
### endblock ClassImports
### block Header
# NOTICE: The code generator will not replace the code in this block
### endblock Header
### block ClassImplementation
# NOTICE: Do not edit anything here, it is generated code
[docs]class GXVOXD(gxapi_cy.WrapVOXD):
"""
GXVOXD class.
`GXVOX <geosoft.gxapi.GXVOX>` Display object.
"""
[docs] def __init__(self, handle=0):
super(GXVOXD, self).__init__(GXContext._get_tls_geo(), handle)
[docs] @classmethod
def null(cls):
"""
A null (undefined) instance of `GXVOXD <geosoft.gxapi.GXVOXD>`
:returns: A null `GXVOXD <geosoft.gxapi.GXVOXD>`
:rtype: GXVOXD
"""
return GXVOXD()
[docs] def is_null(self):
"""
Check if this is a null (undefined) instance
:returns: True if this is a null (undefined) instance, False otherwise.
:rtype: bool
"""
return self._internal_handle() == 0
# Miscellaneous
[docs] @classmethod
def create(cls, vox, table, zone, contour):
"""
Create a new `GXVOXD <geosoft.gxapi.GXVOXD>`
:param vox: `GXVOX <geosoft.gxapi.GXVOX>` Object
:param table: Color table name, "" for default
:param zone: :ref:`ITR_ZONE`
:param contour: Color contour interval or `rDUMMY <geosoft.gxapi.rDUMMY>`
:type vox: GXVOX
:type table: str
:type zone: int
:type contour: float
:returns: `GXVOXD <geosoft.gxapi.GXVOXD>` handle, terminates if creation fails
:rtype: GXVOXD
.. versionadded:: 6.2
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
**Note:** Fails if the `GXVOX <geosoft.gxapi.GXVOX>` object is NOT thematic.
(See the `create_thematic <geosoft.gxapi.GXVOXD.create_thematic>` function.)
"""
ret_val = gxapi_cy.WrapVOXD._create(GXContext._get_tls_geo(), vox, table.encode(), zone, contour)
return GXVOXD(ret_val)
[docs] @classmethod
def create_itr(cls, vox, itr):
"""
Create a new `GXVOXD <geosoft.gxapi.GXVOXD>` with our own `GXITR <geosoft.gxapi.GXITR>`
:param vox: `GXVOX <geosoft.gxapi.GXVOX>` Object
:param itr: `GXITR <geosoft.gxapi.GXITR>` Object
:type vox: GXVOX
:type itr: GXITR
:returns: `GXVOXD <geosoft.gxapi.GXVOXD>` handle, terminates if creation fails
:rtype: GXVOXD
.. versionadded:: 6.2
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
**Note:** Fails if the `GXVOX <geosoft.gxapi.GXVOX>` object is thematic.
(See the `create_thematic <geosoft.gxapi.GXVOXD.create_thematic>` function.)
"""
ret_val = gxapi_cy.WrapVOXD._create_itr(GXContext._get_tls_geo(), vox, itr)
return GXVOXD(ret_val)
[docs] @classmethod
def create_thematic(cls, vox):
"""
Create a new `GXVOXD <geosoft.gxapi.GXVOXD>` for a thematic `GXVOX <geosoft.gxapi.GXVOX>` object.
:param vox: `GXVOX <geosoft.gxapi.GXVOX>` Object
:type vox: GXVOX
:returns: `GXVOXD <geosoft.gxapi.GXVOXD>` handle, terminates if creation fails
:rtype: GXVOXD
.. versionadded:: 7.0
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
**Note:** A thematic voxel is one where the stored integer values
represent indices into an internally stored `GXTPAT <geosoft.gxapi.GXTPAT>` 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 `GXVOX <geosoft.gxapi.GXVOX>` object is thematic, use the
`is_thematic <geosoft.gxapi.GXVOXD.is_thematic>` function.
Fails if the `GXVOX <geosoft.gxapi.GXVOX>` object is NOT thematic.
"""
ret_val = gxapi_cy.WrapVOXD._create_thematic(GXContext._get_tls_geo(), vox)
return GXVOXD(ret_val)
[docs] def is_thematic(self):
"""
Is this a thematic voxel?
:returns: 1 if `GXVOX <geosoft.gxapi.GXVOX>` is thematic
:rtype: int
.. versionadded:: 9.3
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
**Note:** A thematic voxel is one where the stored integer values
represent indices into an internally stored `GXTPAT <geosoft.gxapi.GXTPAT>` object.
Thematic voxels contain their own color definitions, and
normal numerical operations, such as applying ITRs for display,
are not valid.
"""
ret_val = self._is_thematic()
return ret_val
[docs] def get_thematic_info(self, tpat, vv):
"""
Get a copy of a thematic voxel's `GXTPAT <geosoft.gxapi.GXTPAT>` object and a `GXVV <geosoft.gxapi.GXVV>` containing the current display selections.
:param tpat: `GXTPAT <geosoft.gxapi.GXTPAT>` object to get
:param vv: `GXVV <geosoft.gxapi.GXVV>` (int) object to fill with current selections
:type tpat: GXTPAT
:type vv: GXVV
.. versionadded:: 9.3
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
"""
self._get_thematic_info(tpat, vv)
[docs] def set_thematic_selection(self, vv):
"""
Get a copy of a thematic voxel's `GXTPAT <geosoft.gxapi.GXTPAT>` object and a `GXVV <geosoft.gxapi.GXVV>` containing the current display selections.
:param vv: `GXVV <geosoft.gxapi.GXVV>` (int) object to set the current selections to
:type vv: GXVV
.. versionadded:: 9.3
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
"""
self._set_thematic_selection(vv)
[docs] def get_draw_controls(self, box, trans, min_x, min_y, min_z, max_x, max_y, max_z):
"""
Get the draw controls
:param box: Draw Bounding Box
:param trans: Transparency
:param min_x: Min X
:param min_y: Min Y
:param min_z: Min Z
:param max_x: Max X
:param max_y: Max Y
:param max_z: Max Z
:type box: int_ref
:type trans: float_ref
:type min_x: float_ref
:type min_y: float_ref
:type min_z: float_ref
:type max_x: float_ref
:type max_y: float_ref
:type max_z: float_ref
.. versionadded:: 6.2
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
"""
box.value, trans.value, min_x.value, min_y.value, min_z.value, max_x.value, max_y.value, max_z.value = self._get_draw_controls(box.value, trans.value, min_x.value, min_y.value, min_z.value, max_x.value, max_y.value, max_z.value)
[docs] def get_name(self, name):
"""
Gets the file name of the voxel.
:param name: File name returned
:type name: str_ref
.. versionadded:: 8.2
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
"""
name.value = self._get_name(name.value.encode())
[docs] def get_itr(self, itr):
"""
Get the `GXITR <geosoft.gxapi.GXITR>` of the `GXVOXD <geosoft.gxapi.GXVOXD>`
:param itr: `GXITR <geosoft.gxapi.GXITR>` object
:type itr: GXITR
.. versionadded:: 6.2
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
"""
self._get_itr(itr)
[docs] def get_shell_controls(self, min, max):
"""
Get the shell controls
:param min: Min Value (`rDUMMY <geosoft.gxapi.rDUMMY>` for no limit)
:param max: Max Value (`rDUMMY <geosoft.gxapi.rDUMMY>` for no limit)
:type min: float_ref
:type max: float_ref
.. versionadded:: 6.2
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
"""
min.value, max.value = self._get_shell_controls(min.value, max.value)
[docs] def set_draw_controls(self, box, trans, min_x, min_y, min_z, max_x, max_y, max_z):
"""
Set the draw controls
:param box: Draw Bounding Box
:param trans: Transparency
:param min_x: Min X
:param min_y: Min Y
:param min_z: Min Z
:param max_x: Max X
:param max_y: Max Y
:param max_z: Max Z
:type box: int
:type trans: float
:type min_x: float
:type min_y: float
:type min_z: float
:type max_x: float
:type max_y: float
:type max_z: float
.. versionadded:: 6.2
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
"""
self._set_draw_controls(box, trans, min_x, min_y, min_z, max_x, max_y, max_z)
[docs] def set_itr(self, itr):
"""
Set the `GXITR <geosoft.gxapi.GXITR>` of the `GXVOXD <geosoft.gxapi.GXVOXD>`
:param itr: `GXITR <geosoft.gxapi.GXITR>` object
:type itr: GXITR
.. versionadded:: 6.2
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
"""
self._set_itr(itr)
[docs] def set_shell_controls(self, min, max):
"""
Set the shell controls
:param min: Min Value (`rDUMMY <geosoft.gxapi.rDUMMY>` for no limit)
:param max: Max Value (`rDUMMY <geosoft.gxapi.rDUMMY>` for no limit)
:type min: float
:type max: float
.. versionadded:: 6.2
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
"""
self._set_shell_controls(min, max)
[docs] def get_render_mode(self, render_mode):
"""
Get voxel render mode.
:param render_mode: :ref:`VOXELRENDER_MODE`
:type render_mode: int_ref
.. versionadded:: 9.5
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
"""
render_mode.value = self._get_render_mode(render_mode.value)
[docs] def set_render_mode(self, render_mode):
"""
Get voxel render mode.
:param render_mode: :ref:`VOXELRENDER_MODE`
:type render_mode: int
.. versionadded:: 9.5
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
"""
self._set_render_mode(render_mode)
### endblock ClassImplementation
### block ClassExtend
# NOTICE: The code generator will not replace the code in this block
### endblock ClassExtend
### block Footer
# NOTICE: The code generator will not replace the code in this block
### endblock Footer