TextureScreenOverlayFactory#

class ansys.stk.core.graphics.TextureScreenOverlayFactory#: A rectangular overlay that can be assigned a texture.

Overview#

Methods

`initialize`	Initialize the overlay with a position of (0, 0), a width of 100 pixels, and a height of 50 pixels.
`initialize_with_xy_width_height`	Initialize the overlay with the specified x position, y position, width, and height, all specified in pixels.
`initialize_with_position_size`	Initialize the overlay with the specified position and size.
`initialize_with_xy_texture`	Initialize the overlay with a specified background texture. The size of the overlay will be the same as the size of the texture.
`initialize_with_position_texture`	Initialize the overlay with a specified background texture. The size of the overlay will be the same as the size of the texture.

Import detail#

from ansys.stk.core.graphics import TextureScreenOverlayFactory

Method detail#

TextureScreenOverlayFactory.initialize(self) → TextureScreenOverlay#

Initialize the overlay with a position of (0, 0), a width of 100 pixels, and a height of 50 pixels.

Returns:: TextureScreenOverlay

TextureScreenOverlayFactory.initialize_with_xy_width_height(self, x_pixels: float, y_pixels: float, width_pixels: float, height_pixels: float) → TextureScreenOverlay#

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:

TextureScreenOverlay

TextureScreenOverlayFactory.initialize_with_position_size(self, position: list, size: list) → TextureScreenOverlay#

Initialize the overlay with the specified position and size.

Parameters:

position : list

size : list

Returns:

TextureScreenOverlay

TextureScreenOverlayFactory.initialize_with_xy_texture(self, x_pixels: float, y_pixels: float, texture: RendererTexture2D) → TextureScreenOverlay#

Initialize the overlay with a specified background texture. The size of the overlay will be the same as the size of the texture.

Parameters:

x_pixels : float

y_pixels : float

texture : RendererTexture2D

Returns:

TextureScreenOverlay

TextureScreenOverlayFactory.initialize_with_position_texture(self, position: list, texture: RendererTexture2D) → TextureScreenOverlay#

Initialize the overlay with a specified background texture. The size of the overlay will be the same as the size of the texture.

Parameters:

position : list

texture : RendererTexture2D

Returns:

TextureScreenOverlay