## On this page

  

 

 # ensight

 Last update: 16.07.2025 

<a id="l00001" name="l00001"></a> 1 // \*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*

<a id="l00002" name="l00002"></a> 2 // Copyright 2020-2022 ANSYS, Inc.

<a id="l00003" name="l00003"></a> 3 // All Rights Reserved.

<a id="l00004" name="l00004"></a> 4 //

<a id="l00005" name="l00005"></a> 5 // Restricted Rights Legend

<a id="l00006" name="l00006"></a> 6 //

<a id="l00007" name="l00007"></a> 7 // Use, duplication, or disclosure of this

<a id="l00008" name="l00008"></a> 8 // software and its documentation by the

<a id="l00009" name="l00009"></a> 9 // Government is subject to restrictions as

<a id="l00010" name="l00010"></a> 10 // set forth in subdivision \[(b)(3)(ii)\] of

<a id="l00011" name="l00011"></a> 11 // the Rights in Technical Data and Computer

<a id="l00012" name="l00012"></a> 12 // Software clause at 52.227-7013.

<a id="l00013" name="l00013"></a> 13 // \*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*

<a id="l00014" name="l00014"></a> 14 

<a id="l00015" name="l00015"></a> 15 syntax = "proto3";

<a id="l00016" name="l00016"></a> 16 

<a id="l00017" name="l00017"></a> 17 //@ingroup grpc

<a id="l00018" name="l00018"></a> 18 // gRPC service definition for the EnSight Application

<a id="l00019" name="l00019"></a>[ 19](namespaceensightservice.xhtml) 

<a id="l00020" name="l00020"></a> 20 package ensightservice;

<a id="l00021" name="l00021"></a> 21 

<a id="l00022" name="l00022"></a> 22 //@defgroup EnSightService EnSightService

<a id="l00023" name="l00023"></a> 23 //@ingroup grpc

<a id="l00024" name="l00024"></a> 24 //@brief The core EnSight gRPC service

<a id="l00025" name="l00025"></a> 25 //

<a id="l00026" name="l00026"></a> 26 // The remote EnSight command and control functions provided by the EnSight core.

<a id="l00027" name="l00027"></a> 27 // They provide access to the EnSight Python interpreter, scene geometry (via glTF blobs),

<a id="l00028" name="l00028"></a> 28 // the generated image stream and the internal event queue. Custom, special purpose 

<a id="l00029" name="l00029"></a> 29 // interfaces exist for other applications. Most of these calls require the complete

<a id="l00030" name="l00030"></a> 30 // attention of the EnSight core to perform their operations and thus will block until 

<a id="l00031" name="l00031"></a> 31 // the EnSight core becomes available. Calls that do not block in this fashion are

<a id="l00032" name="l00032"></a> 32 // marked "(non-blocking)" in their description.

<a id="l00034" name="l00034"></a> 34 service EnSightService {

<a id="l00035" name="l00035"></a> 35 //@addtogroup EnSightService

<a id="l00037" name="l00037"></a> 37  

<a id="l00038" name="l00038"></a> 38 // Run a Python command string in the EnSight Python interpreter

<a id="l00039" name="l00039"></a> 39 // @return PythonReply the result of the string

<a id="l00040" name="l00040"></a>[ 40](group___en_sight_service.xhtml#ga73690c0e3495951863406e26dd7f906b) rpc [RunPython](group___en_sight_service.xhtml#ga73690c0e3495951863406e26dd7f906b) ([PythonRequest](structensightservice_1_1_python_request.xhtml)) returns ([PythonReply](structensightservice_1_1_python_reply.xhtml)) {}

<a id="l00041" name="l00041"></a> 41 

<a id="l00042" name="l00042"></a> 42 // Render an image of the current scene

<a id="l00043" name="l00043"></a> 43 // @return RenderReply the rendered image

<a id="l00044" name="l00044"></a>[ 44](group___en_sight_service.xhtml#gadf6500961c95cd701020e5c8d2005138) rpc [RenderImage](group___en_sight_service.xhtml#gadf6500961c95cd701020e5c8d2005138) ([RenderRequest](structensightservice_1_1_render_request.xhtml)) returns ([RenderReply](structensightservice_1_1_render_reply.xhtml)) {}

<a id="l00045" name="l00045"></a> 45 

<a id="l00046" name="l00046"></a> 46 // Return current scene geometry representation

<a id="l00047" name="l00047"></a> 47 // @return GeometryReply the current scene geometry in glTF format

<a id="l00048" name="l00048"></a>[ 48](group___en_sight_service.xhtml#gafa5fd7a25231c0b93591f681c3679d3b) rpc [GetGeometry](group___en_sight_service.xhtml#gafa5fd7a25231c0b93591f681c3679d3b) ([GeometryRequest](structensightservice_1_1_geometry_request.xhtml)) returns ([GeometryReply](structensightservice_1_1_geometry_reply.xhtml)) {}

<a id="l00049" name="l00049"></a> 49 

<a id="l00050" name="l00050"></a> 50 // Shutdown EnSight session

<a id="l00051" name="l00051"></a> 51 // @return ExitReply an acknowledgment from the EnSight server

<a id="l00052" name="l00052"></a>[ 52](group___en_sight_service.xhtml#gaa5a89ed87c59689f8be8dbfa474323d4) rpc [Exit](group___en_sight_service.xhtml#gaa5a89ed87c59689f8be8dbfa474323d4) ([ExitRequest](structensightservice_1_1_exit_request.xhtml)) returns ([ExitReply](structensightservice_1_1_exit_reply.xhtml)) {}

<a id="l00053" name="l00053"></a> 53 

<a id="l00054" name="l00054"></a> 54 // Enable a filtered stream of callback events from the EnSight session (non-blocking)

<a id="l00055" name="l00055"></a> 55 //

<a id="l00056" name="l00056"></a> 56 // EnSight supports a callback registration system that can associate a callback with

<a id="l00057" name="l00057"></a> 57 // with any attribute change in the client. This is the ensight.objs.addcallback()

<a id="l00058" name="l00058"></a> 58 // Python call. For example:

<a id="l00059" name="l00059"></a> 59 // ~~~~~~~~~~~~~~~{.py}

<a id="l00060" name="l00060"></a> 60 // ensight.objs.addcallback(ensight.objs.core, None, prefix+"PARTLIST\_CHANGED", 

<a id="l00061" name="l00061"></a> 61 // attrs=\['PARTS'\], flags=ensight.objs.EVENTMAP\_FLAG\_COMP\_GLOBAL)

<a id="l00062" name="l00062"></a> 62 // ~~~~~~~~~~~~~~~

<a id="l00063" name="l00063"></a> 63 // will register a callback event associated with any changes in the ensight.objs.core.PARTS

<a id="l00064" name="l00064"></a> 64 // attribute. When this happens, EnSight will emit an event with the string 

<a id="l00065" name="l00065"></a> 65 // "prefix+'PARTLIST\_CHANGED'". The gRPC interface enables a stream of these event strings

<a id="l00066" name="l00066"></a> 66 // to be returned to the calling application in EventReply messages. It also provides a 

<a id="l00067" name="l00067"></a> 67 // simple prefix filter, so that only messages that start with the specific prefix will be 

<a id="l00068" name="l00068"></a> 68 // returned on the event stream. This prefix is passed in the EventStreamRequest message.

<a id="l00069" name="l00069"></a> 69 // @return EventReply a stream of EventReply messages for each emitted event

<a id="l00070" name="l00070"></a>[ 70](group___en_sight_service.xhtml#gab64a0bc516588def314e022736cc1dcc) rpc [GetEventStream](group___en_sight_service.xhtml#gab64a0bc516588def314e022736cc1dcc) ([EventStreamRequest](structensightservice_1_1_event_stream_request.xhtml)) returns (stream [EventReply](structensightservice_1_1_event_reply.xhtml)) {}

<a id="l00071" name="l00071"></a> 71 

<a id="l00072" name="l00072"></a> 72 // Subscribe to the EnSight event stream via reverse gRPC connection (non-blocking)

<a id="l00073" name="l00073"></a> 73 //

<a id="l00074" name="l00074"></a> 74 // Some gRPC clients have demonstrated problems maintaining a continuous EventReply 

<a id="l00075" name="l00075"></a> 75 // stream. For these clients, it is possible for the client to reverse the gRPC 

<a id="l00076" name="l00076"></a> 76 // connection so EnSight will make gRPC calls back to the client. In this case,

<a id="l00077" name="l00077"></a> 77 // the client application will start an \\ref EnSightSubscription service and inform

<a id="l00078" name="l00078"></a> 78 // EnSight of how to connect to it via SubscribeEventOptions. EnSight will then

<a id="l00079" name="l00079"></a> 79 // make PublishEvent calls with the EventReply messages

<a id="l00080" name="l00080"></a> 80 // it would have used in the GetEventStream() configuration.

<a id="l00081" name="l00081"></a>[ 81](group___en_sight_service.xhtml#gab466da93dfd6027a2a6dbe5df6902189) rpc [SubscribeEvents](group___en_sight_service.xhtml#gab466da93dfd6027a2a6dbe5df6902189) ([SubscribeEventOptions](structensightservice_1_1_subscribe_event_options.xhtml)) returns ([GenericResponse](structensightservice_1_1_generic_response.xhtml)) {}

<a id="l00082" name="l00082"></a> 82 

<a id="l00083" name="l00083"></a> 83 // Subscribe to the EnSight image stream via reverse gRPC connection (non-blocking)

<a id="l00084" name="l00084"></a> 84 //

<a id="l00085" name="l00085"></a> 85 // Some gRPC clients have demonstrated problems maintaining a continuous ImageReply 

<a id="l00086" name="l00086"></a> 86 // stream. For these clients, it is possible for the client to reverse the gRPC 

<a id="l00087" name="l00087"></a> 87 // connection so EnSight will make gRPC calls back to the client. In this case,

<a id="l00088" name="l00088"></a> 88 // the client application will start an \\ref EnSightSubscription service and inform

<a id="l00089" name="l00089"></a> 89 // EnSight of how to connect to it via SubscribeImageOptions. EnSight will then

<a id="l00090" name="l00090"></a> 90 // make PublishImage calls with a short lived (single image frame) ImageReply message

<a id="l00091" name="l00091"></a> 91 // stream it would have used in the GetEventStream() configuration. EnSight will

<a id="l00092" name="l00092"></a> 92 // make a separate PublishImage call for every frame of imagery it generates.

<a id="l00093" name="l00093"></a>[ 93](group___en_sight_service.xhtml#ga6295c516b8a271034e9ee785991c2e7b) rpc [SubscribeImages](group___en_sight_service.xhtml#ga6295c516b8a271034e9ee785991c2e7b) ([SubscribeImageOptions](structensightservice_1_1_subscribe_image_options.xhtml)) returns ([GenericResponse](structensightservice_1_1_generic_response.xhtml)) {}

<a id="l00094" name="l00094"></a> 94 

<a id="l00095" name="l00095"></a> 95 // Discontinue a previous established stream subscription (non-blocking)

<a id="l00096" name="l00096"></a> 96 //

<a id="l00097" name="l00097"></a> 97 // This call will cause EnSight to stop making gRPC calls to the client gRPC server

<a id="l00098" name="l00098"></a> 98 // associated with the prefix string. It can be used to stop a SubscribeEvents() or 

<a id="l00099" name="l00099"></a> 99 // SubscribeImages() call.

<a id="l00100" name="l00100"></a>[ 100](group___en_sight_service.xhtml#ga9161e678fe3d7608820907269d55bf8c) rpc [Unsubscribe](group___en_sight_service.xhtml#ga9161e678fe3d7608820907269d55bf8c) ([Prefix](structensightservice_1_1_prefix.xhtml)) returns ([GenericResponse](structensightservice_1_1_generic_response.xhtml)) {}

<a id="l00101" name="l00101"></a> 101 

<a id="l00102" name="l00102"></a> 102 // Enable a stream of rendered images from the EnSight session (non-blocking)

<a id="l00103" name="l00103"></a> 103 //

<a id="l00104" name="l00104"></a> 104 // A stream of the images rendered by EnSight.

<a id="l00105" name="l00105"></a> 105 // @return ImageReply a stream of ImageReply messages for each image rendered

<a id="l00106" name="l00106"></a>[ 106](group___en_sight_service.xhtml#gaec3249209f41b4042cd2c24ba7f11024) rpc [GetImageStream](group___en_sight_service.xhtml#gaec3249209f41b4042cd2c24ba7f11024) ([ImageStreamRequest](structensightservice_1_1_image_stream_request.xhtml)) returns (stream [ImageReply](structensightservice_1_1_image_reply.xhtml)) {}

<a id="l00107" name="l00107"></a> 107 

<a id="l00108" name="l00108"></a> 108 // An interface to save an image or animation

<a id="l00109" name="l00109"></a> 109 // @return AnimSaveReply

<a id="l00110" name="l00110"></a>[ 110](group___en_sight_service.xhtml#ga9235533bdc45ad02be7cbed281eaca37) rpc [AnimSave](group___en_sight_service.xhtml#ga9235533bdc45ad02be7cbed281eaca37) ([AnimSaveRequest](structensightservice_1_1_anim_save_request.xhtml)) returns ([AnimSaveReply](structensightservice_1_1_anim_save_reply.xhtml)) {}

<a id="l00111" name="l00111"></a> 111 

<a id="l00112" name="l00112"></a> 112 // An interface to query the progress an animation being saved

<a id="l00113" name="l00113"></a> 113 // @return AnimQueryProgressReply describing progress toward completion

<a id="l00114" name="l00114"></a>[ 114](group___en_sight_service.xhtml#ga571dc2c8bebe8c38e011cb4f3a3d5b0d) rpc [AnimQueryProgress](group___en_sight_service.xhtml#ga571dc2c8bebe8c38e011cb4f3a3d5b0d) ([AnimQueryProgressRequest](structensightservice_1_1_anim_query_progress_request.xhtml)) returns ([AnimQueryProgressReply](structensightservice_1_1_anim_query_progress_reply.xhtml)) {}

<a id="l00115" name="l00115"></a> 115 

<a id="l00117" name="l00117"></a> 117 }

<a id="l00119" name="l00119"></a> 119 

<a id="l00120" name="l00120"></a> 120 //@defgroup EnSightSubscription EnSightSubscription

<a id="l00121" name="l00121"></a> 121 //@ingroup grpc

<a id="l00122" name="l00122"></a> 122 //@brief Client-side, reverse gRPC service

<a id="l00123" name="l00123"></a> 123 //

<a id="l00124" name="l00124"></a> 124 // Definition of the client-side, reverse gRPC service that EnSight 

<a id="l00125" name="l00125"></a> 125 // will connect to in response to a stream subscription request.

<a id="l00127" name="l00127"></a> 127 service EnSightSubscription {

<a id="l00128" name="l00128"></a> 128 //@addtogroup EnSightSubscription

<a id="l00130" name="l00130"></a> 130  

<a id="l00131" name="l00131"></a> 131 // Publish a single image (possibly in chucks) to the remote server

<a id="l00132" name="l00132"></a> 132 // @param ImageReply The stream of ImageReply objects

<a id="l00133" name="l00133"></a> 133 // @return GenericResponse

<a id="l00134" name="l00134"></a> 134 rpc [PublishImage](group___en_sight_subscription.xhtml#ga052334cb4098295f08b649151eb24320)(stream ImageReply) returns (GenericResponse) {}

<a id="l00135" name="l00135"></a> 135 

<a id="l00136" name="l00136"></a>[ 136](group___en_sight_subscription.xhtml#ga052334cb4098295f08b649151eb24320) // Publish an event to the remote server

<a id="l00137" name="l00137"></a> 137 // @return GenericResponse

<a id="l00138" name="l00138"></a> 138 rpc [PublishEvent](group___en_sight_subscription.xhtml#gaaded4bebe805118acaa44365183c2586)([EventReply](structensightservice_1_1_event_reply.xhtml)) returns ([GenericResponse](structensightservice_1_1_generic_response.xhtml)) {}

<a id="l00139" name="l00139"></a> 139 

<a id="l00141" name="l00141"></a> 141 }

<a id="l00143" name="l00143"></a> 143 

<a id="l00144" name="l00144"></a> 144 

<a id="l00145" name="l00145"></a> 145 // The generic return value for an EnSightSubscription rpc call

<a id="l00146" name="l00146"></a> 146 message GenericResponse {

<a id="l00147" name="l00147"></a> 147 string str = 1; // Generic return string

<a id="l00148" name="l00148"></a>[ 148](structensightservice_1_1_generic_response.xhtml) }

<a id="l00149" name="l00149"></a>[ 149](structensightservice_1_1_generic_response.xhtml#a0ca4eb2922396b33ad6e2ef4465081e3) 

<a id="l00150" name="l00150"></a> 150 // The prefix to be Unsubscribe

<a id="l00151" name="l00151"></a> 151 message [Prefix](structensightservice_1_1_prefix.xhtml) {

<a id="l00152" name="l00152"></a> 152 string prefix = 1; // The subscription prefix passed in SubscribeEventOptions or SubscribeImageOptions

<a id="l00153" name="l00153"></a>[ 153](structensightservice_1_1_prefix.xhtml) }

<a id="l00154" name="l00154"></a>[ 154](structensightservice_1_1_prefix.xhtml#ab157818111d057540b175af7f0f77292) 

<a id="l00155" name="l00155"></a> 155 

<a id="l00156" name="l00156"></a> 156 // The event subscription options 

<a id="l00157" name="l00157"></a> 157 message [SubscribeEventOptions](structensightservice_1_1_subscribe_event_options.xhtml) {

<a id="l00158" name="l00158"></a>[ 158](structensightservice_1_1_subscribe_event_options.xhtml) // @brief Subscription channel type

<a id="l00159" name="l00159"></a> 159 // Presently, only image subscriptions are supported

<a id="l00160" name="l00160"></a> 160 enum [ChannelType](structensightservice_1_1_subscribe_event_options.xhtml#a40c27f449a1bef4be2896c9ddabc33ec) {

<a id="l00161" name="l00161"></a> 161 GRPC = 0; // EnSight should use gRPC PublishEvent() to send the events back to the client

<a id="l00162" name="l00162"></a>[ 162](structensightservice_1_1_subscribe_event_options.xhtml#a40c27f449a1bef4be2896c9ddabc33ec) }

<a id="l00163" name="l00163"></a>[ 163](structensightservice_1_1_subscribe_event_options.xhtml#a40c27f449a1bef4be2896c9ddabc33ecac76af920867bae3f2205d0257ed35248) string prefix = 1; // A unique prefix string (perhaps a GUID) used to identify this stream (used by Unsubscribe())

<a id="l00164" name="l00164"></a> 164 [ChannelType](structensightservice_1_1_subscribe_event_options.xhtml#a40c27f449a1bef4be2896c9ddabc33ec) type = 2; // The EventReply transport mechanism (GRPC)

<a id="l00165" name="l00165"></a>[ 165](structensightservice_1_1_subscribe_event_options.xhtml#a082993f0eb40371edb50a17748c35478) // @brief various type specific options

<a id="l00166" name="l00166"></a>[ 166](structensightservice_1_1_subscribe_event_options.xhtml#a48a6a952356ad524def1932913f05dd0) //

<a id="l00167" name="l00167"></a> 167 // For type=ChannelType::GRPC, 'uri' map key contains the URI for the server launched by the client (required). 'num\_retries' map

<a id="l00168" name="l00168"></a> 168 // key is the number of times EnSight should attempt to connect before failing the operation. 'shared\_secret' map

<a id="l00169" name="l00169"></a> 169 // key is the shared secret that the client gRPC server is expecting to see to authenticate a connection.

<a id="l00170" name="l00170"></a> 170 map&lt;string, string&gt; options = 3;

<a id="l00171" name="l00171"></a> 171 }

<a id="l00172" name="l00172"></a> 172 

<a id="l00173" name="l00173"></a>[ 173](structensightservice_1_1_subscribe_event_options.xhtml#a9fea05c94fe1c3d637193793a4c27ccb) 

<a id="l00174" name="l00174"></a> 174 // The image subscription options

<a id="l00175" name="l00175"></a> 175 message [SubscribeImageOptions](structensightservice_1_1_subscribe_image_options.xhtml) {

<a id="l00176" name="l00176"></a> 176 // @brief Image channel type

<a id="l00177" name="l00177"></a>[ 177](structensightservice_1_1_subscribe_image_options.xhtml) // The image subscription can be via gRPC protocol or via shared memory transport

<a id="l00178" name="l00178"></a> 178 enum [ChannelType](structensightservice_1_1_subscribe_image_options.xhtml#afa81ebc38c1801fe0f3ae7262798d340) {

<a id="l00179" name="l00179"></a> 179 GRPC = 0; // EnSight should use gRPC PublishImage() calls to send images back to the client

<a id="l00180" name="l00180"></a> 180 SHARED_MEM = 1; // EnSight should use a \\ref SharedMemoryImageStream to send images back to the client

<a id="l00181" name="l00181"></a>[ 181](structensightservice_1_1_subscribe_image_options.xhtml#afa81ebc38c1801fe0f3ae7262798d340) }

<a id="l00182" name="l00182"></a>[ 182](structensightservice_1_1_subscribe_image_options.xhtml#afa81ebc38c1801fe0f3ae7262798d340a74944b7a7e1ad133402aa6e048dfe4c6) string prefix = 1; // A unique prefix string (perhaps a GUID) used to identify this stream (used by Unsubscribe())

<a id="l00183" name="l00183"></a>[ 183](structensightservice_1_1_subscribe_image_options.xhtml#afa81ebc38c1801fe0f3ae7262798d340ad27444fa0b847e6156e29260e99b32c8) [ChannelType](structensightservice_1_1_subscribe_image_options.xhtml#afa81ebc38c1801fe0f3ae7262798d340) type = 2; // Select GRPC or SHARED\_MEM transport

<a id="l00184" name="l00184"></a> 184 bool flip_vertical = 3; // If true, flip the image over the X axis before sending the image

<a id="l00185" name="l00185"></a>[ 185](structensightservice_1_1_subscribe_image_options.xhtml#a3c11161da5e7dd00b8c3930651329d9b) bool chunk = 4; // Set to send images in 1MB chunks to speed up large (&gt;1MB) image transfers (see ImageStreamRequest and ImageReply)

<a id="l00186" name="l00186"></a>[ 186](structensightservice_1_1_subscribe_image_options.xhtml#a5542ba033c19b9319e825ae01861617b) // @brief various type specific options

<a id="l00187" name="l00187"></a>[ 187](structensightservice_1_1_subscribe_image_options.xhtml#a5e15879112029f4c126e615d42ef2fdd) //

<a id="l00188" name="l00188"></a>[ 188](structensightservice_1_1_subscribe_image_options.xhtml#a04eab75e486e8586ce9e434596190fa0) // For type=GRPC, 'uri' map key contains the URI for the server launched by the client (required). 'num\_retries' map

<a id="l00189" name="l00189"></a> 189 // key is the number of times EnSight should attempt to connect before failing the operation. 'shared\_secret' map

<a id="l00190" name="l00190"></a> 190 // key is the shared secret that the client gRPC server is expecting to see to authenticate a connection.

<a id="l00191" name="l00191"></a> 191 //

<a id="l00192" name="l00192"></a> 192 // For type=SHARED\_MEM, 'filename' map key contains the name of local file to be used

<a id="l00193" name="l00193"></a> 193 // as the memory mapped shared memory block (required).

<a id="l00194" name="l00194"></a> 194 map&lt;string, string&gt; options = 5; 

<a id="l00195" name="l00195"></a> 195 }

<a id="l00196" name="l00196"></a> 196 

<a id="l00197" name="l00197"></a> 197 // A string to execute in the EnSight Python interpreter and execution options

<a id="l00198" name="l00198"></a>[ 198](structensightservice_1_1_subscribe_image_options.xhtml#a9915819de6a6c41c9710a2d811fb3cb6) message [PythonRequest](structensightservice_1_1_python_request.xhtml) {

<a id="l00199" name="l00199"></a> 199 // @brief Specify the execution type and return value for the Python command

<a id="l00200" name="l00200"></a> 200 enum CmdType {

<a id="l00201" name="l00201"></a> 201 EXEC_NO_RESULT = 0; // Run the command with exec() with no return value

<a id="l00202" name="l00202"></a>[ 202](structensightservice_1_1_python_request.xhtml) EXEC_RETURN_PYTHON = 1; // Run the string using eval() and return the resulting Python object via Python repr()

<a id="l00203" name="l00203"></a> 203 EXEC_RETURN_JSON = 2; // Run the string using eval() and return the resulting Python object encoded via json

<a id="l00204" name="l00204"></a> 204 }

<a id="l00205" name="l00205"></a>[ 205](structensightservice_1_1_python_request.xhtml#a5b38efa006c583052c1fd92c01811b4c) [CmdType](structensightservice_1_1_python_request.xhtml#a5b38efa006c583052c1fd92c01811b4c) type = 1; // Specify how the string should be executed and what the return value should be

<a id="l00206" name="l00206"></a>[ 206](structensightservice_1_1_python_request.xhtml#a5b38efa006c583052c1fd92c01811b4caa457d5ed12f0a22855fc9cbf11ab8f12) string command = 2; // UTF8 encoded string to be exec() or eval() by the EnSight Python interpreter

<a id="l00207" name="l00207"></a>[ 207](structensightservice_1_1_python_request.xhtml#a5b38efa006c583052c1fd92c01811b4caf7efb6586d41f7ef06f9430899dccf33) }

<a id="l00208" name="l00208"></a>[ 208](structensightservice_1_1_python_request.xhtml#a5b38efa006c583052c1fd92c01811b4ca3d0d8c2e0e4e07259828979638233e5d) 

<a id="l00209" name="l00209"></a> 209 // The result of executing a Python string in EnSight

<a id="l00210" name="l00210"></a>[ 210](structensightservice_1_1_python_request.xhtml#a69df81025a161dbe3efbb1ce5be37951) message [PythonReply](structensightservice_1_1_python_reply.xhtml) {

<a id="l00211" name="l00211"></a>[ 211](structensightservice_1_1_python_request.xhtml#ae6161a1f28bc6b6d0774346cea096b05) string value = 1; // UTF8 encoded string, the repr() or json representation of the evaluated expression depending on the PythonRequest::CmdType specified

<a id="l00212" name="l00212"></a> 212 int32 error = 2; // If error &lt; 0 an error occurred

<a id="l00213" name="l00213"></a> 213 }

<a id="l00214" name="l00214"></a> 214 

<a id="l00215" name="l00215"></a>[ 215](structensightservice_1_1_python_reply.xhtml) // Control options for a single image render request

<a id="l00216" name="l00216"></a>[ 216](structensightservice_1_1_python_reply.xhtml#a4a877b8be80e175c8a6f2f70fd7de0d6) message [RenderRequest](structensightservice_1_1_render_request.xhtml) {

<a id="l00217" name="l00217"></a>[ 217](structensightservice_1_1_python_reply.xhtml#a31138ba0be4a2af567e317a29c8b4b90) // @brief Specify the return type of the rendering request

<a id="l00218" name="l00218"></a> 218 enum RenderType {

<a id="l00219" name="l00219"></a> 219 IMAGE_PNG = 0; // The returned image will be encoded into the PNG image file format and returned as an array of bytes.

<a id="l00220" name="l00220"></a> 220 IMAGE_RAW = 1; // The returned value be in raw binary bytes: RGBRGBRGB... width\*height\*3 bytes total

<a id="l00221" name="l00221"></a>[ 221](structensightservice_1_1_render_request.xhtml) }

<a id="l00222" name="l00222"></a> 222 RenderType type = 1; // Select the format the returned image should be in.

<a id="l00223" name="l00223"></a> 223 int32 image_width = 2; // The desired image width in pixels

<a id="l00224" name="l00224"></a>[ 224](structensightservice_1_1_render_request.xhtml#a98477acc54de7574602f36ed266c4122) int32 image_height = 3; // The desired image height in pixels

<a id="l00225" name="l00225"></a>[ 225](structensightservice_1_1_render_request.xhtml#a98477acc54de7574602f36ed266c4122a24ca50772e6eb62831dc1b5859234328) int32 image_aa_passes = 4; // The number of anti-aliasing passes to be applied

<a id="l00226" name="l00226"></a>[ 226](structensightservice_1_1_render_request.xhtml#a98477acc54de7574602f36ed266c4122a1984c4e599cd46467c28ae82a91893d8) bool include_highlighting = 5; // If true, any dynamic overlay will be included in the rendered image

<a id="l00227" name="l00227"></a> 227 }

<a id="l00228" name="l00228"></a>[ 228](structensightservice_1_1_render_request.xhtml#aefa3944f221f219bddc1b996d41ce3f6) 

<a id="l00229" name="l00229"></a>[ 229](structensightservice_1_1_render_request.xhtml#acc1fccf32ccf502623426d71bd90c4f0) // The returned, rendered image

<a id="l00230" name="l00230"></a>[ 230](structensightservice_1_1_render_request.xhtml#af8d0600e4baa6e53e760b4ab65fcebd8) message [RenderReply](structensightservice_1_1_render_reply.xhtml) {

<a id="l00231" name="l00231"></a>[ 231](structensightservice_1_1_render_request.xhtml#af5e5b4a7e1a519149f50a6a6f980f34a) bytes value = 1; // An array of byte representing the image. See RenderRequest::RenderType for the specific format.

<a id="l00232" name="l00232"></a>[ 232](structensightservice_1_1_render_request.xhtml#a7c270f2115888abd7d06fdbf6966ad93) }

<a id="l00233" name="l00233"></a> 233 

<a id="l00234" name="l00234"></a> 234 

<a id="l00235" name="l00235"></a> 235 // Request that an image or animation be saved. 

<a id="l00236" name="l00236"></a>[ 236](structensightservice_1_1_render_reply.xhtml) // If saving an animation, and format is an image format like png, save multiple images 

<a id="l00237" name="l00237"></a>[ 237](structensightservice_1_1_render_reply.xhtml#a04df8b7984ad443e75c009c95e157b39) // and insert an index like "\_0003" into the file name before the extension.

<a id="l00238" name="l00238"></a> 238 // If saving one frame in an animation format, a one-frame movie will be written.

<a id="l00239" name="l00239"></a> 239 // Valid anim formats: .mp4, .avi, .mov

<a id="l00240" name="l00240"></a> 240 // Valid image formats: .png, .tif/.tiff, .jpg/.jpeg, .ppm

<a id="l00241" name="l00241"></a> 241 // 

<a id="l00242" name="l00242"></a> 242 // Format Option name Value Notes

<a id="l00243" name="l00243"></a> 243 // mp4: Quality Best|High|Medium|Low default: High

<a id="l00244" name="l00244"></a> 244 // Type 0|1 default: 1 1 for H.264, 0 for non-H.264

<a id="l00245" name="l00245"></a> 245 // avi: Compression MJPEG|RAW|MPEG4V2 default: MPEG4V2

<a id="l00246" name="l00246"></a> 246 // BitRate (a value between 0 and 80000) default: 20000 kbits/sec 

<a id="l00247" name="l00247"></a> 247 // mov: BitRate (a value between 0 and 80000) default: 20000 kbits/sec 

<a id="l00248" name="l00248"></a> 248 // png: Compression None|Fast|Best|Default default: Default (zlib compression setting)

<a id="l00249" name="l00249"></a> 249 // tif: Compression None|PackBits|Deflate default: PackBits

<a id="l00250" name="l00250"></a> 250 // jpg: Quality (a value between 0 and 100) default: 75

<a id="l00251" name="l00251"></a> 251 // ppm: Format Binary|Ascii default: Binary

<a id="l00252" name="l00252"></a> 252 message [AnimSaveRequest](structensightservice_1_1_anim_save_request.xhtml) {

<a id="l00253" name="l00253"></a> 253 string id = 1; // Handle used to query progress or cancel a save. Any unique string, provided by the caller.

<a id="l00254" name="l00254"></a> 254 string filename = 2; // Name of file to save. Format determined from file extension. Defaults to .mp4 or .png with no file extension. UTF8 encoding. Existing files are overwritten.

<a id="l00255" name="l00255"></a> 255 map&lt;string, string&gt; format_options = 3; // Options specific to certain formats, as (option\_name, value) pairs

<a id="l00256" name="l00256"></a> 256 uint32 width = 4; // Image width. 0 means current window width.

<a id="l00257" name="l00257"></a>[ 257](structensightservice_1_1_anim_save_request.xhtml) uint32 height = 5; // Image height. 0 means current window height.

<a id="l00258" name="l00258"></a>[ 258](structensightservice_1_1_anim_save_request.xhtml#af913dc443e4fd1144801f856371e8382) uint32 aa_passes = 6; // Num anti-aliasing passes. 0 uses EnSight default 4-pass antialiasing.

<a id="l00259" name="l00259"></a>[ 259](structensightservice_1_1_anim_save_request.xhtml#aed89c5bf60803520c1913f57fd3f4e24) bool white_background = 7; // If True, set background to white, and change text and misc colors to black as necessary. Restore all, after save. If False, leave all colors as they are.

<a id="l00260" name="l00260"></a>[ 260](structensightservice_1_1_anim_save_request.xhtml#a3c8150118e98048a89dfccc01bf425e8) int32 start_frame = 8; // First frame to save. 0-based. -1 special value that means the current timestep

<a id="l00261" name="l00261"></a>[ 261](structensightservice_1_1_anim_save_request.xhtml#aea93ee30169d4bcf0ec93a8d8b9f4c17) int32 num_frames = 9; // Num frames to save. -1 special value that means all timesteps. num\_frames &gt; num timesteps allows multiple cycles through time.

<a id="l00262" name="l00262"></a>[ 262](structensightservice_1_1_anim_save_request.xhtml#a8e87977a7346548017e762bec03a735c) float fps = 10; // Frames/sec. Ignored if saving an image.

<a id="l00263" name="l00263"></a>[ 263](structensightservice_1_1_anim_save_request.xhtml#a44c9d1da2cba6eca416d718bff933721) }

<a id="l00264" name="l00264"></a>[ 264](structensightservice_1_1_anim_save_request.xhtml#a0edbc19bd0f34f98ac52b430047e69f1) // Reply to request to save an image or animation

<a id="l00265" name="l00265"></a>[ 265](structensightservice_1_1_anim_save_request.xhtml#a60bc3fb7914b4e44127e342d2ec214c9) message [AnimSaveReply](structensightservice_1_1_anim_save_reply.xhtml) {

<a id="l00266" name="l00266"></a>[ 266](structensightservice_1_1_anim_save_request.xhtml#af4c8190c87265afdaf18c26a40110016) }

<a id="l00267" name="l00267"></a>[ 267](structensightservice_1_1_anim_save_request.xhtml#a3108fd76dfcc451879339f6c99a01ce0) 

<a id="l00268" name="l00268"></a> 268 // Query the progress of an animation being saved. This can be called while AnimSaveRequest is in progress

<a id="l00269" name="l00269"></a> 269 message [AnimQueryProgressRequest](structensightservice_1_1_anim_query_progress_request.xhtml) {

<a id="l00270" name="l00270"></a> 270 string id = 1; // Handle for the save operation, same as in the request

<a id="l00271" name="l00271"></a>[ 271](structensightservice_1_1_anim_save_reply.xhtml) bool cancel = 2; // If True, request cancellation of the save. 

<a id="l00272" name="l00272"></a> 272 }

<a id="l00273" name="l00273"></a> 273 // Reply to query of animation progress

<a id="l00274" name="l00274"></a> 274 message [AnimQueryProgressReply](structensightservice_1_1_anim_query_progress_reply.xhtml) {

<a id="l00275" name="l00275"></a>[ 275](structensightservice_1_1_anim_query_progress_request.xhtml) // @brief The current status of the animation rendering operation

<a id="l00276" name="l00276"></a>[ 276](structensightservice_1_1_anim_query_progress_request.xhtml#af373d49350a69dd84c35f4bdf3bca2bf) enum Status {

<a id="l00277" name="l00277"></a>[ 277](structensightservice_1_1_anim_query_progress_request.xhtml#a73eee2f395467b3961eef8422ee0fc06) IN_PROGRESS = 0; // Saving

<a id="l00278" name="l00278"></a> 278 COMPLETE = 1; // Successfully completed. 

<a id="l00279" name="l00279"></a> 279 CANCEL_REQUESTED = 2; // Cancellation requested, but not yet cancelled

<a id="l00280" name="l00280"></a> 280 CANCELLED = 3; // Cancellation completed

<a id="l00281" name="l00281"></a>[ 281](structensightservice_1_1_anim_query_progress_reply.xhtml) WRITE_ERROR = 4; // Animation could not be saved - file not writable, output size too big, ...

<a id="l00282" name="l00282"></a> 282 }

<a id="l00283" name="l00283"></a> 283 string id = 1; // Handle for the save operation, same as in the request

<a id="l00284" name="l00284"></a>[ 284](structensightservice_1_1_anim_query_progress_reply.xhtml#acf97ca8571bba823e4a3449a749fa7d3) uint32 num_frames_finished = 2; // Is 0 at first, will be equal to num\_frames when finished.

<a id="l00285" name="l00285"></a>[ 285](structensightservice_1_1_anim_query_progress_reply.xhtml#acf97ca8571bba823e4a3449a749fa7d3a8d5bd7ab98f75ad9075c688fed50b624) uint32 num_frames = 3; // Same as num\_frames in request, unless num\_frames in request == -1.

<a id="l00286" name="l00286"></a>[ 286](structensightservice_1_1_anim_query_progress_reply.xhtml#acf97ca8571bba823e4a3449a749fa7d3ad4088e7f9222e0c7c7dac02ebf67e633) [Status](structensightservice_1_1_anim_query_progress_reply.xhtml#acf97ca8571bba823e4a3449a749fa7d3) status = 4; // If 'cancel' is True in the request, but the anim had already completed or errored out, returned status is COMPLETE or ERROR

<a id="l00287" name="l00287"></a>[ 287](structensightservice_1_1_anim_query_progress_reply.xhtml#acf97ca8571bba823e4a3449a749fa7d3a0f42169fcc38699ccba3da0020ca89ad) string error_msg = 5; // If the status==WRITE\_ERROR, the error message

<a id="l00288" name="l00288"></a>[ 288](structensightservice_1_1_anim_query_progress_reply.xhtml#acf97ca8571bba823e4a3449a749fa7d3a61f072e6d795f6d19ae9478520aee776) }

<a id="l00289" name="l00289"></a>[ 289](structensightservice_1_1_anim_query_progress_reply.xhtml#acf97ca8571bba823e4a3449a749fa7d3a833167b5ad8686ad147784dff9cb4256) 

<a id="l00290" name="l00290"></a> 290 

<a id="l00291" name="l00291"></a>[ 291](structensightservice_1_1_anim_query_progress_reply.xhtml#af63f10e954b89055deca8728fb274c83) // Control options for a geometry pull request

<a id="l00292" name="l00292"></a>[ 292](structensightservice_1_1_anim_query_progress_reply.xhtml#aaa25eee1d9e5f2b5358ed71d9098f870) message [GeometryRequest](structensightservice_1_1_geometry_request.xhtml) {

<a id="l00293" name="l00293"></a>[ 293](structensightservice_1_1_anim_query_progress_reply.xhtml#a25531173d585182fd80d864580b8b89b) // @brief select the format of the geometry reqquest

<a id="l00294" name="l00294"></a>[ 294](structensightservice_1_1_anim_query_progress_reply.xhtml#a4d9e6cf495beafbed3f444a673e14820) enum GeometryType {

<a id="l00295" name="l00295"></a>[ 295](structensightservice_1_1_anim_query_progress_reply.xhtml#af59568db7fe2d5d8a358af9a9d2973fd) GEOMETRY_GLB = 0; // The returned geometry is returned as an in-memory glTF encoded file

<a id="l00296" name="l00296"></a> 296 }

<a id="l00297" name="l00297"></a> 297 GeometryType type = 1; // The format the geometry data should be returned in.

<a id="l00298" name="l00298"></a> 298 }

<a id="l00299" name="l00299"></a>[ 299](structensightservice_1_1_geometry_request.xhtml) 

<a id="l00300" name="l00300"></a> 300 // The returned geometry request payload

<a id="l00301" name="l00301"></a> 301 message [GeometryReply](structensightservice_1_1_geometry_reply.xhtml) {

<a id="l00302" name="l00302"></a>[ 302](structensightservice_1_1_geometry_request.xhtml#a6dfcd12a837a513b553fd3a9f26a1949) bytes value = 1; // a binary array containing the geometry in the format specified by GeometryRequest::GeometryType

<a id="l00303" name="l00303"></a>[ 303](structensightservice_1_1_geometry_request.xhtml#a6dfcd12a837a513b553fd3a9f26a1949a573d6f6381c7608c4d822817e9048e1b) }

<a id="l00304" name="l00304"></a> 304 

<a id="l00305" name="l00305"></a>[ 305](structensightservice_1_1_geometry_request.xhtml#a66eb5611c0387f5e3440d0b3a24408a0) // Request that the EnSight server shut down

<a id="l00306" name="l00306"></a> 306 message [ExitRequest](structensightservice_1_1_exit_request.xhtml) {

<a id="l00307" name="l00307"></a> 307 }

<a id="l00308" name="l00308"></a> 308 

<a id="l00309" name="l00309"></a>[ 309](structensightservice_1_1_geometry_reply.xhtml) // The value returned by an ExitRequest rpc call

<a id="l00310" name="l00310"></a>[ 310](structensightservice_1_1_geometry_reply.xhtml#a0db2ff8e58afa9f66cb1d5dd2f793435) // Note: it is not uncommon for the ExitRequest call to return a gRPC error due to shutdown race conditions.

<a id="l00311" name="l00311"></a> 311 message [ExitReply](structensightservice_1_1_exit_reply.xhtml) {

<a id="l00312" name="l00312"></a> 312 }

<a id="l00313" name="l00313"></a> 313 

<a id="l00314" name="l00314"></a>[ 314](structensightservice_1_1_exit_request.xhtml) // @brief Request the start of an image stream

<a id="l00315" name="l00315"></a> 315 //

<a id="l00316" name="l00316"></a> 316 // This message dictates the form of the ImageReply messages. One can have the images flipped vertically

<a id="l00317" name="l00317"></a> 317 // and can optionally chunk an entire image frame into multiple ImageReply messages. Empirical measurements

<a id="l00318" name="l00318"></a> 318 // demonstrate that gRPC can transfer smaller blocks of pixels faster that larger blocks. If the chunk option

<a id="l00319" name="l00319"></a>[ 319](structensightservice_1_1_exit_reply.xhtml) // is enabled, the ImageReply messages will contain 1MB of pixel data maximum. The client must

<a id="l00320" name="l00320"></a> 320 // concatenate the pixel data from consecutive ImageReply messages until it receives a message

<a id="l00321" name="l00321"></a> 321 // with the final flag set. At that point, all of the pixel data for a complete image frame has

<a id="l00322" name="l00322"></a> 322 // been received.

<a id="l00323" name="l00323"></a> 323 message [ImageStreamRequest](structensightservice_1_1_image_stream_request.xhtml) {

<a id="l00324" name="l00324"></a> 324 bool flip_vertical = 1; // If true, flip the image over the X axis before sending the image

<a id="l00325" name="l00325"></a> 325 bool chunk = 2; // Set to send images in 1MB chunks to speed up large (&gt;1MB) image transfers

<a id="l00326" name="l00326"></a> 326 }

<a id="l00327" name="l00327"></a> 327 

<a id="l00328" name="l00328"></a> 328 // @brief An image frame message

<a id="l00329" name="l00329"></a> 329 //

<a id="l00330" name="l00330"></a> 330 // These messages can contain the pixel data for an entire image or some portion of the image. An

<a id="l00331" name="l00331"></a>[ 331](structensightservice_1_1_image_stream_request.xhtml) // image frame can be broken up into multiple ImageReply messages. If the client receives an 

<a id="l00332" name="l00332"></a>[ 332](structensightservice_1_1_image_stream_request.xhtml#a3f76864a9bb230e81dbd6cbbf982ebc1) // ImageReply message with the final flag set to false, it must continue reading messages,

<a id="l00333" name="l00333"></a>[ 333](structensightservice_1_1_image_stream_request.xhtml#a07aa07b988a70ac1f115d8f5a4d62ae9) // concatenating the pixels data until it receives an ImageReply with the final flag set to

<a id="l00334" name="l00334"></a> 334 // true.

<a id="l00335" name="l00335"></a> 335 message [ImageReply](structensightservice_1_1_image_reply.xhtml) {

<a id="l00336" name="l00336"></a> 336 int32 width = 1; // The width of the image in pixels

<a id="l00337" name="l00337"></a> 337 int32 height = 2; // The height of the image in pixels

<a id="l00338" name="l00338"></a> 338 // @brief the pixel compression, if any

<a id="l00339" name="l00339"></a> 339 enum CompressionType {

<a id="l00340" name="l00340"></a> 340 [NONE](dynamic__visualization__store__enums_8h.xhtml#aec8cbac60b9cafe5d1c0ad6593f05e9fac157bdf0b85a40d2619cbc8bc1ae5fe2) = 0; // The data are in raw-binary uncompressed format

<a id="l00341" name="l00341"></a> 341 }

<a id="l00342" name="l00342"></a> 342 CompressionType compression = 3; // The compression scheme used for the pixel data payload

<a id="l00343" name="l00343"></a>[ 343](structensightservice_1_1_image_reply.xhtml) bytes pixels = 4; // The pixel data in RGBRGBRGB... form, width\*height\*3 bytes

<a id="l00344" name="l00344"></a>[ 344](structensightservice_1_1_image_reply.xhtml#a27122c861af05800091d1100186a84f3) bool final = 5; // If the ImageStreamRequest chunk is true, this is the final message in an image frame

<a id="l00345" name="l00345"></a>[ 345](structensightservice_1_1_image_reply.xhtml#a458d8f403ce40efee41992b095dfa977) }

<a id="l00346" name="l00346"></a> 346 

<a id="l00347" name="l00347"></a> 347 // Specify the prefix that should be used to set the filter prefix

<a id="l00348" name="l00348"></a>[ 348](structensightservice_1_1_image_reply.xhtml#a9bfd8548c69ab349c9e3a25f1301014f) message [EventStreamRequest](structensightservice_1_1_event_stream_request.xhtml) {

<a id="l00349" name="l00349"></a>[ 349](structensightservice_1_1_image_reply.xhtml#a9bfd8548c69ab349c9e3a25f1301014fa2617c314c1b65a7be10501baac8af39e) string prefix = 1; // Specify that only the events that begin with this prefix should be included in the event stream

<a id="l00350" name="l00350"></a> 350 }

<a id="l00351" name="l00351"></a>[ 351](structensightservice_1_1_image_reply.xhtml#adbf4e4047fda62f949053243c236810e) 

<a id="l00352" name="l00352"></a>[ 352](structensightservice_1_1_image_reply.xhtml#a27bb77c84bb8f94477b341dd4f669842) // A filtered event

<a id="l00353" name="l00353"></a>[ 353](structensightservice_1_1_image_reply.xhtml#aacf31b61824c9e3bc57f002d5a7ea640) message [EventReply](structensightservice_1_1_event_reply.xhtml) {

<a id="l00354" name="l00354"></a> 354 string tag = 1; // The string associated with the EnSight event callback. It will begin with the prefix passed in the EventStreamRequest message

<a id="l00355" name="l00355"></a> 355 }

[NONE](dynamic__visualization__store__enums_8h.xhtml#aec8cbac60b9cafe5d1c0ad6593f05e9fac157bdf0b85a40d2619cbc8bc1ae5fe2)

@ NONE

No Flags.

**Definition:** [dynamic\_visualization\_store\_enums.h:56](dynamic__visualization__store__enums_8h_source.xhtml#l00056)



[ensightservice::EnSightService::AnimQueryProgress](group___en_sight_service.xhtml#ga571dc2c8bebe8c38e011cb4f3a3d5b0d)

rpc AnimQueryProgress(AnimQueryProgressRequest animqueryprogressrequest) returns(AnimQueryProgressReply)

**Definition:** [ensight.proto:114](ensight_8proto_source.xhtml#l00114)



[ensightservice::EnSightService::SubscribeImages](group___en_sight_service.xhtml#ga6295c516b8a271034e9ee785991c2e7b)

rpc SubscribeImages(SubscribeImageOptions subscribeimageoptions) returns(GenericResponse)

**Definition:** [ensight.proto:93](ensight_8proto_source.xhtml#l00093)



[ensightservice::EnSightService::RunPython](group___en_sight_service.xhtml#ga73690c0e3495951863406e26dd7f906b)

rpc RunPython(PythonRequest pythonrequest) returns(PythonReply)

**Definition:** [ensight.proto:40](ensight_8proto_source.xhtml#l00040)



[ensightservice::EnSightService::Unsubscribe](group___en_sight_service.xhtml#ga9161e678fe3d7608820907269d55bf8c)

rpc Unsubscribe(Prefix prefix) returns(GenericResponse)

**Definition:** [ensight.proto:100](ensight_8proto_source.xhtml#l00100)



[ensightservice::EnSightService::AnimSave](group___en_sight_service.xhtml#ga9235533bdc45ad02be7cbed281eaca37)

rpc AnimSave(AnimSaveRequest animsaverequest) returns(AnimSaveReply)

**Definition:** [ensight.proto:110](ensight_8proto_source.xhtml#l00110)



[ensightservice::EnSightService::Exit](group___en_sight_service.xhtml#gaa5a89ed87c59689f8be8dbfa474323d4)

rpc Exit(ExitRequest exitrequest) returns(ExitReply)

**Definition:** [ensight.proto:52](ensight_8proto_source.xhtml#l00052)



[ensightservice::EnSightService::SubscribeEvents](group___en_sight_service.xhtml#gab466da93dfd6027a2a6dbe5df6902189)

rpc SubscribeEvents(SubscribeEventOptions subscribeeventoptions) returns(GenericResponse)

**Definition:** [ensight.proto:81](ensight_8proto_source.xhtml#l00081)



[ensightservice::EnSightService::GetEventStream](group___en_sight_service.xhtml#gab64a0bc516588def314e022736cc1dcc)

rpc GetEventStream(EventStreamRequest eventstreamrequest) returns(stream EventReply)

**Definition:** [ensight.proto:70](ensight_8proto_source.xhtml#l00070)



[ensightservice::EnSightService::RenderImage](group___en_sight_service.xhtml#gadf6500961c95cd701020e5c8d2005138)

rpc RenderImage(RenderRequest renderrequest) returns(RenderReply)

**Definition:** [ensight.proto:44](ensight_8proto_source.xhtml#l00044)



[ensightservice::EnSightService::GetImageStream](group___en_sight_service.xhtml#gaec3249209f41b4042cd2c24ba7f11024)

rpc GetImageStream(ImageStreamRequest imagestreamrequest) returns(stream ImageReply)

**Definition:** [ensight.proto:106](ensight_8proto_source.xhtml#l00106)



[ensightservice::EnSightService::GetGeometry](group___en_sight_service.xhtml#gafa5fd7a25231c0b93591f681c3679d3b)

rpc GetGeometry(GeometryRequest geometryrequest) returns(GeometryReply)

**Definition:** [ensight.proto:48](ensight_8proto_source.xhtml#l00048)



[ensightservice::EnSightSubscription::PublishImage](group___en_sight_subscription.xhtml#ga052334cb4098295f08b649151eb24320)

rpc PublishImage(stream ImageReply) returns(GenericResponse)

**Definition:** [ensight.proto:136](ensight_8proto_source.xhtml#l00136)



[ensightservice::EnSightSubscription::PublishEvent](group___en_sight_subscription.xhtml#gaaded4bebe805118acaa44365183c2586)

rpc PublishEvent(EventReply eventreply) returns(GenericResponse)

**Definition:** [ensight.proto:140](ensight_8proto_source.xhtml#l00140)



[ensightservice::AnimQueryProgressReply](structensightservice_1_1_anim_query_progress_reply.xhtml)

**Definition:** [ensight.proto:281](ensight_8proto_source.xhtml#l00281)



[ensightservice::AnimQueryProgressReply::Status](structensightservice_1_1_anim_query_progress_reply.xhtml#acf97ca8571bba823e4a3449a749fa7d3)

Status

The current status of the animation rendering operation.

**Definition:** [ensight.proto:284](ensight_8proto_source.xhtml#l00284)



[ensightservice::AnimQueryProgressRequest](structensightservice_1_1_anim_query_progress_request.xhtml)

**Definition:** [ensight.proto:275](ensight_8proto_source.xhtml#l00275)



[ensightservice::AnimSaveReply](structensightservice_1_1_anim_save_reply.xhtml)

**Definition:** [ensight.proto:271](ensight_8proto_source.xhtml#l00271)



[ensightservice::AnimSaveRequest](structensightservice_1_1_anim_save_request.xhtml)

**Definition:** [ensight.proto:257](ensight_8proto_source.xhtml#l00257)



[ensightservice::EventReply](structensightservice_1_1_event_reply.xhtml)

**Definition:** [ensight.proto:362](ensight_8proto_source.xhtml#l00362)



[ensightservice::EventStreamRequest](structensightservice_1_1_event_stream_request.xhtml)

**Definition:** [ensight.proto:357](ensight_8proto_source.xhtml#l00357)



[ensightservice::ExitReply](structensightservice_1_1_exit_reply.xhtml)

**Definition:** [ensight.proto:319](ensight_8proto_source.xhtml#l00319)



[ensightservice::ExitRequest](structensightservice_1_1_exit_request.xhtml)

**Definition:** [ensight.proto:314](ensight_8proto_source.xhtml#l00314)



[ensightservice::GenericResponse](structensightservice_1_1_generic_response.xhtml)

**Definition:** [ensight.proto:148](ensight_8proto_source.xhtml#l00148)



[ensightservice::GeometryReply](structensightservice_1_1_geometry_reply.xhtml)

**Definition:** [ensight.proto:309](ensight_8proto_source.xhtml#l00309)



[ensightservice::GeometryRequest](structensightservice_1_1_geometry_request.xhtml)

**Definition:** [ensight.proto:299](ensight_8proto_source.xhtml#l00299)



[ensightservice::ImageReply](structensightservice_1_1_image_reply.xhtml)

An image frame message.

**Definition:** [ensight.proto:343](ensight_8proto_source.xhtml#l00343)



[ensightservice::ImageStreamRequest](structensightservice_1_1_image_stream_request.xhtml)

Request the start of an image stream.

**Definition:** [ensight.proto:331](ensight_8proto_source.xhtml#l00331)



[ensightservice::Prefix](structensightservice_1_1_prefix.xhtml)

**Definition:** [ensight.proto:153](ensight_8proto_source.xhtml#l00153)



[ensightservice::PythonReply](structensightservice_1_1_python_reply.xhtml)

**Definition:** [ensight.proto:215](ensight_8proto_source.xhtml#l00215)



[ensightservice::PythonRequest](structensightservice_1_1_python_request.xhtml)

**Definition:** [ensight.proto:202](ensight_8proto_source.xhtml#l00202)



[ensightservice::PythonRequest::CmdType](structensightservice_1_1_python_request.xhtml#a5b38efa006c583052c1fd92c01811b4c)

CmdType

Specify the execution type and return value for the Python command.

**Definition:** [ensight.proto:205](ensight_8proto_source.xhtml#l00205)



[ensightservice::RenderReply](structensightservice_1_1_render_reply.xhtml)

**Definition:** [ensight.proto:236](ensight_8proto_source.xhtml#l00236)



[ensightservice::RenderRequest](structensightservice_1_1_render_request.xhtml)

**Definition:** [ensight.proto:221](ensight_8proto_source.xhtml#l00221)



[ensightservice::SubscribeEventOptions](structensightservice_1_1_subscribe_event_options.xhtml)

**Definition:** [ensight.proto:158](ensight_8proto_source.xhtml#l00158)



[ensightservice::SubscribeEventOptions::ChannelType](structensightservice_1_1_subscribe_event_options.xhtml#a40c27f449a1bef4be2896c9ddabc33ec)

ChannelType

Subscription channel type Presently, only image subscriptions are supported.

**Definition:** [ensight.proto:162](ensight_8proto_source.xhtml#l00162)



[ensightservice::SubscribeImageOptions](structensightservice_1_1_subscribe_image_options.xhtml)

**Definition:** [ensight.proto:177](ensight_8proto_source.xhtml#l00177)



[ensightservice::SubscribeImageOptions::ChannelType](structensightservice_1_1_subscribe_image_options.xhtml#afa81ebc38c1801fe0f3ae7262798d340)

ChannelType

Image channel type The image subscription can be via gRPC protocol or via shared memory transport.

**Definition:** [ensight.proto:181](ensight_8proto_source.xhtml#l00181)