Blender  V3.3
rna_speaker.c
Go to the documentation of this file.
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 
7 #include <stdlib.h>
8 
9 #include "RNA_define.h"
10 #include "RNA_enum_types.h"
11 
12 #include "rna_internal.h"
13 
14 #include "DNA_sound_types.h"
15 #include "DNA_speaker_types.h"
16 
17 #include "BLT_translation.h"
18 
19 #ifdef RNA_RUNTIME
20 
21 # include "MEM_guardedalloc.h"
22 
23 # include "BKE_main.h"
24 
25 # include "WM_api.h"
26 # include "WM_types.h"
27 
28 #else
29 
30 static void rna_def_speaker(BlenderRNA *brna)
31 {
32  StructRNA *srna;
33  PropertyRNA *prop;
34 
35  srna = RNA_def_struct(brna, "Speaker", "ID");
36  RNA_def_struct_ui_text(srna, "Speaker", "Speaker data-block for 3D audio speaker objects");
37  RNA_def_struct_ui_icon(srna, ICON_SPEAKER);
38 
39  prop = RNA_def_property(srna, "muted", PROP_BOOLEAN, PROP_NONE);
42  RNA_def_property_ui_text(prop, "Mute", "Mute the speaker");
44 # if 0
45  RNA_def_property_update(prop, 0, "rna_Speaker_update");
46 # endif
47 
48  prop = RNA_def_property(srna, "sound", PROP_POINTER, PROP_NONE);
49  RNA_def_property_struct_type(prop, "Sound");
53  RNA_def_property_ui_text(prop, "Sound", "Sound data-block used by this speaker");
54 # if 0
55  RNA_def_property_float_funcs(prop, NULL, "rna_Speaker_sound_set", NULL);
56  RNA_def_property_update(prop, 0, "rna_Speaker_update");
57 # endif
58 
59  prop = RNA_def_property(srna, "volume_max", PROP_FLOAT, PROP_FACTOR);
61  RNA_def_property_range(prop, 0.0f, 1.0f);
63  prop, "Maximum Volume", "Maximum volume, no matter how near the object is");
64 # if 0
65  RNA_def_property_float_funcs(prop, NULL, "rna_Speaker_volume_max_set", NULL);
66  RNA_def_property_update(prop, 0, "rna_Speaker_update");
67 # endif
68 
69  prop = RNA_def_property(srna, "volume_min", PROP_FLOAT, PROP_FACTOR);
71  RNA_def_property_range(prop, 0.0f, 1.0f);
73  prop, "Minimum Volume", "Minimum volume, no matter how far away the object is");
74 # if 0
75  RNA_def_property_float_funcs(prop, NULL, "rna_Speaker_volume_min_set", NULL);
76  RNA_def_property_update(prop, 0, "rna_Speaker_update");
77 # endif
78 
79  prop = RNA_def_property(srna, "distance_max", PROP_FLOAT, PROP_NONE);
81  RNA_def_property_range(prop, 0.0f, FLT_MAX);
83  prop,
84  "Maximum Distance",
85  "Maximum distance for volume calculation, no matter how far away the object is");
86 # if 0
87  RNA_def_property_float_funcs(prop, NULL, "rna_Speaker_distance_max_set", NULL);
88  RNA_def_property_update(prop, 0, "rna_Speaker_update");
89 # endif
90 
91  prop = RNA_def_property(srna, "distance_reference", PROP_FLOAT, PROP_NONE);
93  RNA_def_property_range(prop, 0.0f, FLT_MAX);
95  prop, "Reference Distance", "Reference distance at which volume is 100%");
96 # if 0
97  RNA_def_property_float_funcs(prop, NULL, "rna_Speaker_distance_reference_set", NULL);
98  RNA_def_property_update(prop, 0, "rna_Speaker_update");
99 # endif
100 
101  prop = RNA_def_property(srna, "attenuation", PROP_FLOAT, PROP_NONE);
103  RNA_def_property_range(prop, 0.0f, FLT_MAX);
105  prop, "Attenuation", "How strong the distance affects volume, depending on distance model");
106 # if 0
107  RNA_def_property_float_funcs(prop, NULL, "rna_Speaker_attenuation_set", NULL);
108  RNA_def_property_update(prop, 0, "rna_Speaker_update");
109 # endif
110 
111  prop = RNA_def_property(srna, "cone_angle_outer", PROP_FLOAT, PROP_NONE);
113  RNA_def_property_range(prop, 0.0f, 360.0f);
115  prop,
116  "Outer Cone Angle",
117  "Angle of the outer cone, in degrees, outside this cone the volume is "
118  "the outer cone volume, between inner and outer cone the volume is interpolated");
119 # if 0
120  RNA_def_property_float_funcs(prop, NULL, "rna_Speaker_cone_angle_outer_set", NULL);
121  RNA_def_property_update(prop, 0, "rna_Speaker_update");
122 # endif
123 
124  prop = RNA_def_property(srna, "cone_angle_inner", PROP_FLOAT, PROP_NONE);
126  RNA_def_property_range(prop, 0.0f, 360.0f);
128  prop,
129  "Inner Cone Angle",
130  "Angle of the inner cone, in degrees, inside the cone the volume is 100%");
131 # if 0
132  RNA_def_property_float_funcs(prop, NULL, "rna_Speaker_cone_angle_inner_set", NULL);
133  RNA_def_property_update(prop, 0, "rna_Speaker_update");
134 # endif
135 
136  prop = RNA_def_property(srna, "cone_volume_outer", PROP_FLOAT, PROP_FACTOR);
138  RNA_def_property_range(prop, 0.0f, 1.0f);
139  RNA_def_property_ui_text(prop, "Outer Cone Volume", "Volume outside the outer cone");
140 # if 0
141  RNA_def_property_float_funcs(prop, NULL, "rna_Speaker_cone_volume_outer_set", NULL);
142  RNA_def_property_update(prop, 0, "rna_Speaker_update");
143 # endif
144 
145  prop = RNA_def_property(srna, "volume", PROP_FLOAT, PROP_FACTOR);
146  RNA_def_property_range(prop, 0.0f, 1.0f);
147  RNA_def_property_ui_text(prop, "Volume", "How loud the sound is");
149 # if 0
150  RNA_def_property_float_funcs(prop, NULL, "rna_Speaker_volume_set", NULL);
151  RNA_def_property_update(prop, 0, "rna_Speaker_update");
152 # endif
153 
154  prop = RNA_def_property(srna, "pitch", PROP_FLOAT, PROP_NONE);
155  RNA_def_property_range(prop, 0.1f, 10.0f);
156  RNA_def_property_ui_text(prop, "Pitch", "Playback pitch of the sound");
158 # if 0
159  RNA_def_property_float_funcs(prop, NULL, "rna_Speaker_pitch_set", NULL);
160  RNA_def_property_update(prop, 0, "rna_Speaker_update");
161 # endif
162 
163  /* common */
165 }
166 
168 {
169  rna_def_speaker(brna);
170 }
171 
172 #endif
#define BLT_I18NCONTEXT_ID_SOUND
#define SPK_MUTED
Read Guarded memory(de)allocation.
@ PROP_FLOAT
Definition: RNA_types.h:61
@ PROP_BOOLEAN
Definition: RNA_types.h:59
@ PROP_POINTER
Definition: RNA_types.h:64
@ PROPOVERRIDE_OVERRIDABLE_LIBRARY
Definition: RNA_types.h:312
@ PROP_ANIMATABLE
Definition: RNA_types.h:202
@ PROP_EDITABLE
Definition: RNA_types.h:189
@ PROP_NONE
Definition: RNA_types.h:126
@ PROP_FACTOR
Definition: RNA_types.h:144
void rna_def_animdata_common(StructRNA *srna)
void RNA_def_property_boolean_sdna(PropertyRNA *prop, const char *structname, const char *propname, int64_t bit)
Definition: rna_define.c:2236
void RNA_def_property_float_funcs(PropertyRNA *prop, const char *get, const char *set, const char *range)
Definition: rna_define.c:3126
void RNA_def_property_ui_text(PropertyRNA *prop, const char *name, const char *description)
Definition: rna_define.c:1645
void RNA_def_struct_ui_text(StructRNA *srna, const char *name, const char *description)
Definition: rna_define.c:1237
void RNA_def_property_range(PropertyRNA *prop, double min, double max)
Definition: rna_define.c:1737
void RNA_def_property_struct_type(PropertyRNA *prop, const char *type)
Definition: rna_define.c:1772
void RNA_def_property_update(PropertyRNA *prop, int noteflag, const char *func)
Definition: rna_define.c:2900
PropertyRNA * RNA_def_property(StructOrFunctionRNA *cont_, const char *identifier, int type, int subtype)
Definition: rna_define.c:1257
void RNA_def_property_clear_flag(PropertyRNA *prop, PropertyFlag flag)
Definition: rna_define.c:1495
StructRNA * RNA_def_struct(BlenderRNA *brna, const char *identifier, const char *from)
Definition: rna_define.c:1028
void RNA_def_struct_ui_icon(StructRNA *srna, int icon)
Definition: rna_define.c:1245
void RNA_def_property_translation_context(PropertyRNA *prop, const char *context)
Definition: rna_define.c:2848
void RNA_def_property_flag(PropertyRNA *prop, PropertyFlag flag)
Definition: rna_define.c:1490
void RNA_def_property_override_flag(PropertyRNA *prop, PropertyOverrideFlag flag)
Definition: rna_define.c:1503
static void rna_def_speaker(BlenderRNA *brna)
Definition: rna_speaker.c:30
void RNA_def_speaker(BlenderRNA *brna)
Definition: rna_speaker.c:167