Scan Movement

`SM_01`: Pan Left

Version: 1.0.0
Interface: scan_movement
Action: sm_01

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.
`F00001`	Function is not defined
`F00008`	Function is not found

`SM_02`: Pan Right

Version: 1.0.0
Interface: scan_movement
Action: sm_02

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.
`F00001`	Function is not defined
`F00008`	Function is not found

`SM_03`: Pan Up

Version: 1.0.0
Interface: scan_movement
Action: sm_03

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.
`F00001`	Function is not defined
`F00008`	Function is not found

`SM_04`: Pan Down

Version: 1.0.0
Interface: scan_movement
Action: sm_04

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.
`F00001`	Function is not defined
`F00008`	Function is not found

`SM_05`: Pan Sensitivity

Version: 1.0.0
Interface: scan_movement
Action: sm_05

Payload Definition

Type: `SliderValue`

{
  "Version": "String",
  "Value": "Float"
}

Example definition

Type: `SliderValue`

{
  "Version": "1.0.0",
  "Value": 0
}

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

`SM_06`: Zoom In

Version: 1.0.0
Interface: scan_movement
Action: sm_06

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.
`F00001`	Function is not defined
`F00008`	Function is not found

`SM_07`: Zoom Out

Version: 1.0.0
Interface: scan_movement
Action: sm_07

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.
`F00001`	Function is not defined
`F00008`	Function is not found

`SM_08`: Zoom Sensitivity

Version: 1.0.0
Interface: scan_movement
Action: sm_08

Payload Definition

Type: `SliderValue`

{
  "Version": "String",
  "Value": "Float"
}

Example definition

Type: `SliderValue`

{
  "Version": "1.0.0",
  "Value": 0
}

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

`SM_09`: Rotate (3D Movement)

Version: 1.0.0
Interface: scan_movement
Action: sm_09

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.
`F00001`	Function is not defined
`F00008`	Function is not found

`SM_10`: Rotation Sensitivity

Version: 1.0.0
Interface: scan_movement
Action: sm_10

Payload Definition

Type: `SliderValue`

{
  "Version": "String",
  "Value": "Float"
}

Example definition

Type: `SliderValue`

{
  "Version": "1.0.0",
  "Value": 0
}

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

`SM_11`: Rotate 3D Camera without moving Scan Volume

Version: 1.0.0
Interface: scan_movement
Action: sm_11

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.
`F00001`	Function is not defined
`F00008`	Function is not found

`SM_12`: Camera Rotate Sensitivity

Version: 1.0.0
Interface: scan_movement
Action: sm_12

Payload Definition

Type: `SliderValue`

{
  "Version": "String",
  "Value": "Float"
}

Example definition

Type: `SliderValue`

{
  "Version": "1.0.0",
  "Value": 0
}

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

`SM_13`: Pan Left (Front End Interaction)

Version: 1.0.0
Interface: scan_movement
Action: sm_13

Payload Definition

Type: `MovementData`

{
  "Version": "String",
  "View": "ENUM: ScanView",
  "Movement": "Float"
}

Example definition

Type: `MovementData`

"MovementData"

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
`F00015`	Enum value out of range

`SM_14`: Pan Right (Front End Interaction)

Version: 1.0.0
Interface: scan_movement
Action: sm_14

Payload Definition

Type: `MovementData`

{
  "Version": "String",
  "View": "ENUM: ScanView",
  "Movement": "Float"
}

Example definition

Type: `MovementData`

"MovementData"

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
`F00015`	Enum value out of range

`SM_15`: Pan Up (Front End Interaction)

Version: 1.0.0
Interface: scan_movement
Action: sm_15

Payload Definition

Type: `MovementData`

{
  "Version": "String",
  "View": "ENUM: ScanView",
  "Movement": "Float"
}

Example definition

Type: `MovementData`

"MovementData"

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
`F00015`	Enum value out of range

`SM_16`: Pan Down (Front End Interaction)

Version: 1.0.0
Interface: scan_movement
Action: sm_16

Payload Definition

Type: `MovementData`

{
  "Version": "String",
  "View": "ENUM: ScanView",
  "Movement": "Float"
}

Example definition

Type: `MovementData`

"MovementData"

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
`F00015`	Enum value out of range

`SM_17`: Zoom In (Front End Interaction)

Version: 1.0.0
Interface: scan_movement
Action: sm_17

Payload Definition

Type: `MovementData`

{
  "Version": "String",
  "View": "ENUM: ScanView",
  "Movement": "Float"
}

Example definition

Type: `MovementData`

"MovementData"

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
`F00015`	Enum value out of range

`SM_18`: Zoom Out (Front End Interaction)

Version: 1.0.0
Interface: scan_movement
Action: sm_18

Payload Definition

Type: `MovementData`

{
  "Version": "String",
  "View": "ENUM: ScanView",
  "Movement": "Float"
}

Example definition

Type: `MovementData`

"MovementData"

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
`F00015`	Enum value out of range

`SM_19`: Rotate (3D Movement) (Front End Interaction)

Version: 1.0.0
Interface: scan_movement
Action: sm_19

Payload Definition

Type: `Vector3Data`

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

Example definition

Type: `Vector3Data`

{
  "Version": "1.1.0",
  "X": 0,
  "Y": 0,
  "Z": 0
}

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

`SM_20`: Rotate 3D Camera without moving Scan Volume (Front End Interaction)

Version: 1.0.0
Interface: scan_movement
Action: sm_20

Payload Definition

Type: `Vector3Data`

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

Example definition

Type: `Vector3Data`

{
  "Version": "1.1.0",
  "X": 0,
  "Y": 0,
  "Z": 0
}

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

`SM_21`: Absolute Pan (Front End Interaction)

Version: 1.0.0
Interface: scan_movement
Action: sm_21

Payload Definition

Type: `VectorMovementData`

{
  "Version": "String",
  "View": "ENUM: ScanView",
  "Movement": {
    "Version": "String",
    "X": "Float",
    "Y": "Float"
  }
}

Example definition

Type: `VectorMovementData`

"VectorMovementData"

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
`F00015`	Enum value out of range

`SM_22`: Absolute Zoom (Front End Interaction)

Version: 1.0.0
Interface: scan_movement
Action: sm_22

Payload Definition

Type: `MovementData`

{
  "Version": "String",
  "View": "ENUM: ScanView",
  "Movement": "Float"
}

Example definition

Type: `MovementData`

"MovementData"

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
`F00015`	Enum value out of range
`F00029`	Given value cannot be a lower than 0

`SM_23`: Absolute Rotate (Front End Interaction)

Version: 1.0.0
Interface: scan_movement
Action: sm_23

Payload Definition

Type: `Vector3Data`

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

Example definition

Type: `Vector3Data`

{
  "Version": "1.1.0",
  "X": 0,
  "Y": 0,
  "Z": 0
}

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

`SM_24`: Absolute Rotate 3D Camera without moving Scan Volume (Front End Interaction)

Version: 1.0.0
Interface: scan_movement
Action: sm_24

Payload Definition

Type: `Vector3Data`

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

Example definition

Type: `Vector3Data`

{
  "Version": "1.1.0",
  "X": 0,
  "Y": 0,
  "Z": 0
}

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

`SM_25`: Automatically Set Zoom to Fit Canvas at Load

Version: 1.0.0
Interface: scan_movement
Action: sm_25

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.
`F00001`	Function is not defined
`F00008`	Function is not found