Public Types
enum	VarLocation { NODAL = 0 , ELEMENTAL = 1 }

enum	VarDimension { SCALAR = 0 , VECTOR = 1 }

enum	PaletteInterpolation { CONTINUOUS = 0 , BANDED = 1 }

enum	UndefinedDisplay { AS_ZERO = 0 , AS_INVISIBLE = 1 , USE_PART_COLOR = 2 , USE_UNDEF_COLOR = 3 }

Public Attributes
uint64	id = 1

uint64	parent_id = 2

string	name = 3

VarLocation	location = 4

VarDimension	dimension = 5

float	undefined_value = 6

PaletteInterpolation	pal_interp = 7

repeated VariableLevel	levels = 8

uint32	sub_levels = 9

UndefinedDisplay	undefined_display = 10

repeated float	undefined_color = 11

bytes	texture = 12

map< string, string >	attributes = 13

string	hash = 14

Detailed Description

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.

Definition at line 421 of file dynamic_scene_graph.proto.

Member Enumeration Documentation

◆ PaletteInterpolation

enum ensightservice::UpdateVariable::PaletteInterpolation

Palette interpolation options.

Specify if palette interpolation should be linear or stepwise.

Enumerator
CONTINUOUS	The interpolation of the variable palette is linear.
BANDED	The interpolation of the variable palette is a step function.

Definition at line 443 of file dynamic_scene_graph.proto.

◆ UndefinedDisplay

enum ensightservice::UpdateVariable::UndefinedDisplay

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
AS_ZERO	Draw 'undefined' as 0.0.
AS_INVISIBLE	Don't draw any pixels where the variable value is undefined.
USE_PART_COLOR	Draw 'undefined' areas using the 'fill_color' value on the part.
USE_UNDEF_COLOR	Draw 'undefined' areas using a color given below in undefined_color.

Definition at line 453 of file dynamic_scene_graph.proto.

◆ VarDimension

enum ensightservice::UpdateVariable::VarDimension

Declare the variable dimension.

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

Enumerator
SCALAR	The variable has one value per location.
VECTOR	The variable has three values per location.

Definition at line 435 of file dynamic_scene_graph.proto.

◆ VarLocation

enum ensightservice::UpdateVariable::VarLocation

Declare where a variable is defined to exist.

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

Enumerator
NODAL	The variable is specified per mesh node.
ELEMENTAL	The variable is specified per mesh element (e.g. triangle)

Definition at line 426 of file dynamic_scene_graph.proto.

Member Data Documentation

◆ attributes

map<string,string> ensightservice::UpdateVariable::attributes = 13

General attributes associated with this Variable.

Definition at line 471 of file dynamic_scene_graph.proto.

◆ dimension

VarDimension ensightservice::UpdateVariable::dimension = 5

The dimensionality of the variable.

Definition at line 463 of file dynamic_scene_graph.proto.

◆ hash

string ensightservice::UpdateVariable::hash = 14

hash for this message payload

Definition at line 472 of file dynamic_scene_graph.proto.

◆ id

uint64 ensightservice::UpdateVariable::id = 1

The Variable entity id.

Definition at line 459 of file dynamic_scene_graph.proto.

◆ levels

repeated VariableLevel ensightservice::UpdateVariable::levels = 8

The color and var value at palette levels. Lowest to highest.

Definition at line 466 of file dynamic_scene_graph.proto.

◆ location

VarLocation ensightservice::UpdateVariable::location = 4

The location of the variable.

Definition at line 462 of file dynamic_scene_graph.proto.

◆ name

string ensightservice::UpdateVariable::name = 3

The name of the variable.

Definition at line 461 of file dynamic_scene_graph.proto.

◆ pal_interp

PaletteInterpolation ensightservice::UpdateVariable::pal_interp = 7

How the color palette specified by levels should be interpolated.

Definition at line 465 of file dynamic_scene_graph.proto.

◆ parent_id

uint64 ensightservice::UpdateVariable::parent_id = 2

The parent scene id.

Definition at line 460 of file dynamic_scene_graph.proto.

◆ sub_levels

uint32 ensightservice::UpdateVariable::sub_levels = 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.

Definition at line 467 of file dynamic_scene_graph.proto.

◆ texture

bytes ensightservice::UpdateVariable::texture = 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.

Definition at line 470 of file dynamic_scene_graph.proto.

◆ undefined_color

repeated float ensightservice::UpdateVariable::undefined_color = 11

If undefined_display==USE_UNDEF_COLOR, rgb in [0,1] given here.

Definition at line 469 of file dynamic_scene_graph.proto.

◆ undefined_display

UndefinedDisplay ensightservice::UpdateVariable::undefined_display = 10

How should the undefined values be displayed.

Definition at line 468 of file dynamic_scene_graph.proto.

◆ undefined_value

float ensightservice::UpdateVariable::undefined_value = 6

The float value that should be interpreted as "Undefined".

Definition at line 464 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

Post-processing tools 2024 R1

ensightservice::UpdateVariable Struct Reference

Public Types

Public Attributes