Blender V5.3
ED_object.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2008 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#pragma once
10
11#include <string>
12
13#include "BLI_compiler_attrs.hh"
14#include "BLI_function_ref.hh"
15#include "BLI_map.hh"
17#include "BLI_string_ref.hh"
18#include "BLI_vector.hh"
19
20#include "DNA_listBase.h"
21#include "DNA_object_enums.h"
22#include "DNA_userdef_enums.h"
23
24namespace blender {
25
26struct Base;
27struct Depsgraph;
28struct EnumPropertyItem;
29struct ID;
30struct KeyBlock;
32struct Main;
33struct ModifierData;
34struct Object;
35struct PointerRNA;
36struct ReportList;
37struct Scene;
38struct ShaderFxData;
39struct View3D;
40struct ViewLayer;
41struct bConstraint;
42struct bContext;
43struct bPoseChannel;
44struct wmKeyConfig;
45struct wmOperator;
46struct wmOperatorType;
48
49namespace ui {
50struct Layout;
51} // namespace ui
52
53enum eObject_Partype : short;
54
55namespace ed::object {
56
57struct XFormObjectData;
58
59/* `object_edit.cc` */
60
69
79 bool (*filter_fn)(const Object *ob, void *user_data),
80 void *filter_user_data);
81
89
90/* `object_shapekey.cc` */
91
97bool shape_key_report_if_locked(const Object *obedit, ReportList *reports);
98
105
112
119bool shape_key_is_selected(const Object &object, const KeyBlock &kb, int keyblock_index);
120
121void shape_key_mirror(Object *ob, KeyBlock *kb, bool use_topology, int &totmirr, int &totfail);
122
123/* `object_utils.cc` */
124
125bool calc_active_center_for_editmode(Object *obedit, bool select_only, float r_center[3]);
126bool calc_active_center_for_posemode(Object *ob, bool select_only, float r_center[3]);
127bool calc_active_center(Object *ob, bool select_only, float r_center[3]);
128
129/* Object Data Container helper API. */
138 Main *bmain,
139 Depsgraph *depsgraph);
141
143enum {
160};
161struct XFormObjectSkipChild_Container;
162XFormObjectSkipChild_Container *xform_skip_child_container_create();
163void xform_skip_child_container_item_ensure_from_array(XFormObjectSkipChild_Container *xcs,
164 const Main &bmain,
165 const Scene *scene,
166 ViewLayer *view_layer,
167 Object **objects,
168 uint objects_len);
169void object_xform_skip_child_container_destroy(XFormObjectSkipChild_Container *xcs);
170void object_xform_skip_child_container_update_all(XFormObjectSkipChild_Container *xcs,
171 Main *bmain,
172 Depsgraph *depsgraph);
173void object_xform_skip_child_container_item_ensure(XFormObjectSkipChild_Container *xcs,
174 Object *ob,
175 Object *ob_parent_recurse,
176 int mode);
177
178void object_xform_array_m4(Object **objects, uint objects_len, const float matrix[4][4]);
179
180/* `object_ops.cc` */
181
184void keymap_object(wmKeyConfig *keyconf);
185
186/* `object_relations.cc` */
187
203
209
215
216#ifdef __RNA_TYPES_H__
221#endif
222
226bool parent_set(ReportList *reports,
227 const bContext *C,
228 Scene *scene,
229 Object *const ob,
230 Object *const par,
231 int partype,
232 bool xmirror,
233 bool keep_transform,
234 const int vert_par[3]);
235void parent_clear(Main *bmain, Object *ob, int type);
236
245void base_select(Base *base, eObjectSelect_Mode mode);
249void base_activate(bContext *C, Base *base);
254void base_active_refresh(Main *bmain, Scene *scene, ViewLayer *view_layer);
259void base_free_and_unlink(Main *bmain, Scene *scene, Object *ob);
265bool base_deselect_all_ex(const Main &bmain,
266 const Scene *scene,
267 ViewLayer *view_layer,
268 View3D *v3d,
269 int action,
270 bool *r_any_visible);
272 const Main &bmain, const Scene *scene, ViewLayer *view_layer, View3D *v3d, int action);
273
282 Main *bmain, Scene *scene, ViewLayer *view_layer, Base *base, eDupli_ID_Flags dupflag);
283
284void parent_set(Object *ob, Object *parent, eObject_Partype type, const char *substr);
285std::string drop_named_material_tooltip(bContext *C, StringRef name, const int mval[2]);
286std::string drop_geometry_nodes_tooltip(bContext *C, PointerRNA *properties, const int mval[2]);
287
289enum {
290 EM_FREEDATA = (1 << 0),
291 EM_NO_CONTEXT = (1 << 1),
292};
297bool editmode_exit_ex(Main *bmain, Scene *scene, Object *obedit, int flag);
298bool editmode_exit(bContext *C, int flag);
299
305bool editmode_free_ex(Main *bmain, Object *obedit);
306
307bool editmode_exit_multi_ex(Main *bmain, Scene *scene, ViewLayer *view_layer, int flag);
308bool editmode_exit_multi(bContext *C, int flag);
309
310bool editmode_enter_ex(Main *bmain, Scene *scene, Object *ob, int flag);
311bool editmode_enter(bContext *C, int flag);
312bool editmode_load(Main *bmain, Object *obedit);
313
314void location_from_view(bContext *C, float loc[3]);
315void rotation_from_quat(float rot[3], const float quat[4], char align_axis);
316void rotation_from_view(bContext *C, float rot[3], char align_axis);
317void init_transform_on_add(Object *object, const float loc[3], const float rot[3]);
323 Object *obedit,
324 const float loc[3],
325 const float rot[3],
326 const float scale[3],
327 float primmat[4][4]);
328
332#define OBJECT_ADD_SIZE_MAXF 1.0e12f
333
334void add_unit_props_size(wmOperatorType *ot, float default_value = 2.0f);
335void add_unit_props_radius_ex(wmOperatorType *ot, float default_value);
336void add_unit_props_radius(wmOperatorType *ot);
337void add_generic_props(wmOperatorType *ot, bool do_editmode);
338void add_mesh_props(wmOperatorType *ot);
339void add_generic_get_opts(bContext *C,
340 wmOperator *op,
341 char view_align_axis,
342 float r_loc[3],
343 float r_rot[3],
344 float r_scale[3],
345 bool *r_enter_editmode,
346 unsigned short *r_local_view_bits,
347 bool *r_is_view_aligned);
348
355Object *add_type_with_obdata(bContext *C,
356 int type,
357 const char *name,
358 const float loc[3],
359 const float rot[3],
360 bool enter_editmode,
361 ushort local_view_bits,
362 ID *obdata);
363Object *add_type(bContext *C,
364 int type,
365 const char *name,
366 const float loc[3],
367 const float rot[3],
368 bool enter_editmode,
369 unsigned short local_view_bits) ATTR_NONNULL(1) ATTR_RETURNS_NONNULL;
370
374void object_single_user_make(Main *bmain, Scene *scene, Object *ob);
375
376void single_obdata_user_make(Main *bmain, Scene *scene, Object *ob);
377
378/* object motion paths */
379
383void motion_paths_clear(bContext *C, bool only_selected);
384
389void motion_paths_recalc(bContext *C, Scene *scene, const Span<Object *> objects);
390
391/* constraints */
396ListBaseT<bConstraint> *constraint_active_list(Object *ob);
401ListBaseT<bConstraint> *pose_constraint_list(const bContext *C);
406ListBaseT<bConstraint> *constraint_list_from_constraint(Object *ob,
407 bConstraint *con,
408 bPoseChannel **r_pchan);
412bConstraint *constraint_active_get(Object *ob);
413
414void object_test_constraints(Main *bmain, Object *ob);
415
416void constraint_active_set(Object *ob, bConstraint *con);
417void constraint_update(Main *bmain, Object *ob);
418void constraint_dependency_update(Main *bmain, Object *ob);
419
420void constraint_tag_update(Main *bmain, Object *ob, bConstraint *con);
421void constraint_dependency_tag_update(Main *bmain, Object *ob, bConstraint *con);
422
423bool constraint_move_to_index(Object *ob, bConstraint *con, int index);
424void constraint_link(Main *bmain,
425 Object *ob_dst,
426 ListBaseT<bConstraint> *dst,
427 ListBaseT<bConstraint> *src);
428void constraint_copy_for_object(Main *bmain, Object *ob_dst, bConstraint *con);
429void constraint_copy_for_pose(Main *bmain, Object *ob_dst, bPoseChannel *pchan, bConstraint *con);
430
431/* `object_modes.cc` */
432
437bool mode_compat_test(const Object *ob, eObjectMode mode);
447bool mode_compat_set(bContext *C, Object *ob, eObjectMode mode, ReportList *reports);
448bool mode_set_ex(bContext *C, eObjectMode mode, bool use_undo, ReportList *reports);
449bool mode_set(bContext *C, eObjectMode mode);
450
451void mode_generic_exit(Main *bmain, Depsgraph *depsgraph, Scene *scene, Object *ob);
452bool mode_generic_has_data(Depsgraph *depsgraph, const Object *ob);
453
454void posemode_set_for_weight_paint(bContext *C, Main *bmain, Object *ob, bool is_mode_set);
455
468int object_in_mode_to_index(const Main &bmain,
469 const Scene *scene,
470 ViewLayer *view_layer,
471 eObjectMode mode,
472 const Object *ob);
473
478 const Main &bmain, const Scene *scene, ViewLayer *view_layer, eObjectMode mode, int index);
479
485Map<std::string, float, 1> mode_transfer_overlay_current_state();
486
487/* `object_modifier.cc` */
488
489enum {
492};
493
501 ReportList *reports, Main *bmain, Scene *scene, Object *ob, const char *name, int type);
502bool modifier_remove(ReportList *reports, Main *bmain, Scene *scene, Object *ob, ModifierData *md);
503void modifiers_clear(Main *bmain, Scene *scene, Object *ob);
504bool modifier_move_down(ReportList *reports, eReportType error_type, Object *ob, ModifierData *md);
505bool modifier_move_up(ReportList *reports, eReportType error_type, Object *ob, ModifierData *md);
507 eReportType error_type,
508 Object *ob,
509 ModifierData *md,
510 int index,
511 bool allow_partial);
512
513bool convert_psys_to_mesh(ReportList *reports,
514 Main *bmain,
515 Depsgraph *depsgraph,
516 Scene *scene,
517 ViewLayer *view_layer,
518 Object *ob,
519 ModifierData *md);
520bool modifier_apply(Main *bmain,
521 ReportList *reports,
522 Depsgraph *depsgraph,
523 Scene *scene,
524 Object *ob,
525 ModifierData *md,
526 int mode,
527 bool keep_modifier,
528 bool do_all_keyframes);
529bool modifier_copy(ReportList *reports, Main *bmain, Scene *scene, Object *ob, ModifierData *md);
530void modifier_link(bContext *C, Object *ob_dst, Object *ob_src);
532 const Scene *scene,
533 const Object *ob_src,
534 const ModifierData *md,
535 Object *ob_dst,
536 ReportList *reports);
546bool iter_other(Main *bmain,
547 Object *orig_ob,
548 bool include_orig,
549 bool (*callback)(Object *ob, void *callback_data),
550 void *callback_data);
551
556bool multires_update_totlevels(Object *ob, void *totlevel_v);
557
558/* `object_shader_fx.cc` */
559
561 ReportList *reports, Main *bmain, Scene *scene, Object *ob, const char *name, int type);
562bool shaderfx_remove(ReportList *reports, Main *bmain, Object *ob, ShaderFxData *fx);
563void shaderfx_clear(Main *bmain, Object *ob);
564int shaderfx_move_down(ReportList *reports, Object *ob, ShaderFxData *fx);
565int shaderfx_move_up(ReportList *reports, Object *ob, ShaderFxData *fx);
566bool shaderfx_move_to_index(ReportList *reports, Object *ob, ShaderFxData *fx, int index);
567void shaderfx_link(Object *dst, Object *src);
568void shaderfx_copy(Object *dst, ShaderFxData *fx);
569
570/* `object_select.cc` */
571
572void select_linked_by_id(bContext *C, ID *id);
573
574void check_force_modifiers(Main *bmain, Scene *scene, Object *object);
575
580Base *find_first_by_data_id(const Main &bmain, const Scene *scene, ViewLayer *view_layer, ID *id);
581
588bool jump_to_object(bContext *C, Object *ob, bool reveal_hidden);
596bool jump_to_bone(bContext *C, Object *ob, const char *bone_name, bool reveal_hidden);
597
598/* `object_data_transform.cc` */
599
602 XFormObjectData() = default;
603 virtual ~XFormObjectData() = default;
604};
605
606std::unique_ptr<XFormObjectData> data_xform_create(ID *id);
607std::unique_ptr<XFormObjectData> data_xform_create_from_edit_mode(ID *id);
608
610
613
615 ui::Layout &layout,
616 StringRef catalog_path,
617 bool skip_essentials);
618
619} // namespace ed::object
620} // namespace blender
#define ATTR_RETURNS_NONNULL
#define ATTR_NONNULL(...)
These structs are the foundation for all linked lists in the library system.
#define C
Definition RandGen.cpp:29
Definition scene.h:133
#define rot(x, k)
#define index(i)
float3x3 scale(float3x3 mat, float2 scale)
bool calc_active_center(Object *ob, bool select_only, float r_center[3])
void object_test_constraints(Main *bmain, Object *ob)
ModifierData * modifier_add(ReportList *reports, Main *bmain, Scene *scene, Object *ob, const char *name, int type)
void single_obdata_user_make(Main *bmain, Scene *scene, Object *ob)
bool mode_generic_has_data(Depsgraph *depsgraph, const Object *ob)
bConstraint * constraint_active_get(Object *ob)
bool jump_to_object(bContext *C, Object *ob, bool reveal_hidden)
bool modifier_apply(Main *bmain, ReportList *reports, Depsgraph *depsgraph, Scene *scene, Object *ob, ModifierData *md, int mode, bool keep_modifier, bool do_all_keyframes)
void add_unit_props_radius(wmOperatorType *ot)
void motion_paths_recalc(bContext *C, Scene *scene, const Span< Object * > objects)
void constraint_copy_for_object(Main *bmain, Object *ob_dst, bConstraint *con)
bool editmode_exit_multi(bContext *C, int flag)
Object * add_type(bContext *C, int type, const char *name, const float loc[3], const float rot[3], bool enter_editmode, unsigned short local_view_bits) ATTR_NONNULL(1) ATTR_RETURNS_NONNULL
void keymap_object(wmKeyConfig *keyconf)
bool editmode_enter(bContext *C, int flag)
void constraint_link(Main *bmain, Object *ob_dst, ListBaseT< bConstraint > *dst, ListBaseT< bConstraint > *src)
void constraint_active_set(Object *ob, bConstraint *con)
const EnumPropertyItem prop_clear_parent_types[]
Object * add_type_with_obdata(bContext *C, int type, const char *name, const float loc[3], const float rot[3], bool enter_editmode, ushort local_view_bits, ID *obdata)
void shaderfx_clear(Main *bmain, Object *ob)
void constraint_copy_for_pose(Main *bmain, Object *ob_dst, bPoseChannel *pchan, bConstraint *con)
@ XFORM_OB_SKIP_CHILD_PARENT_IS_XFORM
Definition ED_object.hh:147
@ XFORM_OB_SKIP_CHILD_PARENT_IS_XFORM_INDIRECT
Definition ED_object.hh:152
void object_xform_array_m4(Object **objects, uint objects_len, const float matrix[4][4])
void constraint_dependency_tag_update(Main *bmain, Object *ob, bConstraint *con)
void data_xform_container_destroy(XFormObjectData_Container *xds)
int shaderfx_move_up(ReportList *reports, Object *ob, ShaderFxData *fx)
void add_unit_props_size(wmOperatorType *ot, float default_value=2.0f)
bool shape_key_report_if_locked(const Object *obedit, ReportList *reports)
float new_primitive_matrix(bContext *C, Object *obedit, const float loc[3], const float rot[3], const float scale[3], float primmat[4][4])
bool iter_other(Main *bmain, Object *orig_ob, bool include_orig, bool(*callback)(Object *ob, void *callback_data), void *callback_data)
Map< std::string, float, 1 > mode_transfer_overlay_current_state()
void motion_paths_clear(bContext *C, bool only_selected)
void rotation_from_view(bContext *C, float rot[3], char align_axis)
void constraint_update(Main *bmain, Object *ob)
void base_activate(bContext *C, Base *base)
bool shape_key_report_if_any_locked(Object *ob, ReportList *reports)
ListBaseT< bConstraint > * constraint_list_from_constraint(Object *ob, bConstraint *con, bPoseChannel **r_pchan)
bool editmode_free_ex(Main *bmain, Object *obedit)
bool modifier_move_up(ReportList *reports, eReportType error_type, Object *ob, ModifierData *md)
bool mode_set_ex(bContext *C, eObjectMode mode, bool use_undo, ReportList *reports)
std::string drop_geometry_nodes_tooltip(bContext *C, PointerRNA *properties, const int mval[2])
bool multires_update_totlevels(Object *ob, void *totlevel_v)
ShaderFxData * shaderfx_add(ReportList *reports, Main *bmain, Scene *scene, Object *ob, const char *name, int type)
const EnumPropertyItem prop_make_parent_types[]
void base_select(Base *base, eObjectSelect_Mode mode)
XFormObjectSkipChild_Container * xform_skip_child_container_create()
void base_free_and_unlink_no_indirect_check(Main *bmain, Scene *scene, Object *ob)
void add_unit_props_radius_ex(wmOperatorType *ot, float default_value)
void rotation_from_quat(float rot[3], const float quat[4], char align_axis)
Object * context_object(const bContext *C)
void operatortypes_object()
Definition object_ops.cc:29
void mode_generic_exit(Main *bmain, Depsgraph *depsgraph, Scene *scene, Object *ob)
void constraint_tag_update(Main *bmain, Object *ob, bConstraint *con)
int shaderfx_move_down(ReportList *reports, Object *ob, ShaderFxData *fx)
ModifierData * modifier_copy_to_object(Main *bmain, const Scene *scene, const Object *ob_src, const ModifierData *md, Object *ob_dst, ReportList *reports)
ListBaseT< bConstraint > * constraint_active_list(Object *ob)
bool parent_set(ReportList *reports, const bContext *C, Scene *scene, Object *const ob, Object *const par, int partype, bool xmirror, bool keep_transform, const int vert_par[3])
void data_xform_container_update_all(XFormObjectData_Container *xds, Main *bmain, Depsgraph *depsgraph)
bool mode_compat_test(const Object *ob, eObjectMode mode)
bool editmode_enter_ex(Main *bmain, Scene *scene, Object *ob, int flag)
void shaderfx_copy(Object *dst, ShaderFxData *fx)
void ui_template_modifier_asset_menu_items(const bContext &C, ui::Layout &layout, StringRef catalog_path, bool skip_essentials)
void data_xform_by_mat4(XFormObjectData &xod, const float4x4 &transform)
void object_xform_skip_child_container_destroy(XFormObjectSkipChild_Container *xcs)
bool modifier_copy(ReportList *reports, Main *bmain, Scene *scene, Object *ob, ModifierData *md)
bool base_deselect_all_ex(const Main &bmain, const Scene *scene, ViewLayer *view_layer, View3D *v3d, int action, bool *r_any_visible)
Object * context_active_object(const bContext *C)
bool modifier_move_down(ReportList *reports, eReportType error_type, Object *ob, ModifierData *md)
std::unique_ptr< XFormObjectData > data_xform_create(ID *id)
bool editmode_exit(bContext *C, int flag)
int object_in_mode_to_index(const Main &bmain, const Scene *scene, ViewLayer *view_layer, eObjectMode mode, const Object *ob)
void shape_key_mirror(Object *ob, KeyBlock *kb, bool use_topology, int &totmirr, int &totfail)
void data_xform_restore(XFormObjectData &xod)
std::unique_ptr< XFormObjectData > data_xform_create_from_edit_mode(ID *id)
void object_xform_skip_child_container_item_ensure(XFormObjectSkipChild_Container *xcs, Object *ob, Object *ob_parent_recurse, int mode)
Base * find_first_by_data_id(const Main &bmain, const Scene *scene, ViewLayer *view_layer, ID *id)
bool shape_key_report_if_active_locked(Object *ob, ReportList *reports)
void data_xform_tag_update(XFormObjectData &xod)
void base_activate_with_mode_exit_if_needed(bContext *C, Base *base)
void posemode_set_for_weight_paint(bContext *C, Main *bmain, Object *ob, bool is_mode_set)
Base * add_duplicate(Main *bmain, Scene *scene, ViewLayer *view_layer, Base *base, eDupli_ID_Flags dupflag)
void constraint_dependency_update(Main *bmain, Object *ob)
bool constraint_move_to_index(Object *ob, bConstraint *con, int index)
void parent_clear(Main *bmain, Object *ob, int type)
bool mode_compat_set(bContext *C, Object *ob, eObjectMode mode, ReportList *reports)
bool editmode_exit_multi_ex(Main *bmain, Scene *scene, ViewLayer *view_layer, int flag)
std::string drop_named_material_tooltip(bContext *C, StringRef name, const int mval[2])
bool jump_to_bone(bContext *C, Object *ob, const char *bone_name, bool reveal_hidden)
void base_active_refresh(Main *bmain, Scene *scene, ViewLayer *view_layer)
void select_linked_by_id(bContext *C, ID *id)
bool calc_active_center_for_editmode(Object *obedit, bool select_only, float r_center[3])
ListBaseT< bConstraint > * pose_constraint_list(const bContext *C)
void collection_hide_menu_draw(const bContext *C, ui::Layout &layout)
void check_force_modifiers(Main *bmain, Scene *scene, Object *object)
bool material_active_index_set(Object *ob, int index)
Object * object_in_mode_from_index(const Main &bmain, const Scene *scene, ViewLayer *view_layer, eObjectMode mode, int index)
bool convert_psys_to_mesh(ReportList *reports, Main *bmain, Depsgraph *depsgraph, Scene *scene, ViewLayer *view_layer, Object *ob, ModifierData *md)
bool modifier_move_to_index(ReportList *reports, eReportType error_type, Object *ob, ModifierData *md, int index, bool allow_partial)
void base_free_and_unlink(Main *bmain, Scene *scene, Object *ob)
bool shaderfx_remove(ReportList *reports, Main *bmain, Object *ob, ShaderFxData *fx)
bool calc_active_center_for_posemode(Object *ob, bool select_only, float r_center[3])
void init_transform_on_add(Object *object, const float loc[3], const float rot[3])
bool shaderfx_move_to_index(ReportList *reports, Object *ob, ShaderFxData *fx, int index)
void add_generic_props(wmOperatorType *ot, bool do_editmode)
void location_from_view(bContext *C, float loc[3])
void add_mesh_props(wmOperatorType *ot)
void data_xform_container_item_ensure(XFormObjectData_Container *xds, Object *ob)
void object_xform_skip_child_container_update_all(XFormObjectSkipChild_Container *xcs, Main *bmain, Depsgraph *depsgraph)
bool mode_set(bContext *C, eObjectMode mode)
bool editmode_load(Main *bmain, Object *obedit)
bool shape_key_is_selected(const Object &object, const KeyBlock &kb, int keyblock_index)
bool base_deselect_all(const Main &bmain, const Scene *scene, ViewLayer *view_layer, View3D *v3d, int action)
Vector< Object * > objects_in_mode_or_selected(bContext *C, bool(*filter_fn)(const Object *ob, void *user_data), void *filter_user_data)
void xform_skip_child_container_item_ensure_from_array(XFormObjectSkipChild_Container *xcs, const Main &bmain, const Scene *scene, ViewLayer *view_layer, Object **objects, uint objects_len)
void add_generic_get_opts(bContext *C, wmOperator *op, char view_align_axis, float r_loc[3], float r_rot[3], float r_scale[3], bool *r_enter_editmode, unsigned short *r_local_view_bits, bool *r_is_view_aligned)
bool editmode_exit_ex(Main *bmain, Scene *scene, Object *obedit, int flag)
void modifier_link(bContext *C, Object *ob_dst, Object *ob_src)
XFormObjectData_Container * data_xform_container_create()
void object_single_user_make(Main *bmain, Scene *scene, Object *ob)
void modifiers_clear(Main *bmain, Scene *scene, Object *ob)
void shaderfx_link(Object *dst, Object *src)
bool modifier_remove(ReportList *reports, Main *bmain, Scene *scene, Object *ob, ModifierData *md)
BMesh Iterators.
unsigned int uint
Definition BKE_text.h:55
unsigned short ushort
Definition BKE_text.h:56
MatBase< float, 4, 4 > float4x4
unsigned short uint16_t
Definition BKE_text.h:80