    

 ## On this page

  

 

 # asset\_preparation::v2::scene\_tree::SceneTreePreparation Class Reference

 Last update: 16.07.2025 

Scene Tree Preparation Service. [More...](a00815.xhtml#details)

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

[CreateSceneTreeResponse](a00823.xhtml) [CreateSceneTree](a00815.xhtml#a5b24c7d0b7c95d7148c5ca00937de6d8) ([CreateSceneTreeRequest](a00819.xhtml)) [GetSceneTreeResponse](a00831.xhtml) [GetSceneTree](a00815.xhtml#aee347e227b001d16ec2b4b1fb8ff5d9a) ([GetSceneTreeRequest](a00827.xhtml)) [ListSceneTreesResponse](a00835.xhtml) [ListSceneTrees](a00815.xhtml#ab23880a149cade0f1ce6c46ec244b31a) (google::protobuf::Empty) [UpdateSceneTreeResponse](a00843.xhtml) [UpdateSceneTree](a00815.xhtml#a2b8296de145f63a145f642f67a9eda40) ([UpdateSceneTreeRequest](a00839.xhtml)) [DeleteSceneTreeResponse](a00851.xhtml) [DeleteSceneTree](a00815.xhtml#af0ea506ff3158f0c5823946a0e167b7a) ([DeleteSceneTreeRequest](a00847.xhtml)) [CreateNodeResponse](a00859.xhtml) [CreateNode](a00815.xhtml#a4acb62404735810ad90a59628302bef9) ([CreateNodeRequest](a00855.xhtml)) [GetNodeResponse](a00867.xhtml) [GetNode](a00815.xhtml#a268b2bbdf7bb41f7b2e082f6928f6b10) ([GetNodeRequest](a00863.xhtml)) [UpdateNodeResponse](a00875.xhtml) [UpdateNode](a00815.xhtml#a8a3963fab21e01e2a8c99d63c11c261f) ([UpdateNodeRequest](a00871.xhtml)) [DeleteNodeResponse](a00883.xhtml) [DeleteNode](a00815.xhtml#a8397cc5689bea68e04cd76e90e004e24) ([DeleteNodeRequest](a00879.xhtml)) [CreateGeometryInstanceResponse](a00891.xhtml) [CreateGeometryInstance](a00815.xhtml#a6c72f62c4e2a4d81da8a4025c6da235e) ([CreateGeometryInstanceRequest](a00887.xhtml)) [GetGeometryInstanceResponse](a00899.xhtml) [GetGeometryInstance](a00815.xhtml#ae547f823ce4cab7ff047bf45f761a9fc) ([GetGeometryInstanceRequest](a00895.xhtml)) [UpdateGeometryInstanceResponse](a00907.xhtml) [UpdateGeometryInstance](a00815.xhtml#afe2134f9726501a5720ca5699ef40599) ([UpdateGeometryInstanceRequest](a00903.xhtml)) [DeleteGeometryInstanceResponse](a00915.xhtml) [DeleteGeometryInstance](a00815.xhtml#a7afba2d1a5f41ec7e94e5d29cc9a2f6c) ([DeleteGeometryInstanceRequest](a00911.xhtml)) [CreateDirectionalLightInstanceResponse](a00923.xhtml) [CreateDirectionalLightInstance](a00815.xhtml#a70c5fa86a2f4f814038f90db20483b42) ([CreateDirectionalLightInstanceRequest](a00919.xhtml)) [GetDirectionalLightInstanceResponse](a00931.xhtml) [GetDirectionalLightInstance](a00815.xhtml#ab2dbe697b0118838ca9b7914471d78d1) ([GetDirectionalLightInstanceRequest](a00927.xhtml)) [UpdateDirectionalLightInstanceResponse](a00939.xhtml) [UpdateDirectionalLightInstance](a00815.xhtml#aeac89981e64a71fb74aaa947697cd95a) ([UpdateDirectionalLightInstanceRequest](a00935.xhtml)) [DeleteDirectionalLightInstanceResponse](a00947.xhtml) [DeleteDirectionalLightInstance](a00815.xhtml#a2aaa640d6fad0756d5533e0a86571dee) ([DeleteDirectionalLightInstanceRequest](a00943.xhtml)) [CreatePointLightInstanceResponse](a00955.xhtml) [CreatePointLightInstance](a00815.xhtml#aba6fd449711f59779e293f1ea875b43a) ([CreatePointLightInstanceRequest](a00951.xhtml)) [GetPointLightInstanceResponse](a00963.xhtml) [GetPointLightInstance](a00815.xhtml#a23c0387a1be104669d58758348c0d1e2) ([GetPointLightInstanceRequest](a00959.xhtml)) [UpdatePointLightInstanceResponse](a00971.xhtml) [UpdatePointLightInstance](a00815.xhtml#a8e18d20c4939d8182e31a0c264d30bbc) ([UpdatePointLightInstanceRequest](a00967.xhtml)) [DeletePointLightInstanceResponse](a00979.xhtml) [DeletePointLightInstance](a00815.xhtml#a667dc3baca9d2977f20af3bbfc167474) ([DeletePointLightInstanceRequest](a00975.xhtml)) stream [common::Chunk](a00235.xhtml) [GetAssetChunks](a00815.xhtml#a4b5669f8b02bb34d49a8845eef0755e2) ([GetAssetChunksRequest](a00983.xhtml)) [GetAssetFileResponse](a00991.xhtml) [GetAssetFile](a00815.xhtml#acc9ebb9412c6bbd558701eb28b00bbc4) ([GetAssetFileRequest](a00987.xhtml)) <a id="details" name="details"></a>## Detailed Description

Scene Tree Preparation Service.

This service is used to create, edit and manage scene trees.



## Member Function Documentation

<a id="a70c5fa86a2f4f814038f90db20483b42"></a>## [◆ ](#a70c5fa86a2f4f814038f90db20483b42)CreateDirectionalLightInstance()

 [CreateDirectionalLightInstanceResponse](a00923.xhtml) asset\_preparation::v2::scene\_tree::SceneTreePreparation::CreateDirectionalLightInstance  ( [CreateDirectionalLightInstanceRequest](a00919.xhtml)  ) 

Creates a directional light instance under a node, given the node identifier and directional light instance parameters.

NoteThe directional light instance is visible by default.Returns the identifier of the created directional light instance.





<a id="a6c72f62c4e2a4d81da8a4025c6da235e"></a>## [◆ ](#a6c72f62c4e2a4d81da8a4025c6da235e)CreateGeometryInstance()

 [CreateGeometryInstanceResponse](a00891.xhtml) asset\_preparation::v2::scene\_tree::SceneTreePreparation::CreateGeometryInstance  ( [CreateGeometryInstanceRequest](a00887.xhtml)  ) 

Creates a geometry instance under a node, given the node identifier and geometry instance parameters.

NoteThe geometry instance is visible by default.Returns the identifier of the created geometry instance.





<a id="a4acb62404735810ad90a59628302bef9"></a>## [◆ ](#a4acb62404735810ad90a59628302bef9)CreateNode()

 [CreateNodeResponse](a00859.xhtml) asset\_preparation::v2::scene\_tree::SceneTreePreparation::CreateNode  ( [CreateNodeRequest](a00855.xhtml)  ) 

Creates a node given the parent scene tree or node identifier, with optional node parameters.

NoteNames must be unique amongst sibling nodes.The node is visible by default.Returns the identifier of the created node.





<a id="aba6fd449711f59779e293f1ea875b43a"></a>## [◆ ](#aba6fd449711f59779e293f1ea875b43a)CreatePointLightInstance()

 [CreatePointLightInstanceResponse](a00955.xhtml) asset\_preparation::v2::scene\_tree::SceneTreePreparation::CreatePointLightInstance  ( [CreatePointLightInstanceRequest](a00951.xhtml)  ) 

Creates a point light instance under a node, given the node identifier and point light instance parameters.

NoteThe point light instance is visible by default.Returns the identifier of the created point light instance.





<a id="a5b24c7d0b7c95d7148c5ca00937de6d8"></a>## [◆ ](#a5b24c7d0b7c95d7148c5ca00937de6d8)CreateSceneTree()

 [CreateSceneTreeResponse](a00823.xhtml) asset\_preparation::v2::scene\_tree::SceneTreePreparation::CreateSceneTree  ( [CreateSceneTreeRequest](a00819.xhtml)  ) 

Creates a new scene tree with an optional given name.

NoteNames must be unique amongst scene trees.Returns the identifier of the created scene tree.





<a id="a2aaa640d6fad0756d5533e0a86571dee"></a>## [◆ ](#a2aaa640d6fad0756d5533e0a86571dee)DeleteDirectionalLightInstance()

 [DeleteDirectionalLightInstanceResponse](a00947.xhtml) asset\_preparation::v2::scene\_tree::SceneTreePreparation::DeleteDirectionalLightInstance  ( [DeleteDirectionalLightInstanceRequest](a00943.xhtml)  ) 

Deletes a directional light instance, given its identifier.





<a id="a7afba2d1a5f41ec7e94e5d29cc9a2f6c"></a>## [◆ ](#a7afba2d1a5f41ec7e94e5d29cc9a2f6c)DeleteGeometryInstance()

 [DeleteGeometryInstanceResponse](a00915.xhtml) asset\_preparation::v2::scene\_tree::SceneTreePreparation::DeleteGeometryInstance  ( [DeleteGeometryInstanceRequest](a00911.xhtml)  ) 

Deletes a geometry instance, given its identifier.





<a id="a8397cc5689bea68e04cd76e90e004e24"></a>## [◆ ](#a8397cc5689bea68e04cd76e90e004e24)DeleteNode()

 [DeleteNodeResponse](a00883.xhtml) asset\_preparation::v2::scene\_tree::SceneTreePreparation::DeleteNode  ( [DeleteNodeRequest](a00879.xhtml)  ) 

Deletes a node, given its identifier.





<a id="a667dc3baca9d2977f20af3bbfc167474"></a>## [◆ ](#a667dc3baca9d2977f20af3bbfc167474)DeletePointLightInstance()

 [DeletePointLightInstanceResponse](a00979.xhtml) asset\_preparation::v2::scene\_tree::SceneTreePreparation::DeletePointLightInstance  ( [DeletePointLightInstanceRequest](a00975.xhtml)  ) 

Deletes a point light instance, given its identifier.





<a id="af0ea506ff3158f0c5823946a0e167b7a"></a>## [◆ ](#af0ea506ff3158f0c5823946a0e167b7a)DeleteSceneTree()

 [DeleteSceneTreeResponse](a00851.xhtml) asset\_preparation::v2::scene\_tree::SceneTreePreparation::DeleteSceneTree  ( [DeleteSceneTreeRequest](a00847.xhtml)  ) 

Deletes a scene tree, given its identifier.





<a id="a4b5669f8b02bb34d49a8845eef0755e2"></a>## [◆ ](#a4b5669f8b02bb34d49a8845eef0755e2)GetAssetChunks()

 stream [common::Chunk](a00235.xhtml) asset\_preparation::v2::scene\_tree::SceneTreePreparation::GetAssetChunks  ( [GetAssetChunksRequest](a00983.xhtml)  ) 

Packages the scene tree as an asset and exports it as a byte stream.

NoteThe last chunk of the stream provides the metadata "AVX Status Error" if an error occurred, "AVX Status Warning" or "AVX Status Info" if the export succeeded. 



<a id="acc9ebb9412c6bbd558701eb28b00bbc4"></a>## [◆ ](#acc9ebb9412c6bbd558701eb28b00bbc4)GetAssetFile()

 [GetAssetFileResponse](a00991.xhtml) asset\_preparation::v2::scene\_tree::SceneTreePreparation::GetAssetFile  ( [GetAssetFileRequest](a00987.xhtml)  ) 

Packages the scene tree as an asset and exports it as a .asset file.





<a id="ab2dbe697b0118838ca9b7914471d78d1"></a>## [◆ ](#ab2dbe697b0118838ca9b7914471d78d1)GetDirectionalLightInstance()

 [GetDirectionalLightInstanceResponse](a00931.xhtml) asset\_preparation::v2::scene\_tree::SceneTreePreparation::GetDirectionalLightInstance  ( [GetDirectionalLightInstanceRequest](a00927.xhtml)  ) 

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

Returns the directional light instance properties.





<a id="ae547f823ce4cab7ff047bf45f761a9fc"></a>## [◆ ](#ae547f823ce4cab7ff047bf45f761a9fc)GetGeometryInstance()

 [GetGeometryInstanceResponse](a00899.xhtml) asset\_preparation::v2::scene\_tree::SceneTreePreparation::GetGeometryInstance  ( [GetGeometryInstanceRequest](a00895.xhtml)  ) 

Gets the properties of a geometry instance, given its identifier.

Returns the geometry instances properties.





<a id="a268b2bbdf7bb41f7b2e082f6928f6b10"></a>## [◆ ](#a268b2bbdf7bb41f7b2e082f6928f6b10)GetNode()

 [GetNodeResponse](a00867.xhtml) asset\_preparation::v2::scene\_tree::SceneTreePreparation::GetNode  ( [GetNodeRequest](a00863.xhtml)  ) 

Gets the properties of a node, given its identifier.

Returns the node properties.





<a id="a23c0387a1be104669d58758348c0d1e2"></a>## [◆ ](#a23c0387a1be104669d58758348c0d1e2)GetPointLightInstance()

 [GetPointLightInstanceResponse](a00963.xhtml) asset\_preparation::v2::scene\_tree::SceneTreePreparation::GetPointLightInstance  ( [GetPointLightInstanceRequest](a00959.xhtml)  ) 

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

Returns the point light instance properties.





<a id="aee347e227b001d16ec2b4b1fb8ff5d9a"></a>## [◆ ](#aee347e227b001d16ec2b4b1fb8ff5d9a)GetSceneTree()

 [GetSceneTreeResponse](a00831.xhtml) asset\_preparation::v2::scene\_tree::SceneTreePreparation::GetSceneTree  ( [GetSceneTreeRequest](a00827.xhtml)  ) 

Gets the properties of a scene tree, given its identifier.

Returns the scene tree properties.





<a id="ab23880a149cade0f1ce6c46ec244b31a"></a>## [◆ ](#ab23880a149cade0f1ce6c46ec244b31a)ListSceneTrees()

 [ListSceneTreesResponse](a00835.xhtml) asset\_preparation::v2::scene\_tree::SceneTreePreparation::ListSceneTrees  ( google::protobuf::Empty  ) 

Lists all the created scene trees.

Returns the identifiers and names of the scene trees.





<a id="aeac89981e64a71fb74aaa947697cd95a"></a>## [◆ ](#aeac89981e64a71fb74aaa947697cd95a)UpdateDirectionalLightInstance()

 [UpdateDirectionalLightInstanceResponse](a00939.xhtml) asset\_preparation::v2::scene\_tree::SceneTreePreparation::UpdateDirectionalLightInstance  ( [UpdateDirectionalLightInstanceRequest](a00935.xhtml)  ) 

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





<a id="afe2134f9726501a5720ca5699ef40599"></a>## [◆ ](#afe2134f9726501a5720ca5699ef40599)UpdateGeometryInstance()

 [UpdateGeometryInstanceResponse](a00907.xhtml) asset\_preparation::v2::scene\_tree::SceneTreePreparation::UpdateGeometryInstance  ( [UpdateGeometryInstanceRequest](a00903.xhtml)  ) 

Edits the properties of a geometry instance, given its identifier.





<a id="a8a3963fab21e01e2a8c99d63c11c261f"></a>## [◆ ](#a8a3963fab21e01e2a8c99d63c11c261f)UpdateNode()

 [UpdateNodeResponse](a00875.xhtml) asset\_preparation::v2::scene\_tree::SceneTreePreparation::UpdateNode  ( [UpdateNodeRequest](a00871.xhtml)  ) 

Edits the properties of a node, given its identifier.

NoteNames must be unique amongst sibling nodes. 



<a id="a8e18d20c4939d8182e31a0c264d30bbc"></a>## [◆ ](#a8e18d20c4939d8182e31a0c264d30bbc)UpdatePointLightInstance()

 [UpdatePointLightInstanceResponse](a00971.xhtml) asset\_preparation::v2::scene\_tree::SceneTreePreparation::UpdatePointLightInstance  ( [UpdatePointLightInstanceRequest](a00967.xhtml)  ) 

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





<a id="a2b8296de145f63a145f642f67a9eda40"></a>## [◆ ](#a2b8296de145f63a145f642f67a9eda40)UpdateSceneTree()

 [UpdateSceneTreeResponse](a00843.xhtml) asset\_preparation::v2::scene\_tree::SceneTreePreparation::UpdateSceneTree  ( [UpdateSceneTreeRequest](a00839.xhtml)  ) 

Edits the properties of a scene tree, given its identifier.

NoteNames must be unique amongst scene trees. 



---

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