License
This work is licensed under the MIT license.
Example
![Example display](https://github.com/m-kro/splitflap/raw/main/example.png)
Installation
The folder ./SplitFlapTable contains all the necessary files. Make a zip archive from it and you are ready to
install in in the Blender UI:
Menu > Edit > Preferences > Addons > Install...
.
Requirements
The addon uses the python module pillow to generate the texture images. The module has to be installed to the
python instance that ships with the Blender installation. For this, open a command line where the binary is located
(usually <Blender version>/python/bin
) and execute the following python call:
python -m pip install pillow
Usage
- Open the addon panels in Blender 3D View pressing [N]
- Edit the upper panel settings to create a set of split flap items from the addon template, specify the available characters etc.
- Define the animation using the lower panel: enter time keys in seconds and the texts to display
- Then hit the button to create the animation using the flip speed defined during the split flap item creation
Some time keys may not be allowed as the switch from one text to the next cannot be completed in the meantime.
UI
![User interface](https://github.com/m-kro/splitflap/raw/main/splitFlapUIDesc.png)
Meaning and usage of the UI elements:
- Number of split flap items in horizontal direction
- Number of split flap items in vertical direction
- Space between neighbour split flap items in horizontal direction
- Space between neighbour split flap items in vertical direction
- Radius of the circle where all character cards of the split flap item are attached to
- Time in seconds to switch from one character to the next one in the character order
- Characters to be included in the split flap item (and implicitly how many character cards should be generated)
- Share of the card width a character should fill at most
- Share of the card height (sum of upper and lower part) a character should fill at most
- Ratio of the card width vs. card height (sum of upper and lower part)
- System font to select for the character texture
- Prefix for auto-generated objects and their collection
- Colour used for the characters
- Colour used for the background of the character cards
- Activate to generate a black metallic frame object around the split flap item table
- Generate the split flap item table according to the settings above
- List of split flap item states (text to display, time and collection of split flap items) previously entered through the UI items below
- Activate to enter the text to display directly in the input field next to it (does not allow multi-line text) / use text data block input otherwise
- Either input field for text to display or list of available text data blocks to take the text from (select one of them)
- Time in seconds the animation to display the text should start (text is already on display if time == 0)
- Activate to append space (" ") character to text to display if shorter than possible by the number of split flap items
- Activate to distribute added space characters such that the text is centered (currently works only for a single row)
- List of available split flap collections to use for displaying text
- Save the entered settings to the list of element 17 / Update an existing setting by first selecting it in element 17, editing data in the single UI items and then press this button / Remove a setting previously selected in element 17
- Generate the animation according to the settings saved in element 17
Enter text to be displayed
Two separate ways of entering the text to be displayed are offered. This is mainly due to limitations in the Blender UI
concerning multi-line text.
- Enter the text directly in the input field of the panel added by this Blender addon: No multi-line text
- Use Text data blocks for multi-line text: Open the Text Editor, add a new data block by "+ New", name it, enter your text, select the data block later in UI element 19
Delete items generated through the addon
The addon relies on some invariants, especially the IDs of template 3D objects and materials it uses to generate the final split flap items.
As Blender resolves naming conflicts by appending suffixes, this may disturb the correct function of the addon. If you delete items created through the addon, the .blend file should be saved and reloaded to clear the Blender ID cache. Only then the templates can be imported again without seeing their IDs altered.
Compatibility
Developed using Blender 3.4. Tested with Blender 4.0.