i6engine  1.0
SoundComponent.h
Go to the documentation of this file.
1 /*
2  * i6engine
3  * Copyright (2016) Daniel Bonrath, Michael Baer, All rights reserved.
4  *
5  * This file is part of i6engine; i6engine is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2.1 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18  */
19 
25 #ifndef __I6ENGINE_API_SOUNDCOMPONENT_H__
26 #define __I6ENGINE_API_SOUNDCOMPONENT_H__
27 
29 
31 
32 namespace i6e {
33 namespace api {
34 
36 
52  public:
56  SoundComponent(const int64_t id, const attributeMap & params);
57 
61  ~SoundComponent();
62 
66  attributeMap synchronize() const override;
67 
68  std::string getTemplateName() const override {
69  return "Sound";
70  }
71 
72  std::vector<componentOptions> getComponentOptions() override;
73 
74  private:
78  Vec3 _position;
79 
83  Vec3 _offset;
84 
88  Vec3 _direction;
89 
93  std::string _file;
94 
98  bool _looping;
99 
103  double _maxDist;
104 
109 
113  bool _cacheable;
114 
118  std::string _category;
119 
123  void Init() override;
124 
125  void Finalize() override;
126 
127  void Tick() override;
128 
129  virtual std::pair<AddStrategy, int64_t> howToAdd(const ComPtr & comp) const override;
130  };
131 
132 } /* namespace api */
133 } /* namespace i6e */
134 
135 #endif /* __I6ENGINE_API_SOUNDCOMPONENT_H__ */
136 
#define ISIXE_MODULES_API
A weak pointer observing a sharedPtr.
Definition: sharedPtr.h:53
std::map< std::string, std::string > attributeMap
Definition: attributeMap.h:42
Implements 3-dimensional vectors.
Definition: i6eVector.h:48
Attaches a sound node to an object. The Sound will follow the object For creating a SoundComponent...
A shared pointer counting references and adds objects being not referenced any more to an internal li...
Definition: sharedPtr.h:50
std::string getTemplateName() const override
returns the name this template was registered with
Component Base Class. All Components must derive from Component.
Definition: Component.h:97