asset_preparation::v3::directional_light::DirectionalLightPreparation Class Reference
Last update: 16.07.2025Directional Light Preparation Service. More...
Detailed Description
Directional Light Preparation Service.
This service is used to create, edit and manage directional lights.
Member Function Documentation
◆ CreateDirectionalLight()
| CreateDirectionalLightResponse asset_preparation::v3::directional_light::DirectionalLightPreparation::CreateDirectionalLight | ( | CreateDirectionalLightRequest | ) |
Creates a new directional light with an optional name, type and shadows.
- Note
- Names must be unique amongst sibling directional lights.
- If unspecified, default values are used.
Returns the identifier of the created directional light.
◆ GetDirectionalLight()
| GetDirectionalLightResponse asset_preparation::v3::directional_light::DirectionalLightPreparation::GetDirectionalLight | ( | GetDirectionalLightRequest | ) |
Gets the properties of a directional light, given its identifier.
Returns the directional light properties.
◆ ListDirectionalLights()
| ListDirectionalLightsResponse asset_preparation::v3::directional_light::DirectionalLightPreparation::ListDirectionalLights | ( | google::protobuf::Empty | ) |
Lists all the created directional lights.
Returns the identifiers and names of the directional lights.
◆ UpdateDirectionalLight()
| UpdateDirectionalLightResponse asset_preparation::v3::directional_light::DirectionalLightPreparation::UpdateDirectionalLight | ( | UpdateDirectionalLightRequest | ) |
Edits the properties of a directional light, given its identifier.
- Note
- Names must be unique amongst directional lights.
◆ DeleteDirectionalLight()
| DeleteDirectionalLightResponse asset_preparation::v3::directional_light::DirectionalLightPreparation::DeleteDirectionalLight | ( | DeleteDirectionalLightRequest | ) |
Deletes a directional light, given its identifier.
◆ CreateDirectionalLightState()
| CreateDirectionalLightStateResponse asset_preparation::v3::directional_light::DirectionalLightPreparation::CreateDirectionalLightState | ( | CreateDirectionalLightStateRequest | ) |
Creates a new directional light state with optional properties.
- Note
- Names must be unique amongst sibling directional light states.
- "Default" name is reserved.
- If some properties are not specified, default values are used.
Returns the information about the created directional light state.
◆ GetDirectionalLightState()
| GetDirectionalLightStateResponse asset_preparation::v3::directional_light::DirectionalLightPreparation::GetDirectionalLightState | ( | GetDirectionalLightStateRequest | ) |
Gets the properties of a directional light state, given the parent directional light identifier and the state name.
Returns the directional light state properties.
◆ UpdateDirectionalLightState()
| UpdateDirectionalLightStateResponse asset_preparation::v3::directional_light::DirectionalLightPreparation::UpdateDirectionalLightState | ( | UpdateDirectionalLightStateRequest | ) |
Edits the properties of a state, given the parent directional light identifier and the state name.
- Note
- Names must be unique amongst sibling directional light states.
- "Default" name is reserved.
◆ DeleteDirectionalLightState()
| DeleteDirectionalLightStateResponse asset_preparation::v3::directional_light::DirectionalLightPreparation::DeleteDirectionalLightState | ( | DeleteDirectionalLightStateRequest | ) |
Deletes a directional light state, given the parent directional light identifier and the state name.
The documentation for this class was generated from the following file:
- directional_light.proto
