This introduces the User Interface part of the Asset Browser, based on the design in T54642. Additions: * New Asset Browser (internally a sub-editor of the File Browser). * Navigation region showing asset categories. * Main region showing the assets of the selected asset library with previews. The assets may be stored over multiple .blends in the directory that's "mounted" as asset library in the Preferences. They will all be shown in this list. * Header with an asset library dropdown, allowing to choose the active asset library to show. Options are the "Current File" as asset library and all custom libraries. * Display popover, filter popover and search box (partially dummies, see T82680). * Sidebar showing the metadata of the currently active file (name, preview, description and tags), which can be edited for assets in the "Current File" asset library. (For others it will reset on reload.) * The sidebar includes a button to load a custom preview image from a file. * Make asset files draggable (with preview image). * If a library with invalid path is selected, a message is drawn in the main region to help the user understand what's wrong. * Operators to add and remove asset tags. Exposed in the sidebar. * "Only Assets" option for Link/Append. * Internal utilities for asset UI scripts. For screenshots or demo videos, please see D9725. Or the 2.92 release notes. Note that there are many things to be tweaked and polished in the Asset Browser UI still. For example, the filter and display popovers are mostly dummies. See T82680. Part of the first Asset Browser milestone. Check the #asset_browser_milestone_1 project milestone on developer.blender.org. Differential Revision: https://developer.blender.org/D9725 Reviewed by: Brecht Van Lommel, Hans Goudey
655 lines
25 KiB
C
655 lines
25 KiB
C
/*
|
|
* 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.
|
|
*/
|
|
|
|
/** \file
|
|
* \ingroup RNA
|
|
*/
|
|
|
|
#include <stddef.h>
|
|
#include <stdlib.h>
|
|
|
|
#include "RNA_define.h"
|
|
#include "RNA_enum_types.h"
|
|
|
|
#include "rna_internal.h"
|
|
|
|
#include "DNA_scene_types.h"
|
|
#include "DNA_screen_types.h"
|
|
#include "DNA_workspace_types.h"
|
|
|
|
#include "ED_info.h"
|
|
|
|
const EnumPropertyItem rna_enum_region_type_items[] = {
|
|
{RGN_TYPE_WINDOW, "WINDOW", 0, "Window", ""},
|
|
{RGN_TYPE_HEADER, "HEADER", 0, "Header", ""},
|
|
{RGN_TYPE_CHANNELS, "CHANNELS", 0, "Channels", ""},
|
|
{RGN_TYPE_TEMPORARY, "TEMPORARY", 0, "Temporary", ""},
|
|
{RGN_TYPE_UI, "UI", 0, "UI", ""},
|
|
{RGN_TYPE_TOOLS, "TOOLS", 0, "Tools", ""},
|
|
{RGN_TYPE_TOOL_PROPS, "TOOL_PROPS", 0, "Tool Properties", ""},
|
|
{RGN_TYPE_PREVIEW, "PREVIEW", 0, "Preview", ""},
|
|
{RGN_TYPE_HUD, "HUD", 0, "Floating Region", ""},
|
|
{RGN_TYPE_NAV_BAR, "NAVIGATION_BAR", 0, "Navigation Bar", ""},
|
|
{RGN_TYPE_EXECUTE, "EXECUTE", 0, "Execute Buttons", ""},
|
|
{RGN_TYPE_FOOTER, "FOOTER", 0, "Footer", ""},
|
|
{RGN_TYPE_TOOL_HEADER, "TOOL_HEADER", 0, "Tool Header", ""},
|
|
{0, NULL, 0, NULL, NULL},
|
|
};
|
|
|
|
#include "ED_screen.h"
|
|
|
|
#include "WM_api.h"
|
|
#include "WM_types.h"
|
|
|
|
#ifdef RNA_RUNTIME
|
|
|
|
# include "BKE_global.h"
|
|
# include "BKE_screen.h"
|
|
# include "BKE_workspace.h"
|
|
|
|
# include "DEG_depsgraph.h"
|
|
|
|
# include "UI_view2d.h"
|
|
|
|
# ifdef WITH_PYTHON
|
|
# include "BPY_extern.h"
|
|
# endif
|
|
|
|
static void rna_Screen_bar_update(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
|
|
{
|
|
bScreen *screen = (bScreen *)ptr->data;
|
|
screen->do_draw = true;
|
|
screen->do_refresh = true;
|
|
}
|
|
|
|
static void rna_Screen_redraw_update(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
|
|
{
|
|
bScreen *screen = (bScreen *)ptr->data;
|
|
|
|
/* the settings for this are currently only available from a menu in the TimeLine,
|
|
* hence refresh=SPACE_ACTION, as timeline is now in there
|
|
*/
|
|
ED_screen_animation_timer_update(screen, screen->redraws_flag);
|
|
}
|
|
|
|
static bool rna_Screen_is_animation_playing_get(PointerRNA *UNUSED(ptr))
|
|
{
|
|
/* can be NULL on file load, T42619 */
|
|
wmWindowManager *wm = G_MAIN->wm.first;
|
|
return wm ? (ED_screen_animation_playing(wm) != NULL) : 0;
|
|
}
|
|
|
|
static bool rna_Screen_is_scrubbing_get(PointerRNA *ptr)
|
|
{
|
|
bScreen *screen = (bScreen *)ptr->data;
|
|
return screen->scrubbing;
|
|
}
|
|
|
|
static int rna_region_alignment_get(PointerRNA *ptr)
|
|
{
|
|
ARegion *region = ptr->data;
|
|
return RGN_ALIGN_ENUM_FROM_MASK(region->alignment);
|
|
}
|
|
|
|
static bool rna_Screen_fullscreen_get(PointerRNA *ptr)
|
|
{
|
|
bScreen *screen = (bScreen *)ptr->data;
|
|
return (screen->state == SCREENMAXIMIZED);
|
|
}
|
|
|
|
/* UI compatible list: should not be needed, but for now we need to keep EMPTY
|
|
* at least in the static version of this enum for python scripts. */
|
|
static const EnumPropertyItem *rna_Area_type_itemf(bContext *UNUSED(C),
|
|
PointerRNA *UNUSED(ptr),
|
|
PropertyRNA *UNUSED(prop),
|
|
bool *r_free)
|
|
{
|
|
/* +1 to skip SPACE_EMPTY */
|
|
*r_free = false;
|
|
return rna_enum_space_type_items + 1;
|
|
}
|
|
|
|
static int rna_Area_type_get(PointerRNA *ptr)
|
|
{
|
|
ScrArea *area = (ScrArea *)ptr->data;
|
|
/* Usually 'spacetype' is used. It lags behind a bit while switching area
|
|
* type though, then we use 'butspacetype' instead (T41435). */
|
|
return (area->butspacetype == SPACE_EMPTY) ? area->spacetype : area->butspacetype;
|
|
}
|
|
|
|
static void rna_Area_type_set(PointerRNA *ptr, int value)
|
|
{
|
|
if (ELEM(value, SPACE_TOPBAR, SPACE_STATUSBAR)) {
|
|
/* Special case: An area can not be set to show the top-bar editor (or
|
|
* other global areas). However it should still be possible to identify
|
|
* its type from Python. */
|
|
return;
|
|
}
|
|
|
|
ScrArea *area = (ScrArea *)ptr->data;
|
|
area->butspacetype = value;
|
|
}
|
|
|
|
static void rna_Area_type_update(bContext *C, PointerRNA *ptr)
|
|
{
|
|
bScreen *screen = (bScreen *)ptr->owner_id;
|
|
ScrArea *area = (ScrArea *)ptr->data;
|
|
|
|
/* Running update without having called 'set', see: T64049 */
|
|
if (area->butspacetype == SPACE_EMPTY) {
|
|
return;
|
|
}
|
|
|
|
wmWindowManager *wm = CTX_wm_manager(C);
|
|
wmWindow *win;
|
|
/* XXX this call still use context, so we trick it to work in the right context */
|
|
for (win = wm->windows.first; win; win = win->next) {
|
|
if (screen == WM_window_get_active_screen(win)) {
|
|
wmWindow *prevwin = CTX_wm_window(C);
|
|
ScrArea *prevsa = CTX_wm_area(C);
|
|
ARegion *prevar = CTX_wm_region(C);
|
|
|
|
CTX_wm_window_set(C, win);
|
|
CTX_wm_area_set(C, area);
|
|
CTX_wm_region_set(C, NULL);
|
|
|
|
ED_area_newspace(C, area, area->butspacetype, true);
|
|
ED_area_tag_redraw(area);
|
|
|
|
/* Unset so that rna_Area_type_get uses spacetype instead. */
|
|
area->butspacetype = SPACE_EMPTY;
|
|
|
|
/* It is possible that new layers becomes visible. */
|
|
if (area->spacetype == SPACE_VIEW3D) {
|
|
DEG_on_visible_update(CTX_data_main(C), false);
|
|
}
|
|
|
|
CTX_wm_window_set(C, prevwin);
|
|
CTX_wm_area_set(C, prevsa);
|
|
CTX_wm_region_set(C, prevar);
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
static const EnumPropertyItem *rna_Area_ui_type_itemf(bContext *C,
|
|
PointerRNA *UNUSED(ptr),
|
|
PropertyRNA *UNUSED(prop),
|
|
bool *r_free)
|
|
{
|
|
EnumPropertyItem *item = NULL;
|
|
int totitem = 0;
|
|
|
|
/* +1 to skip SPACE_EMPTY */
|
|
for (const EnumPropertyItem *item_from = rna_enum_space_type_items + 1; item_from->identifier;
|
|
item_from++) {
|
|
if (ELEM(item_from->value, SPACE_TOPBAR, SPACE_STATUSBAR)) {
|
|
continue;
|
|
}
|
|
|
|
SpaceType *st = item_from->identifier[0] ? BKE_spacetype_from_id(item_from->value) : NULL;
|
|
int totitem_prev = totitem;
|
|
if (st && st->space_subtype_item_extend != NULL) {
|
|
st->space_subtype_item_extend(C, &item, &totitem);
|
|
while (totitem_prev < totitem) {
|
|
item[totitem_prev++].value |= item_from->value << 16;
|
|
}
|
|
}
|
|
else {
|
|
RNA_enum_item_add(&item, &totitem, item_from);
|
|
item[totitem_prev++].value = item_from->value << 16;
|
|
}
|
|
}
|
|
RNA_enum_item_end(&item, &totitem);
|
|
*r_free = true;
|
|
|
|
return item;
|
|
}
|
|
|
|
static int rna_Area_ui_type_get(PointerRNA *ptr)
|
|
{
|
|
ScrArea *area = ptr->data;
|
|
const int area_type = rna_Area_type_get(ptr);
|
|
const bool area_changing = area->butspacetype != SPACE_EMPTY;
|
|
int value = area_type << 16;
|
|
|
|
/* Area->type can be NULL when not yet initialized (for example when accessed
|
|
* through the outliner or API when not visible), or it can be wrong while
|
|
* the area type is changing.
|
|
* So manually do the lookup in those cases, but do not actually change area->type
|
|
* since that prevents a proper exit when the area type is changing.
|
|
* Logic copied from `ED_area_init()`.*/
|
|
SpaceType *type = area->type;
|
|
if (type == NULL || area_changing) {
|
|
type = BKE_spacetype_from_id(area_type);
|
|
if (type == NULL) {
|
|
type = BKE_spacetype_from_id(SPACE_VIEW3D);
|
|
}
|
|
BLI_assert(type != NULL);
|
|
}
|
|
if (type->space_subtype_item_extend != NULL) {
|
|
value |= area_changing ? area->butspacetype_subtype : type->space_subtype_get(area);
|
|
}
|
|
return value;
|
|
}
|
|
|
|
static void rna_Area_ui_type_set(PointerRNA *ptr, int value)
|
|
{
|
|
ScrArea *area = ptr->data;
|
|
const int space_type = value >> 16;
|
|
SpaceType *st = BKE_spacetype_from_id(space_type);
|
|
|
|
rna_Area_type_set(ptr, space_type);
|
|
|
|
if (st && st->space_subtype_item_extend != NULL) {
|
|
area->butspacetype_subtype = value & 0xffff;
|
|
}
|
|
}
|
|
|
|
static void rna_Area_ui_type_update(bContext *C, PointerRNA *ptr)
|
|
{
|
|
ScrArea *area = ptr->data;
|
|
SpaceType *st = BKE_spacetype_from_id(area->butspacetype);
|
|
|
|
rna_Area_type_update(C, ptr);
|
|
|
|
if ((area->type == st) && (st->space_subtype_item_extend != NULL)) {
|
|
st->space_subtype_set(area, area->butspacetype_subtype);
|
|
}
|
|
area->butspacetype_subtype = 0;
|
|
|
|
ED_area_tag_refresh(area);
|
|
}
|
|
|
|
static void rna_View2D_region_to_view(struct View2D *v2d, float x, float y, float result[2])
|
|
{
|
|
UI_view2d_region_to_view(v2d, x, y, &result[0], &result[1]);
|
|
}
|
|
|
|
static void rna_View2D_view_to_region(
|
|
struct View2D *v2d, float x, float y, bool clip, int result[2])
|
|
{
|
|
if (clip) {
|
|
UI_view2d_view_to_region_clip(v2d, x, y, &result[0], &result[1]);
|
|
}
|
|
else {
|
|
UI_view2d_view_to_region(v2d, x, y, &result[0], &result[1]);
|
|
}
|
|
}
|
|
|
|
static const char *rna_Screen_statusbar_info_get(struct bScreen *UNUSED(screen),
|
|
Main *bmain,
|
|
bContext *C)
|
|
{
|
|
return ED_info_statusbar_string(bmain, CTX_data_scene(C), CTX_data_view_layer(C));
|
|
}
|
|
|
|
#else
|
|
|
|
/* Area.spaces */
|
|
static void rna_def_area_spaces(BlenderRNA *brna, PropertyRNA *cprop)
|
|
{
|
|
StructRNA *srna;
|
|
PropertyRNA *prop;
|
|
|
|
RNA_def_property_srna(cprop, "AreaSpaces");
|
|
srna = RNA_def_struct(brna, "AreaSpaces", NULL);
|
|
RNA_def_struct_sdna(srna, "ScrArea");
|
|
RNA_def_struct_ui_text(srna, "Area Spaces", "Collection of spaces");
|
|
|
|
prop = RNA_def_property(srna, "active", PROP_POINTER, PROP_NONE);
|
|
RNA_def_property_pointer_sdna(prop, NULL, "spacedata.first");
|
|
RNA_def_property_struct_type(prop, "Space");
|
|
RNA_def_property_ui_text(prop, "Active Space", "Space currently being displayed in this area");
|
|
}
|
|
|
|
static void rna_def_area_api(StructRNA *srna)
|
|
{
|
|
FunctionRNA *func;
|
|
PropertyRNA *parm;
|
|
|
|
RNA_def_function(srna, "tag_redraw", "ED_area_tag_redraw");
|
|
|
|
func = RNA_def_function(srna, "header_text_set", "ED_area_status_text");
|
|
RNA_def_function_ui_description(func, "Set the header status text");
|
|
parm = RNA_def_string(
|
|
func, "text", NULL, 0, "Text", "New string for the header, None clears the text");
|
|
RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
|
|
RNA_def_property_clear_flag(parm, PROP_NEVER_NULL);
|
|
}
|
|
|
|
static void rna_def_area(BlenderRNA *brna)
|
|
{
|
|
StructRNA *srna;
|
|
PropertyRNA *prop;
|
|
|
|
srna = RNA_def_struct(brna, "Area", NULL);
|
|
RNA_def_struct_ui_text(srna, "Area", "Area in a subdivided screen, containing an editor");
|
|
RNA_def_struct_sdna(srna, "ScrArea");
|
|
|
|
prop = RNA_def_property(srna, "spaces", PROP_COLLECTION, PROP_NONE);
|
|
RNA_def_property_collection_sdna(prop, NULL, "spacedata", NULL);
|
|
RNA_def_property_struct_type(prop, "Space");
|
|
RNA_def_property_ui_text(prop,
|
|
"Spaces",
|
|
"Spaces contained in this area, the first being the active space "
|
|
"(NOTE: Useful for example to restore a previously used 3D view space "
|
|
"in a certain area to get the old view orientation)");
|
|
rna_def_area_spaces(brna, prop);
|
|
|
|
prop = RNA_def_property(srna, "regions", PROP_COLLECTION, PROP_NONE);
|
|
RNA_def_property_collection_sdna(prop, NULL, "regionbase", NULL);
|
|
RNA_def_property_struct_type(prop, "Region");
|
|
RNA_def_property_ui_text(prop, "Regions", "Regions this area is subdivided in");
|
|
|
|
prop = RNA_def_property(srna, "show_menus", PROP_BOOLEAN, PROP_NONE);
|
|
RNA_def_property_boolean_negative_sdna(prop, NULL, "flag", HEADER_NO_PULLDOWN);
|
|
RNA_def_property_ui_text(prop, "Show Menus", "Show menus in the header");
|
|
|
|
prop = RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
|
|
RNA_def_property_enum_sdna(prop, NULL, "spacetype");
|
|
RNA_def_property_enum_items(prop, rna_enum_space_type_items);
|
|
RNA_def_property_enum_default(prop, SPACE_VIEW3D);
|
|
RNA_def_property_enum_funcs(
|
|
prop, "rna_Area_type_get", "rna_Area_type_set", "rna_Area_type_itemf");
|
|
RNA_def_property_ui_text(prop, "Editor Type", "Current editor type for this area");
|
|
RNA_def_property_flag(prop, PROP_CONTEXT_UPDATE);
|
|
RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
|
|
RNA_def_property_update(prop, 0, "rna_Area_type_update");
|
|
|
|
prop = RNA_def_property(srna, "ui_type", PROP_ENUM, PROP_NONE);
|
|
RNA_def_property_enum_items(prop, DummyRNA_NULL_items); /* in fact dummy */
|
|
RNA_def_property_enum_default(prop, SPACE_VIEW3D << 16);
|
|
RNA_def_property_enum_funcs(
|
|
prop, "rna_Area_ui_type_get", "rna_Area_ui_type_set", "rna_Area_ui_type_itemf");
|
|
RNA_def_property_ui_text(prop, "Editor Type", "Current editor type for this area");
|
|
RNA_def_property_flag(prop, PROP_CONTEXT_UPDATE);
|
|
RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
|
|
RNA_def_property_update(prop, 0, "rna_Area_ui_type_update");
|
|
|
|
prop = RNA_def_property(srna, "x", PROP_INT, PROP_NONE);
|
|
RNA_def_property_int_sdna(prop, NULL, "totrct.xmin");
|
|
RNA_def_property_clear_flag(prop, PROP_EDITABLE);
|
|
RNA_def_property_ui_text(
|
|
prop, "X Position", "The window relative vertical location of the area");
|
|
|
|
prop = RNA_def_property(srna, "y", PROP_INT, PROP_NONE);
|
|
RNA_def_property_int_sdna(prop, NULL, "totrct.ymin");
|
|
RNA_def_property_clear_flag(prop, PROP_EDITABLE);
|
|
RNA_def_property_ui_text(
|
|
prop, "Y Position", "The window relative horizontal location of the area");
|
|
|
|
prop = RNA_def_property(srna, "width", PROP_INT, PROP_UNSIGNED);
|
|
RNA_def_property_int_sdna(prop, NULL, "winx");
|
|
RNA_def_property_clear_flag(prop, PROP_EDITABLE);
|
|
RNA_def_property_ui_text(prop, "Width", "Area width");
|
|
|
|
prop = RNA_def_property(srna, "height", PROP_INT, PROP_UNSIGNED);
|
|
RNA_def_property_int_sdna(prop, NULL, "winy");
|
|
RNA_def_property_clear_flag(prop, PROP_EDITABLE);
|
|
RNA_def_property_ui_text(prop, "Height", "Area height");
|
|
|
|
rna_def_area_api(srna);
|
|
}
|
|
|
|
static void rna_def_view2d_api(StructRNA *srna)
|
|
{
|
|
FunctionRNA *func;
|
|
PropertyRNA *parm;
|
|
|
|
static const float view_default[2] = {0.0f, 0.0f};
|
|
static const int region_default[2] = {0.0f, 0.0f};
|
|
|
|
func = RNA_def_function(srna, "region_to_view", "rna_View2D_region_to_view");
|
|
RNA_def_function_ui_description(func, "Transform region coordinates to 2D view");
|
|
parm = RNA_def_float(func, "x", 0, -FLT_MAX, FLT_MAX, "x", "Region x coordinate", -10000, 10000);
|
|
RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
|
|
parm = RNA_def_float(func, "y", 0, -FLT_MAX, FLT_MAX, "y", "Region y coordinate", -10000, 10000);
|
|
RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
|
|
parm = RNA_def_float_array(func,
|
|
"result",
|
|
2,
|
|
view_default,
|
|
-FLT_MAX,
|
|
FLT_MAX,
|
|
"Result",
|
|
"View coordinates",
|
|
-10000.0f,
|
|
10000.0f);
|
|
RNA_def_parameter_flags(parm, PROP_THICK_WRAP, 0);
|
|
RNA_def_function_output(func, parm);
|
|
|
|
func = RNA_def_function(srna, "view_to_region", "rna_View2D_view_to_region");
|
|
RNA_def_function_ui_description(func, "Transform 2D view coordinates to region");
|
|
parm = RNA_def_float(
|
|
func, "x", 0.0f, -FLT_MAX, FLT_MAX, "x", "2D View x coordinate", -10000.0f, 10000.0f);
|
|
RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
|
|
parm = RNA_def_float(
|
|
func, "y", 0.0f, -FLT_MAX, FLT_MAX, "y", "2D View y coordinate", -10000.0f, 10000.0f);
|
|
RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
|
|
RNA_def_boolean(func, "clip", 1, "Clip", "Clip coordinates to the visible region");
|
|
parm = RNA_def_int_array(func,
|
|
"result",
|
|
2,
|
|
region_default,
|
|
INT_MIN,
|
|
INT_MAX,
|
|
"Result",
|
|
"Region coordinates",
|
|
-10000,
|
|
10000);
|
|
RNA_def_parameter_flags(parm, PROP_THICK_WRAP, 0);
|
|
RNA_def_function_output(func, parm);
|
|
}
|
|
|
|
static void rna_def_view2d(BlenderRNA *brna)
|
|
{
|
|
StructRNA *srna;
|
|
/* PropertyRNA *prop; */
|
|
|
|
srna = RNA_def_struct(brna, "View2D", NULL);
|
|
RNA_def_struct_ui_text(srna, "View2D", "Scroll and zoom for a 2D region");
|
|
RNA_def_struct_sdna(srna, "View2D");
|
|
|
|
/* TODO more View2D properties could be exposed here (read-only) */
|
|
|
|
rna_def_view2d_api(srna);
|
|
}
|
|
|
|
static void rna_def_region(BlenderRNA *brna)
|
|
{
|
|
StructRNA *srna;
|
|
PropertyRNA *prop;
|
|
|
|
static const EnumPropertyItem alignment_types[] = {
|
|
{RGN_ALIGN_NONE, "NONE", 0, "None", "Don't use any fixed alignment, fill available space"},
|
|
{RGN_ALIGN_TOP, "TOP", 0, "Top", ""},
|
|
{RGN_ALIGN_BOTTOM, "BOTTOM", 0, "Bottom", ""},
|
|
{RGN_ALIGN_LEFT, "LEFT", 0, "Left", ""},
|
|
{RGN_ALIGN_RIGHT, "RIGHT", 0, "Right", ""},
|
|
{RGN_ALIGN_HSPLIT, "HORIZONTAL_SPLIT", 0, "Horizontal Split", ""},
|
|
{RGN_ALIGN_VSPLIT, "VERTICAL_SPLIT", 0, "Vertical Split", ""},
|
|
{RGN_ALIGN_FLOAT,
|
|
"FLOAT",
|
|
0,
|
|
"Float",
|
|
"Region floats on screen, doesn't use any fixed alignment"},
|
|
{RGN_ALIGN_QSPLIT,
|
|
"QUAD_SPLIT",
|
|
0,
|
|
"Quad Split",
|
|
"Region is split horizontally and vertically"},
|
|
{0, NULL, 0, NULL, NULL},
|
|
};
|
|
|
|
srna = RNA_def_struct(brna, "Region", NULL);
|
|
RNA_def_struct_ui_text(srna, "Region", "Region in a subdivided screen area");
|
|
RNA_def_struct_sdna(srna, "ARegion");
|
|
|
|
prop = RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
|
|
RNA_def_property_enum_sdna(prop, NULL, "regiontype");
|
|
RNA_def_property_enum_items(prop, rna_enum_region_type_items);
|
|
RNA_def_property_clear_flag(prop, PROP_EDITABLE);
|
|
RNA_def_property_ui_text(prop, "Region Type", "Type of this region");
|
|
|
|
prop = RNA_def_property(srna, "x", PROP_INT, PROP_NONE);
|
|
RNA_def_property_int_sdna(prop, NULL, "winrct.xmin");
|
|
RNA_def_property_clear_flag(prop, PROP_EDITABLE);
|
|
RNA_def_property_ui_text(
|
|
prop, "X Position", "The window relative vertical location of the region");
|
|
|
|
prop = RNA_def_property(srna, "y", PROP_INT, PROP_NONE);
|
|
RNA_def_property_int_sdna(prop, NULL, "winrct.ymin");
|
|
RNA_def_property_clear_flag(prop, PROP_EDITABLE);
|
|
RNA_def_property_ui_text(
|
|
prop, "Y Position", "The window relative horizontal location of the region");
|
|
|
|
prop = RNA_def_property(srna, "width", PROP_INT, PROP_UNSIGNED);
|
|
RNA_def_property_int_sdna(prop, NULL, "winx");
|
|
RNA_def_property_clear_flag(prop, PROP_EDITABLE);
|
|
RNA_def_property_ui_text(prop, "Width", "Region width");
|
|
|
|
prop = RNA_def_property(srna, "height", PROP_INT, PROP_UNSIGNED);
|
|
RNA_def_property_int_sdna(prop, NULL, "winy");
|
|
RNA_def_property_clear_flag(prop, PROP_EDITABLE);
|
|
RNA_def_property_ui_text(prop, "Height", "Region height");
|
|
|
|
prop = RNA_def_property(srna, "view2d", PROP_POINTER, PROP_NONE);
|
|
RNA_def_property_pointer_sdna(prop, NULL, "v2d");
|
|
RNA_def_property_clear_flag(prop, PROP_EDITABLE);
|
|
RNA_def_property_flag(prop, PROP_NEVER_NULL);
|
|
RNA_def_property_ui_text(prop, "View2D", "2D view of the region");
|
|
|
|
prop = RNA_def_property(srna, "alignment", PROP_ENUM, PROP_NONE);
|
|
RNA_def_property_clear_flag(prop, PROP_EDITABLE);
|
|
RNA_def_property_enum_items(prop, alignment_types);
|
|
RNA_def_property_enum_funcs(prop, "rna_region_alignment_get", NULL, NULL);
|
|
RNA_def_property_ui_text(prop, "Alignment", "Alignment of the region within the area");
|
|
|
|
RNA_def_function(srna, "tag_redraw", "ED_region_tag_redraw");
|
|
}
|
|
|
|
static void rna_def_screen(BlenderRNA *brna)
|
|
{
|
|
StructRNA *srna;
|
|
PropertyRNA *prop;
|
|
|
|
FunctionRNA *func;
|
|
PropertyRNA *parm;
|
|
|
|
srna = RNA_def_struct(brna, "Screen", "ID");
|
|
RNA_def_struct_sdna(srna, "Screen"); /* it is actually bScreen but for 2.5 the dna is patched! */
|
|
RNA_def_struct_ui_text(
|
|
srna, "Screen", "Screen data-block, defining the layout of areas in a window");
|
|
RNA_def_struct_ui_icon(srna, ICON_WORKSPACE);
|
|
|
|
/* collections */
|
|
prop = RNA_def_property(srna, "areas", PROP_COLLECTION, PROP_NONE);
|
|
RNA_def_property_collection_sdna(prop, NULL, "areabase", NULL);
|
|
RNA_def_property_struct_type(prop, "Area");
|
|
RNA_def_property_ui_text(prop, "Areas", "Areas the screen is subdivided into");
|
|
|
|
/* readonly status indicators */
|
|
prop = RNA_def_property(srna, "is_animation_playing", PROP_BOOLEAN, PROP_NONE);
|
|
RNA_def_property_clear_flag(prop, PROP_EDITABLE);
|
|
RNA_def_property_boolean_funcs(prop, "rna_Screen_is_animation_playing_get", NULL);
|
|
RNA_def_property_ui_text(prop, "Animation Playing", "Animation playback is active");
|
|
|
|
prop = RNA_def_property(srna, "is_scrubbing", PROP_BOOLEAN, PROP_NONE);
|
|
RNA_def_property_clear_flag(prop, PROP_EDITABLE);
|
|
RNA_def_property_boolean_funcs(prop, "rna_Screen_is_scrubbing_get", NULL);
|
|
RNA_def_property_ui_text(
|
|
prop, "User is Scrubbing", "True when the user is scrubbing through time");
|
|
|
|
prop = RNA_def_property(srna, "is_temporary", PROP_BOOLEAN, PROP_NONE);
|
|
RNA_def_property_clear_flag(prop, PROP_EDITABLE);
|
|
RNA_def_property_boolean_sdna(prop, NULL, "temp", 1);
|
|
RNA_def_property_ui_text(prop, "Temporary", "");
|
|
|
|
prop = RNA_def_property(srna, "show_fullscreen", PROP_BOOLEAN, PROP_NONE);
|
|
RNA_def_property_clear_flag(prop, PROP_EDITABLE);
|
|
RNA_def_property_boolean_funcs(prop, "rna_Screen_fullscreen_get", NULL);
|
|
RNA_def_property_ui_text(prop, "Maximize", "An area is maximized, filling this screen");
|
|
|
|
/* Status Bar. */
|
|
|
|
prop = RNA_def_property(srna, "show_statusbar", PROP_BOOLEAN, PROP_NONE);
|
|
RNA_def_property_boolean_negative_sdna(prop, NULL, "flag", SCREEN_COLLAPSE_STATUSBAR);
|
|
RNA_def_property_ui_text(prop, "Show Status Bar", "Show status bar");
|
|
RNA_def_property_update(prop, 0, "rna_Screen_bar_update");
|
|
|
|
func = RNA_def_function(srna, "statusbar_info", "rna_Screen_statusbar_info_get");
|
|
RNA_def_function_flag(func, FUNC_USE_MAIN | FUNC_USE_CONTEXT);
|
|
parm = RNA_def_string(func, "statusbar_info", NULL, 0, "Status Bar Info", "");
|
|
RNA_def_function_return(func, parm);
|
|
|
|
/* Define Anim Playback Areas */
|
|
prop = RNA_def_property(srna, "use_play_top_left_3d_editor", PROP_BOOLEAN, PROP_NONE);
|
|
RNA_def_property_boolean_sdna(prop, NULL, "redraws_flag", TIME_REGION);
|
|
RNA_def_property_ui_text(prop, "Top-Left 3D Editor", "");
|
|
RNA_def_property_update(prop, NC_SPACE | ND_SPACE_TIME, "rna_Screen_redraw_update");
|
|
|
|
prop = RNA_def_property(srna, "use_play_3d_editors", PROP_BOOLEAN, PROP_NONE);
|
|
RNA_def_property_boolean_sdna(prop, NULL, "redraws_flag", TIME_ALL_3D_WIN);
|
|
RNA_def_property_ui_text(prop, "All 3D Viewports", "");
|
|
RNA_def_property_update(prop, NC_SPACE | ND_SPACE_TIME, "rna_Screen_redraw_update");
|
|
|
|
prop = RNA_def_property(srna, "use_follow", PROP_BOOLEAN, PROP_NONE);
|
|
RNA_def_property_boolean_sdna(prop, NULL, "redraws_flag", TIME_FOLLOW);
|
|
RNA_def_property_ui_text(prop, "Follow", "Follow current frame in editors");
|
|
RNA_def_property_update(prop, NC_SPACE | ND_SPACE_TIME, "rna_Screen_redraw_update");
|
|
|
|
prop = RNA_def_property(srna, "use_play_animation_editors", PROP_BOOLEAN, PROP_NONE);
|
|
RNA_def_property_boolean_sdna(prop, NULL, "redraws_flag", TIME_ALL_ANIM_WIN);
|
|
RNA_def_property_ui_text(prop, "Animation Editors", "");
|
|
RNA_def_property_update(prop, NC_SPACE | ND_SPACE_TIME, "rna_Screen_redraw_update");
|
|
|
|
prop = RNA_def_property(srna, "use_play_properties_editors", PROP_BOOLEAN, PROP_NONE);
|
|
RNA_def_property_boolean_sdna(prop, NULL, "redraws_flag", TIME_ALL_BUTS_WIN);
|
|
RNA_def_property_ui_text(prop, "Property Editors", "");
|
|
RNA_def_property_update(prop, NC_SPACE | ND_SPACE_TIME, "rna_Screen_redraw_update");
|
|
|
|
prop = RNA_def_property(srna, "use_play_image_editors", PROP_BOOLEAN, PROP_NONE);
|
|
RNA_def_property_boolean_sdna(prop, NULL, "redraws_flag", TIME_ALL_IMAGE_WIN);
|
|
RNA_def_property_ui_text(prop, "Image Editors", "");
|
|
RNA_def_property_update(prop, NC_SPACE | ND_SPACE_TIME, "rna_Screen_redraw_update");
|
|
|
|
prop = RNA_def_property(srna, "use_play_sequence_editors", PROP_BOOLEAN, PROP_NONE);
|
|
RNA_def_property_boolean_sdna(prop, NULL, "redraws_flag", TIME_SEQ);
|
|
RNA_def_property_ui_text(prop, "Sequencer Editors", "");
|
|
RNA_def_property_update(prop, NC_SPACE | ND_SPACE_TIME, "rna_Screen_redraw_update");
|
|
|
|
prop = RNA_def_property(srna, "use_play_node_editors", PROP_BOOLEAN, PROP_NONE);
|
|
RNA_def_property_boolean_sdna(prop, NULL, "redraws_flag", TIME_NODES);
|
|
RNA_def_property_ui_text(prop, "Node Editors", "");
|
|
RNA_def_property_update(prop, NC_SPACE | ND_SPACE_TIME, "rna_Screen_redraw_update");
|
|
|
|
prop = RNA_def_property(srna, "use_play_clip_editors", PROP_BOOLEAN, PROP_NONE);
|
|
RNA_def_property_boolean_sdna(prop, NULL, "redraws_flag", TIME_CLIPS);
|
|
RNA_def_property_ui_text(prop, "Clip Editors", "");
|
|
RNA_def_property_update(prop, NC_SPACE | ND_SPACE_TIME, "rna_Screen_redraw_update");
|
|
}
|
|
|
|
void RNA_def_screen(BlenderRNA *brna)
|
|
{
|
|
rna_def_screen(brna);
|
|
rna_def_area(brna);
|
|
rna_def_region(brna);
|
|
rna_def_view2d(brna);
|
|
}
|
|
|
|
#endif
|