ED_object.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2008 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

 
#pragma once
 
#include <string>
 
#include "BLI_compiler_attrs.h"
#include "BLI_function_ref.hh"
#include "BLI_map.hh"
#include "BLI_math_matrix_types.hh"
#include "BLI_string_ref.hh"
#include "BLI_vector.hh"
 
#include "DNA_object_enums.h"
#include "DNA_userdef_enums.h"
 
struct Base;
struct Depsgraph;
struct EnumPropertyItem;
struct ID;
struct KeyBlock;
struct GpencilModifierData;
struct ListBase;
struct Main;
struct ModifierData;
struct Object;
struct PointerRNA;
struct ReportList;
struct Scene;
struct ShaderFxData;
struct View3D;
struct ViewLayer;
struct bConstraint;
struct bContext;
struct bPoseChannel;
struct uiLayout;
struct wmKeyConfig;
struct wmOperator;
struct wmOperatorType;
enum eReportType : uint16_t;
 
namespace blender::ed::object {
 
struct XFormObjectData;
 
/* `object_edit.cc` */

Object *context_object(const bContext *C);
Object *context_active_object(const bContext *C);
void collection_hide_menu_draw(const bContext *C, uiLayout *layout);

blender::Vector<Object *> objects_in_mode_or_selected(
    bContext *C, bool (*filter_fn)(const Object *ob, void *user_data), void *filter_user_data);

bool material_active_index_set(Object *ob, int index);
 
/* `object_shapekey.cc` */

bool shape_key_report_if_locked(const Object *obedit, ReportList *reports);

bool shape_key_report_if_active_locked(Object *ob, ReportList *reports);

bool shape_key_report_if_any_locked(Object *ob, ReportList *reports);

bool shape_key_is_selected(const Object &object, const KeyBlock &kb, int keyblock_index);
 
void shape_key_mirror(Object *ob, KeyBlock *kb, bool use_topology, int &totmirr, int &totfail);
 
/* `object_utils.cc` */
 
bool calc_active_center_for_editmode(Object *obedit, bool select_only, float r_center[3]);
bool calc_active_center_for_posemode(Object *ob, bool select_only, float r_center[3]);
bool calc_active_center(Object *ob, bool select_only, float r_center[3]);
 
/* Object Data Container helper API. */
struct XFormObjectData_Container;
XFormObjectData_Container *data_xform_container_create();
void data_xform_container_destroy(XFormObjectData_Container *xds);
void data_xform_container_update_all(XFormObjectData_Container *xds,
                                     Main *bmain,
                                     Depsgraph *depsgraph);
void data_xform_container_item_ensure(XFormObjectData_Container *xds, Object *ob);

enum {
  XFORM_OB_SKIP_CHILD_PARENT_IS_XFORM = 1,
  XFORM_OB_SKIP_CHILD_PARENT_IS_XFORM_INDIRECT = 3,
  XFORM_OB_SKIP_CHILD_PARENT_APPLY = 2,
};
struct XFormObjectSkipChild_Container;
XFormObjectSkipChild_Container *xform_skip_child_container_create();
void xform_skip_child_container_item_ensure_from_array(XFormObjectSkipChild_Container *xcs,
                                                       const Scene *scene,
                                                       ViewLayer *view_layer,
                                                       Object **objects,
                                                       uint objects_len);
void object_xform_skip_child_container_destroy(XFormObjectSkipChild_Container *xcs);
void object_xform_skip_child_container_update_all(XFormObjectSkipChild_Container *xcs,
                                                  Main *bmain,
                                                  Depsgraph *depsgraph);
void object_xform_skip_child_container_item_ensure(XFormObjectSkipChild_Container *xcs,
                                                   Object *ob,
                                                   Object *ob_parent_recurse,
                                                   int mode);
 
void object_xform_array_m4(Object **objects, uint objects_len, const float matrix[4][4]);
 
/* `object_ops.cc` */
 
void operatortypes_object();
void operatormacros_object();
void keymap_object(wmKeyConfig *keyconf);
 
/* `object_relations.cc` */
 
enum eParentType {
  PAR_OBJECT,
  PAR_ARMATURE,
  PAR_ARMATURE_NAME,
  PAR_ARMATURE_ENVELOPE,
  PAR_ARMATURE_AUTO,
  PAR_BONE,
  PAR_BONE_RELATIVE,
  PAR_CURVE,
  PAR_FOLLOW,
  PAR_PATH_CONST,
  PAR_LATTICE,
  PAR_VERTEX,
  PAR_VERTEX_TRI,
};
 
enum eObjectSelect_Mode {
  BA_DESELECT = 0,
  BA_SELECT = 1,
  BA_INVERT = 2,
};
 
enum eObClearParentTypes {
  CLEAR_PARENT_ALL = 0,
  CLEAR_PARENT_KEEP_TRANSFORM,
  CLEAR_PARENT_INVERSE,
};
 
#ifdef __RNA_TYPES_H__
extern const EnumPropertyItem prop_clear_parent_types[];
extern const EnumPropertyItem prop_make_parent_types[];
#endif

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 parent_clear(Object *ob, int type);

void base_select(Base *base, eObjectSelect_Mode mode);
void base_activate(bContext *C, Base *base);
void base_activate_with_mode_exit_if_needed(bContext *C, Base *base);
void base_active_refresh(Main *bmain, Scene *scene, ViewLayer *view_layer);
void base_free_and_unlink(Main *bmain, Scene *scene, Object *ob);
void base_free_and_unlink_no_indirect_check(Main *bmain, Scene *scene, Object *ob);
bool base_deselect_all_ex(
    const Scene *scene, ViewLayer *view_layer, View3D *v3d, int action, bool *r_any_visible);
bool base_deselect_all(const Scene *scene, ViewLayer *view_layer, View3D *v3d, int action);

Base *add_duplicate(
    Main *bmain, Scene *scene, ViewLayer *view_layer, Base *base, eDupli_ID_Flags dupflag);
 
void parent_set(Object *ob, Object *parent, int type, const char *substr);
std::string drop_named_material_tooltip(bContext *C, const char *name, const int mval[2]);
std::string drop_geometry_nodes_tooltip(bContext *C, PointerRNA *properties, const int mval[2]);

enum {
  EM_FREEDATA = (1 << 0),
  EM_NO_CONTEXT = (1 << 1),
};
bool editmode_exit_ex(Main *bmain, Scene *scene, Object *obedit, int flag);
bool editmode_exit(bContext *C, int flag);

bool editmode_free_ex(Main *bmain, Object *obedit);
 
bool editmode_exit_multi_ex(Main *bmain, Scene *scene, ViewLayer *view_layer, int flag);
bool editmode_exit_multi(bContext *C, int flag);
 
bool editmode_enter_ex(Main *bmain, Scene *scene, Object *ob, int flag);
bool editmode_enter(bContext *C, int flag);
bool editmode_load(Main *bmain, Object *obedit);
 
void location_from_view(bContext *C, float loc[3]);
void rotation_from_quat(float rot[3], const float quat[4], char align_axis);
void rotation_from_view(bContext *C, float rot[3], char align_axis);
void init_transform_on_add(Object *object, const float loc[3], const float rot[3]);
float new_primitive_matrix(bContext *C,
                           Object *obedit,
                           const float loc[3],
                           const float rot[3],
                           const float scale[3],
                           float primmat[4][4]);

#define OBJECT_ADD_SIZE_MAXF 1.0e12f
 
void add_unit_props_size(wmOperatorType *ot);
void add_unit_props_radius_ex(wmOperatorType *ot, float default_value);
void add_unit_props_radius(wmOperatorType *ot);
void add_generic_props(wmOperatorType *ot, bool do_editmode);
void add_mesh_props(wmOperatorType *ot);
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);

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);
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 object_single_user_make(Main *bmain, Scene *scene, Object *ob);
 
void single_obdata_user_make(Main *bmain, Scene *scene, Object *ob);
 
/* object motion paths */

void motion_paths_clear(bContext *C, bool only_selected);
 
/* Corresponds to eAnimvizCalcRange. */
enum eObjectPathCalcRange {
  OBJECT_PATH_CALC_RANGE_CURRENT_FRAME,
  OBJECT_PATH_CALC_RANGE_CHANGED,
  OBJECT_PATH_CALC_RANGE_FULL,
};

void motion_paths_recalc(bContext *C,
                         Scene *scene,
                         eObjectPathCalcRange range,
                         ListBase *ld_objects);
 
void motion_paths_recalc_selected(bContext *C, Scene *scene, eObjectPathCalcRange range);
 
void motion_paths_recalc_visible(bContext *C, Scene *scene, eObjectPathCalcRange range);
 
/* constraints */
ListBase *constraint_active_list(Object *ob);
ListBase *pose_constraint_list(const bContext *C);
ListBase *constraint_list_from_constraint(Object *ob, bConstraint *con, bPoseChannel **r_pchan);
bConstraint *constraint_active_get(Object *ob);
 
void object_test_constraints(Main *bmain, Object *ob);
 
void constraint_active_set(Object *ob, bConstraint *con);
void constraint_update(Main *bmain, Object *ob);
void constraint_dependency_update(Main *bmain, Object *ob);
 
void constraint_tag_update(Main *bmain, Object *ob, bConstraint *con);
void constraint_dependency_tag_update(Main *bmain, Object *ob, bConstraint *con);
 
bool constraint_move_to_index(Object *ob, bConstraint *con, int index);
void constraint_link(Main *bmain, Object *ob_dst, ListBase *dst, ListBase *src);
void constraint_copy_for_object(Main *bmain, Object *ob_dst, bConstraint *con);
void constraint_copy_for_pose(Main *bmain, Object *ob_dst, bPoseChannel *pchan, bConstraint *con);
 
/* `object_modes.cc` */

bool mode_compat_test(const Object *ob, eObjectMode mode);
bool mode_compat_set(bContext *C, Object *ob, eObjectMode mode, ReportList *reports);
bool mode_set_ex(bContext *C, eObjectMode mode, bool use_undo, ReportList *reports);
bool mode_set(bContext *C, eObjectMode mode);
 
void mode_generic_exit(Main *bmain, Depsgraph *depsgraph, Scene *scene, Object *ob);
bool mode_generic_has_data(Depsgraph *depsgraph, const Object *ob);
 
void posemode_set_for_weight_paint(bContext *C, Main *bmain, Object *ob, bool is_mode_set);

int object_in_mode_to_index(const Scene *scene,
                            ViewLayer *view_layer,
                            eObjectMode mode,
                            const Object *ob);

Object *object_in_mode_from_index(const Scene *scene,
                                  ViewLayer *view_layer,
                                  eObjectMode mode,
                                  int index);

Map<std::string, float, 1> mode_transfer_overlay_current_state();
 
/* `object_modifier.cc` */
 
enum {
  MODIFIER_APPLY_DATA = 1,
  MODIFIER_APPLY_SHAPE,
};

ModifierData *modifier_add(
    ReportList *reports, Main *bmain, Scene *scene, Object *ob, const char *name, int type);
bool modifier_remove(ReportList *reports, Main *bmain, Scene *scene, Object *ob, ModifierData *md);
void modifiers_clear(Main *bmain, Scene *scene, Object *ob);
bool modifier_move_down(ReportList *reports, eReportType error_type, Object *ob, ModifierData *md);
bool modifier_move_up(ReportList *reports, eReportType error_type, Object *ob, ModifierData *md);
bool modifier_move_to_index(ReportList *reports,
                            eReportType error_type,
                            Object *ob,
                            ModifierData *md,
                            int index,
                            bool allow_partial);
 
bool convert_psys_to_mesh(ReportList *reports,
                          Main *bmain,
                          Depsgraph *depsgraph,
                          Scene *scene,
                          ViewLayer *view_layer,
                          Object *ob,
                          ModifierData *md);
bool modifier_apply(Main *bmain,
                    ReportList *reports,
                    Depsgraph *depsgraph,
                    Scene *scene,
                    Object *ob,
                    ModifierData *md,
                    int mode,
                    bool keep_modifier,
                    bool do_all_keyframes);
bool modifier_copy(ReportList *reports, Main *bmain, Scene *scene, Object *ob, ModifierData *md);
void modifier_link(bContext *C, Object *ob_dst, Object *ob_src);
bool modifier_copy_to_object(Main *bmain,
                             const Scene *scene,
                             const Object *ob_src,
                             const ModifierData *md,
                             Object *ob_dst,
                             ReportList *reports);
bool iter_other(Main *bmain,
                Object *orig_ob,
                bool include_orig,
                bool (*callback)(Object *ob, void *callback_data),
                void *callback_data);

bool multires_update_totlevels(Object *ob, void *totlevel_v);
 
/* `object_shader_fx.cc` */
 
ShaderFxData *shaderfx_add(
    ReportList *reports, Main *bmain, Scene *scene, Object *ob, const char *name, int type);
bool shaderfx_remove(ReportList *reports, Main *bmain, Object *ob, ShaderFxData *fx);
void shaderfx_clear(Main *bmain, Object *ob);
int shaderfx_move_down(ReportList *reports, Object *ob, ShaderFxData *fx);
int shaderfx_move_up(ReportList *reports, Object *ob, ShaderFxData *fx);
bool shaderfx_move_to_index(ReportList *reports, Object *ob, ShaderFxData *fx, int index);
void shaderfx_link(Object *dst, Object *src);
void shaderfx_copy(Object *dst, ShaderFxData *fx);
 
/* `object_select.cc` */
 
void select_linked_by_id(bContext *C, ID *id);
 
void check_force_modifiers(Main *bmain, Scene *scene, Object *object);

Base *find_first_by_data_id(const Scene *scene, ViewLayer *view_layer, ID *id);

bool jump_to_object(bContext *C, Object *ob, bool reveal_hidden);
bool jump_to_bone(bContext *C, Object *ob, const char *bone_name, bool reveal_hidden);
 
/* `object_data_transform.cc` */
 
struct XFormObjectData {
  ID *id;
  XFormObjectData() = default;
  virtual ~XFormObjectData() = default;
};
 
std::unique_ptr<XFormObjectData> data_xform_create(ID *id);
std::unique_ptr<XFormObjectData> data_xform_create_from_edit_mode(ID *id);
 
void data_xform_by_mat4(XFormObjectData &xod, const float4x4 &transform);
 
void data_xform_restore(XFormObjectData &xod);
void data_xform_tag_update(XFormObjectData &xod);
 
void ui_template_modifier_asset_menu_items(uiLayout &layout,
                                           StringRef catalog_path,
                                           bool skip_essentials);
 
}  // namespace blender::ed::object