asset_preparation::v3::point_light::PointLightPreparation Class Reference
Last update: 16.07.2025Point Light Preparation Service. More...
Detailed Description
Point Light Preparation Service.
This service is used to create, edit and manage point lights.
Member Function Documentation
◆ CreatePointLight()
| CreatePointLightResponse asset_preparation::v3::point_light::PointLightPreparation::CreatePointLight | ( | CreatePointLightRequest | ) |
Creates a new point light with optional properties.
- Note
- Names must be unique amongst sibling point lights.
- If unspecified, default values are used.
Returns the identifier of the created point light.
◆ GetPointLight()
| GetPointLightResponse asset_preparation::v3::point_light::PointLightPreparation::GetPointLight | ( | GetPointLightRequest | ) |
Gets the properties of a point light, given its identifier.
Returns the point light properties.
◆ ListPointLights()
| ListPointLightsResponse asset_preparation::v3::point_light::PointLightPreparation::ListPointLights | ( | google::protobuf::Empty | ) |
Lists all the created point lights.
Returns the identifiers and names of the point lights.
◆ UpdatePointLight()
| UpdatePointLightResponse asset_preparation::v3::point_light::PointLightPreparation::UpdatePointLight | ( | UpdatePointLightRequest | ) |
Edits the properties of a point light, given its identifier.
- Note
- Names must be unique amongst point lights.
◆ DeletePointLight()
| DeletePointLightResponse asset_preparation::v3::point_light::PointLightPreparation::DeletePointLight | ( | DeletePointLightRequest | ) |
Deletes a point light, given its identifier.
◆ CreatePointLightState()
| CreatePointLightStateResponse asset_preparation::v3::point_light::PointLightPreparation::CreatePointLightState | ( | CreatePointLightStateRequest | ) |
Creates a new point light state with optional properties.
- Note
- Names must be unique amongst sibling point light states.
- "Default" name is reserved.
- If some properties are not specified, default values are used.
Returns the information about the created point light state.
◆ GetPointLightState()
| GetPointLightStateResponse asset_preparation::v3::point_light::PointLightPreparation::GetPointLightState | ( | GetPointLightStateRequest | ) |
Gets the properties of a point light state, given the parent point light identifier and the state name.
Returns the point light state properties.
◆ UpdatePointLightState()
| UpdatePointLightStateResponse asset_preparation::v3::point_light::PointLightPreparation::UpdatePointLightState | ( | UpdatePointLightStateRequest | ) |
Edits the properties of a state, given the parent point light identifier and the state name.
- Note
- Names must be unique amongst sibling point light states.
- "Default" name is reserved.
◆ DeletePointLightState()
| DeletePointLightStateResponse asset_preparation::v3::point_light::PointLightPreparation::DeletePointLightState | ( | DeletePointLightStateRequest | ) |
Deletes a point light state, given the parent point light identifier and the state name.
The documentation for this class was generated from the following file:
- point_light.proto
