ensightservice::SceneClientInit Struct Reference
Last update: 16.07.2025Public Attributes | |
| bool | allow_spontaneous = 1 |
| bool | allow_incremental_updates = 2 |
| int32 | maximum_chunk_size = 3 |
| bool | include_temporal_geometry = 4 |
Detailed Description
This SceneClientCommand sub message is sent by the client at startup or whenever the client would like a scene update. The server will respond by starting a scene update command sequence, beginning with a SceneUpdateCommand message, UpdateSceneBegin sub command. The update sequence will end with a SceneUpdateCommand message, UpdateSceneEnd sub command.
This message also informs the server what the maximum size of a block of data should be (in bytes). It also can be used to enable "spontaneous" scene updates that can be started by the EnSight server at any time. If the client would like the server to rebroadcast the entire scene, it should set the allow_incremental_updates flag to false, suppressing state cache tracking by the server.
Definition at line 183 of file dynamic_scene_graph.proto.
Member Data Documentation
◆ allow_incremental_updates
| bool ensightservice::SceneClientInit::allow_incremental_updates = 2 |
If true, EnSight is allowed/encouraged to send the minimal number of update packets. If false, the client must re-send the entire scene.
Definition at line 185 of file dynamic_scene_graph.proto.
◆ allow_spontaneous
| bool ensightservice::SceneClientInit::allow_spontaneous = 1 |
If true, EnSight is allowed to spontaneously start a scene update. If false, updates can only be initiated by the client via this message.
Definition at line 184 of file dynamic_scene_graph.proto.
◆ include_temporal_geometry
| bool ensightservice::SceneClientInit::include_temporal_geometry = 4 |
If true, request that the current temporal geometry be sent. If false, the current static view is sent.
Definition at line 187 of file dynamic_scene_graph.proto.
◆ maximum_chunk_size
| int32 ensightservice::SceneClientInit::maximum_chunk_size = 3 |
Sets the maximum payload blocksize in bytes in a single UpdateGeom message (0=unrestricted payload size).
Definition at line 186 of file dynamic_scene_graph.proto.
The documentation for this struct was generated from the following file:
- D:/Product-src/ensight/client/rpc_interface/dynamic_scene_graph.proto