Skip to content

Commit

Permalink
docs: update docs with new drone radius param
Browse files Browse the repository at this point in the history
(last commit message is wrong, it is not about column spacing but drone radius, sorry)
  • Loading branch information
vasarhelyi committed Oct 9, 2024
1 parent c113296 commit f124454
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 5 deletions.
Binary file modified doc/modules/ROOT/assets/images/panels/swarm/swarm.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 12 additions & 2 deletions doc/modules/ROOT/pages/panels/formations/swarm.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,20 @@ The swarm panel helps you setup your drone show with all technical parts that ar

image::panels/swarm/swarm.jpg[Swarm panel]

== Show type

Please specify whether you designed a show for outdoor or indoor settings. This will help setup drone size, exporters and possibly other parameters adaptively.

== Drone collection

Click on the btn:[Drones] button to select the collection that is your primary source of your drone objects. By default you do not have to change this setting, the btn:[Create Takeoff Grid] button below will create a "Drones" collection and set it as your primary source automatically.

IMPORTANT: Any mesh that is placed in the collection selected here will be treated as a drone by *Skybrush Studio*, and it may adjust the constraints and other properties of the mesh as needed when performing certain operations. Make sure that there are no other objects in the collection that you select here, only the ones that you want to consider drones.

== Max acceleration

The btn:[Max acceleration] button sets up a maximal acceleration (in all directions) that is used by the automated motion planning functions of *Skybrush Studio*, for example when automatic transitions or transition times are calculated.

== Drone template

Before creating your first takeoff grid that initializes your drone objects, you can select a template object for your future drones. There are three options to select from, given by the btn:[Drone template] drop down menu.
Expand All @@ -22,9 +30,11 @@ The default option is an isotropic *Sphere*. Select *Cone* to have a simple anis

If *Selected Object* is chosen, make sure you have your template object selected before pressing the btn:[Create takeoff grid] button. Note that this object will disappear after the creation of the swarm as it shall be used for the template only.

== Max acceleration
== Drone radius

The btn:[Max acceleration] button sets up a maximal acceleration (in all directions) that is used by the automated motion planning functions of *Skybrush Studio*, for example when automatic transitions or transition times are calculated.
If you select a "Sphere" or "Cone" type drone template, you can also setup a radius for your template object before creating your first takeoff grid. Similarly to the btn:[Drone template] option, this setting will also disappear after creating the takeoff grid.

If you wish to change your drone size at a later stage, you can use standard Blender tools for this. First select all your drone objects you wish to resize, then set the "Transform Pivot Point" to "Individual Origins" and the simply scale up all objects around their own origins with kbd:[s].

== Create Takeoff Grid

Expand Down
10 changes: 7 additions & 3 deletions doc/modules/ROOT/pages/panels/safety_and_export/export.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@

Once you are finished with your drone show, use the Export panel to export it from Blender to different formats for further processing or direct upload to the drones.

image::panels/export/export.jpg[Export panel]
The available output formats depend on whether you selected the "Indoor" or "Outdoor" setting in the xref:panels/formations/swarm.adoc[Swarm panel]'s btn:[Show type] dropdown, and also on your specific license purchased.
== Show type
image::panels/export/export.jpg[Export panel]
Please specify whether you designed a show for outdoor or indoor settings. This will help setup exporters adaptively.
The following options are available in general...
== Export to .skyc
Expand Down Expand Up @@ -81,3 +81,7 @@ WARNING: Creating this plot might take a longer time, depending on the number of
Create individual drone plots:: Include validation plots for each drone individually on separate pages in the final output.
+
WARNING: Creating these plots might take a long time, depending on the number of drones, frames and output frame rate.
== Export to third-party show formats
Upon purchasing a professional license, we provide additional exporters to various external drone show formats. mailto:support@collmot.com[Contact us] for details.

0 comments on commit f124454

Please sign in to comment.