archive/blender-archive
Archived
1
1
Fork 0
Code Pull Requests Packages Activity
This repository has been archived on 2023-10-09. You can view files and clone it, but cannot push or open issues or pull requests.
Files
974dc284761338da477fc1e4e901b6ad1b82805f
blender-archive/source/blender/makesrna/intern/rna_armature_api.c
Alexander Gavrilov fcf2a712ec Armature: add Inherit Scale options to remove shear or average the scale. 
As an inherent property of matrix-based transformation math, non-
uniform scaling of a parent bone induces shear into the transform
matrix of any rotated child. Such matrices cannot be cleanly
decomposed into a combination of location/rotation/scale, which
causes issues for rigging and animation tools.

Blender bones have options to exclude rotation and/or scale from the
inherited transformation, but don't have any support for removing the
often undesired shear component. That goal requires replacing simple
parenting with a combination of multiple bones and constraints. The
same is true about the goal of inheriting some scale, but completely
avoiding shear.

This patch replaces the old Inherit Scale checkbox with a enum that
supports multiple options:

* Full: inherit all effects of scale, like with enabled Inherit Scale.

* Fix Shear: removes shear from the final inherited transformation.

  The cleanup math is specifically designed to preserve the main
  axis of the bone, its length and total volume, and minimally
  affect roll on average. It however will not prevent reappearance
  of shear due to local rotation of the child or its children.

* Average: inherit uniform scale that represents the parent volume.

  This is the simplest foolproof solution that will inherit some
  scale without ever causing shear.

* None: completely remove scale and shear.

* None (Legacy): old disabled Inherit Scale checkbox.

  This mode does not handle parent shear in any way, so the child
  is likely to end up having both scale and shear. It is retained
  for backward compatibility.

Since many rigging-related addons access the use_inherit_scale
property from Python, it is retained as a backward compatibility
stub that provides the old functionality.

As a side effect of reworking the code, this also fixes a matrix
multiplication order bug in the Inherit Rotation code, which caused
the parent local scale to be applied in world space. In rigger
opinion this option is useless in production rigs, so this fix
should not be a problem.

Reviewers: brecht

Differential Revision: https://developer.blender.org/D5588
2019-09-04 10:34:21 +03:00

219 lines
9.0 KiB
C
Raw Blame History

/*
* 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.
*
* The Original Code is Copyright (C) 2009 Blender Foundation.
* All rights reserved.
*/
/** \file
* \ingroup RNA
*/
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <time.h>
#include "RNA_define.h"
#include "rna_internal.h" /* own include */
#ifdef RNA_RUNTIME
# include <stddef.h>
# include "DNA_armature_types.h"
# include "BLI_math_vector.h"
# include "BKE_armature.h"
static void rna_EditBone_align_roll(EditBone *ebo, float no[3])
{
ebo->roll = ED_armature_ebone_roll_to_vector(ebo, no, false);
}
static float rna_Bone_do_envelope(Bone *bone, float *vec)
{
float scale = (bone->flag & BONE_MULT_VG_ENV) == BONE_MULT_VG_ENV ? bone->weight : 1.0f;
return distfactor_to_bone(vec,
bone->arm_head,
bone->arm_tail,
bone->rad_head * scale,
bone->rad_tail * scale,
bone->dist * scale);
}
static void rna_Bone_convert_local_to_pose(Bone *bone,
float *r_matrix,
float *matrix,
float *matrix_local,
float *parent_matrix,
float *parent_matrix_local,
bool invert)
{
BoneParentTransform bpt;
float offs_bone[4][4];
float(*bone_arm_mat)[4] = (float(*)[4])matrix_local;
float(*parent_pose_mat)[4] = (float(*)[4])parent_matrix;
float(*parent_arm_mat)[4] = (float(*)[4])parent_matrix_local;
if (is_zero_m4(parent_pose_mat) || is_zero_m4(parent_arm_mat)) {
/* No parent case. */
BKE_bone_parent_transform_calc_from_matrices(
bone->flag, bone->inherit_scale_mode, bone_arm_mat, NULL, NULL, &bpt);
}
else {
invert_m4_m4(offs_bone, parent_arm_mat);
mul_m4_m4m4(offs_bone, offs_bone, bone_arm_mat);
BKE_bone_parent_transform_calc_from_matrices(
bone->flag, bone->inherit_scale_mode, offs_bone, parent_arm_mat, parent_pose_mat, &bpt);
}
if (invert) {
BKE_bone_parent_transform_invert(&bpt);
}
BKE_bone_parent_transform_apply(&bpt, (float(*)[4])matrix, (float(*)[4])r_matrix);
}
static void rna_Bone_MatrixFromAxisRoll(float *axis, float roll, float *r_matrix)
{
vec_roll_to_mat3(axis, roll, (float(*)[3])r_matrix);
}
static void rna_Bone_AxisRollFromMatrix(float *matrix,
float *axis_override,
float *r_axis,
float *r_roll)
{
float mat[3][3];
normalize_m3_m3(mat, (float(*)[3])matrix);
if (normalize_v3_v3(r_axis, axis_override) != 0.0f) {
mat3_vec_to_roll(mat, r_axis, r_roll);
}
else {
mat3_to_vec_roll(mat, r_axis, r_roll);
}
}
#else
void RNA_api_armature_edit_bone(StructRNA *srna)
{
FunctionRNA *func;
PropertyRNA *parm;
func = RNA_def_function(srna, "align_roll", "rna_EditBone_align_roll");
RNA_def_function_ui_description(func,
"Align the bone to a localspace roll so the Z axis "
"points in the direction of the vector given");
parm = RNA_def_float_vector(
func, "vector", 3, NULL, -FLT_MAX, FLT_MAX, "Vector", "", -FLT_MAX, FLT_MAX);
RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
}
void RNA_api_bone(StructRNA *srna)
{
PropertyRNA *parm;
FunctionRNA *func;
func = RNA_def_function(srna, "evaluate_envelope", "rna_Bone_do_envelope");
RNA_def_function_ui_description(func, "Calculate bone envelope at given point");
parm = RNA_def_float_vector_xyz(func,
"point",
3,
NULL,
-FLT_MAX,
FLT_MAX,
"Point",
"Position in 3d space to evaluate",
-FLT_MAX,
FLT_MAX);
RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
/* return value */
parm = RNA_def_float(
func, "factor", 0, -FLT_MAX, FLT_MAX, "Factor", "Envelope factor", -FLT_MAX, FLT_MAX);
RNA_def_function_return(func, parm);
func = RNA_def_function(srna, "convert_local_to_pose", "rna_Bone_convert_local_to_pose");
RNA_def_function_ui_description(func,
"Transform a matrix from Local to Pose space (or back), taking "
"into account options like Inherit Scale and Local Location. "
"Unlike Object.convert_space, this uses custom rest and pose "
"matrices provided by the caller. If the parent matrices are "
"omitted, the bone is assumed to have no parent.");
parm = RNA_def_property(func, "matrix_return", PROP_FLOAT, PROP_MATRIX);
RNA_def_property_multi_array(parm, 2, rna_matrix_dimsize_4x4);
RNA_def_property_ui_text(parm, "", "The transformed matrix");
RNA_def_function_output(func, parm);
parm = RNA_def_property(func, "matrix", PROP_FLOAT, PROP_MATRIX);
RNA_def_property_multi_array(parm, 2, rna_matrix_dimsize_4x4);
RNA_def_property_ui_text(parm, "", "The matrix to transform");
RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
parm = RNA_def_property(func, "matrix_local", PROP_FLOAT, PROP_MATRIX);
RNA_def_property_multi_array(parm, 2, rna_matrix_dimsize_4x4);
RNA_def_property_ui_text(parm, "", "The custom rest matrix of this bone (Bone.matrix_local)");
RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
parm = RNA_def_property(func, "parent_matrix", PROP_FLOAT, PROP_MATRIX);
RNA_def_property_multi_array(parm, 2, rna_matrix_dimsize_4x4);
RNA_def_property_ui_text(
parm, "", "The custom pose matrix of the parent bone (PoseBone.matrix)");
parm = RNA_def_property(func, "parent_matrix_local", PROP_FLOAT, PROP_MATRIX);
RNA_def_property_multi_array(parm, 2, rna_matrix_dimsize_4x4);
RNA_def_property_ui_text(
parm, "", "The custom rest matrix of the parent bone (Bone.matrix_local)");
parm = RNA_def_boolean(func, "invert", false, "", "Convert from Pose to Local space");
/* Conversions between Matrix and Axis + Roll representations. */
func = RNA_def_function(srna, "MatrixFromAxisRoll", "rna_Bone_MatrixFromAxisRoll");
RNA_def_function_ui_description(func, "Convert the axis + roll representation to a matrix");
RNA_def_function_flag(func, FUNC_NO_SELF);
parm = RNA_def_property(func, "axis", PROP_FLOAT, PROP_XYZ);
RNA_def_property_array(parm, 3);
RNA_def_property_ui_text(parm, "", "The main axis of the bone (tail - head)");
RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED);
parm = RNA_def_property(func, "roll", PROP_FLOAT, PROP_NONE);
RNA_def_property_ui_text(parm, "", "The roll of the bone");
RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
parm = RNA_def_property(func, "result_matrix", PROP_FLOAT, PROP_MATRIX);
RNA_def_property_multi_array(parm, 2, rna_matrix_dimsize_3x3);
RNA_def_property_ui_text(parm, "", "The resulting orientation matrix");
RNA_def_function_output(func, parm);
func = RNA_def_function(srna, "AxisRollFromMatrix", "rna_Bone_AxisRollFromMatrix");
RNA_def_function_ui_description(func,
"Convert a rotational matrix to the axis + roll representation");
RNA_def_function_flag(func, FUNC_NO_SELF);
parm = RNA_def_property(func, "matrix", PROP_FLOAT, PROP_MATRIX);
RNA_def_property_multi_array(parm, 2, rna_matrix_dimsize_3x3);
RNA_def_property_ui_text(parm, "", "The orientation matrix of the bone");
RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED);
parm = RNA_def_property(func, "axis", PROP_FLOAT, PROP_MATRIX);
RNA_def_property_array(parm, 3);
RNA_def_property_ui_text(
parm, "", "The optional override for the axis (finds closest approximation for the matrix)");
parm = RNA_def_property(func, "result_axis", PROP_FLOAT, PROP_XYZ);
RNA_def_property_array(parm, 3);
RNA_def_property_ui_text(parm, "", "The main axis of the bone");
RNA_def_function_output(func, parm);
parm = RNA_def_property(func, "result_roll", PROP_FLOAT, PROP_NONE);
RNA_def_property_ui_text(parm, "", "The roll of the bone");
RNA_def_function_output(func, parm);
}
#endif
View Git Blame Copy Permalink