WIP: Brushstroke Tools: Initial Version #328

Simon Thommes · 2024-08-21T14:55:18+02:00

Simon Thommes commented

2024-08-21 14:55:18 +02:00

Package brushstroke tooling developed for the Blender Studio Project Gold production based majorly on Geometry Nodes in a convenient addon to create, manage and edit brushstroke objects.

Principles

base implementation of features on technical level should be as generic as reasonably possible
- proof-of-concept for potential future node-tools workflow
allow highly flexible workflow for advanced users, while providing intuitive and simple UX for the average user
avoid changes to surface objects (use on linked data)

Progress

Required:

initial migration from (WIP) Scribble Buddy repository
convert into extension
include brushstroke assets in resources
use brushstroke node-groups for presets
add scatter(/fill) functionality
- split presets into categories
- create flow object
- integrate scattering nodes
define context flow object (flag + context)
- add concept and tracking of flow object
- context flag in modifier
additional context link types (Material, UVMap)
Reuse surface object instead of stacking
display brushstroke Modifier UI based on context
- Show sibling context
- UI for multiple context brushstroke objects
- detach modifier display from active object (?)
handle active context brushstrokes switching
- active object / selection
- mode
add operators to uilist
- delete
- edit
- duplicate
- add helper object
- Select Surface
- Copy to selected surface objects
- Copy All to selected surface objects
make edit mode node tools available for marking brush flow
fix pointer property editing in viewport context
basic material style setup
expose material properties as part of preset
node-group refactor (scope TBD, as modular as possible)
deformation handling (+ linked data)
validate/mitigate performance penalty of continuous context checks
set up parenting relation
options to simplify modifier UI by hiding/pinning individual sockets (ability to reset)
preferences to include textures/datablocks or link
operators to fix mod_info data once out of sync
operator to fix render settings
write docs

Nice to have:

change edit button label depending on context method
brushstrokes renaming
pie menu for edit mode operators
allow no surface context
hook up preset system to assets (empty objects, material pointer ?)
allow for link workflow
allow resource path customization
brush stroke style management and customization
create new brush style node-groups and push to library based on atlas image
- potentially customizable atlas layout
customizable default naming pattern
customizable collection assignment rules
estimate fill density
- ~~hook up to bounding box size via context linking with exponent slider~~
display link enum options based on input type
more context link types
operators to create and assign flow/break etc. afterwards
option to reuse flow object
expose material viewport color
visibility options in layer stack
use project on selection with surface obejct
copy settings to selected
copy brushstrokes to selected surface
context dependent UI based on enum sockets
tag brushstrokes object with addon version number

TBD:

simplify
- remove/hide custom draw tool functionality
- restrict modifier system to brush stroke asset stack
brush stroke type based on ID
baking utilities
more context link types
- Active Camera Object
- Random Value
- Custom
apply curves step
change fill/draw into enum and base purely on presets
fill coloration workflow (flow object/color object/texture/setting/attribute)
custom attribute drawing in tool settings

To Fix:

rename modifiers
image texture path options
material assignment messed up when preset is initialized
UVmap linking on surface draw method (?)
fix use attribute button
select active + edit accumulates editing context
add deformation modifier on flow curves
allow id picking for textures and materials
tracking active brushstrokes layer
write back preset of active brushstrokes layer, even when node active object
nullchecks (e.g. deleted surface obj)
missing icon for draw tool
missing constraint on flow object
keep context all links when writing back to preset
- copy complete socket info to brushstroke object
change use_attribute toggle when brush stroke object isn't active
change delete modifier operator when brush stroke object isn't active
make make preset work on active context brushstroke if not active object

Nodes

refactor and modularize
surface vs point flow modes
separate meshing node-group (?)
propagate additional properties from flow curves
- size
- color
- noise
random orientation without flow
randomization of general orientation
color methods
break on surface creases/edges
figure out proper normals (alternatively)
tangent space back-deformation

Package brushstroke tooling developed for the Blender Studio Project Gold production based majorly on Geometry Nodes in a convenient addon to create, manage and edit brushstroke objects. ### Principles - base implementation of features on technical level should be as generic as reasonably possible - proof-of-concept for potential future node-tools workflow - allow highly flexible workflow for advanced users, while providing intuitive and simple UX for the average user - avoid changes to surface objects (use on linked data) --- ### Progress #### Required: - [x] initial migration from (WIP) [Scribble Buddy repository](https://projects.blender.org/SimonThommes/scribble-buddy) - [x] convert into extension - [x] include brushstroke assets in resources - [x] use brushstroke node-groups for presets - [x] add scatter(/fill) functionality - [x] split presets into categories - [x] create flow object - [x] integrate scattering nodes - [x] define context flow object (flag + context) - [x] add concept and tracking of flow object - [x] context flag in modifier - [x] additional context link types (Material, UVMap) - [x] Reuse surface object instead of stacking - [x] display brushstroke Modifier UI based on context - [x] Show sibling context - [x] UI for multiple context brushstroke objects - [x] detach modifier display from active object (?) - [x] handle active context brushstrokes switching - [x] active object / selection - [x] mode - [ ] add operators to uilist - [x] delete - [x] edit - [x] duplicate - [ ] add helper object - [x] Select Surface - [ ] Copy to selected surface objects - [ ] Copy All to selected surface objects - [x] make edit mode node tools available for marking brush flow - [x] fix pointer property editing in viewport context - [x] basic material style setup - [x] expose material properties as part of preset - [ ] node-group refactor (scope TBD, as modular as possible) - [ ] deformation handling (+ linked data) - [ ] validate/mitigate performance penalty of continuous context checks - [x] set up parenting relation - [x] options to simplify modifier UI by hiding/pinning individual sockets (ability to reset) - [ ] preferences to include textures/datablocks or link - [ ] operators to fix mod_info data once out of sync - [ ] operator to fix render settings - [ ] write docs #### Nice to have: - [x] change edit button label depending on context method - [x] brushstrokes renaming - [x] pie menu for edit mode operators - [ ] allow no surface context - [ ] hook up preset system to assets (empty objects, material pointer ?) - [ ] allow for link workflow - [ ] allow resource path customization - [ ] brush stroke style management and customization - [ ] create new brush style node-groups and push to library based on atlas image - [ ] potentially customizable atlas layout - [ ] customizable default naming pattern - [ ] customizable collection assignment rules - [x] estimate fill density - [ ] ~~hook up to bounding box size via context linking with exponent slider~~ - [ ] display link enum options based on input type - [x] more context link types - [ ] operators to create and assign flow/break etc. afterwards - [x] option to reuse flow object - [ ] expose material viewport color - [x] visibility options in layer stack - [x] use `project on selection` with surface obejct - [ ] copy settings to selected - [ ] copy brushstrokes to selected surface - [x] context dependent UI based on enum sockets - [x] tag brushstrokes object with addon version number #### TBD: - [ ] simplify - [ ] remove/hide custom draw tool functionality - [ ] restrict modifier system to brush stroke asset stack - [ ] brush stroke type based on ID - [ ] baking utilities - [ ] more context link types - [ ] Active Camera Object - [x] Random Value - [ ] Custom - [ ] apply curves step - [ ] change fill/draw into enum and base purely on presets - [ ] fill coloration workflow (flow object/color object/texture/setting/attribute) - [ ] custom attribute drawing in tool settings #### To Fix: - [x] rename modifiers - [ ] image texture path options - [ ] material assignment messed up when preset is initialized - [ ] UVmap linking on surface draw method (?) - [x] fix use attribute button - [ ] select active + edit accumulates editing context - [ ] add deformation modifier on flow curves - [x] allow id picking for textures and materials - [x] tracking active brushstrokes layer - [ ] write back preset of active brushstrokes layer, even when node active object - [ ] nullchecks (e.g. deleted surface obj) - [ ] missing icon for draw tool - [x] missing constraint on flow object - [ ] keep context all links when writing back to preset - [ ] copy complete socket info to brushstroke object - [ ] change `use_attribute` toggle when brush stroke object isn't active - [ ] change delete modifier operator when brush stroke object isn't active - [ ] make `make preset` work on active context brushstroke if not active object --- ### Nodes - [ ] refactor and modularize - [ ] surface vs point flow modes - [ ] separate meshing node-group (?) - [ ] propagate additional properties from flow curves - [ ] size - [x] color - [ ] noise - [ ] random orientation without flow - [ ] randomization of general orientation - [x] color methods - [ ] break on surface creases/edges - [x] figure out proper normals (alternatively) - [ ] tangent space back-deformation

Simon Thommes added 1 commit 2024-08-21 14:55:20 +02:00

Brushstroke Tools: 343a3ad9b0

- initial migration from (WIP) Scribble Buddy repository (https://projects.blender.org/SimonThommes/scribble-buddy)
- convert into extension

Simon Thommes added 1 commit 2024-08-21 15:20:37 +02:00

- change icon 6f13c98284

Simon Thommes added 3 commits 2024-08-21 16:21:47 +02:00

- typos fixed a1c76bbc22

- UI reshuffle af17e5dbe0

- add brushstroke_method property 969dd44df8

Simon Thommes added 2 commits 2024-08-21 18:53:48 +02:00

- split presets into method categories a2485dcd43

- basis for generalized brushstroke context 7378e61cbe

Simon Thommes added 1 commit 2024-08-22 14:49:50 +02:00

- refactor some utility functionality db553e1cb9

Simon Thommes added 3 commits 2024-08-22 17:27:08 +02:00

- add flow object concept f967b92bfa

- re-use surface object from context to avoid chaining 5b8e70e59b

- rename brushstrokes in UIList 0742269206

Simon Thommes added 2 commits 2024-08-22 18:52:57 +02:00

- renema object data alongside object 253bf681b4

- include initial brushstroke nodegroups ee0dea07eb

- include initial brushstroke material
- add initial brush atlas library

Simon Thommes added 3 commits 2024-08-22 19:30:10 +02:00

- always init preset first when adding a new brushstroke instance d54a7d5039

- rename node-groups ce8dec26e9

- initial brushstroke fill/draw preset setup e666f55059

Simon Thommes added 2 commits 2024-08-23 16:21:59 +02:00

- change default density 76d278bf2e

- refactor and extend context linking to more generic implementation 0e32f44f19

Simon Thommes added 1 commit 2024-08-23 17:53:00 +02:00

- small UI improvements f86097ac1b

Simon Thommes added 3 commits 2024-08-23 18:58:14 +02:00

- minor fix to not show init_preset operator out of preset mode 20992ea679

- sync object selection with brushstroke selection 8b562e0a79

- small drawing refactor to reuse type method icons aef3b163f3

Simon Thommes added 2 commits 2024-08-23 19:11:19 +02:00

- replace transform constraint with parenting relationship df7191c29b

- add parenting to flow object

- nullcheck for missing property 161f07c104

Simon Thommes added 1 commit 2024-08-23 19:25:36 +02:00

- adjust node-rgoup defaults f7b144b1a2

Simon Thommes changed title from ~~Brushstroke Tools: Initial Version~~ to WIP: Brushstroke Tools: Initial Version

2024-08-26 12:15:43 +02:00

Simon Thommes added 3 commits 2024-08-26 12:41:47 +02:00

- fix for empty brush context 87c29cee08

- adjust node-group defaults 282e22ad40

- make new brushstrokes active 9df8627513

Simon Thommes added 1 commit 2024-08-26 12:51:06 +02:00

- remove print bee6c3d710

Jacques Lucke reviewed 2024-08-26 12:52:27 +02:00

Jacques Lucke left a comment

First-time contributor

Was just reading this because I was curious, left some general code style comments. Maybe that's useful.

scripts-blender/addons/brushstroke_tools/__init__.py Outdated

						
				@ -0,0 +7,4 @@

					    m.register()

				def unregister():

					for m in modules:

Jacques Lucke commented

2024-08-26 12:42:55 +02:00

First-time contributor

Generally it's recommended to unregister in reverse registration order: for m in reversed(modules):

Generally it's recommended to unregister in reverse registration order: `for m in reversed(modules):`

SimonThommes marked this conversation as resolved

scripts-blender/addons/brushstroke_tools/ops.py Outdated

						
				@ -0,0 +202,4 @@

				            mod_info = settings.preset_object.modifier_info.add()

				            mod_info.name = mod.name

				        utils.mark_socket_context_type(mod_info, 'Socket_2', 'SURFACE_OBJECT')

Jacques Lucke commented

2024-08-26 12:44:25 +02:00

First-time contributor

It's not really necessary to have empty return statements.

SimonThommes marked this conversation as resolved

scripts-blender/addons/brushstroke_tools/settings.py Outdated

						
				@ -0,0 +35,4 @@

				    if not settings.context_brushstrokes:

				        return

				    if len_prev == len(settings.context_brushstrokes):

				        settings.active_context_brushstrokes_index = idx

Jacques Lucke commented

2024-08-26 12:51:52 +02:00

First-time contributor

Generally, the code would be easier to read if line lengths were more limited. E.g. for Blender we have a 120 line length limit. That also makes it easier to have two files open next to each other. Such limits can be enforced automatically with auto-formatters like autopep8 (what we currently use in Blender) or e.g. black.

Generally, the code would be easier to read if line lengths were more limited. E.g. for Blender we have a 120 line length limit. That also makes it easier to have two files open next to each other. Such limits can be enforced automatically with auto-formatters like `autopep8` (what we currently use in Blender) or e.g. `black`.

SimonThommes marked this conversation as resolved

scripts-blender/addons/brushstroke_tools/utils.py Outdated

						
				@ -0,0 +124,4 @@

				    return bs['BSBST_surface_object']

				def get_flow_object(bs):

				    if not 'BSBST_flow_object' in bs.keys():

Jacques Lucke commented

2024-08-26 12:49:23 +02:00

First-time contributor

Would recommend using x not in y instead of not x in y for improved readability.

https://stackoverflow.com/a/3481700

Would recommend using `x not in y` instead of `not x in y` for improved readability. https://stackoverflow.com/a/3481700

SimonThommes marked this conversation as resolved

Simon Thommes added 3 commits 2024-08-26 13:13:08 +02:00

- remove unnecessary depsgraph update 4a2b860880

- unregister in reversed order f8288fb47e

- code style improvements 72bf473bf9

Simon Thommes commented

2024-08-26 13:13:34 +02:00

@JacquesLucke thanks for the input! I implemented most of the suggestions

Simon Thommes added 1 commit 2024-08-26 14:19:09 +02:00

- formatting changes 473c53f211

Simon Thommes added 2 commits 2024-08-26 17:16:43 +02:00

- add ability for custom icons and additional custom link type entries 7545daf2de

- implement random value initialization via context linking 515c824dc1

Simon Thommes added 4 commits 2024-08-27 15:13:02 +02:00

- rename mod_info hierarchy to make it more clear 523232bc59

- add function to create deep copy of mod_info c8f840e9e1

- reorganize fill settings 27773e1a8c

- implement different color methods (base + texture + curves)

- add functionality to customize UI by hiding modifiers/panels/sockets 9debde1599

Simon Thommes added 2 commits 2024-08-27 17:00:35 +02:00

- implement keyword matching to hide inputs based on menu switch 232708666c

- tweak defaults and node-group 311d8f20cb

Simon Thommes added 1 commit 2024-08-27 17:10:33 +02:00

- minor draw tool improvements 974a4bd6c5

Simon Thommes added 2 commits 2024-08-27 17:23:05 +02:00

- remove wrong property assignment b135be19f7

- disable all rendering visibility options for flow object 8e8ff6d687

Simon Thommes added 1 commit 2024-08-27 17:49:45 +02:00

- UI tweaks a1b55956c8

Simon Thommes added 1 commit 2024-08-27 18:03:46 +02:00

- reuse flow object from active brushstrokes as option b938c8909b

Simon Thommes added 8 commits 2024-08-28 16:53:29 +02:00

Kitsu: Fix bulk shot initialization fa3ba599f8

The manual_shot_name prop was being evaluated exclusively (ignoring
shot_name, which is set on shot init). This made it impossible to
submit newly initialized shots unless a manual_shot_name was set.

Now both props are taken into account, and if manual_shot_name is not
set, we show show_name as placeholder.

Kitsu: Black formatting 52893965fa

Kitsu: Further fixes to batch shot submission b1d9b3966b

Take into account the existence of strip.kitsu.shot_name in more
places (currently we were only evaluating manual_shot_name.

Kitsu: Black formatting 114496f1de

- select context brushstrokes if active object is matching 18ee45937a

- implement basic UI for brushstroke editing (not functional yet) b1644a9c30

- invert UI hiding concept to pinning and visualize with drawing based on nested hide state 4cdf4f24e1

- changes to default shader eeb5453f9c

Simon Thommes force-pushed brushstroke_tools-initial-version from eeb5453f9c to 88b9de2ab2

2024-08-28 17:29:34 +02:00

Compare

Simon Thommes added 1 commit 2024-08-28 17:42:54 +02:00

- rename and restructure shading node-groups 4043cafb80

Simon Thommes added 2 commits 2024-08-28 19:03:16 +02:00

- fix issue when active object is not enabled in viewport 4e455179af

- base visibility settings in uilist 30ac4ba9e7

Simon Thommes added 1 commit 2024-08-29 19:52:00 +02:00

- add viewport hiding functionality (eye icon) 1b58fb484e

Simon Thommes added 1 commit 2024-08-30 19:05:17 +02:00

- rename preset to default in UI 76cbc59e55

Simon Thommes added 2 commits 2024-09-02 11:51:17 +02:00

- add icons to datablock pickers 2421ffb116

- fix uneditable id pickers for [material, texture, collection] 4f28a192f4

Simon Thommes added 6 commits 2024-09-02 16:07:57 +02:00

- optimize material and object visibility for Eevee Next 2299b3716f

- add support for non-uniform normal smoothing 934a4b0840

- tag brushstrokes object with addon version number e7c23bbc91

- write version number as integer tuple 4c8520d71b

- slightly fix back-deformation for curves outside of surface in drawing tool c35a7811db

- implement functionality of edit operator and live edit toggle 96511099d6

Simon Thommes added 2 commits 2024-09-02 16:53:28 +02:00

- add/remove addon asset library e2fa4b0c2a

- adjust asset library settings path and add catalogs 081f9e164d

Simon Thommes added 1 commit 2024-09-02 18:04:25 +02:00

- add shortcut for pie menu with brushstroke data marking in mesh edit mode d35bc52414

Simon Thommes added 2 commits 2024-09-02 19:16:31 +02:00

- add several nullchecks 548f92ebeb

- add operator to delete brushstrokes including controllers 5885226c48

Simon Thommes added 2 commits 2024-09-03 11:01:43 +02:00

- expose wildcard attribute removal 1d51461a6b

- fix curve color sampling bb551d4adf

Simon Thommes added 1 commit 2024-09-03 13:55:23 +02:00

- fix selection behavior and retaining the edit toggle 2fe146d897

Simon Thommes added 1 commit 2024-09-04 20:01:00 +02:00

- fix use_attribute toggle on brushstrokes context 6095595ed3

Simon Thommes added 2 commits 2024-09-05 16:58:26 +02:00

- ignore catalog backup file 2cbc1a8587

- set and assign preset material 4c63bc2a2c

Simon Thommes added 1 commit 2024-09-06 14:58:07 +02:00

- refactor active brushstroke access 62d570369e

Simon Thommes added 2 commits 2024-09-06 16:12:45 +02:00

- fix mode switch for grease pencil 36c3bdc094

- implement initial material swapping 64bd04e517

Simon Thommes added 3 commits 2024-09-06 16:29:15 +02:00

- add operator to select actuve surface object 10762817d6

- make edit button UI text context dependent 5b9c896fc3

- minor code style improvement f53b0da211

Simon Thommes added 2 commits 2024-09-06 18:02:55 +02:00

- surface draw method UI initialization e22d858587

- expose initial material settings 2759bce45f

Simon Thommes added 1 commit 2024-09-10 19:10:38 +02:00

- implement dimensional estimation based on bbox to give reasonable starting point f99a6cb80f

Simon Thommes added 1 commit 2024-09-12 16:58:45 +02:00

- add nullcheck for missing node-group datablock 6429189422

Simon Thommes added 1 commit 2024-09-12 17:08:18 +02:00

- UI tweaks 75e7c0911b

Simon Thommes added 1 commit 2024-09-12 17:20:11 +02:00

- allow renaming modifiers by displaying mod_info property and adding get/set functions 9cb21c19af

Simon Thommes added 2 commits 2024-09-12 17:45:39 +02:00

- display clearly whether there is a valid surface object in the context a7be999291

- check for object visibility on view layer to avoid errors on brushstroke layer selectiong in uilist e134eb2d0e

Simon Thommes added 1 commit 2024-09-12 18:48:10 +02:00

- use different library for toml 8efaf4ad50

Simon Thommes added 3 commits 2024-09-13 14:20:51 +02:00

- Add reroutes and explicit naming to shader node-tree to expose functionality 54637cae9a

- adjust material panel drawing 529b2b66c6

- add fx settings drawing in UI 6fea737a96

Simon Thommes added 2 commits 2024-09-13 18:23:40 +02:00

- hook up available brushstroke style to UI selection 1a09a1df63

- gray out unused properties 5fad5d7c69

Simon Thommes added 2 commits 2024-09-13 19:06:59 +02:00

- reshuffle UI slightly bb577f7df4

- add operator to duplicate brushstrokes fb77bf421d

Simon Thommes added 1 commit 2024-09-13 19:11:17 +02:00

- minor fix b1e227e949

This pull request is marked as a work in progress.

This branch is out-of-date with the base branch

View command line instructions.

Checkout

From your project repository, check out a new branch and test the changes.

git fetch -u brushstroke_tools-initial-version:SimonThommes-brushstroke_tools-initial-version

git checkout SimonThommes-brushstroke_tools-initial-version

Sign in to join this conversation.

No reviewers

No Milestone

No project

No Assignees

2 Participants

Notifications

Due Date

The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: studio/blender-studio-pipeline#328

Download

What's New

Blender Studio

Manual

Developers Blog

Documentation

Benchmark

Blender Conference

Development Fund

One-time Donations

WIP: Brushstroke Tools: Initial Version #328

Principles

Progress

Required:

Nice to have:

TBD:

To Fix:

Nodes

Checkout