VSoundEffectEvent.h

Engine/source/Verve/Extension/SoundEffect/VSoundEffectEvent.h
Classes:

class
Detailed Description

 1
 2//-----------------------------------------------------------------------------
 3// Verve
 4// Copyright (C) 2014 - Violent Tulip
 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 _VT_VSOUNDEFFECTEVENT_H_
25#define _VT_VSOUNDEFFECTEVENT_H_
26
27#ifndef _VT_VSCENEOBJECTEVENT_H_
28#include "Verve/Extension/SceneObject/VSceneObjectEvent.h"
29#endif
30
31#ifndef _VT_TORQUE_SOUNDEFFECT_H_
32#include "Verve/Torque/TSoundEffect.h"
33#endif
34
35//-----------------------------------------------------------------------------
36
37class VSoundEffectEvent : public VSceneObjectEvent
38{
39    typedef VSceneObjectEvent Parent;
40
41    enum
42    {
43        SFXStartBuffer = 100,
44    };
45
46public:
47
48    SimObjectPtr<VTorque::SoundEffectType>    mSoundEffect;
49
50public:
51
52    VSoundEffectEvent( void );
53
54    static void     initPersistFields( void );
55
56    static bool     setSoundData( void *pObject, const char *pArray, const char *pData );
57
58    // Event Methods.
59
60    virtual void    onTrigger( const S32 &pTime, const S32 &pDelta );
61
62    // Console Declaration.
63
64    DECLARE_CONOBJECT( VSoundEffectEvent );
65
66public:
67
68    // Property Methods.
69
70    virtual void    setDuration( const S32 &pDuration );
71};
72
73//-----------------------------------------------------------------------------
74
75#endif // _VT_VSOUNDEFFECTEVENT_H_
76