ED_util.hh File Reference

#include "BLI_compiler_attrs.h"
#include "WM_types.hh"

Go to the source code of this file.

Namespaces
namespace	blender
namespace	blender::bke
namespace	blender::bke::id

Enumerations
enum	SliderMode { SLIDER_MODE_PERCENT = 0 , SLIDER_MODE_FLOAT = 1 }

Functions
void	ED_editors_init_for_undo (Main *bmain)
void	ED_editors_init (bContext *C)
void	ED_editors_exit (Main *bmain, bool do_undo_system)
bool	ED_editors_flush_edits_for_object_ex (Main *bmain, Object *ob, bool for_render, bool check_needs_flush)
bool	ED_editors_flush_edits_for_object (Main *bmain, Object *ob)
bool	ED_editors_flush_edits_ex (Main *bmain, bool for_render, bool check_needs_flush)
bool	ED_editors_flush_edits (Main *bmain)
void	ED_spacedata_id_remap_single (ScrArea *area, SpaceLink *sl, ID *old_id, ID *new_id)
void	ED_spacedata_id_remap (ScrArea *area, SpaceLink *sl, const blender::bke::id::IDRemapper &mappings)
void	ED_operatortypes_edutils ()
void	ED_region_draw_mouse_line_cb (const bContext *C, ARegion *region, void *arg_info)
void	ED_region_image_metadata_draw (int x, int y, ImBuf *ibuf, const rctf *frame, float zoomx, float zoomy)
tSlider *	ED_slider_create (bContext *C)
void	ED_slider_init (tSlider *slider, const wmEvent *event)
bool	ED_slider_modal (tSlider *slider, const wmEvent *event)
void	ED_slider_destroy (bContext *C, tSlider *slider)
void	ED_slider_status_string_get (const tSlider *slider, char *status_string, size_t size_of_status_string)
float	ED_slider_factor_get (const tSlider *slider)
void	ED_slider_factor_set (tSlider *slider, float factor)
void	ED_slider_allow_overshoot_set (tSlider *slider, bool lower, bool upper)
void	ED_slider_factor_bounds_set (tSlider *slider, float factor_bound_lower, float factor_bound_upper)
bool	ED_slider_allow_increments_get (const tSlider *slider)
void	ED_slider_allow_increments_set (tSlider *slider, bool value)
void	ED_slider_mode_set (tSlider *slider, SliderMode mode)
SliderMode	ED_slider_mode_get (const tSlider *slider)
void	ED_slider_unit_set (tSlider *slider, const char *unit)
void	ED_slider_property_label_set (tSlider *slider, const char *property_label)
void	apply_keyb_grid (bool shift, bool ctrl, float *val, float fac1, float fac2, float fac3, int invert)
void	unpack_menu (bContext *C, const char *opname, const char *id_name, const char *abs_name, const char *folder, PackedFile *pf)

Enumeration Type Documentation

SliderMode

enum SliderMode

Enumerator
SLIDER_MODE_PERCENT
SLIDER_MODE_FLOAT

Definition at line 70 of file ED_util.hh.

Function Documentation

apply_keyb_grid()

void apply_keyb_grid	(	bool	shift,
		bool	ctrl,
		float *	val,
		float	fac1,
		float	fac2,
		float	fac3,
		int	invert )

Now only used in 2D spaces, like time, f-curve, NLA, image, etc.

Note

Shift/Control are not configurable key-bindings.

Definition at line 338 of file ed_util.cc.

References floorf, and invert().

Referenced by ed_marker_move_modal().

ED_editors_exit()

void ED_editors_exit	(	Main *	bmain,
		bool	do_undo_system )

Frees all edit-mode stuff.

Definition at line 218 of file ed_util.cc.

References BKE_undosys_stack_destroy(), DEG_id_tag_update(), ED_mesh_mirror_spatial_table_end(), ED_mesh_mirror_topo_table_end(), G_MAIN, ID_RECALC_GEOMETRY, ID_RECALC_TRANSFORM, LISTBASE_FOREACH, Main::objects, and wmWindowManager::undo_stack.

Referenced by memfile_undosys_step_decode(), WM_exit_ex(), and wm_file_read_setup_wm_init().

ED_editors_flush_edits()

bool ED_editors_flush_edits

(

Main *

bmain

)

Definition at line 331 of file ed_util.cc.

References ED_editors_flush_edits_ex().

Referenced by ed_flush_edits_exec(), scene_add(), WM_autosave_write(), WM_exit_ex(), wm_file_write(), and wm_homefile_write_exec().

ED_editors_flush_edits_ex()

bool ED_editors_flush_edits_ex	(	Main *	bmain,
		bool	for_render,
		bool	check_needs_flush )

Flush any temp data from object editing to DNA before writing files, rendering, copying, etc.

Definition at line 315 of file ed_util.cc.

References ED_editors_flush_edits_for_object_ex(), Main::is_memfile_undo_flush_needed, LISTBASE_FOREACH, and Main::objects.

Referenced by ED_editors_flush_edits(), memfile_undosys_step_encode(), and screen_render_invoke().

ED_editors_flush_edits_for_object()

bool ED_editors_flush_edits_for_object	(	Main *	bmain,
		Object *	ob )

Definition at line 310 of file ed_util.cc.

References ED_editors_flush_edits_for_object_ex().

ED_editors_flush_edits_for_object_ex()

bool ED_editors_flush_edits_for_object_ex	(	Main *	bmain,
		Object *	ob,
		bool	for_render,
		bool	check_needs_flush )

Definition at line 260 of file ed_util.cc.

References BKE_object_data_editmode_flush_ptr_get(), BKE_sculptsession_bm_to_me(), BKE_sculptsession_bm_to_me_for_render(), SculptSession::cache, Object::data, Object::mode, multires_flush_sculpt_updates(), SculptSession::needs_flush_to_id, OB_MODE_EDIT, OB_MODE_SCULPT, and Object::sculpt.

Referenced by ED_editors_flush_edits_ex(), and ED_editors_flush_edits_for_object().

ED_editors_init()

void ED_editors_init

(

bContext *

C

)

Definition at line 94 of file ed_util.cc.

References BKE_collection_has_object_recursive(), BKE_id_is_editable(), BKE_object_has_mode_data(), BKE_object_sculpt_data_create(), BKE_scene_has_object(), BLI_assert_unreachable, CTX_data_active_object(), CTX_data_expect_evaluated_depsgraph(), CTX_data_main(), CTX_data_scene(), CTX_wm_manager(), CTX_wm_reports(), DEG_id_tag_update(), depsgraph, ED_area_tag_redraw(), ED_object_posemode_enter_ex(), ED_object_vpaintmode_enter_ex(), ED_object_wpaintmode_enter_ex(), ED_screen_areas_iter, ED_space_image_paint_update(), ReportList::flag, ID_RECALC_SYNC_TO_EVAL, LISTBASE_FOREACH, OB_HIDE_VIEWPORT, OB_MODE_ALL_SCULPT, OB_MODE_EDIT, OB_MODE_OBJECT, OB_MODE_POSE, OB_MODE_SCULPT, OB_MODE_VERTEX_PAINT, OB_MODE_WEIGHT_PAINT, blender::ed::sculpt_paint::object_sculpt_mode_enter(), Main::objects, wmWindowManager::op_undo_depth, Object::type, wmWindowManager::windows, and WM_window_get_active_screen().

Referenced by wm_file_read_post().

ED_editors_init_for_undo()

void ED_editors_init_for_undo

(

Main *

bmain

)

Definition at line 64 of file ed_util.cc.

References BKE_texpaint_slots_refresh_object(), BKE_view_layer_active_object_get(), BKE_view_layer_synced_ensure(), ED_paint_proj_mesh_data_check(), ListBase::first, View3D_Runtime::flag, LISTBASE_FOREACH, View3D::localvd, Object::mode, OB_MODE_TEXTURE_PAINT, View3D::runtime, Main::screens, SPACE_VIEW3D, V3D_RUNTIME_LOCAL_MAYBE_EMPTY, wmWindowManager::windows, Main::wm, WM_window_get_active_scene(), and WM_window_get_active_view_layer().

Referenced by image_undosys_step_decode(), and memfile_undosys_step_decode().

ED_operatortypes_edutils()

void ED_operatortypes_edutils

(

)

Definition at line 405 of file ed_util_ops.cc.

References ED_OT_flush_edits(), ED_OT_lib_id_fake_user_toggle(), ED_OT_lib_id_generate_preview(), ED_OT_lib_id_generate_preview_from_object(), ED_OT_lib_id_load_custom_preview(), ED_OT_lib_id_override_editable_toggle(), ED_OT_lib_id_unlink(), ED_OT_redo(), ED_OT_undo(), ED_OT_undo_history(), ED_OT_undo_push(), ED_OT_undo_redo(), and WM_operatortype_append().

Referenced by ED_spacetypes_init().

ED_region_draw_mouse_line_cb()

void ED_region_draw_mouse_line_cb	(	const bContext *	C,
		ARegion *	region,
		void *	arg_info )

Callback that draws a line between the mouse and a position given as the initial argument.

Definition at line 626 of file ed_draw.cc.

References CTX_wm_window(), wmWindow::eventstate, float, GPU_COMP_F32, GPU_FETCH_FLOAT, GPU_line_width(), GPU_PRIM_LINES, GPU_SHADER_3D_LINE_DASHED_UNIFORM_COLOR, GPU_vertformat_attr_add(), GPU_viewport_size_get_f(), immBegin(), immBindBuiltinProgram(), immEnd(), immUnbindProgram(), immUniform1f(), immUniform1i(), immUniform2f(), immUniformThemeColor3(), immVertex2fv(), immVertexFormat(), TH_VIEW_OVERLAY, UI_SCALE_FAC, and wmEvent::xy.

Referenced by edbm_bevel_init(), and edbm_inset_init().

ED_region_image_metadata_draw()

void ED_region_image_metadata_draw	(	int	x,
		int	y,
		ImBuf *	ibuf,
		const rctf *	frame,
		float	zoomx,
		float	zoomy )

Note

Keep in sync with BKE_image_stamp_buf.

Definition at line 876 of file ed_draw.cc.

References BLF_CLIPPING, BLF_clipping(), BLF_disable(), BLF_enable(), blf_mono_font, BLF_size(), BLI_rctf_init(), GPU_blend(), GPU_BLEND_ALPHA, GPU_BLEND_NONE, GPU_COMP_F32, GPU_FETCH_FLOAT, GPU_matrix_pop(), GPU_matrix_push(), GPU_matrix_scale_2f(), GPU_matrix_translate_2f(), GPU_SHADER_3D_UNIFORM_COLOR, GPU_vertformat_attr_add(), immBindBuiltinProgram(), immRectf(), immUnbindProgram(), immUniformThemeColorAlpha(), immVertexFormat(), ImBuf::metadata, metadata_box_height_get(), metadata_draw_imbuf(), uiFontStyle::points, pos, TH_METADATA_BG, TH_METADATA_TEXT, UI_FontThemeColor(), UI_SCALE_FAC, UI_style_get_dpi(), uiStyle::widget, rctf::xmax, rctf::xmin, rctf::ymax, and rctf::ymin.

Referenced by draw_movieclip_buffer(), image_main_region_draw(), and sequencer_draw_preview().

ED_slider_allow_increments_get()

bool ED_slider_allow_increments_get

(

const tSlider *

slider

)

Definition at line 586 of file ed_draw.cc.

References tSlider::allow_increments.

ED_slider_allow_increments_set()

void ED_slider_allow_increments_set	(	tSlider *	slider,
		bool	value )

Definition at line 591 of file ed_draw.cc.

References tSlider::allow_increments.

Referenced by poselib_blend_init_data().

ED_slider_allow_overshoot_set()

void ED_slider_allow_overshoot_set	(	tSlider *	slider,
		bool	lower,
		bool	upper )

One bool value for each side of the slider. Allows to enable overshoot only on one side.

Definition at line 580 of file ed_draw.cc.

References tSlider::allow_overshoot_lower, and tSlider::allow_overshoot_upper.

Referenced by blend_to_ease_invoke(), btw_smooth_invoke(), decimate_invoke(), ease_invoke(), ease_modal(), gaussian_smooth_invoke(), match_slope_invoke(), and poselib_blend_init_data().

ED_slider_create()

tSlider * ED_slider_create

(

bContext *

C

)

Definition at line 427 of file ed_draw.cc.

References tSlider::allow_increments, tSlider::allow_overshoot_lower, tSlider::allow_overshoot_upper, tSlider::area, CTX_data_scene(), CTX_wm_area(), CTX_wm_region(), tSlider::draw_handle, ED_area_status_text(), ED_region_draw_cb_activate(), tSlider::factor, tSlider::factor_bounds, LISTBASE_FOREACH, tSlider::raw_factor, REGION_DRAW_POST_PIXEL, tSlider::region_header, ScrArea::regionbase, RGN_TYPE_HEADER, tSlider::scene, slider_draw(), tSlider::slider_mode, SLIDER_MODE_PERCENT, and tSlider::unit_string.

Referenced by graph_slider_invoke(), pose_slide_init(), and poselib_blend_init_data().

ED_slider_destroy()

void ED_slider_destroy	(	bContext *	C,
		tSlider *	slider )

Definition at line 553 of file ed_draw.cc.

References tSlider::area, tSlider::draw_handle, ED_area_status_text(), ED_region_draw_cb_exit(), ED_workspace_status_text(), tSlider::region_header, and ARegion::type.

Referenced by graph_slider_exit(), pose_slide_exit(), and poselib_blend_cleanup().

ED_slider_factor_bounds_set()

void ED_slider_factor_bounds_set	(	tSlider *	slider,
		float	factor_bound_lower,
		float	factor_bound_upper )

Set the soft limits for the slider, which are applied until the user enables overshooting.

Definition at line 596 of file ed_draw.cc.

References tSlider::factor_bounds.

Referenced by blend_offset_invoke(), blend_to_ease_invoke(), blend_to_neighbor_invoke(), breakdown_invoke(), btw_smooth_invoke(), ease_invoke(), ease_modal(), match_slope_invoke(), pose_slide_blend_rest_invoke(), poselib_blend_init_data(), push_pull_invoke(), scale_average_invoke(), scale_from_neighbor_invoke(), shear_invoke(), and time_offset_invoke().

ED_slider_factor_get()

float ED_slider_factor_get

(

const tSlider *

slider

)

Definition at line 566 of file ed_draw.cc.

References tSlider::factor.

Referenced by blend_to_default_modal_update(), pose_slide_apply_quat(), pose_slide_apply_val(), pose_slide_modal(), pose_slide_rest_pose_apply_other_rot(), pose_slide_rest_pose_apply_vec3(), poselib_blend_handle_event(), and slider_factor_get_and_remember().

ED_slider_factor_set()

void ED_slider_factor_set	(	tSlider *	slider,
		float	factor )

Definition at line 571 of file ed_draw.cc.

References clamp_f(), tSlider::factor, tSlider::factor_bounds, tSlider::overshoot, and tSlider::raw_factor.

Referenced by blend_offset_invoke(), blend_to_default_invoke(), blend_to_ease_invoke(), blend_to_neighbor_invoke(), breakdown_invoke(), btw_smooth_invoke(), ease_invoke(), ease_modal(), gaussian_smooth_invoke(), graph_slider_modal(), match_slope_invoke(), pose_slide_blend_rest_invoke(), pose_slide_init(), pose_slide_modal(), poselib_blend_init_data(), push_pull_invoke(), scale_average_invoke(), scale_from_neighbor_invoke(), shear_invoke(), and time_offset_invoke().

ED_slider_init()

void ED_slider_init	(	tSlider *	slider,
		const wmEvent *	event )

For modal operations so the percentage doesn't pop on the first mouse movement.

Definition at line 467 of file ed_draw.cc.

References copy_v2fl_v2i(), tSlider::last_cursor, and wmEvent::xy.

Referenced by graph_slider_invoke(), pose_slide_invoke_common(), and poselib_blend_init_data().

ED_slider_modal()

bool ED_slider_modal	(	tSlider *	slider,
		const wmEvent *	event )

Calculate slider factor based on mouse position.

Definition at line 472 of file ed_draw.cc.

References tSlider::allow_increments, tSlider::allow_overshoot_lower, tSlider::allow_overshoot_upper, ED_region_tag_redraw(), EVT_EKEY, EVT_LEFTCTRLKEY, EVT_LEFTSHIFTKEY, EVT_RIGHTCTRLKEY, EVT_RIGHTSHIFTKEY, tSlider::increments, KM_PRESS, MOUSEMOVE, tSlider::overshoot, tSlider::precision, tSlider::region_header, slider_update_factor(), and wmEvent::type.

Referenced by graph_slider_modal(), pose_slide_modal(), and poselib_blend_handle_event().

ED_slider_mode_get()

SliderMode ED_slider_mode_get

(

const tSlider *

slider

)

Definition at line 609 of file ed_draw.cc.

References tSlider::slider_mode.

Referenced by graph_slider_modal().

ED_slider_mode_set()

void ED_slider_mode_set	(	tSlider *	slider,
		SliderMode	mode )

Definition at line 604 of file ed_draw.cc.

References tSlider::slider_mode.

Referenced by btw_smooth_invoke(), ease_modal(), and time_offset_invoke().

ED_slider_property_label_set()

void ED_slider_property_label_set	(	tSlider *	slider,
		const char *	property_label )

Definition at line 619 of file ed_draw.cc.

References tSlider::property_label.

Referenced by ease_invoke(), and ease_modal().

ED_slider_status_string_get()

void ED_slider_status_string_get	(	const tSlider *	slider,
		char *	status_string,
		size_t	size_of_status_string )

Return string based on the current state of the slider.

Definition at line 505 of file ed_draw.cc.

References tSlider::allow_increments, tSlider::allow_overshoot_lower, tSlider::allow_overshoot_upper, BLI_snprintf(), IFACE_, tSlider::increments, tSlider::overshoot, tSlider::precision, and STRNCPY.

Referenced by common_draw_status_header(), decimate_draw_status(), ease_draw_status_header(), pose_slide_draw_status(), poselib_blend_modal(), scale_from_neighbor_draw_status_header(), and shear_draw_status_header().

ED_slider_unit_set()

void ED_slider_unit_set	(	tSlider *	slider,
		const char *	unit )

Definition at line 614 of file ed_draw.cc.

References STRNCPY, and tSlider::unit_string.

Referenced by btw_smooth_invoke(), ease_modal(), and time_offset_invoke().

ED_spacedata_id_remap()

void ED_spacedata_id_remap	(	ScrArea *	area,
		SpaceLink *	sl,
		const blender::bke::id::IDRemapper &	mappings )

Definition at line 472 of file ed_util.cc.

References BKE_spacetype_from_id(), SpaceType::id_remap, and SpaceLink::spacetype.

Referenced by WM_main_remap_editor_id_reference().

ED_spacedata_id_remap_single()

void ED_spacedata_id_remap_single	(	ScrArea *	area,
		SpaceLink *	sl,
		ID *	old_id,
		ID *	new_id )

Use to free ID references within runtime data (stored outside of DNA)

Parameters

new_id

may be NULL to unlink old_id.

Definition at line 482 of file ed_util.cc.

References blender::bke::id::IDRemapper::add(), BKE_spacetype_from_id(), SpaceType::id_remap, and SpaceLink::spacetype.

Referenced by WM_init().

unpack_menu()

void unpack_menu	(	bContext *	C,
		const char *	opname,
		const char *	id_name,
		const char *	abs_name,
		const char *	folder,
		PackedFile *	pf )

Definition at line 363 of file ed_util.cc.

References BKE_main_blendfile_path(), BKE_packedfile_compare_to_file(), BLI_path_join, BLI_path_split_file_part(), CTX_data_main(), FILE_MAX, FILE_MAXDIR, id_name(), IFACE_, ot, pf, PF_CMP_DIFFERS, PF_CMP_EQUAL, PF_CMP_NOFILE, PF_REMOVE, PF_USE_LOCAL, PF_USE_ORIGINAL, PF_WRITE_LOCAL, PF_WRITE_ORIGINAL, RNA_enum_set(), RNA_string_set(), SNPRINTF, STREQ, UI_ITEM_NONE, UI_popup_menu_begin(), UI_popup_menu_end(), UI_popup_menu_layout(), uiItemFullO_ptr(), WM_OP_EXEC_DEFAULT, and WM_operatortype_find().

Referenced by image_unpack_invoke(), and sound_unpack_invoke().