Commit aad5508a authored by Jérémy Lacoche's avatar Jérémy Lacoche
Browse files

World Storage API 1.0 from previous repo

parent 97a51f1e

API/API calls.md

0 → 100644
+13 −0
Original line number Diff line number Diff line 
# API calls



## AR17-AddTrackable



![](../API/SEQ-AR17-AddTrackable.png)



## AR17-AddStructuralModelToTrackable



![SEQ-AR17-AddStructuralModelToTrackable](./SEQ-AR17-AddStructuralModelToTrackable.png)



## AR17-RemoveTrackable



![SEQ-AR17-RemoveTrackable](./SEQ-AR17-RemoveTrackable.png)

API/SEQ-AR17-AddStructuralModelToTrackable.png

0 → 100644
+17.7 KiB
Loading image diff...

API/SEQ-AR17-AddStructuralModelToTrackable.puml

0 → 100644
+27 −0
Original line number Diff line number Diff line 
@startuml



participant "World Storage"  as WS

participant "Authoring Tool" as AT



rnote left AT

**Payload**

  Creator UID

+ Trackable UID

+ 3D Transform

+ Unit System

+ Scale

+ Structural Model URL

end rnote



WS <- AT: AR17-AddStructuralModelToTrackable()



alt successful case



return Link ID



else UID not found

WS -> AT: AR17-UID not found



end



@enduml

API/SEQ-AR17-AddTrackable.png

0 → 100644
+41.7 KiB
Loading image diff...

API/SEQ-AR17-AddTrackable.puml

0 → 100644
+45 −0
Original line number Diff line number Diff line 
@startuml



participant "World Storage"  as WS

participant "Authoring Tool" as AT



rnote left AT

**Payload**

  Creator UID

+ Trackable Type

+ Trackable Encoding Information

+ Trackable Payload

+ Local CRS

+ Unit System 

+ Trackable Scale

+ KeyValue Tag List

end rnote



WS <- AT: AR17-AddTrackable()

activate WS



WS -> WS : Extract features







alt successful case

rnote right WS

**Payload**

  Unique Identifier

end rnote

WS -> AT: AR17-Trackable unique Identifier

deactivate WS

note right AT

Stores the identifier with the Trackable in the scene graph

end note

else Trackable type not supported

WS -> AT: AR17-Trackable type not supported

else Trackable Encoding not supported

WS -> AT: AR17-Trackable Encoding not supported

else Trackable Decoding failed

WS -> AT: AR17- Trackable Decoding failed

else Trackable feature extraction error.

WS -> AT: AR17- Trackable feature extraction error.

end



@enduml