tornavis/source/blender/editors/physics/rigidbody_object.cc

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

/** \file
 * \ingroup editor_physics
 * \brief Rigid Body object editing operators
 */

#include <cstdlib>
#include <cstring>

#include "DNA_object_types.h"
#include "DNA_rigidbody_types.h"
#include "DNA_scene_types.h"

#include "BLT_translation.hh"

#include "BKE_context.hh"
#include "BKE_report.hh"
#include "BKE_rigidbody.h"

#include "DEG_depsgraph.hh"
#include "DEG_depsgraph_build.hh"
#include "DEG_depsgraph_query.hh"

#include "RNA_access.hh"
#include "RNA_define.hh"
#include "RNA_enum_types.hh"
#include "RNA_prototypes.h"

#include "WM_api.hh"
#include "WM_types.hh"

#include "ED_object.hh"
#include "ED_physics.hh"
#include "ED_screen.hh"

#include "physics_intern.hh"

/* ********************************************** */
/* Helper API's for RigidBody Objects Editing */

static bool operator_rigidbody_editable_poll(Scene *scene)
{
  if (scene == nullptr || ID_IS_LINKED(scene) || ID_IS_OVERRIDE_LIBRARY(scene) ||
      (scene->rigidbody_world != nullptr && scene->rigidbody_world->group != nullptr &&
       (ID_IS_LINKED(scene->rigidbody_world->group) ||
        ID_IS_OVERRIDE_LIBRARY(scene->rigidbody_world->group))))
  {
    return false;
  }
  return true;
}

static bool ED_operator_rigidbody_active_poll(bContext *C)
{
  Scene *scene = CTX_data_scene(C);
  if (!operator_rigidbody_editable_poll(scene)) {
    return false;
  }

  if (ED_operator_object_active_editable(C)) {
    Object *ob = blender::ed::object::context_active_object(C);
    return (ob && ob->rigidbody_object);
  }

  return false;
}

static bool ED_operator_rigidbody_add_poll(bContext *C)
{
  Scene *scene = CTX_data_scene(C);
  if (!operator_rigidbody_editable_poll(scene)) {
    return false;
  }

  if (ED_operator_object_active_editable(C)) {
    Object *ob = blender::ed::object::context_active_object(C);
    return (ob && ob->type == OB_MESH);
  }

  return false;
}

/* ----------------- */

bool ED_rigidbody_object_add(Main *bmain, Scene *scene, Object *ob, int type, ReportList *reports)
{
  return BKE_rigidbody_add_object(bmain, scene, ob, type, reports);
}

void ED_rigidbody_object_remove(Main *bmain, Scene *scene, Object *ob)
{
  BKE_rigidbody_remove_object(bmain, scene, ob, false);

  DEG_relations_tag_update(bmain);
  DEG_id_tag_update(&ob->id, ID_RECALC_TRANSFORM);
}

/* ********************************************** */
/* Active Object Add/Remove Operators */

/* ************ Add Rigid Body ************** */

static int rigidbody_object_add_exec(bContext *C, wmOperator *op)
{
  Main *bmain = CTX_data_main(C);
  Scene *scene = CTX_data_scene(C);
  Object *ob = blender::ed::object::context_active_object(C);
  int type = RNA_enum_get(op->ptr, "type");
  bool changed;

  /* apply to active object */
  changed = ED_rigidbody_object_add(bmain, scene, ob, type, op->reports);

  if (changed) {
    /* send updates */
    WM_event_add_notifier(C, NC_OBJECT | ND_TRANSFORM, nullptr);
    WM_event_add_notifier(C, NC_OBJECT | ND_POINTCACHE, nullptr);

    /* done */
    return OPERATOR_FINISHED;
  }
  return OPERATOR_CANCELLED;
}

void RIGIDBODY_OT_object_add(wmOperatorType *ot)
{
  /* identifiers */
  ot->idname = "RIGIDBODY_OT_object_add";
  ot->name = "Add Rigid Body";
  ot->description = "Add active object as Rigid Body";

  /* callbacks */
  ot->exec = rigidbody_object_add_exec;
  ot->poll = ED_operator_rigidbody_add_poll;

  /* flags */
  ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;

  /* properties */
  ot->prop = RNA_def_enum(ot->srna,
                          "type",
                          rna_enum_rigidbody_object_type_items,
                          RBO_TYPE_ACTIVE,
                          "Rigid Body Type",
                          "");
}

/* ************ Remove Rigid Body ************** */

static int rigidbody_object_remove_exec(bContext *C, wmOperator *op)
{
  Main *bmain = CTX_data_main(C);
  Scene *scene = CTX_data_scene(C);
  Object *ob = blender::ed::object::context_active_object(C);
  bool changed = false;

  /* apply to active object */
  if (!ELEM(nullptr, ob, ob->rigidbody_object)) {
    ED_rigidbody_object_remove(bmain, scene, ob);
    changed = true;
  }

  if (changed) {
    /* send updates */
    WM_event_add_notifier(C, NC_OBJECT | ND_TRANSFORM, nullptr);
    WM_event_add_notifier(C, NC_OBJECT | ND_POINTCACHE, nullptr);

    /* done */
    return OPERATOR_FINISHED;
  }

  BKE_report(op->reports, RPT_ERROR, "Object has no Rigid Body settings to remove");
  return OPERATOR_CANCELLED;
}

void RIGIDBODY_OT_object_remove(wmOperatorType *ot)
{
  /* identifiers */
  ot->idname = "RIGIDBODY_OT_object_remove";
  ot->name = "Remove Rigid Body";
  ot->description = "Remove Rigid Body settings from Object";

  /* callbacks */
  ot->exec = rigidbody_object_remove_exec;
  ot->poll = ED_operator_rigidbody_active_poll;

  /* flags */
  ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
}

/* ********************************************** */
/* Selected Object Add/Remove Operators */

/* ************ Add Rigid Bodies ************** */

static int rigidbody_objects_add_exec(bContext *C, wmOperator *op)
{
  Main *bmain = CTX_data_main(C);
  Scene *scene = CTX_data_scene(C);
  int type = RNA_enum_get(op->ptr, "type");
  bool changed = false;

  /* create rigid body objects and add them to the world's group */
  CTX_DATA_BEGIN (C, Object *, ob, selected_objects) {
    changed |= ED_rigidbody_object_add(bmain, scene, ob, type, op->reports);
  }
  CTX_DATA_END;

  if (changed) {
    /* send updates */
    WM_event_add_notifier(C, NC_OBJECT | ND_TRANSFORM, nullptr);
    WM_event_add_notifier(C, NC_OBJECT | ND_POINTCACHE, nullptr);

    /* done */
    return OPERATOR_FINISHED;
  }
  return OPERATOR_CANCELLED;
}

void RIGIDBODY_OT_objects_add(wmOperatorType *ot)
{
  /* identifiers */
  ot->idname = "RIGIDBODY_OT_objects_add";
  ot->name = "Add Rigid Bodies";
  ot->description = "Add selected objects as Rigid Bodies";

  /* callbacks */
  ot->exec = rigidbody_objects_add_exec;
  ot->poll = ED_operator_rigidbody_add_poll;

  /* flags */
  ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;

  /* properties */
  ot->prop = RNA_def_enum(ot->srna,
                          "type",
                          rna_enum_rigidbody_object_type_items,
                          RBO_TYPE_ACTIVE,
                          "Rigid Body Type",
                          "");
}

/* ************ Remove Rigid Bodies ************** */

static int rigidbody_objects_remove_exec(bContext *C, wmOperator * /*op*/)
{
  Main *bmain = CTX_data_main(C);
  Scene *scene = CTX_data_scene(C);
  bool changed = false;

  /* apply this to all selected objects... */
  CTX_DATA_BEGIN (C, Object *, ob, selected_objects) {
    if (ob->rigidbody_object) {
      ED_rigidbody_object_remove(bmain, scene, ob);
      changed = true;
    }
  }
  CTX_DATA_END;

  if (changed) {
    /* send updates */
    WM_event_add_notifier(C, NC_OBJECT | ND_TRANSFORM, nullptr);
    WM_event_add_notifier(C, NC_OBJECT | ND_POINTCACHE, nullptr);

    /* done */
    return OPERATOR_FINISHED;
  }
  return OPERATOR_CANCELLED;
}

void RIGIDBODY_OT_objects_remove(wmOperatorType *ot)
{
  /* identifiers */
  ot->idname = "RIGIDBODY_OT_objects_remove";
  ot->name = "Remove Rigid Bodies";
  ot->description = "Remove selected objects from Rigid Body simulation";

  /* callbacks */
  ot->exec = rigidbody_objects_remove_exec;
  ot->poll = ED_operator_rigidbody_active_poll;

  /* flags */
  ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
}

/* ********************************************** */
/* Utility Operators */

/* ************ Change Collision Shapes ************** */

static int rigidbody_objects_shape_change_exec(bContext *C, wmOperator *op)
{
  int shape = RNA_enum_get(op->ptr, "type");
  bool changed = false;

  /* apply this to all selected objects... */
  CTX_DATA_BEGIN (C, Object *, ob, selected_objects) {
    if (ob->rigidbody_object) {
      /* use RNA-system to change the property and perform all necessary changes */
      PointerRNA ptr = RNA_pointer_create(&ob->id, &RNA_RigidBodyObject, ob->rigidbody_object);
      RNA_enum_set(&ptr, "collision_shape", shape);

      DEG_id_tag_update(&ob->id, ID_RECALC_TRANSFORM);

      changed = true;
    }
  }
  CTX_DATA_END;

  if (changed) {
    /* send updates */
    WM_event_add_notifier(C, NC_OBJECT | ND_POINTCACHE, nullptr);
    WM_event_add_notifier(C, NC_SPACE | ND_SPACE_VIEW3D, nullptr);

    /* done */
    return OPERATOR_FINISHED;
  }
  return OPERATOR_CANCELLED;
}

void RIGIDBODY_OT_shape_change(wmOperatorType *ot)
{
  /* identifiers */
  ot->idname = "RIGIDBODY_OT_shape_change";
  ot->name = "Change Collision Shape";
  ot->description = "Change collision shapes for selected Rigid Body Objects";

  /* callbacks */
  ot->invoke = WM_menu_invoke;
  ot->exec = rigidbody_objects_shape_change_exec;
  ot->poll = ED_operator_rigidbody_active_poll;

  /* flags */
  ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;

  /* properties */
  ot->prop = RNA_def_enum(ot->srna,
                          "type",
                          rna_enum_rigidbody_object_shape_items,
                          RB_SHAPE_TRIMESH,
                          "Rigid Body Shape",
                          "");
}

/* ************ Calculate Mass ************** */

/* Entry in material density table */
struct rbMaterialDensityItem {
  const char *name; /* Name of material */
  float density;    /* Density (kg/m^3) */
};

/* Preset density values for materials (kg/m^3)
 * Selected values obtained from:
 * 1) http://www.jaredzone.info/2010/09/densities.html
 * 2) http://www.avlandesign.com/density_construction.htm
 * 3) http://www.avlandesign.com/density_metal.htm
 */
static rbMaterialDensityItem RB_MATERIAL_DENSITY_TABLE[] = {
    {N_("Air"), 1.0f}, /* not quite; adapted from 1.43 for oxygen for use as default */
    {N_("Acrylic"), 1400.0f},
    {N_("Asphalt (Crushed)"), 721.0f},
    {N_("Bark"), 240.0f},
    {N_("Beans (Cocoa)"), 593.0f},
    {N_("Beans (Soy)"), 721.0f},
    {N_("Brick (Pressed)"), 2400.0f},
    {N_("Brick (Common)"), 2000.0f},
    {N_("Brick (Soft)"), 1600.0f},
    {N_("Brass"), 8216.0f},
    {N_("Bronze"), 8860.0f},
    {N_("Carbon (Solid)"), 2146.0f},
    {N_("Cardboard"), 689.0f},
    {N_("Cast Iron"), 7150.0f},     /* {N_("Cement"), 1442.0f}, */
    {N_("Chalk (Solid)"), 2499.0f}, /* {N_("Coffee (Fresh/Roast)"), ~500}, */
    {N_("Concrete"), 2320.0f},
    {N_("Charcoal"), 208.0f},
    {N_("Cork"), 240.0f},
    {N_("Copper"), 8933.0f},
    {N_("Garbage"), 481.0f},
    {N_("Glass (Broken)"), 1940.0f},
    {N_("Glass (Solid)"), 2190.0f},
    {N_("Gold"), 19282.0f},
    {N_("Granite (Broken)"), 1650.0f},
    {N_("Granite (Solid)"), 2691.0f},
    {N_("Gravel"), 2780.0f},
    {N_("Ice (Crushed)"), 593.0f},
    {N_("Ice (Solid)"), 919.0f},
    {N_("Iron"), 7874.0f},
    {N_("Lead"), 11342.0f},
    {N_("Limestone (Broken)"), 1554.0f},
    {N_("Limestone (Solid)"), 2611.0f},
    {N_("Marble (Broken)"), 1570.0f},
    {N_("Marble (Solid)"), 2563.0f},
    {N_("Paper"), 1201.0f},
    {N_("Peanuts (Shelled)"), 641.0f},
    {N_("Peanuts (Not Shelled)"), 272.0f},
    {N_("Plaster"), 849.0f},
    {N_("Plastic"), 1200.0f},
    {N_("Polystyrene"), 1050.0f},
    {N_("Rubber"), 1522.0f},
    {N_("Silver"), 10501.0f},
    {N_("Steel"), 7860.0f},
    {N_("Stone"), 2515.0f},
    {N_("Stone (Crushed)"), 1602.0f},
    {N_("Timber"), 610.0f},
};
static const int NUM_RB_MATERIAL_PRESETS = sizeof(RB_MATERIAL_DENSITY_TABLE) /
                                           sizeof(rbMaterialDensityItem);

/* dynamically generate list of items
 * - Although there is a runtime cost, this has a lower maintenance cost
 *   in the long run than other two-list solutions...
 */
static const EnumPropertyItem *rigidbody_materials_itemf(bContext * /*C*/,
                                                         PointerRNA * /*ptr*/,
                                                         PropertyRNA * /*prop*/,
                                                         bool *r_free)
{
  EnumPropertyItem item_tmp = {0};
  EnumPropertyItem *item = nullptr;
  int totitem = 0;
  int i = 0;

  /* add each preset to the list */
  for (i = 0; i < NUM_RB_MATERIAL_PRESETS; i++) {
    rbMaterialDensityItem *preset = &RB_MATERIAL_DENSITY_TABLE[i];

    item_tmp.identifier = preset->name;
    item_tmp.name = IFACE_(preset->name);
    item_tmp.value = i;
    RNA_enum_item_add(&item, &totitem, &item_tmp);
  }

  /* add special "custom" entry to the end of the list */
  {
    item_tmp.identifier = "Custom";
    item_tmp.name = IFACE_("Custom");
    item_tmp.value = -1;
    RNA_enum_item_add(&item, &totitem, &item_tmp);
  }

  RNA_enum_item_end(&item, &totitem);
  *r_free = true;

  return item;
}

/* ------------------------------------------ */

static int rigidbody_objects_calc_mass_exec(bContext *C, wmOperator *op)
{
  Depsgraph *depsgraph = CTX_data_ensure_evaluated_depsgraph(C);
  int material = RNA_enum_get(op->ptr, "material");
  float density;
  bool changed = false;

  /* get density (kg/m^3) to apply */
  if (material >= 0) {
    /* get density from table, and store in props for later repeating */
    if (material >= NUM_RB_MATERIAL_PRESETS) {
      material = 0;
    }

    density = RB_MATERIAL_DENSITY_TABLE[material].density;
    RNA_float_set(op->ptr, "density", density);
  }
  else {
    /* custom - grab from whatever value is set */
    density = RNA_float_get(op->ptr, "density");
  }

  /* Apply this to all selected objects (with rigid-bodies). */
  CTX_DATA_BEGIN (C, Object *, ob, selected_objects) {
    if (ob->rigidbody_object) {
      float volume; /* m^3 */
      float mass;   /* kg */

      /* mass is calculated from the approximate volume of the object,
       * and the density of the material we're simulating
       */
      Object *ob_eval = DEG_get_evaluated_object(depsgraph, ob);
      BKE_rigidbody_calc_volume(ob_eval, &volume);
      mass = volume * density;

      /* use RNA-system to change the property and perform all necessary changes */
      PointerRNA ptr = RNA_pointer_create(&ob->id, &RNA_RigidBodyObject, ob->rigidbody_object);
      RNA_float_set(&ptr, "mass", mass);

      DEG_id_tag_update(&ob->id, ID_RECALC_TRANSFORM);

      changed = true;
    }
  }
  CTX_DATA_END;

  if (changed) {
    /* send updates */
    WM_event_add_notifier(C, NC_OBJECT | ND_POINTCACHE, nullptr);

    /* done */
    return OPERATOR_FINISHED;
  }
  return OPERATOR_CANCELLED;
}

static bool mass_calculate_poll_property(const bContext * /*C*/,
                                         wmOperator *op,
                                         const PropertyRNA *prop)
{
  const char *prop_id = RNA_property_identifier(prop);

  /* Disable density input when not using the 'Custom' preset. */
  if (STREQ(prop_id, "density")) {
    int material = RNA_enum_get(op->ptr, "material");
    if (material >= 0) {
      RNA_def_property_clear_flag((PropertyRNA *)prop, PROP_EDITABLE);
    }
    else {
      RNA_def_property_flag((PropertyRNA *)prop, PROP_EDITABLE);
    }
  }

  return true;
}

void RIGIDBODY_OT_mass_calculate(wmOperatorType *ot)
{
  PropertyRNA *prop;

  /* identifiers */
  ot->idname = "RIGIDBODY_OT_mass_calculate";
  ot->name = "Calculate Mass";
  ot->description = "Automatically calculate mass values for Rigid Body Objects based on volume";

  /* callbacks */
  ot->invoke = WM_menu_invoke; /* XXX */
  ot->exec = rigidbody_objects_calc_mass_exec;
  ot->poll = ED_operator_rigidbody_active_poll;
  ot->poll_property = mass_calculate_poll_property;

  /* flags */
  ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;

  /* properties */
  ot->prop = prop = RNA_def_enum(
      ot->srna,
      "material",
      rna_enum_dummy_DEFAULT_items,
      0,
      "Material Preset",
      "Type of material that objects are made of (determines material density)");
  RNA_def_enum_funcs(prop, rigidbody_materials_itemf);
  RNA_def_property_flag(prop, PROP_ENUM_NO_TRANSLATE);

  RNA_def_float(ot->srna,
                "density",
                1.0,
                FLT_MIN,
                FLT_MAX,
                "Density",
                "Density value (kg/m^3), allows custom value if the 'Custom' preset is used",
                1.0f,
                2500.0f);
}

/* ********************************************** */