GX3DN class

class geosoft.gx.GX3DN
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 releated to the MVIEW class.
copy((GX3DN)arg1) → None:
Copy one 3DN object to another.
Parameters:arg1 (geosoft.gx.GX3DN) – Source 3DN to Copy from
Returns:Nothing
Return type:None

New in version 5.1.2.

static create((GXContext)ctx) → GX3DN:
Creates a 3DN.
Parameters:ctx (geosoft.gx.GXContext) – The GX execution context
Returns:3DN Object
Return type:geosoft.gx.GX3DN

New in version 5.1.2.

get_axis_color() → int:
Get the Axis draw color
Returns:Axis Color
Return type:int

New in version 6.3.0.

get_axis_font((str_ref)arg1) → None:
Get the Axis font
Parameters:arg1 (geosoft.gx.str_ref) – Font name
Returns:Nothing
Return type:None

New in version 6.3.0.

get_background_color() → int:
Get the window background color
Returns:Background Color value
Return type:int

New in version 6.3.0.

get_point_of_view((float_ref)arg1, (float_ref)arg2, (float_ref)arg3) → None:
Get location of the point we are looking from
Parameters:
Returns:

Nothing
Return type:

None

New in version 6.3.0.

get_render_controls((int_ref)arg1, (int_ref)arg2, (str_ref)arg3, (str_ref)arg4, (str_ref)arg5) → None:
Get the rendering controls
Parameters:
Returns:

Nothing
Return type:

None

New in version 6.3.0.

get_scale((float_ref)arg1, (float_ref)arg2, (float_ref)arg3) → None:
Get the axis relative scales.
Parameters:
Returns:

Nothing
Return type:

None

New in version 6.3.0.

get_shading() → int:
Set the shading control on or off
Returns:Shading On/Off
Return type:int

New in version 6.3.0.

is_null() → bool

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

Returns:True if this is a null instance of geosoft.gx.GX3DN, False otherwise.
Return type:bool`
static null() → GX3DN

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

Returns:A null geosoft.gx.GX3DN
Return type:geosoft.gx.GX3DN
set_axis_color((int)arg1) → None:
Set the Axis draw color
Parameters:arg1 (int) – Axis Color
Returns:Nothing
Return type:None

New in version 5.1.6.

set_axis_font((str)arg1) → None:
Set the Axis font
Parameters:arg1 (str) – Font name
Returns:Nothing
Return type:None

New in version 5.1.6.

set_background_color((int)arg1) → None:
Set the window background color
Parameters:arg1 (int) – Background Color
Returns:Nothing
Return type:None

New in version 5.1.6.

set_point_of_view((float)arg1, (float)arg2, (float)arg3) → None:
Set location of the point we are looking from
Parameters:
  • arg1 (float) – Distance from center relative to longest grid dimension (which is 1.0)
  • arg2 (float) – Declination, 0 to 360 CW from Y
  • arg3 (float) – Inclination, -90 to +90
Returns:

Nothing
Return type:

None

New in version 5.1.2.

set_render_controls((int)arg1, (int)arg2, (str)arg3, (str)arg4, (str)arg5) → None:
Set the rendering controls
Parameters:
  • arg1 (int) – Render Bounding Box (0 or 1)
  • arg2 (int) – Render Axis (0 or 1)
  • arg3 (str) – Label for X axis
  • arg4 (str) – Label for Y axis
  • arg5 (str) – Label for Z axis
Returns:

Nothing
Return type:

None

New in version 5.1.2.

set_scale((float)arg1, (float)arg2, (float)arg3) → None:
Set the axis relative scales.
Parameters:
  • arg1 (float) – X Scale (default 1.0)
  • arg2 (float) – Y Scale (default 1.0)
  • arg3 (float) – Z Scale (default 1.0)
Returns:

Nothing
Return type:

None

New in version 6.1.0.

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 exagerate one scale such as Z (1,1,5).
set_shading((int)arg1) → None:
Set the shading control on or off
Parameters:arg1 (int) – 0: Off, 1: On.
Returns:Nothing
Return type:None

New in version 6.3.0.