GPv3: Tint tool #119314

New Issue

Falk David · 2024-03-11T11:12:29+01:00

Falk David commented

2024-03-11 11:12:29 +01:00

The tint tool needs to be added for GPv3.

Here is a checklist for adding the tint operation (without the implementation) and exposing it in the UI:

Adding the operation

Create a file in blender/source/blender/editors/sculpt_paint/ called grease_pencil_tint.cc.
Declare a function std::unique_ptr<GreasePencilStrokeOperation> new_tint_operation(); in blender/source/blender/editors/sculpt_paint/grease_pencil_intern.hh. The implementation will go into grease_pencil_tint.cc
In grease_pencil_tint.cc write a class

class TintOperation : public GreasePencilStrokeOperation {
 public:
  void on_stroke_begin(const bContext &C, const InputSample &start_sample) override;
  void on_stroke_extended(const bContext &C, const InputSample &extension_sample) override;
  void on_stroke_done(const bContext &C) override;
};

Make sure to add the function to create the operation

std::unique_ptr<GreasePencilStrokeOperation> new_tint_operation()
{
  return std::make_unique<TintOperation>();
}

Add a case for GPAINT_TOOL_TINT in start_brush_operation in blender/source/blender/editors/sculpt_paint/grease_pencil_draw_ops.cc. This should call new_tint_operation().release().

Exposing it in the UI

In blender/scripts/startup/bl_ui/space_toolsystem_toolbar.py in the _defs_paint_grease_pencil class add the following snippet:

@ToolDef.from_fn
def tint():
    return dict(
        idname="builtin_brush.Tint",
        label="Tint",
        icon="brush.gpencil_draw.tint",
        data_block='TINT',
    )

Implementation

The implementation is done in the on_stroke_begin, on_stroke_extend, and on_stroke_done functions. See blender/source/blender/editors/sculpt_paint/grease_pencil_paint.cc for how these are used. Generally, it's best to not store anything from the bContext in the class and just re-query it on every on_stroke_extend callback.
See brush_tint_apply in blender/source/blender/editors/gpencil_legacy/gpencil_vertex_paint.cc for the legacy implementation.

The tint tool needs to be added for GPv3. Here is a checklist for adding the tint operation (without the implementation) and exposing it in the UI: ## Adding the operation - [ ] Create a file in `blender/source/blender/editors/sculpt_paint/` called `grease_pencil_tint.cc`. - [ ] Declare a function `std::unique_ptr<GreasePencilStrokeOperation> new_tint_operation();` in `blender/source/blender/editors/sculpt_paint/grease_pencil_intern.hh`. The implementation will go into `grease_pencil_tint.cc` - [ ] In `grease_pencil_tint.cc` write a class ```cpp class TintOperation : public GreasePencilStrokeOperation { public: void on_stroke_begin(const bContext &C, const InputSample &start_sample) override; void on_stroke_extended(const bContext &C, const InputSample &extension_sample) override; void on_stroke_done(const bContext &C) override; }; ``` - [ ] Make sure to add the function to create the operation ```cpp std::unique_ptr<GreasePencilStrokeOperation> new_tint_operation() { return std::make_unique<TintOperation>(); } ``` - [ ] Add a case for `GPAINT_TOOL_TINT` in `start_brush_operation` in `blender/source/blender/editors/sculpt_paint/grease_pencil_draw_ops.cc`. This should call `new_tint_operation().release()`. ## Exposing it in the UI - [ ] In `blender/scripts/startup/bl_ui/space_toolsystem_toolbar.py` in the `_defs_paint_grease_pencil` class add the following snippet: ```py @ToolDef.from_fn def tint(): return dict( idname="builtin_brush.Tint", label="Tint", icon="brush.gpencil_draw.tint", data_block='TINT', ) ``` # Implementation The implementation is done in the `on_stroke_begin`, `on_stroke_extend`, and `on_stroke_done` functions. See `blender/source/blender/editors/sculpt_paint/grease_pencil_paint.cc` for how these are used. Generally, it's best to not store anything from the `bContext` in the class and just re-query it on every `on_stroke_extend` callback. See `brush_tint_apply` in `blender/source/blender/editors/gpencil_legacy/gpencil_vertex_paint.cc` for the legacy implementation.

Falk David added the

Type

To Do

label 2024-03-11 11:12:29 +01:00

Falk David added this to the Grease Pencil project 2024-03-11 11:12:32 +01:00

YimingWu was assigned by Falk David

2024-03-11 11:13:02 +01:00

Falk David commented

2024-03-29 12:43:41 +01:00

Committed 127f879be9.

Committed https://projects.blender.org/blender/blender/commit/127f879be93fc91ed3f7c4ae0c30d395ece8be8a.

Falk David closed this issue