Page MenuHome
Differential D5688 Diff 17947 source/blender/editors/interface/interface_eyedropper_gpencil_color.c

Changeset View

Standalone View

View Options

source/blender/editors/interface/interface_eyedropper_gpencil_color.c

  • This file was added.
/*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* The Original Code is Copyright (C) 2009 Blender Foundation.
* All rights reserved.
*/
/** \file
* \ingroup edinterface
*
* Eyedropper (RGB Color)
*
* Defines:
* - #UI_OT_eyedropper_gpencil_color
*/
#include "MEM_guardedalloc.h"
#include "BLI_string.h"
#include "BLT_translation.h"
#include "DNA_gpencil_types.h"
#include "DNA_space_types.h"
#include "BKE_collection.h"
#include "BKE_context.h"
#include "BKE_gpencil.h"
#include "BKE_main.h"
#include "BKE_material.h"
#include "BKE_report.h"
#include "UI_interface.h"
#include "IMB_colormanagement.h"
#include "WM_api.h"
#include "WM_types.h"
#include "RNA_access.h"
#include "RNA_define.h"
#include "ED_screen.h"
#include "ED_undo.h"
#include "DEG_depsgraph.h"
#include "interface_eyedropper_intern.h"
typedef struct EyedropperGPencil {
struct ColorManagedDisplay *display;
bool is_undo;
bool is_set;
bool is_raw;
/* Old simplify settings. */
short saved_simplify;
/** color under cursor RGB */
float color[3];
} EyedropperGPencil;
/* Helper: Draw status message while the user is running the operator */
static void eyedropper_gpencil_status_indicators(bContext *C)
{
char msg_str[UI_MAX_DRAW_STR];
BLI_strncpy(msg_str, TIP_("R: ON/OFF Raw Mode Shift: Stroke Shift+Ctrl: Fill"), UI_MAX_DRAW_STR);
ED_workspace_status_text(C, msg_str);
brechtUnsubmitted
Not Done
Inline Actions

This text could be modified to indicate when raw mode is on/off? Now it's unclear to me.

brecht: This text could be modified to indicate when raw mode is on/off? Now it's unclear to me.
}
/* Tag all scene grease pencil object to update. */
brechtUnsubmitted
Not Done
Inline Actions

This message only appears after moving the mouse a little bit, it should appear immediately (call from eyedropper_gpencil_init instead?).

brecht: This message only appears after moving the mouse a little bit, it should appear immediately…
static void eyedropper_gpencil_tag(bContext *C)
{
Scene *scene = CTX_data_scene(C);
brechtUnsubmitted
Not Done
Inline Actions

Could you deduplicate this code with rna_GPencil_update and name it something like ED_gpencil_simplify_update?

brecht: Could you deduplicate this code with `rna_GPencil_update` and name it something like…
/* mark all grease pencil datablocks of the scene */
FOREACH_SCENE_COLLECTION_BEGIN (scene, collection) {
FOREACH_COLLECTION_OBJECT_RECURSIVE_BEGIN (collection, ob) {
if (ob->type == OB_GPENCIL) {
bGPdata *gpd = (bGPdata *)ob->data;
gpd->flag |= GP_DATA_CACHE_IS_DIRTY;
DEG_id_tag_update(&gpd->id,
ID_RECALC_TRANSFORM | ID_RECALC_GEOMETRY | ID_RECALC_COPY_ON_WRITE);
}
}
FOREACH_COLLECTION_OBJECT_RECURSIVE_END;
}
FOREACH_SCENE_COLLECTION_END;
DEG_id_tag_update(&scene->id, ID_RECALC_COPY_ON_WRITE);
WM_main_add_notifier(NC_GPENCIL | NA_EDITED, NULL);
}
/* Initialize. */
static bool eyedropper_gpencil_init(bContext *C, wmOperator *op)
{
EyedropperGPencil *eye = MEM_callocN(sizeof(EyedropperGPencil), __func__);
op->customdata = eye;
Scene *scene = CTX_data_scene(C);
const char *display_device;
display_device = scene->display_settings.display_device;
eye->display = IMB_colormanagement_display_get_named(display_device);
eye->saved_simplify = scene->r.simplify_gpencil;
return true;
}
brechtUnsubmitted
Not Done
Inline Actions

Follow comment style:

/* Convert from linear rgb space to display space because grease pencil colors are in display
 * space, and this conversion is needed to undo the conversion to linear performed by
 * eyedropper_color_sample_fl. */
brecht: Follow comment style: ``` /* Convert from linear rgb space to display space because grease…
/* Exit and free memory. */
static void eyedropper_gpencil_exit(bContext *C, wmOperator *op)
{
Scene *scene = CTX_data_scene(C);
EyedropperGPencil *eye = (EyedropperGPencil *)op->customdata;
/* Return simplify status. */
scene->r.simplify_gpencil = eye->saved_simplify;
eyedropper_gpencil_tag(C);
/* Clear status message area. */
brechtUnsubmitted
Not Done
Inline Actions

Only call this if scene->r.simplify_gpencil != eye->saved_simplify.

It's quite expensive to reevaluate all objects, and this should only be done when it's really needed.

brecht: Only call this if `scene->r.simplify_gpencil != eye->saved_simplify`. It's quite expensive to…
ED_workspace_status_text(C, NULL);
MEM_SAFE_FREE(op->customdata);
}
/* Set the material. */
static bool eyedropper_gpencil_color_set(bContext *C, const wmEvent *event, EyedropperGPencil *eye)
{
Main *bmain = CTX_data_main(C);
Object *ob = CTX_data_active_object(C);
Material *ma = NULL;
float col[3];
copy_v3_v3(col, eye->color);
float col_conv[4];
brechtUnsubmitted
Not Done
Inline Actions

Could remove col variable and just use eye->color directly in code below.

brecht: Could remove `col` variable and just use `eye->color` directly in code below.
bool found = false;
bool found_stroke = false;
bool found_fill = false;
/* Convert from linear rgb space to display space. */
if (eye->display) {
copy_v3_v3(col_conv, col);
IMB_colormanagement_scene_linear_to_display_v3(col_conv, eye->display);
}
else {
brechtUnsubmitted
Not Done
Inline Actions

This could use a comment explaining that grease pencil colors are in display space, and that this conversion is needed to undo the conversion to linear performed by eyedropper_color_sample_fl.

brecht: This could use a comment explaining that grease pencil colors are in display space, and that…
copy_v3_v3(col_conv, col);
}
/* Look for a similar material in grease pencil slots. */
short *totcol = give_totcolp(ob);
for (short i = 0; i < *totcol; i++) {
ma = give_current_material(ob, i + 1);
if (ma == NULL) {
continue;
}
MaterialGPencilStyle *gp_style = ma->gp_style;
if (gp_style != NULL) {
/* Check stroke color. */
if (compare_v3v3(gp_style->stroke_rgba, col_conv, 0.01f)) {
ob->actcol = i + 1;
found_stroke = true;
}
brechtUnsubmitted
Not Done
Inline Actions

Use same notifiers as when modifying actol in RNA.

Here that means:

NC_MATERIAL | ND_SHADING_LINKS
NC_SPACE | ND_SPACE_VIEW3D
brecht: Use same notifiers as when modifying `actol` in RNA. Here that means: ``` NC_MATERIAL |…
/* Check fill color. */
if (compare_v3v3(gp_style->fill_rgba, col_conv, 0.01f)) {
if (!found_stroke) {
ob->actcol = i + 1;
}
found_fill = true;
}
/* Set as found. */
found = found_stroke || found_fill;
}
}
/* If material was not found and press Shift add a new material with stroke or fill color
* depending of the secondary key (Shift: Stroke, Shift+Ctrl: Fill)
*/
if (event->shift) {
if (((!found_stroke) && (!event->ctrl)) || ((!found_fill) && (event->ctrl))) {
int idx;
Material *ma_new = BKE_gpencil_object_material_new(bmain, ob, "Material", &idx);
BLI_assert(ma_new != NULL);
brechtUnsubmitted
Not Done
Inline Actions

Use same update as similar code elsewhere. In this case:

WM_main_add_notifier(NC_OBJECT | ND_OB_SHADING, &ob->id);
WM_main_add_notifier(NC_MATERIAL | ND_SHADING_LINKS, NULL);
DEG_relations_tag_update(bmain);
brecht: Use same update as similar code elsewhere. In this case: ``` WM_main_add_notifier(NC_OBJECT…
MaterialGPencilStyle *gp_style_new = ma_new->gp_style;
BLI_assert(gp_style_new != NULL);
if (event->ctrl) {
/* Fill color. */
gp_style_new->flag &= ~GP_STYLE_STROKE_SHOW;
gp_style_new->flag |= GP_STYLE_FILL_SHOW;
copy_v3_v3(gp_style_new->fill_rgba, col_conv);
}
else {
/* Stroke color. */
gp_style_new->flag |= GP_STYLE_STROKE_SHOW;
gp_style_new->flag &= ~GP_STYLE_FILL_SHOW;
copy_v3_v3(gp_style_new->stroke_rgba, col_conv);
}
/* Push undo for new created material. */
ED_undo_push(C, "New Grease Pencil Material created");
found = true;
brechtUnsubmitted
Not Done
Inline Actions

New Grease Pencil Material created -> Add Grease Pencil Material

brecht: `New Grease Pencil Material created` -> `Add Grease Pencil Material`
}
}
eye->is_set = true;
return found;
brechtUnsubmitted
Not Done
Inline Actions

This value is not used anywhere.

brecht: This value is not used anywhere.
}
/* Sample the color below cursor. */
static void eyedropper_gpencil_color_sample(bContext *C, EyedropperGPencil *eye, int mx, int my)
{
float col[3];
eyedropper_color_sample_fl(C, mx, my, col);
copy_v3_v3(eye->color, col);
brechtUnsubmitted
Not Done
Inline Actions

Can just pass eye->color directly without intermediate col variable.

brecht: Can just pass `eye->color` directly without intermediate `col` variable.
}
/* Cancel operator. */
static void eyedropper_gpencil_cancel(bContext *C, wmOperator *op)
{
eyedropper_gpencil_exit(C, op);
}
/* Main modal status check. */
static int eyedropper_gpencil_modal(bContext *C, wmOperator *op, const wmEvent *event)
{
brechtUnsubmitted
Not Done
Inline Actions

eyedropper_gpencil_rawmode_set -> eyedropper_gpencil_rawmode_toggle

brecht: `eyedropper_gpencil_rawmode_set` -> `eyedropper_gpencil_rawmode_toggle`
Scene *scene = CTX_data_scene(C);
EyedropperGPencil *eye = (EyedropperGPencil *)op->customdata;
/* Handle modal keymap */
switch (event->type) {
printf("%d..", event->type);
case EVT_MODAL_MAP: {
/* Bottom Text. */
switch (event->val) {
case EYE_MODAL_SAMPLE_BEGIN: {
eyedropper_gpencil_status_indicators(C);
return OPERATOR_RUNNING_MODAL;
brechtUnsubmitted
Not Done
Inline Actions

Depsgraph tag only the scene here and send notifier for redraw, not all objects.

brecht: Depsgraph tag only the scene here and send notifier for redraw, not all objects.
break;
}
case EYE_MODAL_CANCEL: {
eyedropper_gpencil_cancel(C, op);
return OPERATOR_CANCELLED;
break;
}
case EYE_MODAL_SAMPLE_CONFIRM: {
const bool is_undo = eye->is_undo;
eyedropper_gpencil_color_sample(C, eye, event->x, event->y);
/* Set material. */
brechtUnsubmitted
Not Done
Inline Actions

Comment looks out of place.

brecht: Comment looks out of place.
if (!eyedropper_gpencil_color_set(C, event, eye)) {
BKE_reportf(
op->reports, RPT_ERROR, "Unable to find a material with the sampled color");
}
else {
brechtUnsubmitted
Not Done
Inline Actions

No need to add break; after return.

brecht: No need to add `break;` after `return`.
WM_main_add_notifier(NC_GPENCIL | ND_DATA | NA_EDITED, NULL);
}
eyedropper_gpencil_exit(C, op);
/* Could support finished & undo-skip. */
return is_undo ? OPERATOR_FINISHED : OPERATOR_CANCELLED;
break;
}
default: {
break;
}
}
break;
}
case MOUSEMOVE:
case INBETWEEN_MOUSEMOVE: {
brechtUnsubmitted
Not Done
Inline Actions

is_undo is never set, is this code needed or unfinished?

brecht: `is_undo` is never set, is this code needed or unfinished?
eyedropper_gpencil_color_sample(C, eye, event->x, event->y);
eyedropper_gpencil_status_indicators(C);
break;
}
case RKEY: {
if (event->val == KM_RELEASE) {
/* Just toggle flags. */
if (!eye->is_raw) {
eye->is_raw = true;
scene->r.simplify_gpencil |= SIMPLIFY_GPENCIL_ENABLE | SIMPLIFY_GPENCIL_MODIFIER |
SIMPLIFY_GPENCIL_FX | SIMPLIFY_GPENCIL_TINT;
}
else {
eye->is_raw = false;
scene->r.simplify_gpencil = eye->saved_simplify;
}
eyedropper_gpencil_tag(C);
}
break;
}
default: {
break;
}
}
return OPERATOR_RUNNING_MODAL;
}
/* Modal Operator init */
static int eyedropper_gpencil_invoke(bContext *C, wmOperator *op, const wmEvent *UNUSED(event))
{
/* Init. */
if (eyedropper_gpencil_init(C, op)) {
brechtUnsubmitted
Not Done
Inline Actions

This seems wrong. You press R to enter the eye dropper in raw mode, then release R key and it disables raw mode, while the modal operator keeps running?

brecht: This seems wrong. You press R to enter the eye dropper in raw mode, then release R key and it…
/* Add modal temp handler. */
WM_event_add_modal_handler(C, op);
return OPERATOR_RUNNING_MODAL;
}
else {
return OPERATOR_PASS_THROUGH;
}
}
/* Repeat operator */
static int eyedropper_gpencil_exec(bContext *C, wmOperator *op)
{
/* init */
if (eyedropper_gpencil_init(C, op)) {
/* cleanup */
eyedropper_gpencil_exit(C, op);
return OPERATOR_FINISHED;
}
else {
return OPERATOR_PASS_THROUGH;
}
}
static bool eyedropper_gpencil_poll(bContext *C)
{
/* Only valid if the current active object is grease pencil. */
Object *obact = CTX_data_active_object(C);
if ((obact == NULL) || (obact->type != OB_GPENCIL)) {
return false;
}
/* Test we have a window below. */
return (CTX_wm_window(C) != NULL);
}
void UI_OT_eyedropper_gpencil_color(wmOperatorType *ot)
{
PropertyRNA *prop;
/* identifiers */
ot->name = "Grease Pencil Eyedropper";
ot->idname = "UI_OT_eyedropper_gpencil_color";
ot->description =
"Sample a color from the Blender Window to select and optionally create Grease Pencil "
"material";
/* api callbacks */
ot->invoke = eyedropper_gpencil_invoke;
ot->modal = eyedropper_gpencil_modal;
ot->cancel = eyedropper_gpencil_cancel;
ot->exec = eyedropper_gpencil_exec;
ot->poll = eyedropper_gpencil_poll;
/* flags */
ot->flag = OPTYPE_UNDO | OPTYPE_BLOCKING;
prop = RNA_def_boolean(ot->srna, "raw_mode", false, "Raw Mode", "");
}
brechtUnsubmitted
Not Done
Inline Actions

Add description explaining what Raw Mode is.

brecht: Add description explaining what Raw Mode is.