GX3DN class¶
-
class
GX3DN
(handle=0)¶ GX3DN class.
This class manages the rendering of a 3D view. It allows the positioning of the camera, specification of the zoom as well as some rendering controls for the axis. It is directly related to the
GXMVIEW
class.-
copy
(source)¶ Copy one
GX3DN
object to another.Parameters: source (GX3DN) – Source GX3DN
to Copy fromNew in version 5.1.2.
License: Geosoft Open License
-
classmethod
create
()¶ Creates a
GX3DN
.Returns: GX3DN
ObjectReturn type: GX3DN New in version 5.1.2.
License: Geosoft Open License
-
get_axis_color
()¶ Get the Axis draw color
Returns: Axis Color Return type: int New in version 6.3.
License: Geosoft Open License
-
get_axis_font
(font)¶ Get the Axis font
Parameters: font (str_ref) – Font name New in version 6.3.
License: Geosoft Open License
-
get_background_color
()¶ Get the window background color
Returns: Background Color value Return type: int New in version 6.3.
License: Geosoft Open License
-
get_point_of_view
(distance, declination, inclination)¶ Get location of the point we are looking from
Parameters: New in version 6.3.
License: Geosoft Open License
-
get_render_controls
(box, axis, label_x, label_y, label_z)¶ Get the rendering controls
Parameters: New in version 6.3.
License: Geosoft Open License
-
get_scale
(x, y, z)¶ Get the axis relative scales.
Parameters: New in version 6.3.
License: Geosoft Open License
-
get_shading
()¶ Set the shading control on or off
Returns: Shading On/Off Return type: int New in version 6.3.
License: Geosoft Open License
-
is_null
()¶ Check if this is a null (undefined) instance
Returns: True if this is a null (undefined) instance, False otherwise. Return type: bool
-
set_axis_color
(color)¶ Set the Axis draw color
Parameters: color (int) – Axis Color New in version 5.1.6.
License: Geosoft Open License
-
set_axis_font
(font)¶ Set the Axis font
Parameters: font (str) – Font name New in version 5.1.6.
License: Geosoft Open License
-
set_background_color
(color)¶ Set the window background color
Parameters: color (int) – Background Color New in version 5.1.6.
License: Geosoft Open License
-
set_point_of_view
(distance, declination, inclination)¶ Set location of the point we are looking from
Parameters: - distance (float) – Distance from center relative to longest grid dimension (which is 1.0)
- declination (float) – Declination, 0 to 360 CW from Y
- inclination (float) – Inclination, -90 to +90
New in version 5.1.2.
License: Geosoft Open License
-
set_render_controls
(box, axis, label_x, label_y, label_z)¶ Set the rendering controls
Parameters: - box (int) – Render Bounding Box (0 or 1)
- axis (int) – Render Axis (0 or 1)
- label_x (str) – Label for X axis
- label_y (str) – Label for Y axis
- label_z (str) – Label for Z axis
New in version 5.1.2.
License: Geosoft Open License
-
set_scale
(x, y, z)¶ Set the axis relative scales.
Parameters: - x (float) – X Scale (default 1.0)
- y (float) – Y Scale (default 1.0)
- z (float) – Z Scale (default 1.0)
New in version 6.1.
License: Geosoft Open License
Note: By default all scales are equal (1.0). By setting these scales, relative adjustments to the overall view of the 3D objects can be made. Note that they are relative to each other. Thus, setting the scaling to 5,5,5 is the same as 1,1,1. This is typically used to exaggerate one scale such as Z (1,1,5).
-
set_shading
(shading)¶ Set the shading control on or off
Parameters: shading (int) – 0: Off, 1: On. New in version 6.3.
License: Geosoft Open License
-