From a37b6f8c2c559ee5efd31f71b12548e8e474d427 Mon Sep 17 00:00:00 2001 From: Artem30801 Date: Mon, 12 Oct 2020 01:20:27 +0300 Subject: [PATCH] docs: updated addon docs to include basic info about animation creation --- blender-addon/README.md | 3 ++- docs/en/blender-addon.md | 24 ++++++++++++++++++++++-- 2 files changed, 24 insertions(+), 3 deletions(-) diff --git a/blender-addon/README.md b/blender-addon/README.md index 9fb1d70..0cc84c0 100644 --- a/blender-addon/README.md +++ b/blender-addon/README.md @@ -9,5 +9,6 @@ Export result is a folder with .csv files where each line in file represents a * `red, green, blue` values of the color of an object, each is integer from 0 to 255 Documentation is located here: -* English + +* [English](../docs/en/blender-addon.md) * [Russian](../docs/ru/blender-addon.md) diff --git a/docs/en/blender-addon.md b/docs/en/blender-addon.md index 7a8aeb3..0696b02 100644 --- a/docs/en/blender-addon.md +++ b/docs/en/blender-addon.md @@ -2,7 +2,17 @@ The Addon for Blender is designed to convert Blender's copters flight animations into flight paths for each copter of the animation, including the color of objects at any given time. -## Installation and configuration +## Making the animation + +In order to export drone animation you need to animate movements of any object(s) representing a drone. Coordinates of the drone objects will be used as coordinates for drone animation playback for each frame. +Material color of the object will be exported as LED strip color for each frame. The material name should start with `led`. If material uses nodes, type of material node should be `Emmision` or `Diffuse`. + +If you don't know how to work in Blender you can check out those links: +* [Officail documentation - Interface](https://docs.blender.org/manual/en/latest/interface/index.html) +* [Officail documentation - Animation](https://docs.blender.org/manual/en/latest/animation/index.html) +* [Hotkeys cheat sheet](https://docs.google.com/document/d/1zPBgZAdftWa6WVa7UIFUqW_7EcqOYE0X743RqFuJL3o/edit?usp=sharing) + +## Addon installation and configuration * Download and install the latest version of Blender 2.90 from [the official website](https://www.blender.org/download/). * Open Blender, select `Edit > Preferences` from the top menu. In the opened settings window, select `Add-ons` in the side panel. Click the button `Install...` in the upper right corner of the window. In the dialog box, open the path to the addon folder [clever-show/blender-addon](.../../blender-addon/) and select the file `addon.py`. Click `Install Add-on from file...`. Addon is now installed. @@ -10,6 +20,12 @@ The Addon for Blender is designed to convert Blender's copters flight animations Addon is now active and ready to go. You will not need to perform these operations at further Blender startups on the same PC. +You may want to change FPS of in-Blender animation playback to match it with drone animation execution speed (10 frames per second). In order to change it go to : + +>Properties editor (by default, on the left) > Output properties tab > Dimensions panel > Frame Rate + +Change value of the property to `Custom`, then change value of appeared below `FPS` property to `10`. + ## Exporting with the addon * To open the export dialog box, click on the top menu `File > Export > clever-show animation (.csv)`. In the export window that opens, you should select the destination export path and the name of the folder that the addon will create during the export process. The export options panel is available in the side menu: @@ -18,7 +34,11 @@ Addon is now active and ready to go. You will not need to perform these operatio * `Speed limit` - warnings will be displayed if the specified speed limit is violated. * `Distance limit` - warnings will be displayed if the specified minimum distance between drones is violated. -After configuring the required parameters, press the `Export clever-show animation` button. Animations of the specified objects from the Blender project will be exported to the specified folder in the `.csv` format. +After configuring the required parameters, press the `Export clever-show animation` button. Animations of the specified objects from the Blender project will be exported to the specified folder as files in the `.csv` format where each line in file represents a sequence with comma delimiter: + +* `x, y, z` coordinates of an object in meters +* `yaw` of an object in radians +* `red, green, blue` values of the color of an object, each is integer from 0 to 255 ## Deactivation and removal