Hypertubes
Get a list of all Hypertubes.
Response Body
| Name | Type | Description |
|---|---|---|
ID |
String |
Unique ID of the Hypertube. |
Name |
String |
Name of the Hypertube Type. |
ClassName |
String |
Class Name of the Hypertube. |
ColorSlot |
Object |
Color/Decoration information about the Actor. |
PrimaryColor |
String |
Hex Code of Primary Color |
SecondaryColor |
String |
Hex Code of Secondary Color |
BoundingBox |
Object |
Bounding Box information about the Actor. |
min |
Object |
The minimum boundary of the bounding box in the corresponding axis. |
x |
Float |
Value along the X-axis. |
y |
Float |
Value along the Y-axis. |
z |
Float |
Value along the Z-axis. |
max |
Object |
The maximum boundary of the bounding box in the corresponding axis. |
x |
Float |
Value along the X-axis. |
y |
Float |
Value along the Y-axis. |
z |
Float |
Value along the Z-axis. |
location0 |
Object |
Start Location of the Hypertube |
x |
Float |
X Location in the World. |
y |
Float |
Y Location in the World. |
z |
Float |
Z Location in the World. |
Connected0 |
Boolean |
Is Hypertube Connected at starting point? |
location1 |
Object |
End Location of the Hypertube |
x |
Float |
X Location in the World. |
y |
Float |
Y Location in the World. |
z |
Float |
Z Location in the World. |
Connected1 |
Boolean |
Is Hypertube Connected at ending point? |
Length |
Float |
Length of the Hypertube in centimetre (cm). |
ItemsPerMinute |
Float |
Speed of the Hypertube. |
features |
Object |
An object with actor coordinates and name information. |
properties |
Object |
Name information about the actor. |
name |
String |
Display Name of the Actor. |
type |
String |
Type of the Object. |
geometry |
Object |
Geometry information about the Actor. |
coordinates |
Object |
The Actor coordinates. |
x |
Float |
X Location of the Actor. |
y |
Float |
Y Location of the Actor. |
z |
Float |
Z Location of the Actor. |
type |
String |
It’s always "Point". |
Example Response
[
{
"ID": "Build_PipeHyper_C_2146320548",
"Name": "Hypertube",
"ClassName": "Build_PipeHyper_C",
"location": {
"x": -251831.75,
"y": -66029.2421875,
"z": 1143.29541015625,
"rotation": 90
},
"BoundingBox": {
"min": {
"x": -251831.75,
"y": -66029.2421875,
"z": 1143.29541015625
},
"max": {
"x": -251831.75,
"y": -66029.2421875,
"z": 1143.29541015625
}
},
"ColorSlot": {
"PrimaryColor": "2D2D2D00",
"SecondaryColor": "00000000"
},
"location0": {
"x": -251831.75,
"y": -66029.2421875,
"z": 1143.29541015625
},
"location1": {
"x": -252129.647245099,
"y": -65920.8164624313,
"z": 710.0068359375
},
"SplineData": [
{
"x": -251831.75,
"y": -66029.2421875,
"z": 1143.29541015625
},
{
"x": -251878.262411959,
"y": -66012.3130548064,
"z": 1093.79793547319
},
{
"x": -252004.95387678,
"y": -65966.2011348097,
"z": 735.437320947647
},
{
"x": -252063.868761288,
"y": -65944.7578714859,
"z": 710.0068359375
},
{
"x": -252129.647245099,
"y": -65920.8164624313,
"z": 710.0068359375
}
]
}
]