SkyHelper#

class omni.kit.environment.core.SkyHelper#

Bases: object

Helper for environment sky. Use to find or create sky.

Methods

`__init__`()
`create_dynamic_sky`(url[, sky_path])	Creates dynamic sky from the provided URL.
`create_hdri_sky`(url[, sky_path])	Creates an HDRI sky from the provided URL.
`destroy`()	Destroys the stage event subscription for environment sky updates.
`find_sky`([root_path])	Finds the sky prim and its associated asset path from the specified root prim.
`get_env_file_type`(url)	Detects the environment sky file type based on the provided URL.

static create_dynamic_sky( url: str, sky_path='/Environment/sky', ) → str#

Creates dynamic sky from the provided URL.

Parameters:

url (str) – URL to the sky file.
sky_path (str) – Prim path where the sky will be created. Default is SKY_PRIM_PATH.

Returns:

Prim path if creation is successful; otherwise, an empty string.

Return type:

str

static create_hdri_sky( url: str, sky_path: str = '/Environment/sky', ) → str#

Creates an HDRI sky from the provided URL.

Parameters:

url (str) – URL to the sky file.
sky_path (str) – Prim path where the sky will be created. Default is SKY_PRIM_PATH.

Returns:

Prim path if creation is successful; otherwise, an empty string.

Return type:

str

destroy()#: Destroys the stage event subscription for environment sky updates.

static find_sky( root_path: str = '/Environment', ) → Tuple[str | None, str | None]#

Finds the sky prim and its associated asset path from the specified root prim.

Parameters:: root_path (str) – Root prim path to search for sky.
Returns:: Sky prim path and sky asset path if found; otherwise, (None, None).
Return type:: Tuple[Optional[str], Optional[str]]

static get_env_file_type( url: str, ) → SkyType | None#

Detects the environment sky file type based on the provided URL.