Data Overlays

`DO_01`: Load Annotation Data

Version: 1.0.0
Interface: data_overlay
Action: do_01

Payload Definition

Type: `InitialDataOverlayState`

{
  "Version": "String",
  "DataOverlay": {
    "Version": "String",
    "DataOverlay": {
      "LongLength": "Int64",
      "IsFixedSize": "Boolean",
      "IsReadOnly": "Boolean",
      "IsSynchronized": "Boolean",
      "SyncRoot": {},
      "Length": "Int32",
      "Rank": "Int32"
    }
  }
}

Example definition

Type: `InitialDataOverlayState`

"InitialDataOverlayState"

Response Codes

Code	Description
`S00000`	Action was received from Front End.
`S00001`	Action from Front End has completed.
`F00000`	Error executing the supplied function
`F00001`	Function is not defined
`F00006`	Action did not execute within an allotted time
`F00008`	Function is not found
`F00011`	The payload supplied is invalid
`A00002`	Resource given for {RESOURCE} was not able to be loaded. Function will continue as expected without.
`A00003`	Object with Id, {ID}, is already in session. Given Object was not imported.
`A00004`	Element was invalid for function. Element will be skipped.
`I00003`	Missing fields were replaced with default values. {INPUTS}

`DO_02`: 2D Annotation Event (Interaction in Unity, Data Display on Front End)

Version: 1.0.0
Interface: data_overlay
Action: do_02

Payload Definition

Type: `DataOverlayData`

{
  "Version": "String",
  "Id": "String",
  "Data": "String",
  "DataType": "ENUM: DataOverlayType"
}

Example definition

Type: `DataOverlayData`

"DataOverlayData"

Response Codes

Code	Description
`S00000`	Action was received from Front End.
`S00001`	Action from Front End has completed.
`F00000`	Error executing the supplied function
`F00001`	Function is not defined
`F00006`	Action did not execute within an allotted time
`F00008`	Function is not found
`F00011`	The payload supplied is invalid

`DO_03`: Toggle 2D Annotation Visibility

Version: 1.0.0
Interface: data_overlay
Action: do_03

Payload Definition

Type: `ObjectVisibility`

{
  "Version": "String",
  "Id": "String",
  "Visibility": "Boolean"
}

Example definition

Type: `ObjectVisibility`

"ObjectVisibility"

Response Codes

Code	Description
`S00000`	Action was received from Front End.
`S00001`	Action from Front End has completed.
`F00000`	Error executing the supplied function
`F00001`	Function is not defined
`F00006`	Action did not execute within an allotted time
`F00008`	Function is not found
`F00011`	The payload supplied is invalid
`F00027`	Object with Id, {ID}, could not be found.

`DO_04`: Set 2D Annotation Collider Size

Version: 1.0.0
Interface: data_overlay
Action: do_04

Payload Definition

Type: `ObjectSize2D`

{
  "Version": "String",
  "Id": "String",
  "Size": {
    "Version": "String",
    "X": "Float",
    "Y": "Float"
  }
}

Example definition

Type: `ObjectSize2D`

"ObjectSize2D"

Response Codes

Code	Description
`S00000`	Action was received from Front End.
`S00001`	Action from Front End has completed.
`F00000`	Error executing the supplied function
`F00001`	Function is not defined
`F00006`	Action did not execute within an allotted time
`F00008`	Function is not found
`F00011`	The payload supplied is invalid
`F00014`
`F00027`	Object with Id, {ID}, could not be found.

`DO_05`: Set 2D Annotation Collider Colour & Opacity

Version: 1.0.0
Interface: data_overlay
Action: do_05

Payload Definition

Type: `ObjectColour`

{
  "Version": "String",
  "Id": "String",
  "Colour": {
    "Version": "String",
    "R": "Float",
    "G": "Float",
    "B": "Float",
    "A": "Float"
  }
}

Example definition

Type: `ObjectColour`

"ObjectColour"

Response Codes

Code	Description
`S00000`	Action was received from Front End.
`S00001`	Action from Front End has completed.
`F00000`	Error executing the supplied function
`F00001`	Function is not defined
`F00006`	Action did not execute within an allotted time
`F00008`	Function is not found
`F00011`	The payload supplied is invalid
`F00027`	Object with Id, {ID}, could not be found.

`DO_06`: Set 2D Annotation Collider Icon

Version: 1.0.0
Interface: data_overlay
Action: do_06

Payload Definition

Type: `ObjectIcon`

{
  "Version": "String",
  "Id": "String",
  "Icon": "String"
}

Example definition

Type: `ObjectIcon`

"ObjectIcon"

Response Codes

Code	Description
`S00000`	Action was received from Front End.
`S00001`	Action from Front End has completed.
`F00000`	Error executing the supplied function
`F00001`	Function is not defined
`F00006`	Action did not execute within an allotted time
`F00008`	Function is not found
`F00011`	The payload supplied is invalid
`F00026`	Resource given for {RESOURCE} was not able to be loaded.
`F00027`	Object with Id, {ID}, could not be found.

`DO_07`: 3D Annotation Event (Interaction in Unity, Data Display on Front End)

Version: 1.0.0
Interface: data_overlay
Action: do_07

Payload Definition

Type: `DataOverlayData`

{
  "Version": "String",
  "Id": "String",
  "Data": "String",
  "DataType": "ENUM: DataOverlayType"
}

Example definition

Type: `DataOverlayData`

"DataOverlayData"

Response Codes

Code	Description
`S00000`	Action was received from Front End.
`S00001`	Action from Front End has completed.
`F00000`	Error executing the supplied function
`F00001`	Function is not defined
`F00006`	Action did not execute within an allotted time
`F00008`	Function is not found
`F00011`	The payload supplied is invalid

`DO_08`: Set 3D Annotation Collider Size

Version: 1.0.0
Interface: data_overlay
Action: do_08

Payload Definition

Type: `ObjectSize`

{
  "Version": "String",
  "Id": "String",
  "Size": {
    "Version": "String",
    "X": "Float",
    "Y": "Float",
    "Z": "Float"
  }
}

Example definition

Type: `ObjectSize`

"ObjectSize"

Response Codes

Code	Description
`S00000`	Action was received from Front End.
`S00001`	Action from Front End has completed.
`F00000`	Error executing the supplied function
`F00001`	Function is not defined
`F00006`	Action did not execute within an allotted time
`F00008`	Function is not found
`F00011`	The payload supplied is invalid
`F00014`
`F00027`	Object with Id, {ID}, could not be found.

`DO_09`: Set 3D Annotation Collider Colour & Opacity

Version: 1.0.0
Interface: data_overlay
Action: do_09

Payload Definition

Type: `ObjectColour`

{
  "Version": "String",
  "Id": "String",
  "Colour": {
    "Version": "String",
    "R": "Float",
    "G": "Float",
    "B": "Float",
    "A": "Float"
  }
}

Example definition

Type: `ObjectColour`

"ObjectColour"

Response Codes

Code	Description
`S00000`	Action was received from Front End.
`S00001`	Action from Front End has completed.
`F00000`	Error executing the supplied function
`F00001`	Function is not defined
`F00006`	Action did not execute within an allotted time
`F00008`	Function is not found
`F00011`	The payload supplied is invalid
`F00027`	Object with Id, {ID}, could not be found.

`DO_10`: 3D Annotation Collider Icon

Version: 1.0.0
Interface: data_overlay
Action: do_10

Payload Definition

Type: `EmptyPayload`

{
  "Version": "String"
}

Example definition

Type: `EmptyPayload`

{
  "Version": "0.0.1"
}

Response Codes

Code	Description
`S00000`	Action was received from Front End.
`S00001`	Action from Front End has completed.
`F00000`	Error executing the supplied function
`F00001`	Function is not defined
`F00006`	Action did not execute within an allotted time
`F00008`	Function is not found
`F00011`	The payload supplied is invalid

`DO_11`: Toggle 3D Annotation Visibility

Version: 1.0.0
Interface: data_overlay
Action: do_11

Payload Definition

Type: `ObjectVisibility`

{
  "Version": "String",
  "Id": "String",
  "Visibility": "Boolean"
}

Example definition

Type: `ObjectVisibility`

"ObjectVisibility"

Response Codes

Code	Description
`S00000`	Action was received from Front End.
`S00001`	Action from Front End has completed.
`F00000`	Error executing the supplied function
`F00001`	Function is not defined
`F00006`	Action did not execute within an allotted time
`F00008`	Function is not found
`F00011`	The payload supplied is invalid
`F00027`	Object with Id, {ID}, could not be found.

`DO_18`: Invert Annotation Data

Version: 1.0.0
Interface: data_overlay
Action: do_18

Payload Definition

Type: `ObjectInvert`

{
  "Version": "String",
  "Id": "String",
  "Inverted": {
    "Version": "String",
    "InvertedSagittal": "Boolean",
    "InvertedCoronal": "Boolean",
    "InvertedTransverse": "Boolean"
  }
}

Example definition

Type: `ObjectInvert`

"ObjectInvert"

Response Codes

Code	Description
`S00000`	Action was received from Front End.
`S00001`	Action from Front End has completed.
`F00000`	Error executing the supplied function
`F00001`	Function is not defined
`F00006`	Action did not execute within an allotted time
`F00008`	Function is not found
`F00011`	The payload supplied is invalid
`F00027`	Object with Id, {ID}, could not be found.