# Copyright (c) 2024 Bentley Systems, Incorporated. All rights reserved.
### extends 'class_empty.py'
### block ClassImports
# NOTICE: Do not edit anything here, it is generated code
import warnings
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 GXDXFI(gxapi_cy.WrapDXFI):
"""
GXDXFI class.
The `GXDXFI <geosoft.gxapi.GXDXFI>` class is used for importing AutoCAD® dxf files into Geosoft maps.
"""
[docs]
def __init__(self, handle=0):
super(GXDXFI, self).__init__(GXContext._get_tls_geo(), handle)
[docs]
@classmethod
def null(cls):
"""
A null (undefined) instance of `GXDXFI <geosoft.gxapi.GXDXFI>`
:returns: A null `GXDXFI <geosoft.gxapi.GXDXFI>`
:rtype: GXDXFI
"""
return GXDXFI()
[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, name):
"""
Create `GXDXFI <geosoft.gxapi.GXDXFI>`.
:param name: DXF file name
:type name: str
:returns: `GXDXFI <geosoft.gxapi.GXDXFI>` Object
:rtype: GXDXFI
.. versionadded:: 5.0
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
"""
ret_val = gxapi_cy.WrapDXFI._create(GXContext._get_tls_geo(), name.encode())
return GXDXFI(ret_val)
[docs]
@classmethod
def dxf2_ply(cls, ply, dxfi):
"""
Convert a DXF file to a `GXPLY <geosoft.gxapi.GXPLY>` object
:param ply: `GXPLY <geosoft.gxapi.GXPLY>` handle
:param dxfi: `GXDXFI <geosoft.gxapi.GXDXFI>` handle
:type ply: GXPLY
:type dxfi: GXDXFI
.. versionadded:: 5.1.6
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
"""
gxapi_cy.WrapDXFI._dxf2_ply(GXContext._get_tls_geo(), ply, dxfi)
[docs]
def dxf2_view_ex(self, view, max_pen, pb_group, group, pb_one_color, color):
"""
Draw entities in a DXF file to a view in a map
:param max_pen: User defined number of pens to use (can be `iDUMMY <geosoft.gxapi.iDUMMY>`)
:param pb_group: TRUE to place entire DXF in one group
:param group: Group name for one group (can be "" if above is FALSE)
:param pb_one_color: TRUE to force one color
:param color: :ref:`MVIEW_COLOR` (ignored if above is FALSE)
:type view: GXMVIEW
:type max_pen: int
:type pb_group: int
:type group: str
:type pb_one_color: int
:type color: int
.. versionadded:: 6.2
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
"""
self._dxf2_view_ex(view, max_pen, pb_group, group.encode(), pb_one_color, color)
[docs]
def dxf2_view_no_surfaces(self, view, max_pen, pb_group, group, pb_one_color, color):
"""
Draw entities in a DXF file to a view in a map, but for 3D views skips all surfaces
:param max_pen: User defined number of pens to use (can be `iDUMMY <geosoft.gxapi.iDUMMY>`)
:param pb_group: TRUE to place entire DXF in one group
:param group: Group name for one group (can be "" if above is FALSE)
:param pb_one_color: TRUE to force one color
:param color: :ref:`MVIEW_COLOR` (ignored if above is FALSE)
:type view: GXMVIEW
:type max_pen: int
:type pb_group: int
:type group: str
:type pb_one_color: int
:type color: int
.. versionadded:: 9.7.1
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
"""
self._dxf2_view_no_surfaces(view, max_pen, pb_group, group.encode(), pb_one_color, color)
[docs]
def get_range(self, min_x, max_x, min_y, max_y, min_z, max_z):
"""
Get DXF data range
:param min_x: X min
:param max_x: X max
:param min_y: Y min
:param max_y: Y max
:param min_z: Z min
:param max_z: Z max
:type min_x: float_ref
:type max_x: float_ref
:type min_y: float_ref
:type max_y: float_ref
:type min_z: 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>`_
"""
min_x.value, max_x.value, min_y.value, max_y.value, min_z.value, max_z.value = self._get_range(min_x.value, max_x.value, min_y.value, max_y.value, min_z.value, max_z.value)
# Deprecated
[docs]
@classmethod
def dxf2_map(cls, map, dxfi, scale, u_fac, x0, y0, max_pen, pb_black):
"""
.. deprecated:: None None
Draw entities in a DXF file in a map
:param map: Map handle
:param dxfi: `GXDXFI <geosoft.gxapi.GXDXFI>` handle
:param scale: User defined map scale
:param u_fac: Unit conversion factor
:param x0: X origin of the map
:param y0: Y origin of the map
:param max_pen: User defined number of pens to use
:param pb_black: Force black color if 1
:type map: GXMAP
:type dxfi: GXDXFI
:type scale: float
:type u_fac: float
:type x0: float
:type y0: float
:type max_pen: int
:type pb_black: int
.. versionadded:: 5.0
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
"""
warnings.warn("""Deprecated since unknown, """, )
gxapi_cy.WrapDXFI._dxf2_map(GXContext._get_tls_geo(), map, dxfi, scale, u_fac, x0, y0, max_pen, pb_black)
[docs]
def dxf2_map_ex(self, map, scale, u_fac, x0, y0, max_pen, pb_group, group, pb_one_color, p_color):
"""
.. deprecated:: None None
Draw entities in a DXF file in a map
:param map: Map handle
:param scale: User defined map scale
:param u_fac: Unit conversion factor
:param x0: X origin of the map
:param y0: Y origin of the map
:param max_pen: User defined number of pens to use
:param pb_group: TRUE to place entire DXF in one group
:param group: Group name for one group
:param pb_one_color: TRUE to force one color
:param p_color: :ref:`MVIEW_COLOR`
:type map: GXMAP
:type scale: float
:type u_fac: float
:type x0: float
:type y0: float
:type max_pen: int
:type pb_group: int
:type group: str
:type pb_one_color: int
:type p_color: int
.. versionadded:: 5.0.6
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
**Note:** The DXF will be drawin in the "*Data" view. If a "*Data" view
does not exist, it will be created.
"""
warnings.warn("""Deprecated since unknown, """, )
self._dxf2_map_ex(map, scale, u_fac, x0, y0, max_pen, pb_group, group.encode(), pb_one_color, p_color)
[docs]
def dxf2_view(self, view, scale, u_fac, x0, y0, max_pen, pb_group, group, pb_one_color, p_color):
"""
.. deprecated:: None None
Draw entities in a DXF file to a view in a map
:param scale: User defined map scale
:param u_fac: Unit conversion factor
:param x0: X origin of the map
:param y0: Y origin of the map
:param max_pen: User defined number of pens to use
:param pb_group: TRUE to place entire DXF in one group
:param group: Group name for one group
:param pb_one_color: TRUE to force one color
:param p_color: :ref:`MVIEW_COLOR`
:type view: GXMVIEW
:type scale: float
:type u_fac: float
:type x0: float
:type y0: float
:type max_pen: int
:type pb_group: int
:type group: str
:type pb_one_color: int
:type p_color: int
.. versionadded:: 5.0.6
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
"""
warnings.warn("""Deprecated since unknown, """, )
self._dxf2_view(view, scale, u_fac, x0, y0, max_pen, pb_group, group.encode(), pb_one_color, p_color)
[docs]
def map_extents(self, min_x, min_y, max_x, max_y):
"""
.. deprecated:: None None
Get map extent
:param min_x: Min X - returned
:param min_y: Min Y - returned
:param max_x: Max X - returned
:param max_y: Max Y - returned
:type min_x: float_ref
:type min_y: float_ref
:type max_x: float_ref
:type max_y: float_ref
.. versionadded:: 5.0
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
"""
warnings.warn("""Deprecated since unknown, """, )
min_x.value, min_y.value, max_x.value, max_y.value = self._map_extents(min_x.value, min_y.value, max_x.value, max_y.value)
[docs]
def set_ipj(self, ipj):
"""
.. deprecated:: None None
Set the projection of the DXF.
:param ipj: `GXIPJ <geosoft.gxapi.GXIPJ>` to place in the view
:type ipj: GXIPJ
.. versionadded:: 5.0
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
"""
warnings.warn("""Deprecated since unknown, """, )
self._set_ipj(ipj)
### 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