gimp/libgimpwidgets/gimpcolorselector.c
Jehan 9833ebd0ee app, libgimpwidgets, modules: color selectors are now partly space-invaded.
What this commit does is keep the same code logic while moving to
GeglColor. Yet it's not **really** space-invaded yet. What we need to do
now:

1. Take into account the image space, and this is what we must navigate
   through, in particular for various representations of RGB or HSV.
   I.e. that if the active image is in anyRGB, the RGB values shown must
   be within anyRGB. Right now, everything is still shown/used as sRGB
   (even though it's properly retrieved and transformed to the target
   space thanks to GeglColor).
2. Show space info to make things clear and explicit, by adding some
   label somewhere.
3. Allow to switch between image and softproof spaces, regarding
   out-of-gamut display. I.e. that while RGB/HSV must be shown within
   the image space (assuming it's anyRGB), we may want to show
   out-of-gamut area (pink areas) within the softproof space. This may
   mean adding a checkbox. Or maybe simply taking into account whether
   we are in softproof mode or not?
4. We can likely move off gimp_widget_get_color_transform() into using
   gimp_widget_get_render_space() for display drawing. We don't need any
   soft-proofing or black point compensation for any of these widgets so
   pure babl is fine. Indeed we want to show any in-gamut color
   correctly (and not transformed according to specific intents or
   through soft-proofing). We will take care of the proofing case with
   out-of-gamut area showing only.
5. In the various drawing functions, we should move to
   CAIRO_FORMAT_RGBA128F. The color selection area might be wide enough
   that it makes sense to be more accurate, especially as we are
   essentially showing color gradients in 1 or 2 directions in these
   various widgets.
2024-02-11 23:28:03 +01:00

684 lines
19 KiB
C

/* LIBGIMP - The GIMP Library
* Copyright (C) 1995-1997 Peter Mattis and Spencer Kimball
*
* gimpcolorselector.c
* Copyright (C) 2002 Michael Natterer <mitch@gimp.org>
*
* based on:
* Colour selector module
* Copyright (C) 1999 Austin Donnelly <austin@greenend.org.uk>
*
* This library is free software: you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library. If not, see
* <https://www.gnu.org/licenses/>.
*/
#include "config.h"
#include <gegl.h>
#include <gtk/gtk.h>
#include "libgimpcolor/gimpcolor.h"
#include "libgimpconfig/gimpconfig.h"
#include "gimpwidgetstypes.h"
#include "gimpcolorselector.h"
#include "gimpicons.h"
#include "gimpwidgetsmarshal.h"
/**
* SECTION: gimpcolorselector
* @title: GimpColorSelector
* @short_description: Pluggable GIMP color selector modules.
* @see_also: #GModule, #GTypeModule, #GimpModule
*
* Functions and definitions for creating pluggable GIMP color
* selector modules.
**/
enum
{
COLOR_CHANGED,
CHANNEL_CHANGED,
MODEL_VISIBLE_CHANGED,
LAST_SIGNAL
};
struct _GimpColorSelectorPrivate
{
gboolean toggles_visible;
gboolean toggles_sensitive;
gboolean show_alpha;
gboolean model_visible[3];
GimpColorSelectorChannel channel;
GeglColor *color;
};
#define GET_PRIVATE(obj) (((GimpColorSelector *) (obj))->priv)
static void gimp_color_selector_dispose (GObject *object);
static void gimp_color_selector_emit_color_changed (GimpColorSelector *selector);
static void gimp_color_selector_emit_channel_changed (GimpColorSelector *selector);
static void gimp_color_selector_emit_model_visible_changed (GimpColorSelector *selector,
GimpColorSelectorModel model);
G_DEFINE_TYPE_WITH_PRIVATE (GimpColorSelector, gimp_color_selector,
GTK_TYPE_BOX)
#define parent_class gimp_color_selector_parent_class
static guint selector_signals[LAST_SIGNAL] = { 0 };
static void
gimp_color_selector_class_init (GimpColorSelectorClass *klass)
{
GObjectClass *object_class = G_OBJECT_CLASS (klass);
object_class->dispose = gimp_color_selector_dispose;
selector_signals[COLOR_CHANGED] =
g_signal_new ("color-changed",
G_TYPE_FROM_CLASS (klass),
G_SIGNAL_RUN_FIRST,
G_STRUCT_OFFSET (GimpColorSelectorClass, color_changed),
NULL, NULL, NULL,
G_TYPE_NONE, 1,
GEGL_TYPE_COLOR);
selector_signals[CHANNEL_CHANGED] =
g_signal_new ("channel-changed",
G_TYPE_FROM_CLASS (klass),
G_SIGNAL_RUN_FIRST,
G_STRUCT_OFFSET (GimpColorSelectorClass, channel_changed),
NULL, NULL, NULL,
G_TYPE_NONE, 1,
GIMP_TYPE_COLOR_SELECTOR_CHANNEL);
selector_signals[MODEL_VISIBLE_CHANGED] =
g_signal_new ("model-visible-changed",
G_TYPE_FROM_CLASS (klass),
G_SIGNAL_RUN_FIRST,
G_STRUCT_OFFSET (GimpColorSelectorClass, model_visible_changed),
NULL, NULL,
_gimp_widgets_marshal_VOID__ENUM_BOOLEAN,
G_TYPE_NONE, 2,
GIMP_TYPE_COLOR_SELECTOR_MODEL,
G_TYPE_BOOLEAN);
klass->name = "Unnamed";
klass->help_id = NULL;
klass->icon_name = GIMP_ICON_PALETTE;
klass->set_toggles_visible = NULL;
klass->set_toggles_sensitive = NULL;
klass->set_show_alpha = NULL;
klass->set_color = NULL;
klass->set_channel = NULL;
klass->set_model_visible = NULL;
klass->color_changed = NULL;
klass->channel_changed = NULL;
klass->model_visible_changed = NULL;
klass->set_config = NULL;
}
static void
gimp_color_selector_init (GimpColorSelector *selector)
{
GimpColorSelectorPrivate *priv;
selector->priv = gimp_color_selector_get_instance_private (selector);
priv = GET_PRIVATE (selector);
priv->toggles_visible = TRUE;
priv->toggles_sensitive = TRUE;
priv->show_alpha = TRUE;
gtk_orientable_set_orientation (GTK_ORIENTABLE (selector),
GTK_ORIENTATION_VERTICAL);
priv->channel = GIMP_COLOR_SELECTOR_RED;
priv->color = gegl_color_new ("black");
priv->model_visible[GIMP_COLOR_SELECTOR_MODEL_RGB] = TRUE;
priv->model_visible[GIMP_COLOR_SELECTOR_MODEL_LCH] = TRUE;
priv->model_visible[GIMP_COLOR_SELECTOR_MODEL_HSV] = FALSE;
}
static void
gimp_color_selector_dispose (GObject *object)
{
GimpColorSelector *selector = GIMP_COLOR_SELECTOR (object);
gimp_color_selector_set_config (selector, NULL);
g_clear_object (&selector->priv->color);
G_OBJECT_CLASS (parent_class)->dispose (object);
}
/* public functions */
/**
* gimp_color_selector_new:
* @selector_type: The #GType of the selector to create.
* @color: The initial color to be edited.
* @channel: The selector's initial channel.
*
* Creates a new #GimpColorSelector widget of type @selector_type.
*
* Note that this is mostly internal API to be used by other widgets.
*
* Please use gimp_color_selection_new() for the "GIMP-typical" color
* selection widget. Also see gimp_color_button_new().
*
* Retunn value: the new #GimpColorSelector widget.
**/
GtkWidget *
gimp_color_selector_new (GType selector_type,
GeglColor *color,
GimpColorSelectorChannel channel)
{
GimpColorSelector *selector;
g_return_val_if_fail (g_type_is_a (selector_type, GIMP_TYPE_COLOR_SELECTOR), NULL);
g_return_val_if_fail (GEGL_IS_COLOR (color), NULL);
selector = g_object_new (selector_type, NULL);
gimp_color_selector_set_color (selector, color);
gimp_color_selector_set_channel (selector, channel);
return GTK_WIDGET (selector);
}
/**
* gimp_color_selector_set_toggles_visible:
* @selector: A #GimpColorSelector widget.
* @visible: The new @visible setting.
*
* Sets the @visible property of the @selector's toggles.
*
* This function has no effect if this @selector instance has no
* toggles to switch channels.
**/
void
gimp_color_selector_set_toggles_visible (GimpColorSelector *selector,
gboolean visible)
{
g_return_if_fail (GIMP_IS_COLOR_SELECTOR (selector));
if (selector->priv->toggles_visible != visible)
{
GimpColorSelectorClass *selector_class;
selector->priv->toggles_visible = visible ? TRUE : FALSE;
selector_class = GIMP_COLOR_SELECTOR_GET_CLASS (selector);
if (selector_class->set_toggles_visible)
selector_class->set_toggles_visible (selector, visible);
}
}
/**
* gimp_color_selector_get_toggles_visible:
* @selector: A #GimpColorSelector widget.
*
* Returns the @visible property of the @selector's toggles.
*
* Returns: %TRUE if the #GimpColorSelector's toggles are visible.
*
* Since: 2.10
**/
gboolean
gimp_color_selector_get_toggles_visible (GimpColorSelector *selector)
{
g_return_val_if_fail (GIMP_IS_COLOR_SELECTOR (selector), FALSE);
return selector->priv->toggles_visible;
}
/**
* gimp_color_selector_set_toggles_sensitive:
* @selector: A #GimpColorSelector widget.
* @sensitive: The new @sensitive setting.
*
* Sets the @sensitive property of the @selector's toggles.
*
* This function has no effect if this @selector instance has no
* toggles to switch channels.
**/
void
gimp_color_selector_set_toggles_sensitive (GimpColorSelector *selector,
gboolean sensitive)
{
g_return_if_fail (GIMP_IS_COLOR_SELECTOR (selector));
if (selector->priv->toggles_sensitive != sensitive)
{
GimpColorSelectorClass *selector_class;
selector->priv->toggles_sensitive = sensitive ? TRUE : FALSE;
selector_class = GIMP_COLOR_SELECTOR_GET_CLASS (selector);
if (selector_class->set_toggles_sensitive)
selector_class->set_toggles_sensitive (selector, sensitive);
}
}
/**
* gimp_color_selector_get_toggles_sensitive:
* @selector: A #GimpColorSelector widget.
*
* Returns the @sensitive property of the @selector's toggles.
*
* Returns: %TRUE if the #GimpColorSelector's toggles are sensitive.
*
* Since: 2.10
**/
gboolean
gimp_color_selector_get_toggles_sensitive (GimpColorSelector *selector)
{
g_return_val_if_fail (GIMP_IS_COLOR_SELECTOR (selector), FALSE);
return selector->priv->toggles_sensitive;
}
/**
* gimp_color_selector_set_show_alpha:
* @selector: A #GimpColorSelector widget.
* @show_alpha: The new @show_alpha setting.
*
* Sets the @show_alpha property of the @selector widget.
**/
void
gimp_color_selector_set_show_alpha (GimpColorSelector *selector,
gboolean show_alpha)
{
g_return_if_fail (GIMP_IS_COLOR_SELECTOR (selector));
if (show_alpha != selector->priv->show_alpha)
{
GimpColorSelectorClass *selector_class;
selector->priv->show_alpha = show_alpha ? TRUE : FALSE;
selector_class = GIMP_COLOR_SELECTOR_GET_CLASS (selector);
if (selector_class->set_show_alpha)
selector_class->set_show_alpha (selector, show_alpha);
}
}
/**
* gimp_color_selector_get_show_alpha:
* @selector: A #GimpColorSelector widget.
*
* Returns the @selector's @show_alpha property.
*
* Returns: %TRUE if the #GimpColorSelector has alpha controls.
*
* Since: 2.10
**/
gboolean
gimp_color_selector_get_show_alpha (GimpColorSelector *selector)
{
g_return_val_if_fail (GIMP_IS_COLOR_SELECTOR (selector), FALSE);
return selector->priv->show_alpha;
}
/**
* gimp_color_selector_set_color:
* @selector: A #GimpColorSelector widget.
* @color: The new color.
*
* Sets the color shown in the @selector widget.
**/
void
gimp_color_selector_set_color (GimpColorSelector *selector,
GeglColor *color)
{
GimpColorSelectorClass *selector_class;
GimpColorSelectorPrivate *priv;
GeglColor *old_color;
g_return_if_fail (GIMP_IS_COLOR_SELECTOR (selector));
g_return_if_fail (GEGL_IS_COLOR (color));
priv = GET_PRIVATE (selector);
old_color = priv->color;
priv->color = gegl_color_duplicate (color);
selector_class = GIMP_COLOR_SELECTOR_GET_CLASS (selector);
if (! gimp_color_is_perceptually_identical (priv->color, old_color))
{
if (selector_class->set_color)
selector_class->set_color (selector, priv->color);
gimp_color_selector_emit_color_changed (selector);
}
g_object_unref (old_color);
}
/**
* gimp_color_selector_get_color:
* @selector: A #GimpColorSelector widget.
*
* Retrieves the color shown in the @selector widget.
*
* Returns: (transfer full): a copy of the selected color.
* Since: 2.10
**/
GeglColor *
gimp_color_selector_get_color (GimpColorSelector *selector)
{
GimpColorSelectorPrivate *priv;
g_return_val_if_fail (GIMP_IS_COLOR_SELECTOR (selector), NULL);
priv = GET_PRIVATE (selector);
return gegl_color_duplicate (priv->color);
}
/**
* gimp_color_selector_set_channel:
* @selector: A #GimpColorSelector widget.
* @channel: The new @channel setting.
*
* Sets the @channel property of the @selector widget.
*
* Changes between displayed channels if this @selector instance has
* the ability to show different channels.
* This will also update the color model if needed.
**/
void
gimp_color_selector_set_channel (GimpColorSelector *selector,
GimpColorSelectorChannel channel)
{
g_return_if_fail (GIMP_IS_COLOR_SELECTOR (selector));
if (channel != selector->priv->channel)
{
GimpColorSelectorClass *selector_class;
GimpColorSelectorModel model = -1;
selector->priv->channel = channel;
switch (channel)
{
case GIMP_COLOR_SELECTOR_RED:
case GIMP_COLOR_SELECTOR_GREEN:
case GIMP_COLOR_SELECTOR_BLUE:
model = GIMP_COLOR_SELECTOR_MODEL_RGB;
break;
case GIMP_COLOR_SELECTOR_HUE:
case GIMP_COLOR_SELECTOR_SATURATION:
case GIMP_COLOR_SELECTOR_VALUE:
model = GIMP_COLOR_SELECTOR_MODEL_HSV;
break;
case GIMP_COLOR_SELECTOR_LCH_LIGHTNESS:
case GIMP_COLOR_SELECTOR_LCH_CHROMA:
case GIMP_COLOR_SELECTOR_LCH_HUE:
model = GIMP_COLOR_SELECTOR_MODEL_LCH;
break;
case GIMP_COLOR_SELECTOR_ALPHA:
/* Alpha channel does not change the color model. */
break;
default:
/* Should not happen. */
g_return_if_reached ();
break;
}
selector_class = GIMP_COLOR_SELECTOR_GET_CLASS (selector);
if (selector_class->set_channel)
selector_class->set_channel (selector, channel);
gimp_color_selector_emit_channel_changed (selector);
if (model != -1)
{
/* make visibility of LCH and HSV mutuallky exclusive */
if (model == GIMP_COLOR_SELECTOR_MODEL_HSV)
{
gimp_color_selector_set_model_visible (selector,
GIMP_COLOR_SELECTOR_MODEL_LCH,
FALSE);
}
else if (model == GIMP_COLOR_SELECTOR_MODEL_LCH)
{
gimp_color_selector_set_model_visible (selector,
GIMP_COLOR_SELECTOR_MODEL_HSV,
FALSE);
}
gimp_color_selector_set_model_visible (selector, model, TRUE);
}
}
}
/**
* gimp_color_selector_get_channel:
* @selector: A #GimpColorSelector widget.
*
* Returns the @selector's current channel.
*
* Returns: The #GimpColorSelectorChannel currently shown by the
* @selector.
*
* Since: 2.10
**/
GimpColorSelectorChannel
gimp_color_selector_get_channel (GimpColorSelector *selector)
{
g_return_val_if_fail (GIMP_IS_COLOR_SELECTOR (selector),
GIMP_COLOR_SELECTOR_RED);
return selector->priv->channel;
}
/**
* gimp_color_selector_set_model_visible:
* @selector: A #GimpColorSelector widget.
* @model: The affected #GimpColorSelectorModel.
* @visible: The new visible setting.
*
* Sets the @model visible/invisible on the @selector widget.
*
* Toggles visibility of displayed models if this @selector instance
* has the ability to show different color models.
*
* Since: 2.10
**/
void
gimp_color_selector_set_model_visible (GimpColorSelector *selector,
GimpColorSelectorModel model,
gboolean visible)
{
GimpColorSelectorPrivate *priv;
g_return_if_fail (GIMP_IS_COLOR_SELECTOR (selector));
priv = GET_PRIVATE (selector);
visible = visible ? TRUE : FALSE;
if (visible != priv->model_visible[model])
{
GimpColorSelectorClass *selector_class;
priv->model_visible[model] = visible;
selector_class = GIMP_COLOR_SELECTOR_GET_CLASS (selector);
if (selector_class->set_model_visible)
selector_class->set_model_visible (selector, model, visible);
gimp_color_selector_emit_model_visible_changed (selector, model);
}
}
/**
* gimp_color_selector_get_model_visible:
* @selector: A #GimpColorSelector widget.
* @model: The #GimpColorSelectorModel.
*
* Returns: whether @model is visible in @selector.
*
* Since: 2.10
**/
gboolean
gimp_color_selector_get_model_visible (GimpColorSelector *selector,
GimpColorSelectorModel model)
{
GimpColorSelectorPrivate *priv;
g_return_val_if_fail (GIMP_IS_COLOR_SELECTOR (selector), FALSE);
priv = GET_PRIVATE (selector);
return priv->model_visible[model];
}
/**
* gimp_color_selector_set_config:
* @selector: a #GimpColorSelector widget.
* @config: a #GimpColorConfig object.
*
* Sets the color management configuration to use with this color selector.
*
* Since: 2.4
*/
void
gimp_color_selector_set_config (GimpColorSelector *selector,
GimpColorConfig *config)
{
GimpColorSelectorClass *selector_class;
g_return_if_fail (GIMP_IS_COLOR_SELECTOR (selector));
g_return_if_fail (config == NULL || GIMP_IS_COLOR_CONFIG (config));
selector_class = GIMP_COLOR_SELECTOR_GET_CLASS (selector);
if (selector_class->set_config)
selector_class->set_config (selector, config);
}
/**
* gimp_color_selector_set_simulation
* @selector: a #GimpColorSelector widget.
* @profile: a #GimpColorProfile object.
* @intent: a #GimpColorRenderingIntent enum.
* @bpc: a gboolean.
*
* Sets the simulation options to use with this color selector.
*
* Since: 3.0
*/
void
gimp_color_selector_set_simulation (GimpColorSelector *selector,
GimpColorProfile *profile,
GimpColorRenderingIntent intent,
gboolean bpc)
{
GimpColorSelectorClass *selector_class;
g_return_if_fail (GIMP_IS_COLOR_SELECTOR (selector));
g_return_if_fail (profile == NULL || GIMP_IS_COLOR_PROFILE (profile));
selector_class = GIMP_COLOR_SELECTOR_GET_CLASS (selector);
if (selector_class->set_simulation)
selector_class->set_simulation (selector, profile, intent, bpc);
}
/* Private functions. */
/**
* gimp_color_selector_emit_color_changed:
* @selector: A #GimpColorSelector widget.
*
* Emits the "color-changed" signal.
*/
static void
gimp_color_selector_emit_color_changed (GimpColorSelector *selector)
{
GimpColorSelectorPrivate *priv;
g_return_if_fail (GIMP_IS_COLOR_SELECTOR (selector));
priv = GET_PRIVATE (selector);
g_signal_emit (selector, selector_signals[COLOR_CHANGED], 0, priv->color);
}
/**
* gimp_color_selector_emit_channel_changed:
* @selector: A #GimpColorSelector widget.
*
* Emits the "channel-changed" signal.
*/
static void
gimp_color_selector_emit_channel_changed (GimpColorSelector *selector)
{
g_return_if_fail (GIMP_IS_COLOR_SELECTOR (selector));
g_signal_emit (selector, selector_signals[CHANNEL_CHANGED], 0,
selector->priv->channel);
}
/**
* gimp_color_selector_emit_model_visible_changed:
* @selector: A #GimpColorSelector widget.
* @model: The #GimpColorSelectorModel where visibility changed.
*
* Emits the "model-visible-changed" signal.
*
* Since: 2.10
*/
static void
gimp_color_selector_emit_model_visible_changed (GimpColorSelector *selector,
GimpColorSelectorModel model)
{
GimpColorSelectorPrivate *priv;
g_return_if_fail (GIMP_IS_COLOR_SELECTOR (selector));
priv = GET_PRIVATE (selector);
g_signal_emit (selector, selector_signals[MODEL_VISIBLE_CHANGED], 0,
model, priv->model_visible[model]);
}