Merge branch 'master' into blender2.8
[blender.git] / source / blender / makesrna / intern / rna_pose_api.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2009 Blender Foundation.
19  * All rights reserved.
20  *
21  *
22  * Contributor(s): Blender Foundation
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file blender/makesrna/intern/rna_pose_api.c
28  *  \ingroup RNA
29  */
30
31
32 #include <stdlib.h>
33 #include <stdio.h>
34 #include <string.h>
35 #include <time.h>
36
37 #include "BLI_utildefines.h"
38
39 #include "RNA_define.h"
40
41 #include "DNA_object_types.h"
42
43 /* #include "BLI_sys_types.h" */
44
45 #include "rna_internal.h"  /* own include */
46
47 #ifdef RNA_RUNTIME
48
49 /* #include "DNA_anim_types.h" */
50 #include "DNA_action_types.h" /* bPose */
51 #include "BKE_armature.h"
52
53 static float rna_PoseBone_do_envelope(bPoseChannel *chan, float *vec)
54 {
55         Bone *bone = chan->bone;
56
57         float scale = (bone->flag & BONE_MULT_VG_ENV) == BONE_MULT_VG_ENV ? bone->weight : 1.0f;
58
59         return distfactor_to_bone(vec, chan->pose_head, chan->pose_tail, bone->rad_head * scale,
60                                   bone->rad_tail * scale, bone->dist * scale);
61 }
62
63 static void rna_PoseBone_bbone_segment_matrix(bPoseChannel *pchan, ReportList *reports, float mat_ret[16], int index, bool rest)
64 {
65         if (!pchan->bone || pchan->bone->segments <= 1) {
66                 BKE_reportf(reports, RPT_ERROR, "Bone '%s' is not a B-Bone!", pchan->name);
67                 return;
68         }
69         if (pchan->runtime.bbone_segments != pchan->bone->segments) {
70                 BKE_reportf(reports, RPT_ERROR, "Bone '%s' has out of date B-Bone segment data!", pchan->name);
71                 return;
72         }
73         if (index < 0 || index >= pchan->runtime.bbone_segments) {
74                 BKE_reportf(reports, RPT_ERROR, "Invalid index %d for B-Bone segments of '%s'!", index, pchan->name);
75                 return;
76         }
77
78         if (rest) {
79                 copy_m4_m4((float (*)[4])mat_ret, pchan->runtime.bbone_rest_mats[index].mat);
80         }
81         else {
82                 copy_m4_m4((float (*)[4])mat_ret, pchan->runtime.bbone_pose_mats[index].mat);
83         }
84 }
85
86 static void rna_PoseBone_compute_bbone_handles(
87         bPoseChannel *pchan, ReportList *reports,
88         float ret_h1[3], float *ret_roll1, float ret_h2[3], float *ret_roll2,
89         bool rest, bool ease, bool offsets)
90 {
91         if (!pchan->bone || pchan->bone->segments <= 1) {
92                 BKE_reportf(reports, RPT_ERROR, "Bone '%s' is not a B-Bone!", pchan->name);
93                 return;
94         }
95
96         BBoneSplineParameters params;
97
98         BKE_pchan_bbone_spline_params_get(pchan, rest, &params);
99         BKE_pchan_bbone_handles_compute(&params, ret_h1, ret_roll1, ret_h2, ret_roll2, ease || offsets, offsets);
100 }
101 #else
102
103 void RNA_api_pose(StructRNA *UNUSED(srna))
104 {
105         /* FunctionRNA *func; */
106         /* PropertyRNA *parm; */
107 }
108
109 void RNA_api_pose_channel(StructRNA *srna)
110 {
111         PropertyRNA *parm;
112         FunctionRNA *func;
113
114         func = RNA_def_function(srna, "evaluate_envelope", "rna_PoseBone_do_envelope");
115         RNA_def_function_ui_description(func, "Calculate bone envelope at given point");
116         parm = RNA_def_float_vector_xyz(func, "point", 3, NULL, -FLT_MAX, FLT_MAX, "Point",
117                                         "Position in 3d space to evaluate", -FLT_MAX, FLT_MAX);
118         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
119         /* return value */
120         parm = RNA_def_float(func, "factor", 0, -FLT_MAX, FLT_MAX, "Factor", "Envelope factor", -FLT_MAX, FLT_MAX);
121         RNA_def_function_return(func, parm);
122
123         /* B-Bone segment matrices */
124         func = RNA_def_function(srna, "bbone_segment_matrix", "rna_PoseBone_bbone_segment_matrix");
125         RNA_def_function_ui_description(func, "Retrieve the matrix of the B-Bone segment if available");
126         RNA_def_function_flag(func, FUNC_USE_REPORTS);
127         parm = RNA_def_property(func, "matrix_return", PROP_FLOAT, PROP_MATRIX);
128         RNA_def_property_multi_array(parm, 2, rna_matrix_dimsize_4x4);
129         RNA_def_property_ui_text(parm, "", "The resulting matrix in bone local space");
130         RNA_def_function_output(func, parm);
131         parm = RNA_def_int(func, "index", 0, 0, INT_MAX, "", "Index of the segment", 0, 10000);
132         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
133         parm = RNA_def_boolean(func, "rest", false, "", "Return the rest pose matrix");
134
135         /* B-Bone custom handle positions */
136         func = RNA_def_function(srna, "compute_bbone_handles", "rna_PoseBone_compute_bbone_handles");
137         RNA_def_function_ui_description(func, "Retrieve the vectors and rolls coming from B-Bone custom handles");
138         RNA_def_function_flag(func, FUNC_USE_REPORTS);
139         parm = RNA_def_property(func, "handle1", PROP_FLOAT, PROP_XYZ);
140         RNA_def_property_array(parm, 3);
141         RNA_def_property_ui_text(parm, "", "The direction vector of the start handle in bone local space");
142         RNA_def_function_output(func, parm);
143         parm = RNA_def_float(func, "roll1", 0, -FLT_MAX, FLT_MAX, "", "Roll of the start handle", -FLT_MAX, FLT_MAX);
144         RNA_def_function_output(func, parm);
145         parm = RNA_def_property(func, "handle2", PROP_FLOAT, PROP_XYZ);
146         RNA_def_property_array(parm, 3);
147         RNA_def_property_ui_text(parm, "", "The direction vector of the end handle in bone local space");
148         RNA_def_function_output(func, parm);
149         parm = RNA_def_float(func, "roll2", 0, -FLT_MAX, FLT_MAX, "", "Roll of the end handle", -FLT_MAX, FLT_MAX);
150         RNA_def_function_output(func, parm);
151         parm = RNA_def_boolean(func, "rest", false, "", "Return the rest pose state");
152         parm = RNA_def_boolean(func, "ease", false, "", "Apply scale from ease values");
153         parm = RNA_def_boolean(func, "offsets", false, "", "Apply roll and curve offsets from bone properties");
154 }
155
156
157 #endif