This commit mainly: * Exposes PreviewImage struct in RNA, including ways for user to set images data. * Adds a new kind of PreviewImage, using a file path and IMB_thumb to get image. * Adds a new kind of custom icon using PreviewImage, unrelated to ID previews system. * Adds a python API (utils.previews) to allow python scripts to access those custom previews/icons. Note that loading image from files' thumbnails is done when needed (deferred loading), not when defining the custom preview/icon. WARNING: for release addons who would want to use this, please keep it to a strict minimum, really needed level. We do not want our UI to explode under hundreds of different flashy icons! For more info, see also the release notes of Blender 2.75 (http://wiki.blender.org/index.php/Dev:Ref/Release_Notes/2.75/Addons) and the example/templates featured with Blender. Patch by Campbell (ideasman42), Inês (brita) and Bastien (mont29). Differential Revision: https://developer.blender.org/D1255
83 lines
2.6 KiB
C
83 lines
2.6 KiB
C
/*
|
|
* ***** BEGIN GPL LICENSE BLOCK *****
|
|
*
|
|
* 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) 2001-2002 by NaN Holding BV.
|
|
* All rights reserved.
|
|
*
|
|
* The Original Code is: all of this file.
|
|
*
|
|
* Contributor(s): none yet.
|
|
*
|
|
* ***** END GPL LICENSE BLOCK *****
|
|
*/
|
|
|
|
/** \file UI_interface_icons.h
|
|
* \ingroup editorui
|
|
*/
|
|
|
|
#ifndef __UI_INTERFACE_ICONS_H__
|
|
#define __UI_INTERFACE_ICONS_H__
|
|
|
|
struct bContext;
|
|
struct ID;
|
|
struct PreviewImage;
|
|
struct PointerRNA;
|
|
|
|
typedef struct IconFile {
|
|
struct IconFile *next, *prev;
|
|
char filename[256]; /* FILE_MAXFILE size */
|
|
int index;
|
|
} IconFile;
|
|
|
|
#define ICON_DEFAULT_HEIGHT 16
|
|
#define ICON_DEFAULT_WIDTH 16
|
|
|
|
#define ICON_DEFAULT_HEIGHT_SCALE ((int)(UI_UNIT_Y * 0.8f))
|
|
#define ICON_DEFAULT_WIDTH_SCALE ((int)(UI_UNIT_X * 0.8f))
|
|
|
|
#define PREVIEW_DEFAULT_HEIGHT 128
|
|
|
|
/*
|
|
* Resizable Icons for Blender
|
|
*/
|
|
void UI_icons_init(int first_dyn_id);
|
|
int UI_icon_get_width(int icon_id);
|
|
int UI_icon_get_height(int icon_id);
|
|
|
|
void UI_id_icon_render(
|
|
const struct bContext *C, struct Scene *scene, struct ID *id, const bool big, const bool use_job);
|
|
|
|
void UI_icon_draw(float x, float y, int icon_id);
|
|
void UI_icon_draw_preview(float x, float y, int icon_id);
|
|
void UI_icon_draw_preview_aspect(float x, float y, int icon_id, float aspect);
|
|
void UI_icon_draw_preview_aspect_size(float x, float y, int icon_id, float aspect, int size);
|
|
|
|
void UI_icon_draw_aspect(float x, float y, int icon_id, float aspect, float alpha);
|
|
void UI_icon_draw_aspect_color(float x, float y, int icon_id, float aspect, const float rgb[3]);
|
|
void UI_icon_draw_size(float x, float y, int size, int icon_id, float alpha);
|
|
void UI_icons_free(void);
|
|
void UI_icons_free_drawinfo(void *drawinfo);
|
|
|
|
struct ListBase *UI_iconfile_list(void);
|
|
int UI_iconfile_get_index(const char *filename);
|
|
|
|
struct PreviewImage *UI_icon_to_preview(int icon_id);
|
|
|
|
int UI_rnaptr_icon_get(struct bContext *C, struct PointerRNA *ptr, int rnaicon, const bool big);
|
|
|
|
#endif /* __UI_INTERFACE_ICONS_H__ */
|