Texture.to_skybox

Contents

Texture.to_skybox#

Texture.to_skybox(
*,
projection: Literal['auto', 'cube', 'sphere'] = 'auto',
floor_plane: Sequence[float] | None = None,
floor_right: Sequence[float] | None = None,
)[source]#

Return the texture as a vtkSkybox.

Cubemap textures default to cube-map projection. Non-cubemap textures default to spherical projection so equirectangular environment textures can also be shown as skyboxes.

Changed in version 0.48: Non-cubemap textures now return a skybox using spherical projection by default. Optional floor orientation parameters were also added.

Parameters:
projection{‘auto’, ‘cube’, ‘sphere’}, default: ‘auto’

Skybox projection mode. 'auto' selects 'cube' for cubemap textures and 'sphere' otherwise.

floor_planesequence[float], optional

Floor plane for the skybox as (nx, ny, nz, d). This can be used to orient equirectangular environments in scenes with a custom up direction.

floor_rightsequence[float], optional

Right direction for the floor plane as (x, y, z).

Returns:
vtkSkybox

Skybox actor.