Merge branch 'master' into blender2.8
[blender.git] / source / blender / makesrna / intern / rna_speaker.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  * Contributor(s): Jörg Müller.
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 /** \file blender/makesrna/intern/rna_speaker.c
24  *  \ingroup RNA
25  */
26
27
28 #include <stdlib.h>
29
30 #include "RNA_define.h"
31 #include "RNA_enum_types.h"
32
33 #include "rna_internal.h"
34
35 #include "DNA_speaker_types.h"
36 #include "DNA_sound_types.h"
37
38 #include "BLT_translation.h"
39
40 #ifdef RNA_RUNTIME
41
42 #include "MEM_guardedalloc.h"
43
44 #include "BKE_main.h"
45
46 #include "WM_api.h"
47 #include "WM_types.h"
48
49 #else
50
51 static void rna_def_speaker(BlenderRNA *brna)
52 {
53         StructRNA *srna;
54         PropertyRNA *prop;
55
56         srna = RNA_def_struct(brna, "Speaker", "ID");
57         RNA_def_struct_ui_text(srna, "Speaker", "Speaker data-block for 3D audio speaker objects");
58         RNA_def_struct_ui_icon(srna, ICON_SPEAKER);
59
60         prop = RNA_def_property(srna, "muted", PROP_BOOLEAN, PROP_NONE);
61         RNA_def_property_boolean_sdna(prop, NULL, "flag", SPK_MUTED);
62         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
63         RNA_def_property_ui_text(prop, "Mute", "Mute the speaker");
64         RNA_def_property_translation_context(prop, BLT_I18NCONTEXT_ID_SOUND);
65         /* RNA_def_property_update(prop, 0, "rna_Speaker_update"); */
66
67         prop = RNA_def_property(srna, "relative", PROP_BOOLEAN, PROP_NONE);
68         RNA_def_property_boolean_sdna(prop, NULL, "flag", SPK_RELATIVE);
69         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
70         RNA_def_property_ui_text(prop, "Relative", "Whether the source is relative to the camera or not");
71         /* RNA_def_property_update(prop, 0, "rna_Speaker_update"); */
72
73         prop = RNA_def_property(srna, "sound", PROP_POINTER, PROP_NONE);
74         RNA_def_property_struct_type(prop, "Sound");
75         RNA_def_property_flag(prop, PROP_EDITABLE);
76         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
77         RNA_def_property_ui_text(prop, "Sound", "Sound data-block used by this speaker");
78         /* RNA_def_property_float_funcs(prop, NULL, "rna_Speaker_sound_set", NULL); */
79         /* RNA_def_property_update(prop, 0, "rna_Speaker_update"); */
80
81         prop = RNA_def_property(srna, "volume_max", PROP_FLOAT, PROP_NONE);
82         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
83         RNA_def_property_range(prop, 0.0f, 1.0f);
84         RNA_def_property_ui_text(prop, "Maximum Volume", "Maximum volume, no matter how near the object is");
85         /* RNA_def_property_float_funcs(prop, NULL, "rna_Speaker_volume_max_set", NULL); */
86         /* RNA_def_property_update(prop, 0, "rna_Speaker_update"); */
87
88         prop = RNA_def_property(srna, "volume_min", PROP_FLOAT, PROP_NONE);
89         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
90         RNA_def_property_range(prop, 0.0f, 1.0f);
91         RNA_def_property_ui_text(prop, "Minimum Volume", "Minimum volume, no matter how far away the object is");
92         /* RNA_def_property_float_funcs(prop, NULL, "rna_Speaker_volume_min_set", NULL); */
93         /* RNA_def_property_update(prop, 0, "rna_Speaker_update"); */
94
95         prop = RNA_def_property(srna, "distance_max", PROP_FLOAT, PROP_NONE);
96         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
97         RNA_def_property_range(prop, 0.0f, FLT_MAX);
98         RNA_def_property_ui_text(prop, "Maximum Distance",
99                                  "Maximum distance for volume calculation, no matter how far away the object is");
100         /* RNA_def_property_float_funcs(prop, NULL, "rna_Speaker_distance_max_set", NULL); */
101         /* RNA_def_property_update(prop, 0, "rna_Speaker_update"); */
102
103         prop = RNA_def_property(srna, "distance_reference", PROP_FLOAT, PROP_NONE);
104         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
105         RNA_def_property_range(prop, 0.0f, FLT_MAX);
106         RNA_def_property_ui_text(prop, "Reference Distance", "Reference distance at which volume is 100 %");
107         /* RNA_def_property_float_funcs(prop, NULL, "rna_Speaker_distance_reference_set", NULL); */
108         /* RNA_def_property_update(prop, 0, "rna_Speaker_update"); */
109
110         prop = RNA_def_property(srna, "attenuation", PROP_FLOAT, PROP_NONE);
111         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
112         RNA_def_property_range(prop, 0.0f, FLT_MAX);
113         RNA_def_property_ui_text(prop, "Attenuation", "How strong the distance affects volume, depending on distance model");
114         /* RNA_def_property_float_funcs(prop, NULL, "rna_Speaker_attenuation_set", NULL); */
115         /* RNA_def_property_update(prop, 0, "rna_Speaker_update"); */
116
117         prop = RNA_def_property(srna, "cone_angle_outer", PROP_FLOAT, PROP_NONE);
118         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
119         RNA_def_property_range(prop, 0.0f, 360.0f);
120         RNA_def_property_ui_text(prop, "Outer Cone Angle",
121                                  "Angle of the outer cone, in degrees, outside this cone the volume is "
122                                  "the outer cone volume, between inner and outer cone the volume is interpolated");
123         /* RNA_def_property_float_funcs(prop, NULL, "rna_Speaker_cone_angle_outer_set", NULL); */
124         /* RNA_def_property_update(prop, 0, "rna_Speaker_update"); */
125
126         prop = RNA_def_property(srna, "cone_angle_inner", PROP_FLOAT, PROP_NONE);
127         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
128         RNA_def_property_range(prop, 0.0f, 360.0f);
129         RNA_def_property_ui_text(prop, "Inner Cone Angle",
130                                  "Angle of the inner cone, in degrees, inside the cone the volume is 100 %");
131         /* RNA_def_property_float_funcs(prop, NULL, "rna_Speaker_cone_angle_inner_set", NULL); */
132         /* RNA_def_property_update(prop, 0, "rna_Speaker_update"); */
133
134         prop = RNA_def_property(srna, "cone_volume_outer", PROP_FLOAT, PROP_NONE);
135         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
136         RNA_def_property_range(prop, 0.0f, 1.0f);
137         RNA_def_property_ui_text(prop, "Outer Cone Volume", "Volume outside the outer cone");
138         /* RNA_def_property_float_funcs(prop, NULL, "rna_Speaker_cone_volume_outer_set", NULL); */
139         /* RNA_def_property_update(prop, 0, "rna_Speaker_update"); */
140
141         prop = RNA_def_property(srna, "volume", PROP_FLOAT, PROP_NONE);
142         RNA_def_property_range(prop, 0.0f, 1.0f);
143         RNA_def_property_ui_text(prop, "Volume", "How loud the sound is");
144         RNA_def_property_translation_context(prop, BLT_I18NCONTEXT_ID_SOUND);
145         /* RNA_def_property_float_funcs(prop, NULL, "rna_Speaker_volume_set", NULL); */
146         /* RNA_def_property_update(prop, 0, "rna_Speaker_update"); */
147
148         prop = RNA_def_property(srna, "pitch", PROP_FLOAT, PROP_NONE);
149         RNA_def_property_range(prop, 0.1f, 10.0f);
150         RNA_def_property_ui_text(prop, "Pitch", "Playback pitch of the sound");
151         RNA_def_property_translation_context(prop, BLT_I18NCONTEXT_ID_SOUND);
152         /* RNA_def_property_float_funcs(prop, NULL, "rna_Speaker_pitch_set", NULL); */
153         /* RNA_def_property_update(prop, 0, "rna_Speaker_update"); */
154
155         /* common */
156         rna_def_animdata_common(srna);
157 }
158
159
160 void RNA_def_speaker(BlenderRNA *brna)
161 {
162         rna_def_speaker(brna);
163 }
164
165 #endif
166