Skip to content

Commit

Permalink
doc: updated documentation with SVG and other new import/export options
Browse files Browse the repository at this point in the history
  • Loading branch information
vasarhelyi authored and ntamas committed Oct 12, 2023
1 parent 618a593 commit b84c254
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 1 deletion.
9 changes: 8 additions & 1 deletion doc/modules/ROOT/pages/features.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,13 @@ Formations::
* Smart tools for static/dynamic formation creation
* Easy integration of internal or external 3D animations
* Automatic transitions between formations
* Smart takeoff, return-to-home and landing
* Simple and smart takeoff in multiple phases
* Simple and smart return-to-home and landing

Import & Compatibility::
* Modular import of external formations or animation snippets using simple `.csv` format
* Optimal sampling of drones onto imported SVG drawings
* QR code generation based on a simple url

Lights::
* Dedicated color animation design tools
Expand All @@ -27,3 +33,4 @@ Export & Compatibility::
* Compatible with *Skybrush Viewer* (standalone interactive 3D preview with music, verification, VR and cloud/browser support for easy and clean client previews)
* Compatible with *Skybrush Live* for professional drone show management (2D map, 3D view, list view, compressed view, individual and fleet-level details and checks, RTK support, geofence, auto mapping and a lot more)
* Shows can be exported in Skybrush compiled show format (preferred) or as sampled positions and RGB colors with a fixed FPS in CSV format for further post-processing with external tools
* Shows can also be exported into most of the known drone show formats on the market
2 changes: 2 additions & 0 deletions doc/modules/ROOT/pages/panels/formations/formations.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,8 @@ From static CSV file:: Use this option to import a previously created static for

From zipped CSV files:: Use this option to import previously created animated formations or entire shows modularly from an external .zip source that contains multiple .csv files (one per drone), each containing baked trajectory and light animation in the following line format (colors are optional): `Time_msec`, `x_m`, `y_m`, `z_m`, `Red`, `Green`, `Blue`

From SVG file:: Use this option to import an SVG file to sample it with the given number of drones. Note that only simple, flat SVG files can be imported correctly, and only vector graphic shapes are supported from the SVG file, text, images and other complex formats are not supported (we support what is supported by the external `svgpathtools` Python library). The importer tries to optimize the given number of drones to the imported shapes, which might result in ugly results if there are not enough or too many drones or if the curves are too complex. Try to simplify the SVG before importing as much as possible and experiment iteratively to find the proper number of drones for your SVG drawing! Colors of the curves are also imported.

From QR code:: Use this option to generate a static QR code as part of the show.

== Updating a formation
Expand Down

0 comments on commit b84c254

Please sign in to comment.