Model animations¶
Animations allows to visualize state of equipment in a model by applying the visual effects to a model object. There are following animation types are supported:
- Color. Colors an object with the given color. Optionally object can blink with the given frequency.
- Outline. Draw an object outline with the given color, width, intensity and blurring of the outline. Optionally can blink with the given frequency. Outline can be set to be visible through other objects. Also requires more client hardware resources. Not recommended to use too much outlines especially with the complicated geometry objects
- Rotation. Rotates object clockwise be the vertical axis.
Get list of animations¶
Request¶
GET /models/animations/raw
| Parameter | Description |
|---|---|
| clientname | (mandatory) Portfolio name |
| Authorization | (mandatory) Authentication token |
| select | (optional) List of fields to include into the result |
| filter | (optional) Filter parameters |
| Sort | (optional) Sorting parameters |
Response sample¶
[
{
"Name": "Test animation",
"Definition": "{\"Models\":[{\"Id\":\"f6e60649-aea1-4c3b-a627-0bf83f00b3f8\",\"Ids\":[\"68e3adeb-69f1-4edd-9fea-ebebe475ab3d-001843f8\",\"68e3adeb-69f1-4edd-9fea-ebebe475ab3d-001843f4\",\"68c03d5f-e7b7-47a0-8abb-9f13b8991453-00169e77\"]}],\"Animations\":[{\"Conditions\":[{\"RDSVar\":\"\",\"Type\":\"Equals\",\"Value1\":true}],\"LogicalOperation\":\"AND\",\"AnimationType\":\"Color\",\"Parameters\":\"{\\\"Speed\\\":10.0,\\\"Color\\\":\\\"#1E90FF\\\"}\",\"IsBlinked\":true}]}",
"Id": "5abb3958-7b71-46ca-8eba-8b4143e65d21"
},
{
"Name": "Pump state",
"Definition": "{\"Models\":[{\"Id\":\"f6e60649-aea1-4c3b-a627-0bf83f00b3f8\",\"Ids\":[\"68e3adeb-69f1-4edd-9fea-ebebe475ab3d-00184401\"]}],\"Animations\":[{\"Conditions\":[{\"RDSVar\":\"HSS_A0_L1009_0000ITP_PE09_PV\",\"Type\":\"Greater\",\"Value1\":10}],\"LogicalOperation\":\"AND\",\"AnimationType\":\"Color\",\"Parameters\":\"{\\\"Speed\\\":10.0,\\\"Color\\\":\\\"#1E90FF\\\"}\",\"IsBlinked\":true},{\"Conditions\":[{\"RDSVar\":\"HSS_A0_L1009_0000ITP_PE09_PV\",\"Type\":\"Greater\",\"Value1\":50}],\"LogicalOperation\":\"AND\",\"AnimationType\":\"Color\",\"Parameters\":\"{\\\"Speed\\\":20.0,\\\"Color\\\":\\\"#0000FF\\\"}\",\"IsBlinked\":true}]}",
"Id": "1bee937f-aec6-4579-8284-b50149bf63aa"
}
]
Create animation¶
POST /models/animations/raw
Payload example¶
{
"Name": "Pump state",
"Definition": "{\"Models\":[{\"Id\":\"f6e60649-aea1-4c3b-a627-0bf83f00b3f8\",\"Ids\":[\"68e3adeb-69f1-4edd-9fea-ebebe475ab3d-00184401\"]}],\"Animations\":[{\"Conditions\":[{\"RDSVar\":\"HSS_A0_L1009_0000ITP_PE09_PV\",\"Type\":\"Greater\",\"Value1\":10}],\"LogicalOperation\":\"AND\",\"AnimationType\":\"Color\",\"Parameters\":\"{\\\"Speed\\\":10.0,\\\"Color\\\":\\\"#1E90FF\\\"}\",\"IsBlinked\":true},{\"Conditions\":[{\"RDSVar\":\"HSS_A0_L1009_0000ITP_PE09_PV\",\"Type\":\"Greater\",\"Value1\":50}],\"LogicalOperation\":\"AND\",\"AnimationType\":\"Color\",\"Parameters\":\"{\\\"Speed\\\":20.0,\\\"Color\\\":\\\"#0000FF\\\"}\",\"IsBlinked\":true}]}"
}
Modify animation¶
PUT /models/animations/raw/{animationId}
Payload example¶
{
"Name": "Pump state",
"Definition": "{\"Models\":[{\"Id\":\"f6e60649-aea1-4c3b-a627-0bf83f00b3f8\",\"Ids\":[\"68e3adeb-69f1-4edd-9fea-ebebe475ab3d-00184401\"]}],\"Animations\":[{\"Conditions\":[{\"RDSVar\":\"HSS_A0_L1009_0000ITP_PE09_PV\",\"Type\":\"Greater\",\"Value1\":10}],\"LogicalOperation\":\"AND\",\"AnimationType\":\"Color\",\"Parameters\":\"{\\\"Speed\\\":10.0,\\\"Color\\\":\\\"#1E90FF\\\"}\",\"IsBlinked\":true},{\"Conditions\":[{\"RDSVar\":\"HSS_A0_L1009_0000ITP_PE09_PV\",\"Type\":\"Greater\",\"Value1\":50}],\"LogicalOperation\":\"AND\",\"AnimationType\":\"Color\",\"Parameters\":\"{\\\"Speed\\\":20.0,\\\"Color\\\":\\\"#0000FF\\\"}\",\"IsBlinked\":true}]}",
"Id": "1bee937f-aec6-4579-8284-b50149bf63aa"
}