asset_preparation::v3::natural_sky::NaturalSkyPreparation Class Reference
Last update: 16.07.2025Natural Sky Preparation Service. More...
Detailed Description
Natural Sky Preparation Service.
This service is used to create, edit and manage natural skies.
Member Function Documentation
◆ CreateNaturalSky()
| CreateNaturalSkyResponse asset_preparation::v3::natural_sky::NaturalSkyPreparation::CreateNaturalSky | ( | CreateNaturalSkyRequest | ) |
Creates a new natural sky with an optional name.
- Note
- Names must be unique amongst skies.
- If unspecified, default values are used.
Returns the identifier of the created natural sky.
◆ GetNaturalSky()
| GetNaturalSkyResponse asset_preparation::v3::natural_sky::NaturalSkyPreparation::GetNaturalSky | ( | GetNaturalSkyRequest | ) |
Gets the properties of a natural sky, given its identifier.
Returns the natural sky properties.
◆ ListNaturalSkies()
| ListNaturalSkiesResponse asset_preparation::v3::natural_sky::NaturalSkyPreparation::ListNaturalSkies | ( | google::protobuf::Empty | ) |
Lists all the created natural skies.
Returns the identifiers and names of the natural skies.
◆ UpdateNaturalSky()
| UpdateNaturalSkyResponse asset_preparation::v3::natural_sky::NaturalSkyPreparation::UpdateNaturalSky | ( | UpdateNaturalSkyRequest | ) |
Edits the properties of a natural sky, given its identifier.
- Note
- Names must be unique amongst skies.
◆ DeleteNaturalSky()
| DeleteNaturalSkyResponse asset_preparation::v3::natural_sky::NaturalSkyPreparation::DeleteNaturalSky | ( | DeleteNaturalSkyRequest | ) |
Deletes a natural sky, given its identifier.
- Note
- If you delete a natural sky that is set as the active_sky in an environment, the environment is updated with the default sky set as the active sky.
◆ CreateNaturalSkyState()
| CreateNaturalSkyStateResponse asset_preparation::v3::natural_sky::NaturalSkyPreparation::CreateNaturalSkyState | ( | CreateNaturalSkyStateRequest | ) |
Creates a new natural sky state with optional properties.
- Note
- Names must be unique amongst sibling states.
- "Default" name is reserved.
- If some properties are not specified, default values are used.
Returns the information about the created natural sky state.
◆ GetNaturalSkyState()
| GetNaturalSkyStateResponse asset_preparation::v3::natural_sky::NaturalSkyPreparation::GetNaturalSkyState | ( | GetNaturalSkyStateRequest | ) |
Gets the properties of a natural sky state, given the parent natural sky identifier and the state name.
Returns the natural sky state properties.
◆ UpdateNaturalSkyState()
| UpdateNaturalSkyStateResponse asset_preparation::v3::natural_sky::NaturalSkyPreparation::UpdateNaturalSkyState | ( | UpdateNaturalSkyStateRequest | ) |
Edits the properties of a state, given the parent natural sky identifier and the state name.
- Note
- Names must be unique amongst sibling states.
- "Default" name is reserved.
◆ DeleteNaturalSkyState()
| DeleteNaturalSkyStateResponse asset_preparation::v3::natural_sky::NaturalSkyPreparation::DeleteNaturalSkyState | ( | DeleteNaturalSkyStateRequest | ) |
Deletes a natural sky state, given the parent natural sky identifier and the state name.
The documentation for this class was generated from the following file:
- natural_sky.proto
