Navigation Cube

NC_01: Set Navigation Cube Co-Ordinates And/Or Size

• Version: 1.0.0
• Interface: navigation_cube
• Action: nc_01

Payload Definition

Type: NavigationCubeTransform

{
  "Version": "String",
  "AnchorPoint": "ENUM: AnchorPoint",
  "Position": {
    "Version": "String",
    "X": "Float",
    "Y": "Float"
  },
  "Size": {
    "Version": "String",
    "X": "Float",
    "Y": "Float"
  }
}

Example definition

Type: NavigationCubeTransform

{
  "Version": "1.0.0",
  "AnchorPoint": 0,
  "Position": {
    "Version": "1.0.0",
    "X": 0,
    "Y": 0
  },
  "Size": {
    "Version": "1.0.0",
    "X": 0,
    "Y": 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
F00002	Input data is not valid for function
F00006	Action did not execute within an allotted time
F00008	Function is not found
F00011	The payload supplied is invalid
F00014
F00021	When two inputs are null, but at least one is required
F00029	Given value cannot be a lower than 0
A00005	Part of the navigation cube is out of view.

NC_02: Set Navigation Cube Visibility

• Version: 1.0.0
• Interface: navigation_cube
• Action: nc_02

Payload Definition

Type: InteractivityState

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

Example definition

Type: InteractivityState

{
  "Version": "0.0.1",
  "Value": true
}

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

NC_03: Set Navigation Cube Rotation

• Version: 1.0.0
• Interface: navigation_cube
• Action: nc_03

Payload Definition

Type: InteractivityState

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

Example definition

Type: InteractivityState

{
  "Version": "0.0.1",
  "Value": true
}

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
F00002	Input data is not valid for function
F00006	Action did not execute within an allotted time
F00008	Function is not found

NC_04: Set Navigation Cube Interactivity

• Version: 1.0.0
• Interface: navigation_cube
• Action: nc_04

Payload Definition

Type: InteractivityState

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

Example definition

Type: InteractivityState

{
  "Version": "0.0.1",
  "Value": true
}

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
F00002	Input data is not valid for function
F00006	Action did not execute within an allotted time
F00008	Function is not found

NC_05: Navigation Cube Colour & Opacity

• Version: 1.0.0
• Interface: navigation_cube
• Action: nc_05

Payload Definition

Type: ColourData

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

Example definition

Type: ColourData

{
  "Version": "1.1.0",
  "R": 0,
  "G": 0,
  "B": 0,
  "A": 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
F00014

NC_07: Navigation Cube Highlight Colour

• Version: 1.0.0
• Interface: navigation_cube
• Action: nc_07

Payload Definition

Type: ColourData

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

Example definition

Type: ColourData

{
  "Version": "1.1.0",
  "R": 0,
  "G": 0,
  "B": 0,
  "A": 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
F00014

NC_08: Set Navigation Cube Face Graphics

• Version: 1.0.0
• Interface: navigation_cube
• Action: nc_08

Payload Definition

Type: EnumPayload

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

Example definition

Type: EnumPayload

{
  "Version": "0.0.1",
  "Value": 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