Graphics3DControlBase

class ansys.stk.core.stkx.Graphics3DControlBase

AGI Globe control.

Overview

Methods

picture_put_reference	Set a reference to the splash logo graphic to be displayed in the control.
pick_info	Get detailed information about a mouse pick.
zoom_in	Enter zoom-in mode. User must left click-and-drag mouse to define area to zoom.
rubber_band_pick_info	Get detailed information about a rubber-band mouse pick. The values must be within the VO window (0 to width-1 for left and right, 0 to height-1 for top and bottom).
copy_from_window_id	Copy an existing Window’s scene into this control.
start_object_editing	Enters into 3D object editing mode.
apply_object_editing	Commit changes when in 3D object editing mode.
stop_object_editing	End 3D object editing mode.
set_mouse_cursor_from_file	Set mouse cursor to the selected cursor file.
restore_mouse_cursor	Restores mouse cursor back to normal.
set_mouse_cursor_from_handle	Set mouse cursor to the passed cursor handle.
subscribe	“””Return an IUiAxGraphics3DCntrlEventHandler that is subscribed to handle events associated with this instance of Graphics3DControlBase.”””

Properties

back_color	The background color of the control.
picture	The splash logo graphic to be displayed in the control.
window_id	Window identifier (for Connect commands).
application	Reference to the STK X application object.
no_logo	If true, the splash logo is not shown.
ole_drop_mode	How the control handles drop operations.
vendor_id	Do not use this property, as it is deprecated. The identifier of the vendor.
mouse_mode	Whether this control responds to mouse events.
draw_elements	Elements to draw on the control.
ready_state	Return/sets the background color of the control.
ppt_preload_mode	Special mode for PowerPoint : if true the VO control window is kept around when switching between slides.
advanced_pick_mode	If true, sets the advance pick mode.
is_object_editing	Return true if in 3D object editing mode.
in_zoom_mode	Return true if in zoom in mode.
show_progress_image	The animated progress image type.
progress_image_x_offset	The horizontal X offset for animated progress image.
progress_image_y_offset	The vertical Y offset for animated progress image.
progress_image_file	The complete image file name/path for animated progress image.
progress_image_x_origin	The X origin alignment for animated progress image.
progress_image_y_origin	The Y origin alignment for animated progress image.
picture_from_file	Get or set the splash logo graphic file to be displayed in the control.

Import detail

from ansys.stk.core.stkx import Graphics3DControlBase

Property detail

property Graphics3DControlBase.back_color: Color

The background color of the control.

property Graphics3DControlBase.picture: IPictureDisp

The splash logo graphic to be displayed in the control.

property Graphics3DControlBase.window_id: int

Window identifier (for Connect commands).

property Graphics3DControlBase.application: STKXApplication

Reference to the STK X application object.

property Graphics3DControlBase.no_logo: bool

If true, the splash logo is not shown.

property Graphics3DControlBase.ole_drop_mode: OLEDropMode

How the control handles drop operations.

property Graphics3DControlBase.vendor_id: str

Do not use this property, as it is deprecated. The identifier of the vendor.

property Graphics3DControlBase.mouse_mode: MouseMode

Whether this control responds to mouse events.

property Graphics3DControlBase.draw_elements: IDrawElementCollection

Elements to draw on the control.

property Graphics3DControlBase.ready_state: int

Return/sets the background color of the control.

property Graphics3DControlBase.ppt_preload_mode: bool

Special mode for PowerPoint : if true the VO control window is kept around when switching between slides.

property Graphics3DControlBase.advanced_pick_mode: bool

If true, sets the advance pick mode.

property Graphics3DControlBase.is_object_editing: bool

Return true if in 3D object editing mode.

property Graphics3DControlBase.in_zoom_mode: bool

Return true if in zoom in mode.

property Graphics3DControlBase.show_progress_image: ShowProgressImage

The animated progress image type.

property Graphics3DControlBase.progress_image_x_offset: int

The horizontal X offset for animated progress image.

property Graphics3DControlBase.progress_image_y_offset: int

The vertical Y offset for animated progress image.

property Graphics3DControlBase.progress_image_file: str

The complete image file name/path for animated progress image.

property Graphics3DControlBase.progress_image_x_origin: ProgressImageXOrigin

The X origin alignment for animated progress image.

property Graphics3DControlBase.progress_image_y_origin: ProgressImageYOrigin

The Y origin alignment for animated progress image.

property Graphics3DControlBase.picture_from_file: str

Get or set the splash logo graphic file to be displayed in the control.

Method detail

Graphics3DControlBase.picture_put_reference(self, picture: IPictureDisp) → None

Set a reference to the splash logo graphic to be displayed in the control.

Parameters:

picture : IPictureDisp

Returns:

None

Graphics3DControlBase.pick_info(self, x: int, y: int) → PickInfoData

Get detailed information about a mouse pick.

Parameters:

x : int

y : int

Returns:

PickInfoData

Graphics3DControlBase.zoom_in(self) → None

Enter zoom-in mode. User must left click-and-drag mouse to define area to zoom.

Returns:

None

Graphics3DControlBase.rubber_band_pick_info(self, left: int, top: int, right: int, bottom: int) → RubberBandPickInfoData

Get detailed information about a rubber-band mouse pick. The values must be within the VO window (0 to width-1 for left and right, 0 to height-1 for top and bottom).

Parameters:

left : int

top : int

right : int

bottom : int

Returns:

RubberBandPickInfoData

Graphics3DControlBase.copy_from_window_id(self, win_id: int) → None

Copy an existing Window’s scene into this control.

Parameters:

win_id : int

Returns:

None

Graphics3DControlBase.start_object_editing(self, obj_edit_path: str) → None

Enters into 3D object editing mode.

Parameters:

obj_edit_path : str

Returns:

None

Graphics3DControlBase.apply_object_editing(self) → None

Commit changes when in 3D object editing mode.

Returns:

None

Graphics3DControlBase.stop_object_editing(self, canceled: bool) → None

End 3D object editing mode.

Parameters:

canceled : bool

Returns:

None

Graphics3DControlBase.set_mouse_cursor_from_file(self, cursor_file_name: str) → None

Set mouse cursor to the selected cursor file.

Parameters:

cursor_file_name : str

Returns:

None

Graphics3DControlBase.restore_mouse_cursor(self) → None

Restores mouse cursor back to normal.

Returns:

None

Graphics3DControlBase.set_mouse_cursor_from_handle(self, cursor_handle: int) → None

Set mouse cursor to the passed cursor handle.

Parameters:

cursor_handle : int

Returns:

None