## On this page

  

 

 # ensightservice::UpdateVariable Struct Reference

 Last update: 16.07.2025 

Update a Variable entity. [More...](structensightservice_1_1_update_variable.xhtml#details)

## <a id="pub-types" name="pub-types"></a>Public Types

enum [VarLocation](structensightservice_1_1_update_variable.xhtml#a6049149a3d23ac732df1287d464a5e34) { [NODAL](structensightservice_1_1_update_variable.xhtml#a6049149a3d23ac732df1287d464a5e34a45652249bc0510f101449c35fb92219a) = 0 , [ELEMENTAL](structensightservice_1_1_update_variable.xhtml#a6049149a3d23ac732df1287d464a5e34a5bae0693219c95072c79a57e97220cf3) = 1 } Declare where a variable is defined to exist. [More...](structensightservice_1_1_update_variable.xhtml#a6049149a3d23ac732df1287d464a5e34)  
 enum [VarDimension](structensightservice_1_1_update_variable.xhtml#a8a27406b9f0d1b4d04c7e220290a8832) { [SCALAR](structensightservice_1_1_update_variable.xhtml#a8a27406b9f0d1b4d04c7e220290a8832a181c94167aff4fa32434f11a9517014a) = 0 , [VECTOR](structensightservice_1_1_update_variable.xhtml#a8a27406b9f0d1b4d04c7e220290a8832a89579192578351c228f25c88386790e3) = 1 } Declare the variable dimension. [More...](structensightservice_1_1_update_variable.xhtml#a8a27406b9f0d1b4d04c7e220290a8832)  
 enum [PaletteInterpolation](structensightservice_1_1_update_variable.xhtml#aba525af8da57834327a98c6258f5fda1) { [CONTINUOUS](structensightservice_1_1_update_variable.xhtml#aba525af8da57834327a98c6258f5fda1a6dd78f8b0d101f7bb8c0d74c15c2af04) = 0 , [BANDED](structensightservice_1_1_update_variable.xhtml#aba525af8da57834327a98c6258f5fda1a227dce087f42b9dfa5231856c003529b) = 1 } Palette interpolation options. [More...](structensightservice_1_1_update_variable.xhtml#aba525af8da57834327a98c6258f5fda1)  
 enum [UndefinedDisplay](structensightservice_1_1_update_variable.xhtml#ab07eddb89db3f17a4111c2a2b0ba1c0e) { [AS\_ZERO](structensightservice_1_1_update_variable.xhtml#ab07eddb89db3f17a4111c2a2b0ba1c0eaa8c810fb96b63318847e385ab1ab93ea) = 0 , [AS\_INVISIBLE](structensightservice_1_1_update_variable.xhtml#ab07eddb89db3f17a4111c2a2b0ba1c0ea0a11d139963b16f66721378f6f1f7bcd) = 1 , [USE\_PART\_COLOR](structensightservice_1_1_update_variable.xhtml#ab07eddb89db3f17a4111c2a2b0ba1c0eadb5b985665804d7818f7cbd18708ee3e) = 2 , [USE\_UNDEF\_COLOR](structensightservice_1_1_update_variable.xhtml#ab07eddb89db3f17a4111c2a2b0ba1c0ea4ac541b1e6a12dfca57f55bfea21aac5) = 3 } Undefined interpretation. [More...](structensightservice_1_1_update_variable.xhtml#ab07eddb89db3f17a4111c2a2b0ba1c0e)  
 ## <a id="pub-attribs" name="pub-attribs"></a>Public Attributes

<a id="a740d5ab7439756963cb274aa5d7a395d"></a>uint64 [id](structensightservice_1_1_update_variable.xhtml#a740d5ab7439756963cb274aa5d7a395d) = 1 The Variable entity id.   
 <a id="af0b57f59c0e4898f197637e2130d3652"></a>uint64 [parent\_id](structensightservice_1_1_update_variable.xhtml#af0b57f59c0e4898f197637e2130d3652) = 2 The parent scene id.   
 <a id="af45690c2e8743fe83baa699967ca3737"></a>string [name](structensightservice_1_1_update_variable.xhtml#af45690c2e8743fe83baa699967ca3737) = 3 The name of the variable.   
 <a id="a3d45de0de8053126384af3e5442478f4"></a>[VarLocation](structensightservice_1_1_update_variable.xhtml#a6049149a3d23ac732df1287d464a5e34) [location](structensightservice_1_1_update_variable.xhtml#a3d45de0de8053126384af3e5442478f4) = 4 The location of the variable.   
 <a id="a54f1a5d2fdf41622a3fdd1a29c622b5e"></a>[VarDimension](structensightservice_1_1_update_variable.xhtml#a8a27406b9f0d1b4d04c7e220290a8832) [dimension](structensightservice_1_1_update_variable.xhtml#a54f1a5d2fdf41622a3fdd1a29c622b5e) = 5 The dimensionality of the variable.   
 <a id="abf6d0768db50f923d6ac481949e484a8"></a>float [undefined\_value](structensightservice_1_1_update_variable.xhtml#abf6d0768db50f923d6ac481949e484a8) = 6 The float value that should be interpreted as "Undefined".   
 <a id="a93a37d3801ebe892afd00598cc36e86b"></a>[PaletteInterpolation](structensightservice_1_1_update_variable.xhtml#aba525af8da57834327a98c6258f5fda1) [pal\_interp](structensightservice_1_1_update_variable.xhtml#a93a37d3801ebe892afd00598cc36e86b) = 7 How the color palette specified by levels should be interpolated.   
 <a id="a3a45f0682d9ce64655fdb7c9d21ff9c9"></a>repeated [VariableLevel](structensightservice_1_1_variable_level.xhtml) [levels](structensightservice_1_1_update_variable.xhtml#a3a45f0682d9ce64655fdb7c9d21ff9c9) = 8 The color and var value at palette levels. Lowest to highest.   
 <a id="ae886d67fd989c05978d7c8eb5fc17001"></a>uint32 [sub\_levels](structensightservice_1_1_update_variable.xhtml#ae886d67fd989c05978d7c8eb5fc17001) = 9 The number of "sub-levels" that might be used with BANDED interpolation. The total number of bands is (levels-1)\*(sub\_levels+1). The color in each level is used on the band at and above the level value, except for the last level's color, which is use on the band below it. Linearly interpolate in RGB space to get the colors of the bands between levels.   
 <a id="aae718fe32c4eb203a3b93df836aa65ad"></a>[UndefinedDisplay](structensightservice_1_1_update_variable.xhtml#ab07eddb89db3f17a4111c2a2b0ba1c0e) [undefined\_display](structensightservice_1_1_update_variable.xhtml#aae718fe32c4eb203a3b93df836aa65ad) = 10 How should the undefined values be displayed.   
 <a id="a83751ee84d20f8d059c7d792c4e58be3"></a>repeated float [undefined\_color](structensightservice_1_1_update_variable.xhtml#a83751ee84d20f8d059c7d792c4e58be3) = 11 If undefined\_display==USE\_UNDEF\_COLOR, rgb in \[0,1\] given here.   
 <a id="a0da0813441db9e33553d5fb4c87ed3ce"></a>bytes [texture](structensightservice_1_1_update_variable.xhtml#a0da0813441db9e33553d5fb4c87ed3ce) = 12 rgba pixel values (rrggbbaa 4 bytes/pixel) in \[0,255\]. For the color\_variableid, use only the rgb portion of this texture. For the alpha\_variableid, use only the 'a' portion of this texture. levels\[0\].value should map to tex coord==0 for banded, 0.5 texel for continuous levels\[levels.size()-1\].value should map to tex coord==1 for banded, 1 - 0.5 texel for continuous.   
 <a id="ac82ea8d2dd9ad7410db2a784dfb95921"></a>map&lt; string, string &gt; [attributes](structensightservice_1_1_update_variable.xhtml#ac82ea8d2dd9ad7410db2a784dfb95921) = 13 General attributes associated with this Variable.   
 <a id="affd2266602a0ce71ea4765dd9d2b830b"></a>string [hash](structensightservice_1_1_update_variable.xhtml#affd2266602a0ce71ea4765dd9d2b830b) = 14 hash for this message payload   
 <a id="details" name="details"></a>## Detailed Description

Update a Variable entity.

General meta data about a variable, and about how to color by that variable. All parts colored by a the same variable in EnSight use the same palette, same var range, etc.

The attributes are open for various uses, but several attribute key values have already been defined:

Attribute Value ENS\_OBJ\_TYPE The EnSight object type associated with this Group entity (e.g. "ENS\_PART", "ENS\_CASE", "ENS\_VAR"). ENS\_OBJ\_ID The EnSight object ID associated with the Group entity. ENS\_UNITS\_DIMS The unit dimensionality for the a specific ENS\_VAR. An example for a pressure variable would be: 'M/LTT'. See also [EnSight Units](https://nexusdemo.ensight.com/docs/python/html/ENS_UNITSSchema.html#TOC-ENS_UNITS_SYSTEM "EnSight Units System"). Definition at line [421](dynamic__scene__graph_8proto_source.xhtml#l00421) of file [dynamic\_scene\_graph.proto](dynamic__scene__graph_8proto_source.xhtml).



## Member Enumeration Documentation

<a id="aba525af8da57834327a98c6258f5fda1"></a>## [◆ ](#aba525af8da57834327a98c6258f5fda1)PaletteInterpolation

 enum [ensightservice::UpdateVariable::PaletteInterpolation](structensightservice_1_1_update_variable.xhtml#aba525af8da57834327a98c6258f5fda1)

Palette interpolation options.

Specify if palette interpolation should be linear or stepwise.

Enumerator<a id="aba525af8da57834327a98c6258f5fda1a6dd78f8b0d101f7bb8c0d74c15c2af04"></a>CONTINUOUS The interpolation of the variable palette is linear.

<a id="aba525af8da57834327a98c6258f5fda1a227dce087f42b9dfa5231856c003529b"></a>BANDED The interpolation of the variable palette is a step function.

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





<a id="ab07eddb89db3f17a4111c2a2b0ba1c0e"></a>## [◆ ](#ab07eddb89db3f17a4111c2a2b0ba1c0e)UndefinedDisplay

 enum [ensightservice::UpdateVariable::UndefinedDisplay](structensightservice_1_1_update_variable.xhtml#ab07eddb89db3f17a4111c2a2b0ba1c0e)

Undefined interpretation.

EnSight has a special float value indicating that the variable is undefined for a vertex or element. Options for drawing these elements are in the UndefinedDisplay enum. The value that means 'undefined' is given below in undefined\_value. By default, the undefined value is -1.2345e-10.

Enumerator<a id="ab07eddb89db3f17a4111c2a2b0ba1c0eaa8c810fb96b63318847e385ab1ab93ea"></a>AS\_ZERO Draw 'undefined' as 0.0.

<a id="ab07eddb89db3f17a4111c2a2b0ba1c0ea0a11d139963b16f66721378f6f1f7bcd"></a>AS\_INVISIBLE Don't draw any pixels where the variable value is undefined.

<a id="ab07eddb89db3f17a4111c2a2b0ba1c0eadb5b985665804d7818f7cbd18708ee3e"></a>USE\_PART\_COLOR Draw 'undefined' areas using the 'fill\_color' value on the part.

<a id="ab07eddb89db3f17a4111c2a2b0ba1c0ea4ac541b1e6a12dfca57f55bfea21aac5"></a>USE\_UNDEF\_COLOR Draw 'undefined' areas using a color given below in undefined\_color.

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





<a id="a8a27406b9f0d1b4d04c7e220290a8832"></a>## [◆ ](#a8a27406b9f0d1b4d04c7e220290a8832)VarDimension

 enum [ensightservice::UpdateVariable::VarDimension](structensightservice_1_1_update_variable.xhtml#a8a27406b9f0d1b4d04c7e220290a8832)

Declare the variable dimension.

Variables can either be a single float (SCALAR) per observed location or a 3 float vector (VECTOR).

Enumerator<a id="a8a27406b9f0d1b4d04c7e220290a8832a181c94167aff4fa32434f11a9517014a"></a>SCALAR The variable has one value per location.

<a id="a8a27406b9f0d1b4d04c7e220290a8832a89579192578351c228f25c88386790e3"></a>VECTOR The variable has three values per location.

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





<a id="a6049149a3d23ac732df1287d464a5e34"></a>## [◆ ](#a6049149a3d23ac732df1287d464a5e34)VarLocation

 enum [ensightservice::UpdateVariable::VarLocation](structensightservice_1_1_update_variable.xhtml#a6049149a3d23ac732df1287d464a5e34)

Declare where a variable is defined to exist.

Variables can located at each node or element of the mesh.

Enumerator<a id="a6049149a3d23ac732df1287d464a5e34a45652249bc0510f101449c35fb92219a"></a>NODAL The variable is specified per mesh node.

<a id="a6049149a3d23ac732df1287d464a5e34a5bae0693219c95072c79a57e97220cf3"></a>ELEMENTAL The variable is specified per mesh element (e.g. triangle)

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





---

The documentation for this struct was generated from the following file:- D:/ANSYSDev/NoBackup/branches/EnSight-Second-Coming/ensight/client/rpc\_interface/[dynamic\_scene\_graph.proto](dynamic__scene__graph_8proto_source.xhtml)