|
Carna Registration API Version 1.16.0
|
The Carna Registration API is meant as an unified layer between Carna and Localizer DLL. It makes registering tools and virtual scene elements as simple as possible.
The usage of the Carna Registration API is fairly simple.
First of all, instantiate any implementation of the Localizer interface: This interface represents the tracking service. If you want to keep things simple, simply choose the DefaultLocalizer implementation. However, if you do require more scalability control, you might want to choose to use the LazyLocalizer proxy.
Now that you have your tracking service responsive, you can define any number of Tool objects - those represent the objects that are trackable by your tracking service. Likely the ToolByPort implementation will satisfy your needs: You must pass a reference to the previously defined Localizer to their constructor.
The next step is to establish logical links between trackable objects (tools) and your virtual scene elements. Those links basically describe which tool represents which virtual scene element. Those scene elements are represented by the VirtualElement interface: Choose between the LinkedObject adapter implementation and the LinkedCamera. In order to establish a link, simply pass a pair of corresponding representative objects to a Link instance each.
The final step is to define a registration: This is done by instantiating the Registration class and providing it the links defined priorly. When instantiating this class, you will have to choose some featured tool as your reference base. Furthermore you will have to provide any \( 4 \times 4 \) transforamtion matrix to the registration.
That's it: now invoke Registration::updateVirtualElements periodically, e.g. by a timer.
Requires at least Carna 2.3.
Documentation generated by Doxygen
