## On this page

  

 

 # asset\_preparation::v3::material::MaterialPreparation Class Reference

 Last update: 16.07.2025 

Material Preparation Service. [More...](classasset__preparation_1_1v3_1_1material_1_1_material_preparation.xhtml#details)

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

[CreateMaterialResponse](structasset__preparation_1_1v3_1_1material_1_1_create_material_response.xhtml) [CreateMaterial](classasset__preparation_1_1v3_1_1material_1_1_material_preparation.xhtml#a5f82cb187d3913f95d1bcd329556049b) ([CreateMaterialRequest](structasset__preparation_1_1v3_1_1material_1_1_create_material_request.xhtml)) [GetMaterialResponse](structasset__preparation_1_1v3_1_1material_1_1_get_material_response.xhtml) [GetMaterial](classasset__preparation_1_1v3_1_1material_1_1_material_preparation.xhtml#ac08b554ec2e33175e6d65894183ab0fe) ([GetMaterialRequest](structasset__preparation_1_1v3_1_1material_1_1_get_material_request.xhtml)) [ListMaterialsResponse](structasset__preparation_1_1v3_1_1material_1_1_list_materials_response.xhtml) [ListMaterials](classasset__preparation_1_1v3_1_1material_1_1_material_preparation.xhtml#a7a507848059765805b32120e2548a038) (google::protobuf::Empty) [UpdateMaterialResponse](structasset__preparation_1_1v3_1_1material_1_1_update_material_response.xhtml) [UpdateMaterial](classasset__preparation_1_1v3_1_1material_1_1_material_preparation.xhtml#a2490c920986fd8fa2f1e9ddbc71a06d7) ([UpdateMaterialRequest](structasset__preparation_1_1v3_1_1material_1_1_update_material_request.xhtml)) [DeleteMaterialResponse](structasset__preparation_1_1v3_1_1material_1_1_delete_material_response.xhtml) [DeleteMaterial](classasset__preparation_1_1v3_1_1material_1_1_material_preparation.xhtml#a8c84d6fc6c16bd73cc111e74b41f6a45) ([DeleteMaterialRequest](structasset__preparation_1_1v3_1_1material_1_1_delete_material_request.xhtml)) [CreateMaterialStateResponse](structasset__preparation_1_1v3_1_1material_1_1_create_material_state_response.xhtml) [CreateMaterialState](classasset__preparation_1_1v3_1_1material_1_1_material_preparation.xhtml#abaec75fe9c7b6e66a9050f7a0b036cb0) ([CreateMaterialStateRequest](structasset__preparation_1_1v3_1_1material_1_1_create_material_state_request.xhtml)) [GetMaterialStateResponse](structasset__preparation_1_1v3_1_1material_1_1_get_material_state_response.xhtml) [GetMaterialState](classasset__preparation_1_1v3_1_1material_1_1_material_preparation.xhtml#a5c636d050693816caae4e286bb6de245) ([GetMaterialStateRequest](structasset__preparation_1_1v3_1_1material_1_1_get_material_state_request.xhtml)) [UpdateMaterialStateResponse](structasset__preparation_1_1v3_1_1material_1_1_update_material_state_response.xhtml) [UpdateMaterialState](classasset__preparation_1_1v3_1_1material_1_1_material_preparation.xhtml#aec7732a84d6a7e69422e157b410a5c75) ([UpdateMaterialStateRequest](structasset__preparation_1_1v3_1_1material_1_1_update_material_state_request.xhtml)) [DeleteMaterialStateResponse](structasset__preparation_1_1v3_1_1material_1_1_delete_material_state_response.xhtml) [DeleteMaterialState](classasset__preparation_1_1v3_1_1material_1_1_material_preparation.xhtml#aa1a0ffb3f7f0f9fab7cfeb10ded341cf) ([DeleteMaterialStateRequest](structasset__preparation_1_1v3_1_1material_1_1_delete_material_state_request.xhtml)) <a id="details" name="details"></a>## Detailed Description

Material Preparation Service.

This service is used to create, edit and manage materials.



## Member Function Documentation

<a id="a5f82cb187d3913f95d1bcd329556049b"></a>## [◆ ](#a5f82cb187d3913f95d1bcd329556049b)CreateMaterial()

 [CreateMaterialResponse](structasset__preparation_1_1v3_1_1material_1_1_create_material_response.xhtml) asset\_preparation::v3::material::MaterialPreparation::CreateMaterial  ( [CreateMaterialRequest](structasset__preparation_1_1v3_1_1material_1_1_create_material_request.xhtml)  ) 

Creates a new material with optional properties.

NoteNames must be unique amongst sibling materials.If some properties are not specified, default values are used and no dielectric properties are defined.Returns the information about the created material.





<a id="ac08b554ec2e33175e6d65894183ab0fe"></a>## [◆ ](#ac08b554ec2e33175e6d65894183ab0fe)GetMaterial()

 [GetMaterialResponse](structasset__preparation_1_1v3_1_1material_1_1_get_material_response.xhtml) asset\_preparation::v3::material::MaterialPreparation::GetMaterial  ( [GetMaterialRequest](structasset__preparation_1_1v3_1_1material_1_1_get_material_request.xhtml)  ) 

Gets the properties of a material, given its identifier.

Returns the material properties.





<a id="a7a507848059765805b32120e2548a038"></a>## [◆ ](#a7a507848059765805b32120e2548a038)ListMaterials()

 [ListMaterialsResponse](structasset__preparation_1_1v3_1_1material_1_1_list_materials_response.xhtml) asset\_preparation::v3::material::MaterialPreparation::ListMaterials  ( google::protobuf::Empty  ) 

Lists all the stored materials.

Returns the identifiers and names of the stored materials.





<a id="a2490c920986fd8fa2f1e9ddbc71a06d7"></a>## [◆ ](#a2490c920986fd8fa2f1e9ddbc71a06d7)UpdateMaterial()

 [UpdateMaterialResponse](structasset__preparation_1_1v3_1_1material_1_1_update_material_response.xhtml) asset\_preparation::v3::material::MaterialPreparation::UpdateMaterial  ( [UpdateMaterialRequest](structasset__preparation_1_1v3_1_1material_1_1_update_material_request.xhtml)  ) 

Edits the properties of a material, given its identifier.

NoteNames must be unique amongst materials. 



<a id="a8c84d6fc6c16bd73cc111e74b41f6a45"></a>## [◆ ](#a8c84d6fc6c16bd73cc111e74b41f6a45)DeleteMaterial()

 [DeleteMaterialResponse](structasset__preparation_1_1v3_1_1material_1_1_delete_material_response.xhtml) asset\_preparation::v3::material::MaterialPreparation::DeleteMaterial  ( [DeleteMaterialRequest](structasset__preparation_1_1v3_1_1material_1_1_delete_material_request.xhtml)  ) 

Deletes a material, given its identifier.





<a id="abaec75fe9c7b6e66a9050f7a0b036cb0"></a>## [◆ ](#abaec75fe9c7b6e66a9050f7a0b036cb0)CreateMaterialState()

 [CreateMaterialStateResponse](structasset__preparation_1_1v3_1_1material_1_1_create_material_state_response.xhtml) asset\_preparation::v3::material::MaterialPreparation::CreateMaterialState  ( [CreateMaterialStateRequest](structasset__preparation_1_1v3_1_1material_1_1_create_material_state_request.xhtml)  ) 

Creates a new material state with optional properties.

NoteNames must be unique amongst sibling material states."Default" name is reserved.If some properties are not specified, default values are used and no dielectric properties are defined.Returns the information about the created material state.





<a id="a5c636d050693816caae4e286bb6de245"></a>## [◆ ](#a5c636d050693816caae4e286bb6de245)GetMaterialState()

 [GetMaterialStateResponse](structasset__preparation_1_1v3_1_1material_1_1_get_material_state_response.xhtml) asset\_preparation::v3::material::MaterialPreparation::GetMaterialState  ( [GetMaterialStateRequest](structasset__preparation_1_1v3_1_1material_1_1_get_material_state_request.xhtml)  ) 

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

Returns the material state properties.





<a id="aec7732a84d6a7e69422e157b410a5c75"></a>## [◆ ](#aec7732a84d6a7e69422e157b410a5c75)UpdateMaterialState()

 [UpdateMaterialStateResponse](structasset__preparation_1_1v3_1_1material_1_1_update_material_state_response.xhtml) asset\_preparation::v3::material::MaterialPreparation::UpdateMaterialState  ( [UpdateMaterialStateRequest](structasset__preparation_1_1v3_1_1material_1_1_update_material_state_request.xhtml)  ) 

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

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



<a id="aa1a0ffb3f7f0f9fab7cfeb10ded341cf"></a>## [◆ ](#aa1a0ffb3f7f0f9fab7cfeb10ded341cf)DeleteMaterialState()

 [DeleteMaterialStateResponse](structasset__preparation_1_1v3_1_1material_1_1_delete_material_state_response.xhtml) asset\_preparation::v3::material::MaterialPreparation::DeleteMaterialState  ( [DeleteMaterialStateRequest](structasset__preparation_1_1v3_1_1material_1_1_delete_material_state_request.xhtml)  ) 

Deletes a material state, given the parent material identifier and the state name.





---

The documentation for this class was generated from the following file:- material.proto