sample_library.h
1 /*************************************************************************/
2 /* sample_library.h */
3 /*************************************************************************/
4 /* This file is part of: */
5 /* GODOT ENGINE */
6 /* http://www.godotengine.org */
7 /*************************************************************************/
8 /* Copyright (c) 2007-2016 Juan Linietsky, Ariel Manzur. */
9 /* */
10 /* Permission is hereby granted, free of charge, to any person obtaining */
11 /* a copy of this software and associated documentation files (the */
12 /* "Software"), to deal in the Software without restriction, including */
13 /* without limitation the rights to use, copy, modify, merge, publish, */
14 /* distribute, sublicense, and/or sell copies of the Software, and to */
15 /* permit persons to whom the Software is furnished to do so, subject to */
16 /* the following conditions: */
17 /* */
18 /* The above copyright notice and this permission notice shall be */
19 /* included in all copies or substantial portions of the Software. */
20 /* */
21 /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
22 /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
23 /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
24 /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
25 /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
26 /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
27 /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
28 /*************************************************************************/
29 #ifndef SAMPLE_LIBRARY_H
30 #define SAMPLE_LIBRARY_H
31 
32 #include "resource.h"
33 #include "scene/resources/sample.h"
34 #include "map.h"
35 
36 class SampleLibrary : public Resource {
37 
38  OBJ_TYPE(SampleLibrary,Resource);
39 
40  struct SampleData {
41 
42  Ref<Sample> sample;
43  float db;
44  float pitch_scale;
45 
46  SampleData() { db=0; pitch_scale=1; }
47  };
48 
49  Map<StringName,SampleData > sample_map;
50 protected:
51 
52  bool _set(const StringName& p_name, const Variant& p_value);
53  bool _get(const StringName& p_name,Variant &r_ret) const;
54  void _get_property_list(List<PropertyInfo> *p_list) const;
55 
56  static void _bind_methods();
57 
58 public:
59 
60 
61 
62  void add_sample(const StringName& p_name, const Ref<Sample>& p_sample);
63  bool has_sample(const StringName& p_name) const;
64  void sample_set_volume_db(const StringName& p_name, float p_db);
65  float sample_get_volume_db(const StringName& p_name) const;
66  void sample_set_pitch_scale(const StringName& p_name, float p_pitch);
67  float sample_get_pitch_scale(const StringName& p_name) const;
68  Ref<Sample> get_sample(const StringName& p_name) const;
69  void get_sample_list(List<StringName> *p_samples);
70  void remove_sample(const StringName& p_name);
71  StringName get_sample_idx(int p_idx) const;
72 
73  SampleLibrary();
74 };
75 
76 #endif // SAMPLE_LIBRARY_H
Definition: variant.h:74
Definition: string_db.h:48
Definition: sample_library.h:36
Definition: resource.h:89