## On this page

  

 

 # asset\_preparation::v3::point\_light::PointLightPreparation Class Reference

 Last update: 16.07.2025 

Point Light Preparation Service. [More...](classasset__preparation_1_1v3_1_1point__light_1_1_point_light_preparation.xhtml#details)

## <a name="pub-methods"></a>Public Member Functions

[CreatePointLightResponse](structasset__preparation_1_1v3_1_1point__light_1_1_create_point_light_response.xhtml) [CreatePointLight](classasset__preparation_1_1v3_1_1point__light_1_1_point_light_preparation.xhtml#ad8a5a55a63f741a1d8b0212e431ff7d6) ([CreatePointLightRequest](structasset__preparation_1_1v3_1_1point__light_1_1_create_point_light_request.xhtml)) [GetPointLightResponse](structasset__preparation_1_1v3_1_1point__light_1_1_get_point_light_response.xhtml) [GetPointLight](classasset__preparation_1_1v3_1_1point__light_1_1_point_light_preparation.xhtml#a547cd20295a5858ae5862414c9fee959) ([GetPointLightRequest](structasset__preparation_1_1v3_1_1point__light_1_1_get_point_light_request.xhtml)) [ListPointLightsResponse](structasset__preparation_1_1v3_1_1point__light_1_1_list_point_lights_response.xhtml) [ListPointLights](classasset__preparation_1_1v3_1_1point__light_1_1_point_light_preparation.xhtml#a11cbf10b763127930a1111ffa3b9388d) (google::protobuf::Empty) [UpdatePointLightResponse](structasset__preparation_1_1v3_1_1point__light_1_1_update_point_light_response.xhtml) [UpdatePointLight](classasset__preparation_1_1v3_1_1point__light_1_1_point_light_preparation.xhtml#a70bb2c7bbc291c82c81e7ec0451d324b) ([UpdatePointLightRequest](structasset__preparation_1_1v3_1_1point__light_1_1_update_point_light_request.xhtml)) [DeletePointLightResponse](structasset__preparation_1_1v3_1_1point__light_1_1_delete_point_light_response.xhtml) [DeletePointLight](classasset__preparation_1_1v3_1_1point__light_1_1_point_light_preparation.xhtml#a0bdaae739890424ba67dfd1dc93b963e) ([DeletePointLightRequest](structasset__preparation_1_1v3_1_1point__light_1_1_delete_point_light_request.xhtml)) [CreatePointLightStateResponse](structasset__preparation_1_1v3_1_1point__light_1_1_create_point_light_state_response.xhtml) [CreatePointLightState](classasset__preparation_1_1v3_1_1point__light_1_1_point_light_preparation.xhtml#aef844abdb66eb05d7592239e60786b5f) ([CreatePointLightStateRequest](structasset__preparation_1_1v3_1_1point__light_1_1_create_point_light_state_request.xhtml)) [GetPointLightStateResponse](structasset__preparation_1_1v3_1_1point__light_1_1_get_point_light_state_response.xhtml) [GetPointLightState](classasset__preparation_1_1v3_1_1point__light_1_1_point_light_preparation.xhtml#a03eb04e93556fb36124f7d3a9a1cbcdf) ([GetPointLightStateRequest](structasset__preparation_1_1v3_1_1point__light_1_1_get_point_light_state_request.xhtml)) [UpdatePointLightStateResponse](structasset__preparation_1_1v3_1_1point__light_1_1_update_point_light_state_response.xhtml) [UpdatePointLightState](classasset__preparation_1_1v3_1_1point__light_1_1_point_light_preparation.xhtml#a7ddee84a086f91345b96044c26df8743) ([UpdatePointLightStateRequest](structasset__preparation_1_1v3_1_1point__light_1_1_update_point_light_state_request.xhtml)) [DeletePointLightStateResponse](structasset__preparation_1_1v3_1_1point__light_1_1_delete_point_light_state_response.xhtml) [DeletePointLightState](classasset__preparation_1_1v3_1_1point__light_1_1_point_light_preparation.xhtml#a28924c368c18f5e0854a68753e38df81) ([DeletePointLightStateRequest](structasset__preparation_1_1v3_1_1point__light_1_1_delete_point_light_state_request.xhtml)) <a id="details" name="details"></a>## Detailed Description

Point Light Preparation Service.

This service is used to create, edit and manage point lights.



## Member Function Documentation

<a id="ad8a5a55a63f741a1d8b0212e431ff7d6"></a>## [◆ ](#ad8a5a55a63f741a1d8b0212e431ff7d6)CreatePointLight()

 [CreatePointLightResponse](structasset__preparation_1_1v3_1_1point__light_1_1_create_point_light_response.xhtml) asset\_preparation::v3::point\_light::PointLightPreparation::CreatePointLight  ( [CreatePointLightRequest](structasset__preparation_1_1v3_1_1point__light_1_1_create_point_light_request.xhtml)  ) 

Creates a new point light with optional properties.

NoteNames must be unique amongst sibling point lights.If unspecified, default values are used.Returns the identifier of the created point light.





<a id="a547cd20295a5858ae5862414c9fee959"></a>## [◆ ](#a547cd20295a5858ae5862414c9fee959)GetPointLight()

 [GetPointLightResponse](structasset__preparation_1_1v3_1_1point__light_1_1_get_point_light_response.xhtml) asset\_preparation::v3::point\_light::PointLightPreparation::GetPointLight  ( [GetPointLightRequest](structasset__preparation_1_1v3_1_1point__light_1_1_get_point_light_request.xhtml)  ) 

Gets the properties of a point light, given its identifier.

Returns the point light properties.





<a id="a11cbf10b763127930a1111ffa3b9388d"></a>## [◆ ](#a11cbf10b763127930a1111ffa3b9388d)ListPointLights()

 [ListPointLightsResponse](structasset__preparation_1_1v3_1_1point__light_1_1_list_point_lights_response.xhtml) 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.





<a id="a70bb2c7bbc291c82c81e7ec0451d324b"></a>## [◆ ](#a70bb2c7bbc291c82c81e7ec0451d324b)UpdatePointLight()

 [UpdatePointLightResponse](structasset__preparation_1_1v3_1_1point__light_1_1_update_point_light_response.xhtml) asset\_preparation::v3::point\_light::PointLightPreparation::UpdatePointLight  ( [UpdatePointLightRequest](structasset__preparation_1_1v3_1_1point__light_1_1_update_point_light_request.xhtml)  ) 

Edits the properties of a point light, given its identifier.

NoteNames must be unique amongst point lights. 



<a id="a0bdaae739890424ba67dfd1dc93b963e"></a>## [◆ ](#a0bdaae739890424ba67dfd1dc93b963e)DeletePointLight()

 [DeletePointLightResponse](structasset__preparation_1_1v3_1_1point__light_1_1_delete_point_light_response.xhtml) asset\_preparation::v3::point\_light::PointLightPreparation::DeletePointLight  ( [DeletePointLightRequest](structasset__preparation_1_1v3_1_1point__light_1_1_delete_point_light_request.xhtml)  ) 

Deletes a point light, given its identifier.





<a id="aef844abdb66eb05d7592239e60786b5f"></a>## [◆ ](#aef844abdb66eb05d7592239e60786b5f)CreatePointLightState()

 [CreatePointLightStateResponse](structasset__preparation_1_1v3_1_1point__light_1_1_create_point_light_state_response.xhtml) asset\_preparation::v3::point\_light::PointLightPreparation::CreatePointLightState  ( [CreatePointLightStateRequest](structasset__preparation_1_1v3_1_1point__light_1_1_create_point_light_state_request.xhtml)  ) 

Creates a new point light state with optional properties.

NoteNames 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.





<a id="a03eb04e93556fb36124f7d3a9a1cbcdf"></a>## [◆ ](#a03eb04e93556fb36124f7d3a9a1cbcdf)GetPointLightState()

 [GetPointLightStateResponse](structasset__preparation_1_1v3_1_1point__light_1_1_get_point_light_state_response.xhtml) asset\_preparation::v3::point\_light::PointLightPreparation::GetPointLightState  ( [GetPointLightStateRequest](structasset__preparation_1_1v3_1_1point__light_1_1_get_point_light_state_request.xhtml)  ) 

Gets the properties of a point light state, given the parent point light identifier and the state name.

Returns the point light state properties.





<a id="a7ddee84a086f91345b96044c26df8743"></a>## [◆ ](#a7ddee84a086f91345b96044c26df8743)UpdatePointLightState()

 [UpdatePointLightStateResponse](structasset__preparation_1_1v3_1_1point__light_1_1_update_point_light_state_response.xhtml) asset\_preparation::v3::point\_light::PointLightPreparation::UpdatePointLightState  ( [UpdatePointLightStateRequest](structasset__preparation_1_1v3_1_1point__light_1_1_update_point_light_state_request.xhtml)  ) 

Edits the properties of a state, given the parent point light identifier and the state name.

NoteNames must be unique amongst sibling point light states."Default" name is reserved. 



<a id="a28924c368c18f5e0854a68753e38df81"></a>## [◆ ](#a28924c368c18f5e0854a68753e38df81)DeletePointLightState()

 [DeletePointLightStateResponse](structasset__preparation_1_1v3_1_1point__light_1_1_delete_point_light_state_response.xhtml) asset\_preparation::v3::point\_light::PointLightPreparation::DeletePointLightState  ( [DeletePointLightStateRequest](structasset__preparation_1_1v3_1_1point__light_1_1_delete_point_light_state_request.xhtml)  ) 

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