Skip to main content

AVxcelerate Asset Preparation API 2024 R1

asset_preparation::v2::directional_light::DirectionalLightPreparation Class Reference

Last update: 16.07.2025

Directional Light Preparation Service. More...

Public Member Functions

CreateDirectionalLightResponse CreateDirectionalLight (CreateDirectionalLightRequest)
 
GetDirectionalLightResponse GetDirectionalLight (GetDirectionalLightRequest)
 
ListDirectionalLightsResponse ListDirectionalLights (google::protobuf::Empty)
 
UpdateDirectionalLightResponse UpdateDirectionalLight (UpdateDirectionalLightRequest)
 
DeleteDirectionalLightResponse DeleteDirectionalLight (DeleteDirectionalLightRequest)
 

Detailed Description

Directional Light Preparation Service.

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

Member Function Documentation

◆ CreateDirectionalLight()

CreateDirectionalLightResponse asset_preparation::v2::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.

◆ DeleteDirectionalLight()

DeleteDirectionalLightResponse asset_preparation::v2::directional_light::DirectionalLightPreparation::DeleteDirectionalLight ( DeleteDirectionalLightRequest  )

Deletes a directional light, given its identifier.

◆ GetDirectionalLight()

GetDirectionalLightResponse asset_preparation::v2::directional_light::DirectionalLightPreparation::GetDirectionalLight ( GetDirectionalLightRequest  )

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

Returns the directional light properties.

◆ ListDirectionalLights()

ListDirectionalLightsResponse asset_preparation::v2::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::v2::directional_light::DirectionalLightPreparation::UpdateDirectionalLight ( UpdateDirectionalLightRequest  )

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

Note
Names must be unique amongst directional lights.

The documentation for this class was generated from the following file:
  • directional_light.proto

Connect with Ansys