|
|
|
V_Sim API - Reference Manual | |
|---|---|---|---|---|
#include <coreTools/toolColor.h>
ColorComboBox;
GtkWidget* colorComboBox_new (gboolean hasAlphaChannel);
GtkWidget* colorComboBox_newWithRanges (gboolean hasAlphaChannel);
GdkPixbuf* colorComboBoxBuild_colorStamp (Color *color,
gboolean alpha);
GdkPixbuf* colorComboBoxGet_selectedPixbuf (ColorComboBox *colorComboBox);
Color* colorComboBoxGet_selectedColor (ColorComboBox *colorComboBox);
GdkPixbuf* colorComboBoxGet_pixbufFromColor (ColorComboBox *colorComboBox,
Color *color);
float* colorComboBoxGet_material (ColorComboBox *colorComboBox);
float* colorComboBoxGet_color (ColorComboBox *colorComboBox);
GtkWidget* colorComboBoxGet_rangesWidgets (ColorComboBox *colorComboBox);
gboolean colorComboBoxSet_selectionByColor (ColorComboBox *colorComboBox,
Color *color);
void colorComboBoxSet_expanded (ColorComboBox *colorComboBox,
gboolean value);
void colorComboBoxSet_color (ColorComboBox *colorComboBox,
float rgba[4],
gboolean raiseSignal);
void colorComboBoxSet_material (ColorComboBox *colorComboBox,
float material[nb_material],
gboolean raiseSignal);
void colorComboBoxSet_printValues (ColorComboBox *colorComboBox,
gboolean value);
This widget looks like a GtkComboBox and it displays a list
of stored colours. These colours may come from the configuration
files or can be selected and stored by the user actions. To do it,
the first entry of the combo box is 'new / modify', that opens a GTK
colour picker. The new values are used to craete a new colour entry
in the combo box. In a complete version, the combo box can have a
GtkVBox associated to modify colours without creating new entries, see
colorComboBox_newWithRanges() method. Otherwise, only already
selected colours are available. The stored colours are shared by
all widgets of this class. It is thus a convenient way to have
coherent colour picker through V_Sim.
When the widget is created with ranges, the additional part
can be retrieve with colorComboBoxGet_rangesWidgets() and attached
whereever is convenient. When the ranges are modified, the new
colour is not added to the combo box. It can be read using
colorComboBoxGet_color() or colorComboBoxGet_material(). The combo
box is set thus to an unselected state and
colorComboBoxGet_selectedColor() will return a NULL
pointer. Besides the colour ranges, there is an add button to
insert the newly defined colour into the combo box.
This widget can emit a "color-selected" signal that is a wrapper around the "changed" signal, but it is emitted only when a new colour is selected (either an existing one or a newly created from the picker). This colour is passed to the callback. The two other signals, "color-value-changed" and "material-value-changed", are generated when the widget have been created with ranges and that one of these ranges is modified.
typedef struct _ColorComboBox ColorComboBox;
Private structure to store informations of a ColorComboBox object.
Since 3.1
GtkWidget* colorComboBox_new (gboolean hasAlphaChannel);
A ColorComboBox widget is like a GtkComboBox widget, but it is already filled
with the colors stores in the structures adhoc in visu_tools.h. Using this widget
is a convienient way to share colors between all part of V_Sim and to give a consistent
look of all color selection. If the argument hasAlphaChannel is FALSE, the widget
display all colors but without their alpha channel, assuming it to be fully opaque.
|
a boolean. |
Returns : |
a newly created ColorComboBox widget. |
Since 3.1
GtkWidget* colorComboBox_newWithRanges (gboolean hasAlphaChannel);
Create a color combo and several ranges.
|
a boolean. |
Returns : |
a newly created ColorComboBox widget. |
Since 3.3
GdkPixbuf* colorComboBoxBuild_colorStamp (Color *color,
gboolean alpha);
This method is used by ColorComboBox object to create little stamps
representing the color. If the pixbuf of such stamps are needed, use
colorComboBoxGet_pixbufFromColor() if the color is registered in an
already existing ColorComboBox object or use this method to create
a new stamp.
|
a Color object ; |
|
a boolean. |
Returns : |
a pixbuf pointer corresponding to the little image as shown on
a colorComboBox (use g_object_unref() to free this pixbuf).
|
Since 3.1
GdkPixbuf* colorComboBoxGet_selectedPixbuf (ColorComboBox *colorComboBox);
The colorComboBox has little pixbufs to represent the color. User methods can
use these pixbufs but should considered them read-only.
|
a ColorComboBox widget. |
Returns : |
a pixbuf pointer corresponding to the little image shown on
the colorComboBox.
|
Since 3.1
Color* colorComboBoxGet_selectedColor (ColorComboBox *colorComboBox);
The user can access to the selected Color object using this method.
|
a ColorComboBox widget. |
Returns : |
a pointer to the selected Color object (or NULL). This object is read-only. |
Since 3.1
GdkPixbuf* colorComboBoxGet_pixbufFromColor (ColorComboBox *colorComboBox, Color *color);
The colorComboBox has little pixbufs to represent the color. User methods can
use these pixbufs but should considered them read-only.
|
a ColorComboBox widget ; |
|
a Color object. |
Returns : |
a pixbuf pointer corresponding to the little image shown on
the colorComboBox.
|
Since 3.1
float* colorComboBoxGet_material (ColorComboBox *colorComboBox);
If the colorComboBox uses ranges (see colorComboBox_newWithRanges()), this method
is used to get the values from the material ranges.
|
a ColorComboBox widget. |
Returns : |
a newly created array of size nb_material (see Material). Use g_free()
to delete it.
|
Since 3.3
float* colorComboBoxGet_color (ColorComboBox *colorComboBox);
If the colorComboBox uses ranges (see colorComboBox_newWithRanges()), this method
is used to get the values from the color ranges.
|
a ColorComboBox widget. |
Returns : |
a newly created array of size 4. Use g_free() to delete it.
|
Since 3.2
GtkWidget* colorComboBoxGet_rangesWidgets (ColorComboBox *colorComboBox);
Retrieve the wiodget using to represent the ranges, or NULL if the object has no ranges.
|
a Color object. |
Returns : |
a widget owned by color.
|
Since 3.3
gboolean colorComboBoxSet_selectionByColor (ColorComboBox *colorComboBox, Color *color);
Use this method to set the ComboBox on the given color. This emits a 'color-channel' signal if the color is changed, which means, a previous color has been modified, or a new color is selected.
|
a ColorComboBox widget ; |
|
a Color object. |
Returns : |
TRUE if the color already exists in the model.
|
Since 3.1
void colorComboBoxSet_expanded (ColorComboBox *colorComboBox, gboolean value);
Set the expanded state of the ranges. This is usable only if the colorComboBox has been created with ranges.
|
a Color object ; |
|
a boolean value. |
Since 3.3
void colorComboBoxSet_color (ColorComboBox *colorComboBox, float rgba[4], gboolean raiseSignal);
Change the values for the ranges that control the color. If the color exists
in the list, it is also selected.
This is possible only if the colorComboBox has been created with
colorComboBox_newWithRanges().
|
a ColorComboBox widget ; |
|
4 floating point values ; |
|
if TRUE a material-value-changed can be raised. |
Since 3.3
void colorComboBoxSet_material (ColorComboBox *colorComboBox, float material[nb_material], gboolean raiseSignal);
Change the values for the ranges that control the light (emission, diffuse...).
This is possible only if the colorComboBox has been created with
colorComboBox_newWithRanges().
|
a ColorComboBox widget ; |
|
nb_material (see Material) floating point values ; |
|
if TRUE a material-value-changed can be raised. |
Since 3.3
void colorComboBoxSet_printValues (ColorComboBox *colorComboBox, gboolean value);
Print or not the RGB values.
|
a Color object ; |
|
a boolean. |
Since 3.4