SoundAsset.h

Public Functions

DefineConsoleType(TypeSoundAssetPtr , SoundAsset )

 1
 2#pragma once
 3//-----------------------------------------------------------------------------
 4// Copyright (c) 2013 GarageGames, LLC
 5//
 6// Permission is hereby granted, free of charge, to any person obtaining a copy
 7// of this software and associated documentation files (the "Software"), to
 8// deal in the Software without restriction, including without limitation the
 9// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10// sell copies of the Software, and to permit persons to whom the Software is
11// furnished to do so, subject to the following conditions:
12//
13// The above copyright notice and this permission notice shall be included in
14// all copies or substantial portions of the Software.
15//
16// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
22// IN THE SOFTWARE.
23//-----------------------------------------------------------------------------
24#ifndef SOUND_ASSET_H
25#define SOUND_ASSET_H
26
27#ifndef _ASSET_BASE_H_
28#include "assets/assetBase.h"
29#endif
30
31#ifndef _ASSET_DEFINITION_H_
32#include "assets/assetDefinition.h"
33#endif
34
35#ifndef _STRINGUNIT_H_
36#include "string/stringUnit.h"
37#endif
38
39#ifndef _ASSET_FIELD_TYPES_H_
40#include "assets/assetFieldTypes.h"
41#endif
42
43class SFXTrack;
44
45//-----------------------------------------------------------------------------
46class SoundAsset : public AssetBase
47{
48   typedef AssetBase Parent;
49
50protected:
51   StringTableEntry        mSoundFile;
52   StringTableEntry        mSoundPath;
53   F32                     mPitchAdjust;
54   F32                     mVolumeAdjust;
55
56public:
57   SoundAsset();
58   virtual ~SoundAsset();
59
60   /// Engine.
61   static void initPersistFields();
62   virtual void copyTo(SimObject* object);
63
64   /// Declare Console Object.
65   DECLARE_CONOBJECT(SoundAsset);
66
67   void                    setSoundFile(const char* pSoundFile);
68   inline StringTableEntry getSoundFile(void) const { return mSoundFile; };
69
70   inline StringTableEntry getSoundPath(void) const { return mSoundPath; };
71
72protected:
73   virtual void            initializeAsset(void);
74   virtual void            onAssetRefresh(void);
75
76   static bool setSoundFile(void *obj, const char *index, const char *data) { static_cast<SoundAsset*>(obj)->setSoundFile(data); return false; }
77   static const char* getSoundFile(void* obj, const char* data) { return static_cast<SoundAsset*>(obj)->getSoundFile(); }
78};
79
80DefineConsoleType(TypeSoundAssetPtr, SoundAsset)
81
82#endif // _ASSET_BASE_H_
83
84