asset_preparation::v3::scene_tree::SceneTreePreparation Class Reference
Last update: 16.07.2025Scene Tree Preparation Service. More...
Detailed Description
Scene Tree Preparation Service.
This service is used to create, edit and manage scene trees.
Member Function Documentation
◆ CreateSceneTree()
| CreateSceneTreeResponse asset_preparation::v3::scene_tree::SceneTreePreparation::CreateSceneTree | ( | CreateSceneTreeRequest | ) |
Creates a new scene tree with an optional given name.
- Note
- Names must be unique amongst scene trees.
Returns the identifier of the created scene tree.
◆ GetSceneTree()
| GetSceneTreeResponse asset_preparation::v3::scene_tree::SceneTreePreparation::GetSceneTree | ( | GetSceneTreeRequest | ) |
Gets the properties of a scene tree, given its identifier.
Returns the scene tree properties.
◆ ListSceneTrees()
| ListSceneTreesResponse asset_preparation::v3::scene_tree::SceneTreePreparation::ListSceneTrees | ( | google::protobuf::Empty | ) |
Lists all the created scene trees.
Returns the identifiers and names of the scene trees.
◆ UpdateSceneTree()
| UpdateSceneTreeResponse asset_preparation::v3::scene_tree::SceneTreePreparation::UpdateSceneTree | ( | UpdateSceneTreeRequest | ) |
Edits the properties of a scene tree, given its identifier.
- Note
- Names must be unique amongst scene trees.
◆ DeleteSceneTree()
| DeleteSceneTreeResponse asset_preparation::v3::scene_tree::SceneTreePreparation::DeleteSceneTree | ( | DeleteSceneTreeRequest | ) |
Deletes a scene tree, given its identifier.
◆ CreateNode()
| CreateNodeResponse asset_preparation::v3::scene_tree::SceneTreePreparation::CreateNode | ( | CreateNodeRequest | ) |
Creates a node given the parent scene tree or node identifier, with optional node parameters.
- Note
- Names must be unique amongst sibling nodes.
- The node is visible by default.
Returns the identifier of the created node.
◆ GetNode()
| GetNodeResponse asset_preparation::v3::scene_tree::SceneTreePreparation::GetNode | ( | GetNodeRequest | ) |
Gets the properties of a node, given its identifier.
Returns the node properties.
◆ UpdateNode()
| UpdateNodeResponse asset_preparation::v3::scene_tree::SceneTreePreparation::UpdateNode | ( | UpdateNodeRequest | ) |
Edits the properties of a node, given its identifier.
- Note
- Names must be unique amongst sibling nodes.
◆ DeleteNode()
| DeleteNodeResponse asset_preparation::v3::scene_tree::SceneTreePreparation::DeleteNode | ( | DeleteNodeRequest | ) |
Deletes a node, given its identifier.
◆ CreateGeometryInstance()
| CreateGeometryInstanceResponse asset_preparation::v3::scene_tree::SceneTreePreparation::CreateGeometryInstance | ( | CreateGeometryInstanceRequest | ) |
Creates a geometry instance under a node, given the node identifier and geometry instance parameters.
- Note
- The geometry instance is visible by default.
Returns the identifier of the created geometry instance.
◆ GetGeometryInstance()
| GetGeometryInstanceResponse asset_preparation::v3::scene_tree::SceneTreePreparation::GetGeometryInstance | ( | GetGeometryInstanceRequest | ) |
Gets the properties of a geometry instance, given its identifier.
Returns the geometry instances properties.
◆ UpdateGeometryInstance()
| UpdateGeometryInstanceResponse asset_preparation::v3::scene_tree::SceneTreePreparation::UpdateGeometryInstance | ( | UpdateGeometryInstanceRequest | ) |
Edits the properties of a geometry instance, given its identifier.
◆ DeleteGeometryInstance()
| DeleteGeometryInstanceResponse asset_preparation::v3::scene_tree::SceneTreePreparation::DeleteGeometryInstance | ( | DeleteGeometryInstanceRequest | ) |
Deletes a geometry instance, given its identifier.
◆ CreateDirectionalLightInstance()
| CreateDirectionalLightInstanceResponse asset_preparation::v3::scene_tree::SceneTreePreparation::CreateDirectionalLightInstance | ( | CreateDirectionalLightInstanceRequest | ) |
Creates a directional light instance under a node, given the node identifier and directional light instance parameters.
- Note
- The directional light instance is visible by default.
Returns the identifier of the created directional light instance.
◆ GetDirectionalLightInstance()
| GetDirectionalLightInstanceResponse asset_preparation::v3::scene_tree::SceneTreePreparation::GetDirectionalLightInstance | ( | GetDirectionalLightInstanceRequest | ) |
Gets the properties of a directional light instance, given its identifier.
Returns the directional light instance properties.
◆ UpdateDirectionalLightInstance()
| UpdateDirectionalLightInstanceResponse asset_preparation::v3::scene_tree::SceneTreePreparation::UpdateDirectionalLightInstance | ( | UpdateDirectionalLightInstanceRequest | ) |
Edits the properties of a directional light instance, given its identifier.
◆ DeleteDirectionalLightInstance()
| DeleteDirectionalLightInstanceResponse asset_preparation::v3::scene_tree::SceneTreePreparation::DeleteDirectionalLightInstance | ( | DeleteDirectionalLightInstanceRequest | ) |
Deletes a directional light instance, given its identifier.
◆ CreatePointLightInstance()
| CreatePointLightInstanceResponse asset_preparation::v3::scene_tree::SceneTreePreparation::CreatePointLightInstance | ( | CreatePointLightInstanceRequest | ) |
Creates a point light instance under a node, given the node identifier and point light instance parameters.
- Note
- The point light instance is visible by default.
Returns the identifier of the created point light instance.
◆ GetPointLightInstance()
| GetPointLightInstanceResponse asset_preparation::v3::scene_tree::SceneTreePreparation::GetPointLightInstance | ( | GetPointLightInstanceRequest | ) |
Gets the properties of a point light instance, given its identifier.
Returns the point light instance properties.
◆ UpdatePointLightInstance()
| UpdatePointLightInstanceResponse asset_preparation::v3::scene_tree::SceneTreePreparation::UpdatePointLightInstance | ( | UpdatePointLightInstanceRequest | ) |
Edits the properties of a point light instance, given its identifier.
◆ DeletePointLightInstance()
| DeletePointLightInstanceResponse asset_preparation::v3::scene_tree::SceneTreePreparation::DeletePointLightInstance | ( | DeletePointLightInstanceRequest | ) |
Deletes a point light instance, given its identifier.
◆ GetAssetChunks()
| stream common::Chunk asset_preparation::v3::scene_tree::SceneTreePreparation::GetAssetChunks | ( | GetAssetChunksRequest | ) |
Packages the scene tree as an asset and exports it as a byte stream.
- Note
- The 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.
◆ GetAssetFile()
| GetAssetFileResponse asset_preparation::v3::scene_tree::SceneTreePreparation::GetAssetFile | ( | GetAssetFileRequest | ) |
Packages the scene tree as an asset and exports it as a .asset file.
The documentation for this class was generated from the following file:
- scenetree.proto
