ScreenOverlayFactory

class ansys.stk.core.graphics.ScreenOverlayFactory

A visible element drawn in screen space. Overlays are useful for floating logos, heads up displays, and integrating user interfaces into the 3D window.

Overview

Methods

initialize	Initialize the overlay with the specified x position, y position, width, and height, all specified in pixels.
initialize_with_position_and_size	Initialize the overlay with the specified position and size.

Import detail

from ansys.stk.core.graphics import ScreenOverlayFactory

Method detail

ScreenOverlayFactory.initialize(self, x_pixels: float, y_pixels: float, width_pixels: float, height_pixels: float) → IScreenOverlay

Initialize the overlay with the specified x position, y position, width, and height, all specified in pixels.

Parameters:

x_pixels : float

y_pixels : float

width_pixels : float

height_pixels : float

Returns:

IScreenOverlay

ScreenOverlayFactory.initialize_with_position_and_size(self, position: list, size: list) → IScreenOverlay

Initialize the overlay with the specified position and size.

Parameters:

position : list

size : list

Returns:

IScreenOverlay