Mcad

MC_01: Load STL/OBJ Data

• Version: 1.0.0
• Interface: mcad
• Action: mc_01

Payload Definition

Type: InitialMcadState

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

Example definition

Type: InitialMcadState

"InitialMcadState"

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.
A00004	Element was invalid for function. Element will be skipped.
I00003	Missing fields were replaced with default values. {INPUTS}

MC_02: 3D MCAD Event (Interaction in Unity, Data Display on Front End)

• Version: 1.0.0
• Interface: mcad
• Action: mc_02

Payload Definition

Type: McadInteraction

{
  "Version": "String",
  "Mcad": {
    "Version": "String",
    "Id": "String",
    "Position": {
      "Version": "String",
      "X": "Float",
      "Y": "Float",
      "Z": "Float"
    },
    "Rotation": {
      "Version": "String",
      "X": "Float",
      "Y": "Float",
      "Z": "Float"
    },
    "Scale": {
      "Version": "String",
      "X": "Float",
      "Y": "Float",
      "Z": "Float"
    },
    "Inverted": {
      "Version": "String",
      "InvertedSagittal": "Boolean",
      "InvertedCoronal": "Boolean",
      "InvertedTransverse": "Boolean"
    },
    "Colour": {
      "Version": "String",
      "R": "Float",
      "G": "Float",
      "B": "Float",
      "A": "Float"
    },
    "Visibility": "Boolean",
    "Title": "String",
    "Description": "String",
    "CallToAction": "String",
    "Key": "String",
    "Orientation": {
      "Version": "String",
      "Modifiers": "ENUM: Orientation",
      "ReferencePoint": {
        "Version": "String",
        "X": "Float",
        "Y": "Float",
        "Z": "Float"
      },
      "Position": {
        "Version": "String",
        "X": "Float",
        "Y": "Float",
        "Z": "Float"
      },
      "Rotation": {
        "Version": "String",
        "X": "Float",
        "Y": "Float",
        "Z": "Float"
      },
      "Scale": {
        "Version": "String",
        "X": "Float",
        "Y": "Float",
        "Z": "Float"
      }
    }
  },
  "Interaction": "ENUM: Interactiontype"
}

Example definition

Type: McadInteraction

"McadInteraction"

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

MC_03: Set Visibility of Individual MCAD Objects

• Version: 1.0.0
• Interface: mcad
• Action: mc_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
F00030	Mcad with Id, {ID}, could not be found.

MC_04: Set Colour & Opacity of Individual MCAD Objects

• Version: 1.0.0
• Interface: mcad
• Action: mc_04

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
F00030	Mcad with Id, {ID}, could not be found.

MC_05: Move Individual MCAD Objects in X, Y, Z Planes (Unity-based Interaction)

• Version: 1.0.0
• Interface: mcad
• Action: mc_05

Payload Definition

Type: ObjectBoolean

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

Example definition

Type: ObjectBoolean

"ObjectBoolean"

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
F00030	Mcad with Id, {ID}, could not be found.

MC_16: Invert MCAD Data

• Version: 1.0.0
• Interface: mcad
• Action: mc_16

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
F00030	Mcad with Id, {ID}, could not be found.