Bastien Montagne
d30f664c04
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
119 lines
3.4 KiB
C++
119 lines
3.4 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) 2006-2007 Blender Foundation.
|
|
* All rights reserved.
|
|
*
|
|
* The Original Code is: all of this file.
|
|
*
|
|
* Contributor(s): none yet.
|
|
*
|
|
* ***** END GPL LICENSE BLOCK *****
|
|
*/
|
|
|
|
#ifndef __BKE_ICONS_H__
|
|
#define __BKE_ICONS_H__
|
|
|
|
/** \file BKE_icons.h
|
|
* \ingroup bke
|
|
*
|
|
* Resizable Icons for Blender
|
|
*/
|
|
|
|
typedef void (*DrawInfoFreeFP)(void *drawinfo);
|
|
|
|
struct Icon {
|
|
void *drawinfo;
|
|
void *obj;
|
|
short type;
|
|
DrawInfoFreeFP drawinfo_free;
|
|
};
|
|
|
|
typedef struct Icon Icon;
|
|
|
|
struct PreviewImage;
|
|
struct ID;
|
|
|
|
enum eIconSizes;
|
|
|
|
void BKE_icons_init(int first_dyn_id);
|
|
|
|
/* return icon id for library object or create new icon if not found */
|
|
int BKE_icon_id_ensure(struct ID *id);
|
|
|
|
int BKE_icon_preview_ensure(struct PreviewImage *preview);
|
|
|
|
/* retrieve icon for id */
|
|
struct Icon *BKE_icon_get(int icon_id);
|
|
|
|
/* set icon for id if not already defined */
|
|
/* used for inserting the internal icons */
|
|
void BKE_icon_set(int icon_id, struct Icon *icon);
|
|
|
|
/* remove icon and free data if library object becomes invalid */
|
|
void BKE_icon_id_delete(struct ID *id);
|
|
|
|
void BKE_icon_delete(int icon_id);
|
|
|
|
/* report changes - icon needs to be recalculated */
|
|
void BKE_icon_changed(int icon_id);
|
|
|
|
/* free all icons */
|
|
void BKE_icons_free(void);
|
|
|
|
/* free the preview image for use in list */
|
|
void BKE_previewimg_freefunc(void *link);
|
|
|
|
/* free the preview image */
|
|
void BKE_previewimg_free(struct PreviewImage **prv);
|
|
|
|
/* clear the preview image or icon, but does not free it */
|
|
void BKE_previewimg_clear(struct PreviewImage *prv);
|
|
|
|
/* clear the preview image or icon at a specific size */
|
|
void BKE_previewimg_clear_single(struct PreviewImage *prv, enum eIconSizes size);
|
|
|
|
/* get the preview from any pointer */
|
|
struct PreviewImage **BKE_previewimg_id_get_p(struct ID *id);
|
|
|
|
/* free the preview image belonging to the id */
|
|
void BKE_previewimg_id_free(struct ID *id);
|
|
|
|
/* create a new preview image */
|
|
struct PreviewImage *BKE_previewimg_create(void);
|
|
|
|
/* create a copy of the preview image */
|
|
struct PreviewImage *BKE_previewimg_copy(struct PreviewImage *prv);
|
|
|
|
/* retrieve existing or create new preview image */
|
|
struct PreviewImage *BKE_previewimg_id_ensure(struct ID *id);
|
|
|
|
void BKE_previewimg_ensure(struct PreviewImage *prv, const int size);
|
|
|
|
struct PreviewImage *BKE_previewimg_cached_get(const char *name);
|
|
|
|
struct PreviewImage *BKE_previewimg_cached_ensure(const char *name);
|
|
|
|
struct PreviewImage *BKE_previewimg_cached_thumbnail_read(
|
|
const char *name, const char *path, const int source, bool force_update);
|
|
|
|
void BKE_previewimg_cached_release(const char *name);
|
|
|
|
#define ICON_RENDER_DEFAULT_HEIGHT 32
|
|
|
|
#endif /* __BKE_ICONS_H__ */
|