Post-processing tools 2023 R2

ensightservice::SceneUpdateCommand Struct Reference

Last update: 17.04.2023

Aggregate command sent by EnSight to a client. More...

Public Types

enum  SceneUpdateCommandType {
  UPDATE_SCENE_BEGIN = 0 , UPDATE_SCENE_END = 1 , DELETE_ID = 2 , UPDATE_PART = 3 ,
  UPDATE_GROUP = 4 , UPDATE_GEOM = 5 , UPDATE_VARIABLE = 6 , UPDATE_VIEW = 7 ,
  UPDATE_TEXTURE = 8
}
 Specify the specific command type. More...
 

Public Attributes

SceneUpdateCommandType command_type = 1
 The update command type.
 
union {
   UpdateSceneBegin   scene_begin = 2
 Begin a scene update.
 
   UpdateSceneEnd   scene_end = 3
 End a scene update.
 
   DeleteID   delete_id = 4
 Delete a collection of entities from the cache.
 
   UpdatePart   update_part = 5
 Update a Part entity.
 
   UpdateGroup   update_group = 6
 Update a Group entity.
 
   UpdateGeom   update_geom = 7
 Update a Geom entity.
 
   UpdateVariable   update_variable = 8
 Update a Variable entity.
 
   UpdateView   update_view = 9
 Update a View entity.
 
   UpdateTexture   update_texture = 10
 Update a Texture entity.
 
} UpdateCommand
 The union of the sub-command messages. More...
 

Detailed Description

Aggregate command sent by EnSight to a client.

This command represents a union of a number of different commands: UpdateSceneBegin, UpdateSceneEnd, DeleteID, UpdatePart, UpdateGroup, UpdateGeom, UpdateVariable and UpdateView. To use the message, set the command_type to the type of the message and fill in the appropriate UpdateCommand sub-message.

Definition at line 504 of file dynamic_scene_graph.proto.

Member Enumeration Documentation

◆ SceneUpdateCommandType

enum ensightservice::SceneUpdateCommand::SceneUpdateCommandType

Specify the specific command type.

SceneUpdateCommand object can represent many different sub-commands, but packed into a common message. The SceneUpdateCommandType is the specific sub-command type of the base message.

Enumerator
UPDATE_SCENE_BEGIN 

Marks the beginning of a scene update.

UPDATE_SCENE_END 

Marks the completion of a scene update.

DELETE_ID 

Tell the client to delete an entity ID that was defined in a previous scene update.

UPDATE_PART 

Create/update a Part entity.

UPDATE_GROUP 

Create/update a Group entity.

UPDATE_GEOM 

Create/update a Geom entity.

UPDATE_VARIABLE 

Create/update a Variable entity.

UPDATE_VIEW 

Create/update a View entity.

UPDATE_TEXTURE 

Create/update a Texture entity.

Definition at line 511 of file dynamic_scene_graph.proto.

Member Data Documentation

◆ 

union { ... } ensightservice::SceneUpdateCommand::UpdateCommand

The union of the sub-command messages.

Each SceneUpdateCommand message can be one of the types defined by the command_type. These are represented via a union message construct.

The documentation for this struct was generated from the following file:

Connect with Ansys