Aller au contenu

Service HrzProtocol.SceneModelService

Defined in hrz/protocol/scene_model/service.proto.

This service provides read and write access to the scene model. It should not be used directly, but instead through the path builders API. This is because there is no type-checking, and payloads are serialized, which means that it is easy to make a mistake and send or receive the wrong message type.

Each method is a different access type to the scene model, and uses a path to point to the location in the scene model that should be accessed.

The Get and Set methods cannot operate on an entire array. Use the Add and Remove methods instead, or mutate a parent message, or a single element of the array.

Get(HrzProtocol.Path) -> HrzProtocol.BytesValue

Retrieves a part of the scene model at the given path. The returned value is the Protobuf-serialized value, that should be deserialized using the appropriate message type.

Set(HrzProtocol.SceneModelSet) -> HrzProtocol.Void

Sets a part of the scene model at the given path. The payload is the Protobuf-serialized value, serialized with the appropriate message type.

Add(HrzProtocol.SceneModelSet) -> HrzProtocol.UInt32Value

Adds a new element to an array in the scene model. The path must point to the root of an array (see the Path documentation), and the payload must be the Protobuf-serialized value of the element, serialized with the appropriate message type. The number of elements in the array after adding this new element is returned.

Remove(HrzProtocol.Path) -> HrzProtocol.UInt32Value

Removes an element from an array in the scene model. The path must point to the element in the array to be removed (see the Path documentation). The number of elements in the array after removing this element is returned.

Count(HrzProtocol.Path) -> HrzProtocol.UInt32Value

Counts the number of elements in an array in the scene model. The path must point to the root of an array (see the Path documentation).

GetOneofCase(HrzProtocol.Path) -> HrzProtocol.UInt32Value

Retrieves the discriminant of a oneof field in the scene model. The path must point to any of the variant fields in the oneof (see the Path documentation).