    

 ## On this page

  

 

 # ensightservice::SceneClientInit Struct Reference

 Last update: 16.07.2025 

## <a id="pub-attribs" name="pub-attribs"></a>Public Attributes

bool [allow\_spontaneous](structensightservice_1_1_scene_client_init.xhtml#af8d24ffa4b58dc110e12f89f677c83f0) = 1 bool [allow\_incremental\_updates](structensightservice_1_1_scene_client_init.xhtml#af86e19a41881498e54c38c6e75aa0c76) = 2 int32 [maximum\_chunk\_size](structensightservice_1_1_scene_client_init.xhtml#a628ea445b5f241ed67b8cd1010b91c16) = 3 bool [include\_temporal\_geometry](structensightservice_1_1_scene_client_init.xhtml#aa76dee20a520300fa4fba143f7bf7d05) = 4 <a id="details" name="details"></a>## Detailed Description

This [SceneClientCommand](structensightservice_1_1_scene_client_command.xhtml "Aggregate command sent by a dynamic scene graph client.") 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](structensightservice_1_1_scene_update_command.xhtml "Aggregate command sent by EnSight to a client.") message, [UpdateSceneBegin](structensightservice_1_1_update_scene_begin.xhtml "Begin an update sequence.") sub command. The update sequence will end with a [SceneUpdateCommand](structensightservice_1_1_scene_update_command.xhtml "Aggregate command sent by EnSight to a client.") message, [UpdateSceneEnd](structensightservice_1_1_update_scene_end.xhtml "End an update sequence.") 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](dynamic__scene__graph_8proto_source.xhtml#l00183) of file [dynamic\_scene\_graph.proto](dynamic__scene__graph_8proto_source.xhtml).



## Member Data Documentation

<a id="af86e19a41881498e54c38c6e75aa0c76" name="af86e19a41881498e54c38c6e75aa0c76"></a>## [◆ ](#af86e19a41881498e54c38c6e75aa0c76)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](dynamic__scene__graph_8proto_source.xhtml#l00185) of file [dynamic\_scene\_graph.proto](dynamic__scene__graph_8proto_source.xhtml).





<a id="af8d24ffa4b58dc110e12f89f677c83f0" name="af8d24ffa4b58dc110e12f89f677c83f0"></a>## [◆ ](#af8d24ffa4b58dc110e12f89f677c83f0)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](dynamic__scene__graph_8proto_source.xhtml#l00184) of file [dynamic\_scene\_graph.proto](dynamic__scene__graph_8proto_source.xhtml).





<a id="aa76dee20a520300fa4fba143f7bf7d05" name="aa76dee20a520300fa4fba143f7bf7d05"></a>## [◆ ](#aa76dee20a520300fa4fba143f7bf7d05)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](dynamic__scene__graph_8proto_source.xhtml#l00187) of file [dynamic\_scene\_graph.proto](dynamic__scene__graph_8proto_source.xhtml).





<a id="a628ea445b5f241ed67b8cd1010b91c16" name="a628ea445b5f241ed67b8cd1010b91c16"></a>## [◆ ](#a628ea445b5f241ed67b8cd1010b91c16)maximum\_chunk\_size

 int32 ensightservice::SceneClientInit::maximum\_chunk\_size = 3

Sets the maximum payload blocksize in bytes in a single [UpdateGeom](structensightservice_1_1_update_geom.xhtml "Update a Geom entity.") message (0=unrestricted payload size).

Definition at line [186](dynamic__scene__graph_8proto_source.xhtml#l00186) of file [dynamic\_scene\_graph.proto](dynamic__scene__graph_8proto_source.xhtml).





---

The documentation for this struct was generated from the following file:- D:/Product-src/ensight/client/rpc\_interface/[dynamic\_scene\_graph.proto](dynamic__scene__graph_8proto_source.xhtml)